A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
" } }, + "com.amazonaws.b2bi#CapabilityDirection": { + "type": "enum", + "members": { + "INBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INBOUND" + } + }, + "OUTBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTBOUND" + } + } + } + }, "com.amazonaws.b2bi#CapabilityId": { "type": "string", "traits": { @@ -840,6 +863,20 @@ } } }, + "com.amazonaws.b2bi#CapabilityOptions": { + "type": "structure", + "members": { + "outboundEdi": { + "target": "com.amazonaws.b2bi#OutboundEdiOptions", + "traits": { + "smithy.api#documentation": "A structure that contains the outbound EDI options.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the details for an Outbound EDI capability.
" + } + }, "com.amazonaws.b2bi#CapabilitySummary": { "type": "structure", "members": { @@ -909,6 +946,94 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.b2bi#ConversionSource": { + "type": "structure", + "members": { + "fileFormat": { + "target": "com.amazonaws.b2bi#ConversionSourceFormat", + "traits": { + "smithy.api#documentation": "The format for the input file: either JSON or XML.
", + "smithy.api#required": {} + } + }, + "inputFile": { + "target": "com.amazonaws.b2bi#InputFileSource", + "traits": { + "smithy.api#documentation": "File to be converted", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the input for an outbound transformation.
" + } + }, + "com.amazonaws.b2bi#ConversionSourceFormat": { + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "XML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XML" + } + } + } + }, + "com.amazonaws.b2bi#ConversionTarget": { + "type": "structure", + "members": { + "fileFormat": { + "target": "com.amazonaws.b2bi#ConversionTargetFormat", + "traits": { + "smithy.api#documentation": "Currently, only X12 format is supported.
", + "smithy.api#required": {} + } + }, + "formatDetails": { + "target": "com.amazonaws.b2bi#ConversionTargetFormatDetails", + "traits": { + "smithy.api#documentation": "A structure that contains the formatting details for the conversion target.
" + } + }, + "outputSampleFile": { + "target": "com.amazonaws.b2bi#OutputSampleFileSource", + "traits": { + "smithy.api#documentation": "Customer uses this to provide a sample on what should file look like after conversion\nX12 EDI use case around this would be discovering the file syntax" + } + } + }, + "traits": { + "smithy.api#documentation": "Provide a sample of what the output of the transformation should look like.
" + } + }, + "com.amazonaws.b2bi#ConversionTargetFormat": { + "type": "enum", + "members": { + "X12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12" + } + } + } + }, + "com.amazonaws.b2bi#ConversionTargetFormatDetails": { + "type": "union", + "members": { + "x12": { + "target": "com.amazonaws.b2bi#X12Details" + } + }, + "traits": { + "smithy.api#documentation": "Contains a structure describing the X12 details for the conversion target.
" + } + }, "com.amazonaws.b2bi#CreateCapability": { "type": "operation", "input": { @@ -1246,6 +1371,12 @@ "smithy.api#required": {} } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "Specify the structure that contains the details for the associated capabilities.
" + } + }, "clientToken": { "target": "smithy.api#String", "traits": { @@ -1313,6 +1444,12 @@ "smithy.api#documentation": "Returns one or more capabilities associated with this partnership.
" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "Returns the structure that contains the details for the associated capabilities.
" + } + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -1539,6 +1676,101 @@ "smithy.api#output": {} } }, + "com.amazonaws.b2bi#CreateStarterMappingTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#CreateStarterMappingTemplateRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#CreateStarterMappingTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.
\nIf you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template.\n The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it\n into the JSON or XML file that is used to generate the EDI.
\nIf you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the templateDetails parameter.\n
Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.
", + "smithy.api#examples": [ + { + "title": "Sample CreateStarterMappingTemplate call", + "input": { + "mappingType": "JSONATA", + "templateDetails": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "outputSampleLocation": { + "bucketName": "output-sample-bucket", + "key": "output-sample-key" + } + }, + "output": { + "mappingTemplate": "Example Mapping Template" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/createmappingstarttemplate", + "method": "POST" + } + } + }, + "com.amazonaws.b2bi#CreateStarterMappingTemplateRequest": { + "type": "structure", + "members": { + "outputSampleLocation": { + "target": "com.amazonaws.b2bi#S3Location", + "traits": { + "smithy.api#documentation": "Specify the location of the sample EDI file that is used to generate the mapping template.
" + } + }, + "mappingType": { + "target": "com.amazonaws.b2bi#MappingType", + "traits": { + "smithy.api#documentation": "Specify the format for the mapping template: either JSONATA or XSLT.
", + "smithy.api#required": {} + } + }, + "templateDetails": { + "target": "com.amazonaws.b2bi#TemplateDetails", + "traits": { + "smithy.api#documentation": "\n Describes the details needed for generating the template. Specify the X12 transaction set and version for which the template is used:\n currently, we only support X12.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#CreateStarterMappingTemplateResponse": { + "type": "structure", + "members": { + "mappingTemplate": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Returns a string that represents the mapping template.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.b2bi#CreateTransformer": { "type": "operation", "input": { @@ -1572,24 +1804,46 @@ ], "traits": { "aws.iam#requiredActions": [ - "b2bi:TagResource" + "b2bi:TagResource", + "b2bi:UpdateTransformer", + "logs:CreateLogDelivery", + "logs:CreateLogGroup", + "logs:CreateLogStream", + "logs:DescribeLogGroups", + "logs:DescribeLogStreams", + "logs:DescribeResourcePolicies", + "logs:ListLogDeliveries", + "logs:PutLogEvents", + "logs:PutResourcePolicy" ], - "smithy.api#documentation": "Creates a transformer. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "smithy.api#documentation": "Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:
\n\n Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange \n converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer,\n in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
\n\n Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use\n in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate\n a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
\nThe following fields are provided for backwards compatibility only: fileFormat,\n mappingTemplate, ediType, and sampleDocument.
Use the mapping data type in place of mappingTemplate and fileFormat\n
Use the sampleDocuments data type in place of sampleDocument\n
Use either the inputConversion or outputConversion in place of ediType\n
Reserved for future use.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.b2bi#TagList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
" + } + }, "fileFormat": { "target": "com.amazonaws.b2bi#FileFormat", "traits": { - "smithy.api#documentation": "Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
\nThis parameter is available for backwards compatibility. Use the Mapping data type instead.
\nSpecifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } }, - "clientToken": { - "target": "smithy.api#String", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "Reserved for future use.
", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "Specify the InputConversion object, which contains the format options for the inbound transformation.
Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
" + "smithy.api#documentation": "Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "A structure that contains the OutputConversion object, which contains the format options for the outbound transformation.
Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -1703,20 +2002,6 @@ "smithy.api#required": {} } }, - "fileFormat": { - "target": "com.amazonaws.b2bi#FileFormat", - "traits": { - "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", - "smithy.api#required": {} - } - }, "status": { "target": "com.amazonaws.b2bi#TransformerStatus", "traits": { @@ -1724,24 +2009,75 @@ "smithy.api#required": {} } }, - "ediType": { - "target": "com.amazonaws.b2bi#EdiType", + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", "traits": { - "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", + "smithy.api#documentation": "Returns a timestamp for creation date and time of the transformer.
", "smithy.api#required": {} } }, - "sampleDocument": { - "target": "com.amazonaws.b2bi#FileLocation", + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", "traits": { - "smithy.api#documentation": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns a timestamp for creation date and time of the transformer.
", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" + } + }, + "ediType": { + "target": "com.amazonaws.b2bi#EdiType", + "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" + } + }, + "sampleDocument": { + "target": "com.amazonaws.b2bi#FileLocation", + "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" + } + }, + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", + "traits": { + "smithy.api#documentation": "Returns the InputConversion object, which contains the format options for the inbound transformation.
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "Returns the OutputConversion object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -1974,7 +2310,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified transformer. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "smithy.api#documentation": "Deletes the specified transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "smithy.api#examples": [ { "title": "Sample DeleteTransformer call", @@ -2010,6 +2346,12 @@ "com.amazonaws.b2bi#EdiConfiguration": { "type": "structure", "members": { + "capabilityDirection": { + "target": "com.amazonaws.b2bi#CapabilityDirection", + "traits": { + "smithy.api#documentation": "Specifies whether this is capability is for inbound or outbound transformations.
" + } + }, "type": { "target": "com.amazonaws.b2bi#EdiType", "traits": { @@ -2054,7 +2396,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" + "smithy.api#documentation": "Specifies the details for the EDI standard that is being used for the transformer.\n Currently, only X12 is supported. X12 is a set of standards and corresponding messages \n that define specific business documents.
" } }, "com.amazonaws.b2bi#Email": { @@ -2091,6 +2433,12 @@ "traits": { "smithy.api#enumValue": "JSON" } + }, + "NOT_USED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_USED" + } } } }, @@ -2103,6 +2451,28 @@ } } }, + "com.amazonaws.b2bi#FormatOptions": { + "type": "union", + "members": { + "x12": { + "target": "com.amazonaws.b2bi#X12Details" + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains the X12 transaction set and version.
" + } + }, + "com.amazonaws.b2bi#FromFormat": { + "type": "enum", + "members": { + "X12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12" + } + } + } + }, "com.amazonaws.b2bi#GetCapability": { "type": "operation", "input": { @@ -2378,6 +2748,9 @@ "smithy.api#documentation": "Returns one or more capabilities associated with this partnership.
" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions" + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -2575,7 +2948,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the details for the transformer specified by the transformer ID. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "smithy.api#documentation": "Retrieves the details for the transformer specified by the transformer ID. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "smithy.api#examples": [ { "title": "Sample GetTransformer call", @@ -2584,17 +2957,28 @@ }, "output": { "createdAt": "2023-11-01T21:51:05.504Z", - "ediType": { - "x12Details": { - "transactionSet": "X12_110", - "version": "VERSION_4010" + "name": "transformX12", + "inputConversion": { + "fromFormat": "X12", + "formatOptions": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } } }, - "fileFormat": "JSON", - "mappingTemplate": "$", - "modifiedAt": "2023-11-01T21:51:05.504Z", - "name": "transformJSON", - "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "mapping": { + "templateLanguage": "JSONATA", + "template": "{}" + }, + "sampleDocuments": { + "bucketName": "test-bucket", + "keys": [ + { + "input": "sampleDoc.txt" + } + ] + }, "status": "inactive", "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", "transformerId": "tr-974c129999f84d8c9" @@ -2753,51 +3137,88 @@ "smithy.api#required": {} } }, - "fileFormat": { - "target": "com.amazonaws.b2bi#FileFormat", + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", "traits": { - "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "smithy.api#documentation": "Returns a timestamp for creation date and time of the transformer.
", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.b2bi#TransformerStatus", + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", "traits": { - "smithy.api#documentation": "Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.
Returns a timestamp for last time the transformer was modified.
" + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" } }, "ediType": { "target": "com.amazonaws.b2bi#EdiType", "traits": { - "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } }, - "createdAt": { - "target": "com.amazonaws.b2bi#CreatedDate", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "Returns a timestamp for creation date and time of the transformer.
", - "smithy.api#required": {} + "smithy.api#documentation": "Returns the InputConversion object, which contains the format options for the inbound transformation.
Returns a timestamp for last time the transformer was modified.
" + "smithy.api#documentation": "Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "Returns the OutputConversion object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -2805,6 +3226,45 @@ "smithy.api#output": {} } }, + "com.amazonaws.b2bi#InputConversion": { + "type": "structure", + "members": { + "fromFormat": { + "target": "com.amazonaws.b2bi#FromFormat", + "traits": { + "smithy.api#documentation": "The format for the transformer input: currently on X12 is supported.
A structure that contains the formatting options for an inbound transformer.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the input formatting options for an inbound transformer (takes an X12-formatted\n EDI document as input and converts it to JSON or XML.
" + } + }, + "com.amazonaws.b2bi#InputFileSource": { + "type": "union", + "members": { + "fileContent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specify the input contents, as a string, for the source of an outbound transformation.
", + "smithy.api#length": { + "min": 1, + "max": 5000000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The input file to use for an outbound transformation.
" + } + }, "com.amazonaws.b2bi#InstructionsDocuments": { "type": "list", "member": { @@ -2841,6 +3301,12 @@ "smithy.api#retryable": {} } }, + "com.amazonaws.b2bi#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#SampleDocumentKeys" + } + }, "com.amazonaws.b2bi#ListCapabilities": { "type": "operation", "input": { @@ -3261,7 +3727,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the available transformers. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "smithy.api#documentation": "Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "smithy.api#examples": [ { "title": "Sample ListTransformers call", @@ -3375,6 +3841,27 @@ } } }, + "com.amazonaws.b2bi#Mapping": { + "type": "structure", + "members": { + "templateLanguage": { + "target": "com.amazonaws.b2bi#MappingTemplateLanguage", + "traits": { + "smithy.api#documentation": "The transformation language for the template, either XSLT or JSONATA.
", + "smithy.api#required": {} + } + }, + "template": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#documentation": "A string that represents the mapping template, in the transformation language specified in templateLanguage.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" + } + }, "com.amazonaws.b2bi#MappingTemplate": { "type": "string", "traits": { @@ -3384,6 +3871,40 @@ } } }, + "com.amazonaws.b2bi#MappingTemplateLanguage": { + "type": "enum", + "members": { + "XSLT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XSLT" + } + }, + "JSONATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSONATA" + } + } + } + }, + "com.amazonaws.b2bi#MappingType": { + "type": "enum", + "members": { + "JSONATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSONATA" + } + }, + "XSLT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XSLT" + } + } + } + }, "com.amazonaws.b2bi#MaxResults": { "type": "integer", "traits": { @@ -3399,6 +3920,52 @@ "smithy.api#timestampFormat": "date-time" } }, + "com.amazonaws.b2bi#OutboundEdiOptions": { + "type": "union", + "members": { + "x12": { + "target": "com.amazonaws.b2bi#X12Envelope", + "traits": { + "smithy.api#documentation": "A structure that contains an X12 envelope structure.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A container for outbound EDI options.
" + } + }, + "com.amazonaws.b2bi#OutputConversion": { + "type": "structure", + "members": { + "toFormat": { + "target": "com.amazonaws.b2bi#ToFormat", + "traits": { + "smithy.api#documentation": "The format for the output from an outbound transformer: only X12 is currently supported.
", + "smithy.api#required": {} + } + }, + "formatOptions": { + "target": "com.amazonaws.b2bi#FormatOptions", + "traits": { + "smithy.api#documentation": "A structure that contains the X12 transaction set and version for the transformer output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the formatting options for an outbound transformer (takes JSON or XML as input and converts it to an EDI document (currently only X12 format is supported).
" + } + }, + "com.amazonaws.b2bi#OutputSampleFileSource": { + "type": "union", + "members": { + "fileLocation": { + "target": "com.amazonaws.b2bi#S3Location" + } + }, + "traits": { + "smithy.api#documentation": "Container for the location of a sample file used for outbound transformations.
" + } + }, "com.amazonaws.b2bi#PageToken": { "type": "string", "traits": { @@ -3505,6 +4072,9 @@ "smithy.api#documentation": "Returns one or more capabilities associated with this partnership.
" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions" + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -3717,7 +4287,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2BI Data Interchange. File\n locations in Amazon S3 are identified using a combination of the bucket and key.
" + "smithy.api#documentation": "Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File\n locations in Amazon S3 are identified using a combination of the bucket and key.
" } }, "com.amazonaws.b2bi#S3LocationList": { @@ -3726,6 +4296,48 @@ "target": "com.amazonaws.b2bi#S3Location" } }, + "com.amazonaws.b2bi#SampleDocumentKeys": { + "type": "structure", + "members": { + "input": { + "target": "com.amazonaws.b2bi#S3Key", + "traits": { + "smithy.api#documentation": "An array of keys for your input sample documents.
" + } + }, + "output": { + "target": "com.amazonaws.b2bi#S3Key", + "traits": { + "smithy.api#documentation": "An array of keys for your output sample documents.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An array of the Amazon S3 keys used to identify the location for your sample documents.
" + } + }, + "com.amazonaws.b2bi#SampleDocuments": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.b2bi#BucketName", + "traits": { + "smithy.api#documentation": "Contains the Amazon S3 bucket that is used to hold your sample documents.
", + "smithy.api#required": {} + } + }, + "keys": { + "target": "com.amazonaws.b2bi#KeyList", + "traits": { + "smithy.api#documentation": "Contains an array of the Amazon S3 keys used to identify the location for your sample documents.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" + } + }, "com.amazonaws.b2bi#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -3799,7 +4411,7 @@ } ], "traits": { - "smithy.api#documentation": "Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2BI Data Interchange.
\nIf you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just\n create and configure a transformer, and then run the StartTransformerJob API to process your files.
Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.
\nIf you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just\n create and configure a transformer, and then run the StartTransformerJob API to process your files.
A data structure that contains the information to use when generating a mapping template.
" + } + }, + "com.amazonaws.b2bi#TestConversion": { "type": "operation", "input": { - "target": "com.amazonaws.b2bi#TestMappingRequest" + "target": "com.amazonaws.b2bi#TestConversionRequest" }, "output": { - "target": "com.amazonaws.b2bi#TestMappingResponse" + "target": "com.amazonaws.b2bi#TestConversionResponse" }, "errors": [ { @@ -4036,17 +4659,121 @@ } ], "traits": { - "smithy.api#documentation": "Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the inputFileContent parameter.
This operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string.
", "smithy.api#examples": [ { - "title": "Sample TestMapping call", + "title": "Sample TestConversion call", "input": { - "fileFormat": "JSON", - "inputFileContent": "Sample file content", - "mappingTemplate": "$" + "source": { + "fileFormat": "JSON", + "inputFile": { + "fileContent": "Sample file content" + } + }, + "target": { + "fileFormat": "X12", + "formatDetails": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + } + } }, "output": { - "mappedFileContent": "Sample file content" + "convertedFileContent": "Sample converted file content", + "validationMessages": [] + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/testconversion", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#TestConversionRequest": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.b2bi#ConversionSource", + "traits": { + "smithy.api#documentation": "Specify the source file for an outbound EDI request.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.b2bi#ConversionTarget", + "traits": { + "smithy.api#documentation": "Specify the format (X12 is the only currently supported format), and other details for the conversion target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#TestConversionResponse": { + "type": "structure", + "members": { + "convertedFileContent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Returns the converted file content.
", + "smithy.api#required": {} + } + }, + "validationMessages": { + "target": "com.amazonaws.b2bi#ValidationMessages", + "traits": { + "smithy.api#documentation": "Returns an array of strings, each containing a message that Amazon Web Services B2B Data Interchange generates during the conversion.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#TestMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#TestMappingRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#TestMappingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the inputFileContent parameter.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "smithy.api#documentation": "Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
\nThis parameter is available for backwards compatibility. Use the Mapping data type instead.
\nReturns that the currently supported file formats for EDI transformations are JSON and XML.
Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "smithy.api#documentation": "Returns a timestamp indicating when the transformer was created. For example,\n 2023-07-20T19:58:44.624Z.
Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.
Returns a timestamp representing the date and time for the most recent change for the transformer object.
" + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" } }, "ediType": { "target": "com.amazonaws.b2bi#EdiType", "traits": { - "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } }, - "createdAt": { - "target": "com.amazonaws.b2bi#CreatedDate", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "Returns a timestamp indicating when the transformer was created. For example,\n 2023-07-20T19:58:44.624Z.
Returns a structure that contains the format options for the transformation.
" } }, - "modifiedAt": { - "target": "com.amazonaws.b2bi#ModifiedDate", + "mapping": { + "target": "com.amazonaws.b2bi#Mapping", "traits": { - "smithy.api#documentation": "Returns a timestamp representing the date and time for the most recent change for the transformer object.
" + "smithy.api#documentation": "Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "Returns the OutputConversion object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, "traits": { - "smithy.api#documentation": "Contains the details for a transformer object. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "smithy.api#documentation": "Contains the details for a transformer object. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "smithy.api#references": [ { "resource": "com.amazonaws.b2bi#Transformer" @@ -4796,6 +5572,12 @@ "traits": { "smithy.api#documentation": "List of the capabilities associated with this partnership.
" } + }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "To update, specify the structure that contains the details for the associated capabilities.
" + } } }, "traits": { @@ -4850,6 +5632,12 @@ "smithy.api#documentation": "Returns one or more capabilities associated with this partnership.
" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "Returns the structure that contains the details for the associated capabilities.
" + } + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -5093,39 +5881,63 @@ "b2bi:TagResource", "b2bi:UntagResource" ], - "smithy.api#documentation": "Updates the specified parameters for a transformer. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "smithy.api#documentation": "Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "smithy.api#examples": [ { "title": "Sample UpdateTransformer call", "input": { - "ediType": { - "x12Details": { - "transactionSet": "X12_110", - "version": "VERSION_4010" + "inputConversion": { + "fromFormat": "X12", + "formatOptions": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } } }, - "fileFormat": "JSON", - "mappingTemplate": "{}", - "name": "transformJSON", - "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "mapping": { + "templateLanguage": "JSONATA", + "template": "{}" + }, + "sampleDocuments": { + "bucketName": "test-bucket", + "keys": [ + { + "input": "sampleDoc.txt" + } + ] + }, + "name": "transformX12", "status": "inactive", "transformerId": "tr-974c129999f84d8c9" }, "output": { "createdAt": "2023-11-01T21:51:05.504Z", - "ediType": { - "x12Details": { - "transactionSet": "X12_110", - "version": "VERSION_4010" + "modifiedAt": "2023-11-02T22:31:05.504Z", + "name": "transformX12", + "inputConversion": { + "fromFormat": "X12", + "formatOptions": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } } }, - "fileFormat": "JSON", - "mappingTemplate": "$", - "modifiedAt": "2023-11-01T21:51:05.504Z", - "name": "transformJSON", - "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "mapping": { + "templateLanguage": "JSONATA", + "template": "{}" + }, + "sampleDocuments": { + "bucketName": "test-bucket", + "keys": [ + { + "input": "sampleDoc.txt" + } + ] + }, "status": "inactive", - "transformerArn": "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9", + "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", "transformerId": "tr-974c129999f84d8c9" } } @@ -5155,35 +5967,71 @@ "smithy.api#documentation": "Specify a new name for the transformer, if you want to update it.
" } }, + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", + "traits": { + "smithy.api#documentation": "Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" - } - }, - "status": { - "target": "com.amazonaws.b2bi#TransformerStatus", - "traits": { - "smithy.api#documentation": "Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
\nThis parameter is available for backwards compatibility. Use the Mapping data type instead.
\nSpecifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } + }, + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", + "traits": { + "smithy.api#documentation": "To update, specify the InputConversion object, which contains the format options for the inbound transformation.
Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "To update, specify the OutputConversion object, which contains the format options for the outbound transformation.
Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" + } } }, "traits": { @@ -5214,52 +6062,89 @@ "smithy.api#required": {} } }, - "fileFormat": { - "target": "com.amazonaws.b2bi#FileFormat", + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", "traits": { - "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "smithy.api#documentation": "Returns a timestamp for creation date and time of the transformer.
", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.b2bi#TransformerStatus", + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", "traits": { - "smithy.api#documentation": "Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.
Returns a timestamp for last time the transformer was modified.
", "smithy.api#required": {} } }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" + } + }, "ediType": { "target": "com.amazonaws.b2bi#EdiType", "traits": { - "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } }, - "createdAt": { - "target": "com.amazonaws.b2bi#CreatedDate", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "Returns a timestamp for creation date and time of the transformer.
", - "smithy.api#required": {} + "smithy.api#documentation": "Returns the InputConversion object, which contains the format options for the inbound transformation.
Returns a timestamp for last time the transformer was modified.
", - "smithy.api#required": {} + "smithy.api#documentation": "Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "Returns the OutputConversion object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -5283,6 +6168,88 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.b2bi#ValidationMessages": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.b2bi#X12AcknowledgmentRequestedCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ApplicationReceiverCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ApplicationSenderCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ComponentSeparator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$" + } + }, + "com.amazonaws.b2bi#X12DataElementSeparator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$" + } + }, + "com.amazonaws.b2bi#X12Delimiters": { + "type": "structure", + "members": { + "componentSeparator": { + "target": "com.amazonaws.b2bi#X12ComponentSeparator", + "traits": { + "smithy.api#documentation": "The component, or sub-element, separator. The default value is : (colon).
The data element separator. The default value is * (asterisk).
The segment terminator. The default value is ~ (tilde).
In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.\n The delimiters are part of the message's syntax and divide up its different elements.
" + } + }, "com.amazonaws.b2bi#X12Details": { "type": "structure", "members": { @@ -5295,7 +6262,7 @@ "version": { "target": "com.amazonaws.b2bi#X12Version", "traits": { - "smithy.api#documentation": "Returns the version to use for the specified X12 transaction set.\n \n \n \n
" + "smithy.api#documentation": "Returns the version to use for the specified X12 transaction set.
" } } }, @@ -5303,6 +6270,187 @@ "smithy.api#documentation": "A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
\nIf an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.
\nA container for the X12 outbound EDI headers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A wrapper structure for an X12 definition object.
\nthe X12 envelope ensures the integrity of the data and the efficiency of the information exchange. The X12 message structure has hierarchical levels. From highest to the lowest, they are:
\nInterchange Envelope
\nFunctional Group
\nTransaction Set
\nA value representing the code used to identify the party transmitting a message, at position GS-02.
" + } + }, + "applicationReceiverCode": { + "target": "com.amazonaws.b2bi#X12ApplicationReceiverCode", + "traits": { + "smithy.api#documentation": "A value representing the code used to identify the party receiving a message, at position GS-03.
" + } + }, + "responsibleAgencyCode": { + "target": "com.amazonaws.b2bi#X12ResponsibleAgencyCode", + "traits": { + "smithy.api#documentation": "A code that identifies the issuer of the standard, at position GS-07.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Part of the X12 message structure. These are the functional group headers for the X12 EDI object.
" + } + }, + "com.amazonaws.b2bi#X12IdQualifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12InterchangeControlHeaders": { + "type": "structure", + "members": { + "senderIdQualifier": { + "target": "com.amazonaws.b2bi#X12IdQualifier", + "traits": { + "smithy.api#documentation": "Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
" + } + }, + "senderId": { + "target": "com.amazonaws.b2bi#X12SenderId", + "traits": { + "smithy.api#documentation": "Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
" + } + }, + "receiverId": { + "target": "com.amazonaws.b2bi#X12ReceiverId", + "traits": { + "smithy.api#documentation": "Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
\nThis parameter is only honored for version greater than 401 (VERSION_4010 and higher).
For versions less than 401, this field is called StandardsId, in which case our service\n sets the value to U.
Located at position ISA-14 in the header. The value \"1\" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value \"0\" is used otherwise.
" + } + }, + "usageIndicatorCode": { + "target": "com.amazonaws.b2bi#X12UsageIndicatorCode", + "traits": { + "smithy.api#documentation": "Located at position ISA-15 in the header. Specifies how this interchange is being used:
\n\n T indicates this interchange is for testing.
\n P indicates this interchange is for production.
\n I indicates this interchange is informational.
In X12, the Interchange Control Header is the first segment of an EDI document and is\n part of the Interchange Envelope. It contains information about the sender and receiver,\n the date and time of transmission, and the X12 version being used. It also includes\n delivery information, such as the sender and receiver IDs.
" + } + }, + "com.amazonaws.b2bi#X12OutboundEdiHeaders": { + "type": "structure", + "members": { + "interchangeControlHeaders": { + "target": "com.amazonaws.b2bi#X12InterchangeControlHeaders", + "traits": { + "smithy.api#documentation": "In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
" + } + }, + "functionalGroupHeaders": { + "target": "com.amazonaws.b2bi#X12FunctionalGroupHeaders", + "traits": { + "smithy.api#documentation": "The functional group headers for the X12 object.
" + } + }, + "delimiters": { + "target": "com.amazonaws.b2bi#X12Delimiters", + "traits": { + "smithy.api#documentation": "The delimiters, for example semicolon (;), that separates sections of the headers for the X12 object.
Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.
A structure containing the details for an outbound EDI object.
" + } + }, + "com.amazonaws.b2bi#X12ReceiverId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12RepetitionSeparator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.b2bi#X12ResponsibleAgencyCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12SegmentTerminator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$" + } + }, + "com.amazonaws.b2bi#X12SenderId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, "com.amazonaws.b2bi#X12TransactionSet": { "type": "enum", "members": { @@ -5758,6 +6906,19 @@ } } }, + "com.amazonaws.b2bi#X12UsageIndicatorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ValidateEdi": { + "type": "boolean" + }, "com.amazonaws.b2bi#X12Version": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json index b5b293bf4c5..06389032de7 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json @@ -1504,26 +1504,26 @@ "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", "traits": { - "smithy.api#documentation": "The modelArn used with the external source wrapper object in the retrieveAndGenerate function.
", + "smithy.api#documentation": "The model Amazon Resource Name (ARN) for the external source wrapper object in the retrieveAndGenerate function.
The document used with the external source wrapper object in the retrieveAndGenerate function.
", + "smithy.api#documentation": "The document for the external source wrapper object in the retrieveAndGenerate function.
The prompt used with the external source wrapper object with the retrieveAndGenerate function.
" + "smithy.api#documentation": "The prompt used with the external source wrapper object with the retrieveAndGenerate function.
The configurations of the external source wrapper object in the retrieveAndGenerate function.
" + "smithy.api#documentation": "The configurations of the external source wrapper object in the retrieveAndGenerate function.
Details about the response from the Lambda parsing of the output of the post-processing step.
" } + }, + "rawResponse": { + "target": "com.amazonaws.bedrockagentruntime#RawResponse" + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata" } }, "traits": { @@ -4274,6 +4280,12 @@ "traits": { "smithy.api#documentation": "Details about the response from the Lambda parsing of the output of the pre-processing step.
" } + }, + "rawResponse": { + "target": "com.amazonaws.bedrockagentruntime#RawResponse" + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata" } }, "traits": { @@ -5038,20 +5050,20 @@ "type": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateType", "traits": { - "smithy.api#documentation": "The type of resource that is queried by the request.
", + "smithy.api#documentation": "The type of resource that contains your data for retrieving information and generating responses.
\nIf you choose ot use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.
Contains details about the resource being queried.
" + "smithy.api#documentation": "Contains details about the knowledge base for retrieving information and generating responses.
" } }, "externalSourcesConfiguration": { "target": "com.amazonaws.bedrockagentruntime#ExternalSourcesRetrieveAndGenerateConfiguration", "traits": { - "smithy.api#documentation": "The configuration used with the external source wrapper object in the retrieveAndGenerate function.
" + "smithy.api#documentation": "The configuration for the external source wrapper object in the retrieveAndGenerate function.
The assessment details in the response from the guardrail.
", "smithy.api#required": {} } + }, + "guardrailCoverage": { + "target": "com.amazonaws.bedrockruntime#GuardrailCoverage", + "traits": { + "smithy.api#documentation": "The guardrail coverage details in the apply guardrail response.
" + } } }, "traits": { @@ -1636,6 +1642,12 @@ "traits": { "smithy.api#documentation": "The contextual grounding policy used for the guardrail assessment.
" } + }, + "invocationMetrics": { + "target": "com.amazonaws.bedrockruntime#GuardrailInvocationMetrics", + "traits": { + "smithy.api#documentation": "The invocation metrics for the guardrail assessment.
" + } } }, "traits": { @@ -1732,6 +1744,12 @@ "smithy.api#required": {} } }, + "filterStrength": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentFilterStrength", + "traits": { + "smithy.api#documentation": "The filter strength setting for the guardrail content filter.
" + } + }, "action": { "target": "com.amazonaws.bedrockruntime#GuardrailContentPolicyAction", "traits": { @@ -1779,6 +1797,35 @@ "target": "com.amazonaws.bedrockruntime#GuardrailContentFilter" } }, + "com.amazonaws.bedrockruntime#GuardrailContentFilterStrength": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "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" + } + } + } + }, "com.amazonaws.bedrockruntime#GuardrailContentFilterType": { "type": "enum", "members": { @@ -2060,6 +2107,20 @@ "smithy.api#documentation": "A text block that contains text that you want to assess with a guardrail. For more information, see GuardrailConverseContentBlock.
" } }, + "com.amazonaws.bedrockruntime#GuardrailCoverage": { + "type": "structure", + "members": { + "textCharacters": { + "target": "com.amazonaws.bedrockruntime#GuardrailTextCharactersCoverage", + "traits": { + "smithy.api#documentation": "The text characters of the guardrail coverage details.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The action of the guardrail coverage details.
" + } + }, "com.amazonaws.bedrockruntime#GuardrailCustomWord": { "type": "structure", "members": { @@ -2097,6 +2158,32 @@ "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" } }, + "com.amazonaws.bedrockruntime#GuardrailInvocationMetrics": { + "type": "structure", + "members": { + "guardrailProcessingLatency": { + "target": "com.amazonaws.bedrockruntime#GuardrailProcessingLatency", + "traits": { + "smithy.api#documentation": "The processing latency details for the guardrail invocation metrics.
" + } + }, + "usage": { + "target": "com.amazonaws.bedrockruntime#GuardrailUsage", + "traits": { + "smithy.api#documentation": "The usage details for the guardrail invocation metrics.
" + } + }, + "guardrailCoverage": { + "target": "com.amazonaws.bedrockruntime#GuardrailCoverage", + "traits": { + "smithy.api#documentation": "The coverage details for the guardrail invocation metrics.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The invocation metrics for the guardrail.
" + } + }, "com.amazonaws.bedrockruntime#GuardrailManagedWord": { "type": "structure", "members": { @@ -2392,6 +2479,9 @@ } } }, + "com.amazonaws.bedrockruntime#GuardrailProcessingLatency": { + "type": "long" + }, "com.amazonaws.bedrockruntime#GuardrailRegexFilter": { "type": "structure", "members": { @@ -2558,6 +2648,26 @@ "smithy.api#documentation": "The text block to be evaluated by the guardrail.
" } }, + "com.amazonaws.bedrockruntime#GuardrailTextCharactersCoverage": { + "type": "structure", + "members": { + "guarded": { + "target": "com.amazonaws.bedrockruntime#TextCharactersGuarded", + "traits": { + "smithy.api#documentation": "The text characters that were guarded by the guardrail coverage.
" + } + }, + "total": { + "target": "com.amazonaws.bedrockruntime#TextCharactersTotal", + "traits": { + "smithy.api#documentation": "The total text characters by the guardrail coverage.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The guardrail coverage for the text characters.
" + } + }, "com.amazonaws.bedrockruntime#GuardrailTopic": { "type": "structure", "members": { @@ -3569,6 +3679,12 @@ "target": "com.amazonaws.bedrockruntime#SystemContentBlock" } }, + "com.amazonaws.bedrockruntime#TextCharactersGuarded": { + "type": "integer" + }, + "com.amazonaws.bedrockruntime#TextCharactersTotal": { + "type": "integer" + }, "com.amazonaws.bedrockruntime#ThrottlingException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/iotdeviceadvisor.json b/codegen/sdk-codegen/aws-models/iotdeviceadvisor.json index 0ca5e6ae2f2..fd638cd1e0d 100644 --- a/codegen/sdk-codegen/aws-models/iotdeviceadvisor.json +++ b/codegen/sdk-codegen/aws-models/iotdeviceadvisor.json @@ -55,6 +55,16 @@ } } }, + "com.amazonaws.iotdeviceadvisor#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\u0021-\\u007E]+$" + } + }, "com.amazonaws.iotdeviceadvisor#ConflictException": { "type": "structure", "members": { @@ -112,6 +122,13 @@ "traits": { "smithy.api#documentation": "The tags to be attached to the suite definition.
" } + }, + "clientToken": { + "target": "com.amazonaws.iotdeviceadvisor#ClientToken", + "traits": { + "smithy.api#documentation": "The client token for the test suite definition creation. \n This token is used for tracking test suite definition creation \n using retries and obtaining its status. This parameter is optional.
", + "smithy.api#idempotencyToken": {} + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/ivs-realtime.json b/codegen/sdk-codegen/aws-models/ivs-realtime.json index c3099d5492f..4f32146ef92 100644 --- a/codegen/sdk-codegen/aws-models/ivs-realtime.json +++ b/codegen/sdk-codegen/aws-models/ivs-realtime.json @@ -2190,7 +2190,7 @@ "errorCode": { "target": "com.amazonaws.ivsrealtime#EventErrorCode", "traits": { - "smithy.api#documentation": "If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.\n INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an\n action that the participant’s token is not allowed to do. For more information about\n participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the\n number of participants who want to publish/subscribe to a stage exceeds the quota; for more\n information, see Service Quotas.\n PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a\n publisher that doesn’t exist.
If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.
\n\n B_FRAME_PRESENT —\n\t\t The participant's stream includes B-frames.\n\t\t For details, see \n\t\t IVS RTMP Publishing.
\n BITRATE_EXCEEDED —\n\t\t The participant exceeded the maximum supported bitrate.\n\t\t For details, see \n\t\t Service Quotas.
\n INSUFFICIENT_CAPABILITIES —\n\t\t The participant tried to take an action\n\t\t that the participant’s token is not allowed to do. For details on participant capabilities, see\n\t\t the capabilities field in CreateParticipantToken.
\n INTERNAL_SERVER_EXCEPTION —\n\t\t The participant failed to publish to the stage due to an internal server error.
\n INVALID_AUDIO_CODEC —\n\t\t The participant is using an invalid audio codec.\n\t\t For details, see \n\t\t Stream Ingest.
\n INVALID_INPUT —\n\t\t The participant is using an invalid input stream.
\n INVALID_PROTOCOL —\n\t\t The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP.\n\t\t For details, see \n\t\t IVS RTMP Publishing.
\n INVALID_STREAM_KEY —\n\t\t The participant is using an invalid stream key.\n\t\t For details, see \n\t\t IVS RTMP Publishing.
\n INVALID_VIDEO_CODEC —\n\t\t The participant is using an invalid video codec.\n\t\t For details, see \n\t\t Stream Ingest.
\n PUBLISHER_NOT_FOUND —\n\t\t The participant tried to subscribe to a publisher that doesn’t exist.
\n QUOTA_EXCEEDED —\n\t\t The number of participants who want to publish/subscribe to a stage exceeds the quota.\n\t\t For details, see \n\t\t Service Quotas.
\n RESOLUTION_EXCEEDED —\n\t\t The participant exceeded the maximum supported resolution.\n\t\t For details, see \n\t\t Service Quotas.
\n REUSE_OF_STREAM_KEY —\n\t\t The participant tried to use a stream key that is associated with another active stage session.
\n STREAM_DURATION_EXCEEDED —\n\t\t The participant exceeded the maximum allowed stream duration.\n\t\t For details, see \n\t\t Service Quotas.
Video-resolution width. Note that the maximum value is determined by width\n times height, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 1280.
Video-resolution width. This must be an even number. Note that the maximum value is determined by width\n times height, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 1280.
Video-resolution height. Note that the maximum value is determined by width\n times height, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 720.
Video-resolution height. This must be an even number. Note that the maximum value is determined by width\n times height, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 720.
The base64-encoded, 32-bit CRC32 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#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 CRC32C 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#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": { @@ -18371,13 +18371,13 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "The base64-encoded, 32-bit CRC32 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#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 CRC32C 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#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": { @@ -18476,14 +18476,14 @@ "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 CRC32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.
", + "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 CRC32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.
", + "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" } }, @@ -18575,13 +18575,13 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "The base64-encoded, 32-bit CRC32 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#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 CRC32C 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#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": { @@ -19139,13 +19139,13 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "The base64-encoded, 32-bit CRC32 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#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 CRC32C 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#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": { @@ -19183,13 +19183,13 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "The base64-encoded, 32-bit CRC32 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#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 CRC32C 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#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": { @@ -21137,7 +21137,7 @@ "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.
For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:
CRC32
\nCRC32C
\nSHA1
\nSHA256
\nFor more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
\nIf 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 .
If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.
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.
For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:
\n CRC32\n
\n CRC32C\n
\n SHA1\n
\n SHA256\n
For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
\nIf 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 .
If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.
Indicates which default minimum object size behavior is applied to the lifecycle configuration.
\n\n all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.
\n varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.\n
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
The base64-encoded, 32-bit CRC32 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#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 CRC32C 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#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" } }, @@ -24824,7 +24831,7 @@ } ], "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 metadata.
A HEAD request has the same options as a GET operation on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic code, such as 400 Bad Request, 403 Forbidden, 404 Not\n Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. \n It's not possible to retrieve the exact exception of these error codes.
Request headers are limited to 8 KB in size. For more information, see Common\n Request Headers.
\n\n General purpose bucket permissions - To\n use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation.\n For more information, see Actions, resources, and condition\n keys for Amazon S3 in the Amazon S3\n User Guide.
If the object you request doesn't exist, the error that\n Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3\n returns an HTTP status code 404 Not Found error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns\n an HTTP status code 403 Forbidden error.
\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 .
If you enable x-amz-checksum-mode in the request and the object is encrypted with\n Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.
Encryption request headers, like x-amz-server-side-encryption,\n should not be sent for HEAD requests if your object uses server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side\n encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3\n managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you 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 uses these types of keys, \n you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.
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 the\n metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:
\n\n x-amz-server-side-encryption-customer-algorithm\n
\n x-amz-server-side-encryption-customer-key\n
\n x-amz-server-side-encryption-customer-key-MD5\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the Amazon S3\n User Guide.
\n\n Directory bucket - 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.
\nIf the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.
If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
\n Directory buckets - Delete marker is not supported by directory buckets.
\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 Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.
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-az_id.region.amazonaws.com/key-name\n . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
The following actions are related to HeadObject:
\n GetObject\n
\n\n GetObjectAttributes\n
\nThe 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 metadata.
A HEAD request has the same options as a GET operation on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic code, such as 400 Bad Request, 403 Forbidden, 404 Not\n Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. \n It's not possible to retrieve the exact exception of these error codes.
Request headers are limited to 8 KB in size. For more information, see Common\n Request Headers.
\n\n General purpose bucket permissions - To\n use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation.\n For more information, see Actions, resources, and condition\n keys for Amazon S3 in the Amazon S3\n User Guide. For more information about the permissions to S3 API operations by S3 resource types, see Required permissions for Amazon S3 API operations in the Amazon S3 User Guide.
If the object you request doesn't exist, the error that\n Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3\n returns an HTTP status code 404 Not Found error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns\n an HTTP status code 403 Forbidden error.
\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 .
If you enable x-amz-checksum-mode in the request and the object is encrypted with\n Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.
Encryption request headers, like x-amz-server-side-encryption,\n should not be sent for HEAD requests if your object uses server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side\n encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3\n managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you 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 uses these types of keys, \n you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.
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 the\n metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:
\n\n x-amz-server-side-encryption-customer-algorithm\n
\n x-amz-server-side-encryption-customer-key\n
\n x-amz-server-side-encryption-customer-key-MD5\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the Amazon S3\n User Guide.
\n\n Directory bucket - 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.
\nIf the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.
If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
\n Directory buckets - Delete marker is not supported by directory buckets.
\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 Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.
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-az_id.region.amazonaws.com/key-name\n . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
The following actions are related to HeadObject:
\n GetObject\n
\n\n GetObjectAttributes\n
\nThe base64-encoded, 32-bit CRC32 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#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 CRC32C 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#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" } }, @@ -28635,13 +28642,13 @@ "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 CRC32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.
" + "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 CRC32C 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#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": { @@ -28986,13 +28993,13 @@ "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 CRC32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.
" + "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 CRC32C 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#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": { @@ -29815,14 +29822,14 @@ "target": "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.s3#PutBucketLifecycleConfigurationOutput" }, "traits": { "aws.protocols#httpChecksum": { "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "This operation is not supported by directory buckets.
\nCreates 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.
\nBucket 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.
\nYou 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 adjustable.\n Each rule consists of the following:
\nA filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, object size, or any combination of these.
\nA status indicating whether the rule is in effect.
\nOne 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.
\nFor more information, see Object Lifecycle\n Management and Lifecycle Configuration\n Elements.
\nBy 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 created\n it) can access the resource. The resource owner can optionally grant access\n permissions to others by writing an access policy. For this operation, a user must\n get the s3:PutLifecycleConfiguration permission.
You can also explicitly deny permissions. An explicit deny also supersedes any\n other permissions. If you want to block users or accounts from removing or\n deleting objects from your bucket, you must deny them permissions for the\n following actions:
\n\n s3:DeleteObject\n
\n s3:DeleteObjectVersion\n
\n s3:PutLifecycleConfiguration\n
For more information about permissions, see Managing Access\n Permissions to Your Amazon S3 Resources.
\nThe following operations are related to\n PutBucketLifecycleConfiguration:
This operation is not supported by directory buckets.
\nCreates 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.
\nYou 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 adjustable.
\nBucket lifecycle configuration 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.
\nA lifecycle rule consists of the following:
\nA filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, object size, or any combination of these.
\nA status indicating whether the rule is in effect.
\nOne 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.
\nFor more information, see Object Lifecycle\n Management and Lifecycle Configuration\n Elements.
\nBy 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 created\n it) can access the resource. The resource owner can optionally grant access\n permissions to others by writing an access policy. For this operation, a user must\n get the s3:PutLifecycleConfiguration permission.
You can also explicitly deny permissions. An explicit deny also supersedes any\n other permissions. If you want to block users or accounts from removing or\n deleting objects from your bucket, you must deny them permissions for the\n following actions:
\n\n s3:DeleteObject\n
\n s3:DeleteObjectVersion\n
\n s3:PutLifecycleConfiguration\n
For more information about permissions, see Managing Access\n Permissions to Your Amazon S3 Resources.
\nThe following operations are related to\n PutBucketLifecycleConfiguration:
Indicates which default minimum object size behavior is applied to the lifecycle configuration.
\n\n all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.
\n varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.\n
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
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).
Indicates which default minimum object size behavior is applied to the lifecycle configuration.
\n\n all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.
\n varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.\n
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
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.
For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:
CRC32
\nCRC32C
\nSHA1
\nSHA256
\nFor more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
\nIf 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 .
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
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.
For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:
\n CRC32\n
\n CRC32C\n
\n SHA1\n
\n SHA256\n
For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
\nIf 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 .
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
The base64-encoded, 32-bit CRC32 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#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 CRC32C 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#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" } }, @@ -31462,21 +31491,21 @@ "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.
For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:
CRC32
\nCRC32C
\nSHA1
\nSHA256
\nFor more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
\nIf 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 .
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
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.
For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:
\n CRC32\n
\n CRC32C\n
\n SHA1\n
\n SHA256\n
For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
\nIf 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 .
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
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 CRC32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.
", + "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 CRC32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.
", + "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" } }, @@ -33736,6 +33765,23 @@ "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": { @@ -34085,14 +34131,14 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "The base64-encoded, 32-bit CRC32 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#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 CRC32C 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#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" } }, @@ -34195,14 +34241,14 @@ "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 CRC32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.
", + "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 CRC32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.
", + "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" } }, @@ -34497,14 +34543,14 @@ "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 CRC32\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.
Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.
\n ", + "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.
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 CRC32C\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.
Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.
", + "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.
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" } }, diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 25883e7aeee..0efafed0185 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -7620,6 +7620,12 @@ "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 override changes made in the default \n lifecycle configuration.
" + } } }, "traits": { @@ -17851,6 +17857,12 @@ "traits": { "smithy.api#documentation": "The instance type and the Amazon Resource Name (ARN) of the SageMaker 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": { @@ -35553,6 +35565,12 @@ "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 override changes made in the default \n lifecycle configuration.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/workspaces.json b/codegen/sdk-codegen/aws-models/workspaces.json index 664f150e199..d9aac9a865e 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.json +++ b/codegen/sdk-codegen/aws-models/workspaces.json @@ -2478,7 +2478,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates one or more WorkSpaces.
\nThis operation is asynchronous and returns before the WorkSpaces are created.
\nThe MANUAL running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see Amazon WorkSpaces\n Core.
You don't need to specify the PCOIP protocol for Linux bundles\n because WSP is the default protocol for those bundles.
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces\n Core.
\nReview your running mode to ensure you are using one that is optimal for your needs and budget.\n For more information on switching running modes, see \n \n Can I switch between hourly and monthly billing?\n
\nCreates one or more WorkSpaces.
\nThis operation is asynchronous and returns before the WorkSpaces are created.
\nThe MANUAL running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see Amazon WorkSpaces\n Core.
You don't need to specify the PCOIP protocol for Linux bundles\n because DCV (formerly WSP) is the default protocol for those bundles.
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces\n Core.
\nReview your running mode to ensure you are using one that is optimal for your needs and budget.\n For more information on switching running modes, see \n \n Can I switch between hourly and monthly billing?\n
\nThe ingestion process to be used when importing the image, depending on which protocol\n you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol \n (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in \n _WSP. To use PCoIP, specify a value that does not end in _WSP. \n To use BYOP, specify a value that ends in _BYOP.
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify \n BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, \n depending on the protocol.
The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values\n are only supported by Amazon WorkSpaces Core. Contact your account team to be\n allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
The ingestion process to be used when importing the image, depending on which protocol\n you want to use for your BYOL Workspace image, either PCoIP, DCV, or \n bring your own protocol (BYOP). To use WSP, specify a value that ends in \n _DCV. To use PCoIP, specify a value that does not end in _DCV. \n To use BYOP, specify a value that ends in _BYOP.
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify \n BYOL_REGULAR, BYOL_REGULAR_DCV, or BYOL_REGULAR_BYOP, \n depending on the protocol.
The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values\n are only supported by Amazon WorkSpaces Core. Contact your account team to be\n allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11\n BYOL images. For more information about subscribing to Office for BYOL images, see Bring\n Your Own Windows Desktop Licenses.
\nAlthough this parameter is an array, only one item is allowed at this\n time.
\nDuring the image import process, non-GPU WSP WorkSpaces with Windows 11 support\n only Microsoft_Office_2019. GPU WSP WorkSpaces with Windows 11 do not\n support Office installation.
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11\n BYOL images. For more information about subscribing to Office for BYOL images, see Bring\n Your Own Windows Desktop Licenses.
\nAlthough this parameter is an array, only one item is allowed at this\n time.
\nDuring the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support\n only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not\n support Office installation.
The protocol. For more information, see \n \n Protocols for Amazon WorkSpaces.
\nOnly available for WorkSpaces created with PCoIP bundles.
\nThe Protocols property is case sensitive. Ensure you use PCOIP or WSP.
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles \n (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
\nThe protocol. For more information, see \n \n Protocols for Amazon WorkSpaces.
\nOnly available for WorkSpaces created with PCoIP bundles.
\nThe Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles \n (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
\n