diff --git a/codegen-output/aws-json-1-0/src/awsjson10/models.pyi b/codegen-output/aws-json-1-0/src/awsjson10/models.pyi index 32887dd14..d9e133aea 100644 --- a/codegen-output/aws-json-1-0/src/awsjson10/models.pyi +++ b/codegen-output/aws-json-1-0/src/awsjson10/models.pyi @@ -19,32 +19,50 @@ class _SerdeShape: @classmethod def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ... -class ServiceError(ModeledError): ... +class ServiceError(ModeledError): + """ + Base error for all errors in the service. + + Some exceptions do not extend from this class, including + synthetic, implicit, and shared exception types. + """ @dataclass(kw_only=True) class ClientOptionalDefaults(_SerdeShape): + """Dataclass for ClientOptionalDefaults structure.""" + member: int | None = ... @dataclass(kw_only=True) class ComplexError(ServiceError, _SerdeShape): + """This error is thrown when a request is invalid.""" + top_level: str | None = ... nested: ComplexNestedErrorData | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ComplexNestedErrorData(_SerdeShape): + """Dataclass for ComplexNestedErrorData structure.""" + foo: str | None = ... @dataclass(kw_only=True) class ContentTypeParametersInput(_SerdeShape): + """Dataclass for ContentTypeParametersInput structure.""" + value: int | None = ... @dataclass(kw_only=True) class ContentTypeParametersOutput(_SerdeShape): + """Dataclass for ContentTypeParametersOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class Defaults(_SerdeShape): + """Dataclass for Defaults structure.""" + default_string: str | None = ... default_boolean: bool | None = ... default_list: list[str] | None = ... @@ -76,70 +94,101 @@ class Defaults(_SerdeShape): @dataclass(kw_only=True) class Dialog(_SerdeShape): + """Dataclass for Dialog structure.""" + language: str | None = ... greeting: str | None = ... farewell: Farewell | None = ... @dataclass(kw_only=True) class EmptyInputAndEmptyOutputInput(_SerdeShape): - pass + """Dataclass for EmptyInputAndEmptyOutputInput structure.""" @dataclass(kw_only=True) class EmptyInputAndEmptyOutputOutput(_SerdeShape): + """Dataclass for EmptyInputAndEmptyOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointOperationInput(_SerdeShape): - pass + """Dataclass for EndpointOperationInput structure.""" @dataclass(kw_only=True) class EndpointOperationOutput(_SerdeShape): + """Dataclass for EndpointOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationInput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationInput structure.""" + label: str | None = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationOutput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class Farewell(_SerdeShape): + """Dataclass for Farewell structure.""" + phrase: str | None = ... @dataclass(kw_only=True) class FooError(ServiceError, _SerdeShape): + """ + This error has test cases that test some of the dark corners of Amazon + service framework history. It should only be implemented by clients. + """ + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class GreetingWithErrorsInput(_SerdeShape): + """Dataclass for GreetingWithErrorsInput structure.""" + greeting: str | None = ... @dataclass(kw_only=True) class GreetingWithErrorsOutput(_SerdeShape): + """Dataclass for GreetingWithErrorsOutput structure.""" + greeting: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HostWithPathOperationInput(_SerdeShape): - pass + """Dataclass for HostWithPathOperationInput structure.""" @dataclass(kw_only=True) class HostWithPathOperationOutput(_SerdeShape): + """Dataclass for HostWithPathOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class InvalidGreeting(ServiceError, _SerdeShape): + """This error is thrown when an invalid greeting value is provided.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class JsonUnionsInput(_SerdeShape): + """Dataclass for JsonUnionsInput structure.""" + contents: MyUnion | None = ... + """A union with a representative set of types for members.""" @dataclass(kw_only=True) class JsonUnionsOutput(_SerdeShape): + """Dataclass for JsonUnionsOutput structure.""" + contents: MyUnion | None = ... + """A union with a representative set of types for members.""" response_metadata: ResponseMetadata = ... @dataclass @@ -184,6 +233,12 @@ class MyUnionStructureValue(_SerdeShape): @dataclass class MyUnionUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str MyUnion = Union[ @@ -199,28 +254,35 @@ MyUnion = Union[ | MyUnionStructureValue | MyUnionUnknown ] +"""A union with a representative set of types for members.""" class _MyUnionDeserializer: def deserialize(self, deserializer: ShapeDeserializer) -> MyUnion: ... @dataclass(kw_only=True) class NoInputAndNoOutputInput(_SerdeShape): - pass + """Dataclass for NoInputAndNoOutputInput structure.""" @dataclass(kw_only=True) class NoInputAndNoOutputOutput(_SerdeShape): + """Dataclass for NoInputAndNoOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NoInputAndOutputInput(_SerdeShape): - pass + """Dataclass for NoInputAndOutputInput structure.""" @dataclass(kw_only=True) class NoInputAndOutputOutput(_SerdeShape): + """Dataclass for NoInputAndOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class OperationWithDefaultsInput(_SerdeShape): + """Dataclass for OperationWithDefaultsInput structure.""" + defaults: Defaults | None = ... client_optional_defaults: ClientOptionalDefaults | None = ... top_level_default: str | None = ... @@ -228,6 +290,8 @@ class OperationWithDefaultsInput(_SerdeShape): @dataclass(kw_only=True) class OperationWithDefaultsOutput(_SerdeShape): + """Dataclass for OperationWithDefaultsOutput structure.""" + default_string: str | None = ... default_boolean: bool | None = ... default_list: list[str] | None = ... @@ -260,10 +324,14 @@ class OperationWithDefaultsOutput(_SerdeShape): @dataclass(kw_only=True) class OperationWithNestedStructureInput(_SerdeShape): + """Dataclass for OperationWithNestedStructureInput structure.""" + top_level: TopLevel | None = ... @dataclass(kw_only=True) class OperationWithNestedStructureOutput(_SerdeShape): + """Dataclass for OperationWithNestedStructureOutput structure.""" + dialog: Dialog dialog_list: list[Dialog] | None = ... dialog_map: dict[str, Dialog] | None = ... @@ -271,10 +339,12 @@ class OperationWithNestedStructureOutput(_SerdeShape): @dataclass(kw_only=True) class OperationWithRequiredMembersInput(_SerdeShape): - pass + """Dataclass for OperationWithRequiredMembersInput structure.""" @dataclass(kw_only=True) class OperationWithRequiredMembersOutput(_SerdeShape): + """Dataclass for OperationWithRequiredMembersOutput structure.""" + required_string: str required_boolean: bool required_list: list[str] @@ -291,10 +361,12 @@ class OperationWithRequiredMembersOutput(_SerdeShape): @dataclass(kw_only=True) class OperationWithRequiredMembersWithDefaultsInput(_SerdeShape): - pass + """Dataclass for OperationWithRequiredMembersWithDefaultsInput structure.""" @dataclass(kw_only=True) class OperationWithRequiredMembersWithDefaultsOutput(_SerdeShape): + """Dataclass for OperationWithRequiredMembersWithDefaultsOutput structure.""" + required_string: str | None = ... required_boolean: bool | None = ... required_list: list[str] | None = ... @@ -313,19 +385,25 @@ class OperationWithRequiredMembersWithDefaultsOutput(_SerdeShape): @dataclass(kw_only=True) class PutWithContentEncodingInput(_SerdeShape): + """Dataclass for PutWithContentEncodingInput structure.""" + encoding: str | None = ... data: str | None = ... @dataclass(kw_only=True) class PutWithContentEncodingOutput(_SerdeShape): + """Dataclass for PutWithContentEncodingOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryIncompatibleOperationInput(_SerdeShape): - pass + """Dataclass for QueryIncompatibleOperationInput structure.""" @dataclass(kw_only=True) class QueryIncompatibleOperationOutput(_SerdeShape): + """Dataclass for QueryIncompatibleOperationOutput structure.""" + response_metadata: ResponseMetadata = ... class RequiredEnum(UnknownEnumMixin, StrEnum): @@ -339,11 +417,15 @@ class RequiredIntEnum(UnknownEnumMixin, IntEnum): @dataclass(kw_only=True) class SimpleScalarPropertiesInput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesInput structure.""" + float_value: float | None = ... double_value: float | None = ... @dataclass(kw_only=True) class SimpleScalarPropertiesOutput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesOutput structure.""" + float_value: float | None = ... double_value: float | None = ... response_metadata: ResponseMetadata = ... @@ -359,6 +441,8 @@ class TestIntEnum(UnknownEnumMixin, IntEnum): @dataclass(kw_only=True) class TopLevel(_SerdeShape): + """Dataclass for TopLevel structure.""" + dialog: Dialog dialog_list: list[Dialog] | None = ... dialog_map: dict[str, Dialog] | None = ... @@ -372,6 +456,8 @@ class FooEnum(UnknownEnumMixin, StrEnum): @dataclass(kw_only=True) class GreetingStruct(_SerdeShape): + """Dataclass for GreetingStruct structure.""" + hi: str | None = ... class IntegerEnum(UnknownEnumMixin, IntEnum): diff --git a/codegen-output/aws-json-1-1/src/awsjson11/models.pyi b/codegen-output/aws-json-1-1/src/awsjson11/models.pyi index 9513e9630..4f4de4fed 100644 --- a/codegen-output/aws-json-1-1/src/awsjson11/models.pyi +++ b/codegen-output/aws-json-1-1/src/awsjson11/models.pyi @@ -19,113 +19,157 @@ class _SerdeShape: @classmethod def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ... -class ServiceError(ModeledError): ... +class ServiceError(ModeledError): + """ + Base error for all errors in the service. + + Some exceptions do not extend from this class, including + synthetic, implicit, and shared exception types. + """ @dataclass(kw_only=True) class ComplexError(ServiceError, _SerdeShape): + """This error is thrown when a request is invalid.""" + top_level: str | None = ... nested: ComplexNestedErrorData | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ComplexNestedErrorData(_SerdeShape): + """Dataclass for ComplexNestedErrorData structure.""" + foo: str | None = ... @dataclass(kw_only=True) class ContentTypeParametersInput(_SerdeShape): + """Dataclass for ContentTypeParametersInput structure.""" + value: int | None = ... @dataclass(kw_only=True) class ContentTypeParametersOutput(_SerdeShape): + """Dataclass for ContentTypeParametersOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class DatetimeOffsetsInput(_SerdeShape): - pass + """Dataclass for DatetimeOffsetsInput structure.""" @dataclass(kw_only=True) class DatetimeOffsetsOutput(_SerdeShape): + """Dataclass for DatetimeOffsetsOutput structure.""" + datetime_: datetime | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EmptyOperationInput(_SerdeShape): - pass + """Dataclass for EmptyOperationInput structure.""" @dataclass(kw_only=True) class EmptyOperationOutput(_SerdeShape): + """Dataclass for EmptyOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EmptyStruct(_SerdeShape): - pass + """Dataclass for EmptyStruct structure.""" @dataclass(kw_only=True) class EndpointOperationInput(_SerdeShape): - pass + """Dataclass for EndpointOperationInput structure.""" @dataclass(kw_only=True) class EndpointOperationOutput(_SerdeShape): + """Dataclass for EndpointOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationInput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationInput structure.""" + label: str | None = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationOutput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ErrorWithMembers(ServiceError, _SerdeShape): + """Dataclass for ErrorWithMembers structure.""" + code: str | None = ... complex_data: KitchenSink | None = ... integer_field: int | None = ... list_field: list[str] | None = ... map_field: dict[str, str] | None = ... string_field: str | None = ... + """abc""" response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ErrorWithoutMembers(ServiceError, _SerdeShape): + """Dataclass for ErrorWithoutMembers structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FooError(ServiceError, _SerdeShape): + """ + This error has test cases that test some of the dark corners of Amazon + service framework history. It should only be implemented by clients. + """ + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FractionalSecondsInput(_SerdeShape): - pass + """Dataclass for FractionalSecondsInput structure.""" @dataclass(kw_only=True) class FractionalSecondsOutput(_SerdeShape): + """Dataclass for FractionalSecondsOutput structure.""" + datetime_: datetime | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class GreetingWithErrorsInput(_SerdeShape): - pass + """Dataclass for GreetingWithErrorsInput structure.""" @dataclass(kw_only=True) class GreetingWithErrorsOutput(_SerdeShape): + """Dataclass for GreetingWithErrorsOutput structure.""" + greeting: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HostWithPathOperationInput(_SerdeShape): - pass + """Dataclass for HostWithPathOperationInput structure.""" @dataclass(kw_only=True) class HostWithPathOperationOutput(_SerdeShape): + """Dataclass for HostWithPathOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class InvalidGreeting(ServiceError, _SerdeShape): + """This error is thrown when an invalid greeting value is provided.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class JsonEnumsInput(_SerdeShape): + """Dataclass for JsonEnumsInput structure.""" + foo_enum1: str | None = ... foo_enum2: str | None = ... foo_enum3: str | None = ... @@ -135,6 +179,8 @@ class JsonEnumsInput(_SerdeShape): @dataclass(kw_only=True) class JsonEnumsOutput(_SerdeShape): + """Dataclass for JsonEnumsOutput structure.""" + foo_enum1: str | None = ... foo_enum2: str | None = ... foo_enum3: str | None = ... @@ -145,6 +191,8 @@ class JsonEnumsOutput(_SerdeShape): @dataclass(kw_only=True) class JsonIntEnumsInput(_SerdeShape): + """Dataclass for JsonIntEnumsInput structure.""" + int_enum1: int | None = ... int_enum2: int | None = ... int_enum3: int | None = ... @@ -154,6 +202,8 @@ class JsonIntEnumsInput(_SerdeShape): @dataclass(kw_only=True) class JsonIntEnumsOutput(_SerdeShape): + """Dataclass for JsonIntEnumsOutput structure.""" + int_enum1: int | None = ... int_enum2: int | None = ... int_enum3: int | None = ... @@ -164,15 +214,23 @@ class JsonIntEnumsOutput(_SerdeShape): @dataclass(kw_only=True) class JsonUnionsInput(_SerdeShape): + """A shared structure that contains a single union member.""" + contents: MyUnion | None = ... + """A union with a representative set of types for members.""" @dataclass(kw_only=True) class JsonUnionsOutput(_SerdeShape): + """A shared structure that contains a single union member.""" + contents: MyUnion | None = ... + """A union with a representative set of types for members.""" response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class KitchenSink(_SerdeShape): + """Dataclass for KitchenSink structure.""" + blob: bytes | None = ... boolean: bool | None = ... double: float | None = ... @@ -202,6 +260,8 @@ class KitchenSink(_SerdeShape): @dataclass(kw_only=True) class KitchenSinkOperationInput(_SerdeShape): + """Dataclass for KitchenSinkOperationInput structure.""" + blob: bytes | None = ... boolean: bool | None = ... double: float | None = ... @@ -231,6 +291,8 @@ class KitchenSinkOperationInput(_SerdeShape): @dataclass(kw_only=True) class KitchenSinkOperationOutput(_SerdeShape): + """Dataclass for KitchenSinkOperationOutput structure.""" + blob: bytes | None = ... boolean: bool | None = ... double: float | None = ... @@ -297,6 +359,12 @@ class MyUnionStructureValue(_SerdeShape): @dataclass class MyUnionUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str MyUnion = Union[ @@ -311,74 +379,103 @@ MyUnion = Union[ | MyUnionStructureValue | MyUnionUnknown ] +"""A union with a representative set of types for members.""" class _MyUnionDeserializer: def deserialize(self, deserializer: ShapeDeserializer) -> MyUnion: ... @dataclass(kw_only=True) class NullOperationInput(_SerdeShape): + """Dataclass for NullOperationInput structure.""" + string: str | None = ... @dataclass(kw_only=True) class NullOperationOutput(_SerdeShape): + """Dataclass for NullOperationOutput structure.""" + string: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class OperationWithOptionalInputOutputInput(_SerdeShape): + """Dataclass for OperationWithOptionalInputOutputInput structure.""" + value: str | None = ... @dataclass(kw_only=True) class OperationWithOptionalInputOutputOutput(_SerdeShape): + """Dataclass for OperationWithOptionalInputOutputOutput structure.""" + value: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class PutAndGetInlineDocumentsInput(_SerdeShape): + """Dataclass for PutAndGetInlineDocumentsInput structure.""" + inline_document: Document | None = ... @dataclass(kw_only=True) class PutAndGetInlineDocumentsOutput(_SerdeShape): + """Dataclass for PutAndGetInlineDocumentsOutput structure.""" + inline_document: Document | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class PutWithContentEncodingInput(_SerdeShape): + """Dataclass for PutWithContentEncodingInput structure.""" + encoding: str | None = ... data: str | None = ... @dataclass(kw_only=True) class PutWithContentEncodingOutput(_SerdeShape): + """Dataclass for PutWithContentEncodingOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class SimpleScalarPropertiesInput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesInput structure.""" + float_value: float | None = ... double_value: float | None = ... @dataclass(kw_only=True) class SimpleScalarPropertiesOutput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesOutput structure.""" + float_value: float | None = ... double_value: float | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class SimpleStruct(_SerdeShape): + """Dataclass for SimpleStruct structure.""" + value: str | None = ... @dataclass(kw_only=True) class SparseNullsOperationInput(_SerdeShape): + """Dataclass for SparseNullsOperationInput structure.""" + sparse_string_list: list[str | None] | None = ... sparse_string_map: dict[str, str | None] | None = ... @dataclass(kw_only=True) class SparseNullsOperationOutput(_SerdeShape): + """Dataclass for SparseNullsOperationOutput structure.""" + sparse_string_list: list[str | None] | None = ... sparse_string_map: dict[str, str | None] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class StructWithJsonName(_SerdeShape): + """Dataclass for StructWithJsonName structure.""" + value: str | None = ... class FooEnum(UnknownEnumMixin, StrEnum): @@ -390,6 +487,8 @@ class FooEnum(UnknownEnumMixin, StrEnum): @dataclass(kw_only=True) class GreetingStruct(_SerdeShape): + """Dataclass for GreetingStruct structure.""" + hi: str | None = ... class IntegerEnum(UnknownEnumMixin, IntEnum): diff --git a/codegen-output/aws-query/src/awsquery/models.pyi b/codegen-output/aws-query/src/awsquery/models.pyi index efbbea010..6cbbdd722 100644 --- a/codegen-output/aws-query/src/awsquery/models.pyi +++ b/codegen-output/aws-query/src/awsquery/models.pyi @@ -18,172 +18,232 @@ class _SerdeShape: @classmethod def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ... -class ServiceError(ModeledError): ... +class ServiceError(ModeledError): + """ + Base error for all errors in the service. + + Some exceptions do not extend from this class, including + synthetic, implicit, and shared exception types. + """ @dataclass(kw_only=True) class ComplexError(ServiceError, _SerdeShape): + """This error is thrown when a request is invalid.""" + top_level: str | None = ... nested: ComplexNestedErrorData | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ComplexNestedErrorData(_SerdeShape): + """Dataclass for ComplexNestedErrorData structure.""" + foo: str | None = ... @dataclass(kw_only=True) class CustomCodeError(ServiceError, _SerdeShape): + """Dataclass for CustomCodeError structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class DatetimeOffsetsInput(_SerdeShape): - pass + """Dataclass for DatetimeOffsetsInput structure.""" @dataclass(kw_only=True) class DatetimeOffsetsOutput(_SerdeShape): + """Dataclass for DatetimeOffsetsOutput structure.""" + datetime_: datetime | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EmptyInputAndEmptyOutputInput(_SerdeShape): - pass + """Dataclass for EmptyInputAndEmptyOutputInput structure.""" @dataclass(kw_only=True) class EmptyInputAndEmptyOutputOutput(_SerdeShape): + """Dataclass for EmptyInputAndEmptyOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointOperationInput(_SerdeShape): - pass + """Dataclass for EndpointOperationInput structure.""" @dataclass(kw_only=True) class EndpointOperationOutput(_SerdeShape): + """Dataclass for EndpointOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationInput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationInput structure.""" + label: str | None = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationOutput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FlattenedXmlMapInput(_SerdeShape): - pass + """Dataclass for FlattenedXmlMapInput structure.""" @dataclass(kw_only=True) class FlattenedXmlMapOutput(_SerdeShape): + """Dataclass for FlattenedXmlMapOutput structure.""" + my_map: dict[str, str] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FlattenedXmlMapWithXmlNameInput(_SerdeShape): - pass + """Dataclass for FlattenedXmlMapWithXmlNameInput structure.""" @dataclass(kw_only=True) class FlattenedXmlMapWithXmlNameOutput(_SerdeShape): + """Dataclass for FlattenedXmlMapWithXmlNameOutput structure.""" + my_map: dict[str, str] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FlattenedXmlMapWithXmlNamespaceInput(_SerdeShape): - pass + """Dataclass for FlattenedXmlMapWithXmlNamespaceInput structure.""" @dataclass(kw_only=True) class FlattenedXmlMapWithXmlNamespaceOutput(_SerdeShape): + """Dataclass for FlattenedXmlMapWithXmlNamespaceOutput structure.""" + my_map: dict[str, str] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FractionalSecondsInput(_SerdeShape): - pass + """Dataclass for FractionalSecondsInput structure.""" @dataclass(kw_only=True) class FractionalSecondsOutput(_SerdeShape): + """Dataclass for FractionalSecondsOutput structure.""" + datetime_: datetime | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class GreetingWithErrorsInput(_SerdeShape): - pass + """Dataclass for GreetingWithErrorsInput structure.""" @dataclass(kw_only=True) class GreetingWithErrorsOutput(_SerdeShape): + """Dataclass for GreetingWithErrorsOutput structure.""" + greeting: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HostWithPathOperationInput(_SerdeShape): - pass + """Dataclass for HostWithPathOperationInput structure.""" @dataclass(kw_only=True) class HostWithPathOperationOutput(_SerdeShape): + """Dataclass for HostWithPathOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class IgnoresWrappingXmlNameInput(_SerdeShape): - pass + """Dataclass for IgnoresWrappingXmlNameInput structure.""" @dataclass(kw_only=True) class IgnoresWrappingXmlNameOutput(_SerdeShape): + """Dataclass for IgnoresWrappingXmlNameOutput structure.""" + foo: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class InvalidGreeting(ServiceError, _SerdeShape): + """This error is thrown when an invalid greeting value is provided.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NestedStructuresInput(_SerdeShape): + """Dataclass for NestedStructuresInput structure.""" + nested: StructArg | None = ... @dataclass(kw_only=True) class NestedStructuresOutput(_SerdeShape): + """Dataclass for NestedStructuresOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NestedStructWithList(_SerdeShape): + """Dataclass for NestedStructWithList structure.""" + list_arg: list[str] | None = ... @dataclass(kw_only=True) class NestedStructWithMap(_SerdeShape): + """Dataclass for NestedStructWithMap structure.""" + map_arg: dict[str, str] | None = ... @dataclass(kw_only=True) class NoInputAndNoOutputInput(_SerdeShape): - pass + """Dataclass for NoInputAndNoOutputInput structure.""" @dataclass(kw_only=True) class NoInputAndNoOutputOutput(_SerdeShape): + """Dataclass for NoInputAndNoOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NoInputAndOutputInput(_SerdeShape): - pass + """Dataclass for NoInputAndOutputInput structure.""" @dataclass(kw_only=True) class NoInputAndOutputOutput(_SerdeShape): + """Dataclass for NoInputAndOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class PutWithContentEncodingInput(_SerdeShape): + """Dataclass for PutWithContentEncodingInput structure.""" + encoding: str | None = ... data: str | None = ... @dataclass(kw_only=True) class PutWithContentEncodingOutput(_SerdeShape): + """Dataclass for PutWithContentEncodingOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryIdempotencyTokenAutoFillInput(_SerdeShape): + """Dataclass for QueryIdempotencyTokenAutoFillInput structure.""" + token: str | None = ... @dataclass(kw_only=True) class QueryIdempotencyTokenAutoFillOutput(_SerdeShape): + """Dataclass for QueryIdempotencyTokenAutoFillOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryListsInput(_SerdeShape): + """Dataclass for QueryListsInput structure.""" + list_arg: list[str] | None = ... complex_list_arg: list[GreetingStruct] | None = ... flattened_list_arg: list[str] | None = ... @@ -193,10 +253,14 @@ class QueryListsInput(_SerdeShape): @dataclass(kw_only=True) class QueryListsOutput(_SerdeShape): + """Dataclass for QueryListsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryMapsInput(_SerdeShape): + """Dataclass for QueryMapsInput structure.""" + map_arg: dict[str, str] | None = ... renamed_map_arg: dict[str, str] | None = ... complex_map_arg: dict[str, GreetingStruct] | None = ... @@ -208,39 +272,53 @@ class QueryMapsInput(_SerdeShape): @dataclass(kw_only=True) class QueryMapsOutput(_SerdeShape): + """Dataclass for QueryMapsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryTimestampsInput(_SerdeShape): + """Dataclass for QueryTimestampsInput structure.""" + normal_format: datetime | None = ... epoch_member: datetime | None = ... epoch_target: datetime | None = ... @dataclass(kw_only=True) class QueryTimestampsOutput(_SerdeShape): + """Dataclass for QueryTimestampsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class RecursiveXmlShapesInput(_SerdeShape): - pass + """Dataclass for RecursiveXmlShapesInput structure.""" @dataclass(kw_only=True) class RecursiveXmlShapesOutput(_SerdeShape): + """Dataclass for RecursiveXmlShapesOutput structure.""" + nested: RecursiveXmlShapesOutputNested1 | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class RecursiveXmlShapesOutputNested1(_SerdeShape): + """Dataclass for RecursiveXmlShapesOutputNested1 structure.""" + foo: str | None = ... nested: RecursiveXmlShapesOutputNested2 | None = ... @dataclass(kw_only=True) class RecursiveXmlShapesOutputNested2(_SerdeShape): + """Dataclass for RecursiveXmlShapesOutputNested2 structure.""" + bar: str | None = ... recursive_member: RecursiveXmlShapesOutputNested1 | None = ... @dataclass(kw_only=True) class SimpleInputParamsInput(_SerdeShape): + """Dataclass for SimpleInputParamsInput structure.""" + foo: str | None = ... bar: str | None = ... baz: bool | None = ... @@ -253,14 +331,18 @@ class SimpleInputParamsInput(_SerdeShape): @dataclass(kw_only=True) class SimpleInputParamsOutput(_SerdeShape): + """Dataclass for SimpleInputParamsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class SimpleScalarXmlPropertiesInput(_SerdeShape): - pass + """Dataclass for SimpleScalarXmlPropertiesInput structure.""" @dataclass(kw_only=True) class SimpleScalarXmlPropertiesOutput(_SerdeShape): + """Dataclass for SimpleScalarXmlPropertiesOutput structure.""" + string_value: str | None = ... empty_string_value: str | None = ... true_boolean_value: bool | None = ... @@ -275,39 +357,49 @@ class SimpleScalarXmlPropertiesOutput(_SerdeShape): @dataclass(kw_only=True) class StructArg(_SerdeShape): + """Dataclass for StructArg structure.""" + string_arg: str | None = ... other_arg: bool | None = ... recursive_arg: StructArg | None = ... @dataclass(kw_only=True) class StructureListMember(_SerdeShape): + """Dataclass for StructureListMember structure.""" + a: str | None = ... b: str | None = ... @dataclass(kw_only=True) class XmlBlobsInput(_SerdeShape): - pass + """Dataclass for XmlBlobsInput structure.""" @dataclass(kw_only=True) class XmlBlobsOperationOutput(_SerdeShape): + """Dataclass for XmlBlobsOperationOutput structure.""" + data: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlEmptyBlobsInput(_SerdeShape): - pass + """Dataclass for XmlEmptyBlobsInput structure.""" @dataclass(kw_only=True) class XmlEmptyBlobsOutput(_SerdeShape): + """Dataclass for XmlEmptyBlobsOutput structure.""" + data: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlEmptyListsInput(_SerdeShape): - pass + """Dataclass for XmlEmptyListsInput structure.""" @dataclass(kw_only=True) class XmlEmptyListsOutput(_SerdeShape): + """Dataclass for XmlEmptyListsOutput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -316,6 +408,7 @@ class XmlEmptyListsOutput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" renamed_list_members: list[str] | None = ... flattened_list: list[str] | None = ... flattened_list2: list[str] | None = ... @@ -326,19 +419,23 @@ class XmlEmptyListsOutput(_SerdeShape): @dataclass(kw_only=True) class XmlEmptyMapsInput(_SerdeShape): - pass + """Dataclass for XmlEmptyMapsInput structure.""" @dataclass(kw_only=True) class XmlEmptyMapsOutput(_SerdeShape): + """Dataclass for XmlEmptyMapsOutput structure.""" + my_map: dict[str, GreetingStruct] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlEnumsInput(_SerdeShape): - pass + """Dataclass for XmlEnumsInput structure.""" @dataclass(kw_only=True) class XmlEnumsOutput(_SerdeShape): + """Dataclass for XmlEnumsOutput structure.""" + foo_enum1: str | None = ... foo_enum2: str | None = ... foo_enum3: str | None = ... @@ -349,10 +446,12 @@ class XmlEnumsOutput(_SerdeShape): @dataclass(kw_only=True) class XmlIntEnumsInput(_SerdeShape): - pass + """Dataclass for XmlIntEnumsInput structure.""" @dataclass(kw_only=True) class XmlIntEnumsOutput(_SerdeShape): + """Dataclass for XmlIntEnumsOutput structure.""" + int_enum1: int | None = ... int_enum2: int | None = ... int_enum3: int | None = ... @@ -363,10 +462,12 @@ class XmlIntEnumsOutput(_SerdeShape): @dataclass(kw_only=True) class XmlListsInput(_SerdeShape): - pass + """Dataclass for XmlListsInput structure.""" @dataclass(kw_only=True) class XmlListsOperationOutput(_SerdeShape): + """Dataclass for XmlListsOperationOutput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -375,6 +476,7 @@ class XmlListsOperationOutput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" renamed_list_members: list[str] | None = ... flattened_list: list[str] | None = ... flattened_list2: list[str] | None = ... @@ -385,42 +487,52 @@ class XmlListsOperationOutput(_SerdeShape): @dataclass(kw_only=True) class XmlMapsInput(_SerdeShape): - pass + """Dataclass for XmlMapsInput structure.""" @dataclass(kw_only=True) class XmlMapsOperationOutput(_SerdeShape): + """Dataclass for XmlMapsOperationOutput structure.""" + my_map: dict[str, GreetingStruct] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlMapsXmlNameInput(_SerdeShape): - pass + """Dataclass for XmlMapsXmlNameInput structure.""" @dataclass(kw_only=True) class XmlMapsXmlNameOutput(_SerdeShape): + """Dataclass for XmlMapsXmlNameOutput structure.""" + my_map: dict[str, GreetingStruct] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlNamespaceNested(_SerdeShape): + """Dataclass for XmlNamespaceNested structure.""" + foo: str | None = ... values: list[str] | None = ... @dataclass(kw_only=True) class XmlNamespacesInput(_SerdeShape): - pass + """Dataclass for XmlNamespacesInput structure.""" @dataclass(kw_only=True) class XmlNamespacesOutput(_SerdeShape): + """Dataclass for XmlNamespacesOutput structure.""" + nested: XmlNamespaceNested | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlTimestampsInput(_SerdeShape): - pass + """Dataclass for XmlTimestampsInput structure.""" @dataclass(kw_only=True) class XmlTimestampsOutput(_SerdeShape): + """Dataclass for XmlTimestampsOutput structure.""" + normal: datetime | None = ... date_time: datetime | None = ... date_time_on_target: datetime | None = ... @@ -439,6 +551,8 @@ class FooEnum(UnknownEnumMixin, StrEnum): @dataclass(kw_only=True) class GreetingStruct(_SerdeShape): + """Dataclass for GreetingStruct structure.""" + hi: str | None = ... class IntegerEnum(UnknownEnumMixin, IntEnum): diff --git a/codegen-output/ec2-query/src/ec2query/models.pyi b/codegen-output/ec2-query/src/ec2query/models.pyi index 7b0a86d8c..c60426dbf 100644 --- a/codegen-output/ec2-query/src/ec2query/models.pyi +++ b/codegen-output/ec2-query/src/ec2query/models.pyi @@ -18,129 +18,177 @@ class _SerdeShape: @classmethod def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ... -class ServiceError(ModeledError): ... +class ServiceError(ModeledError): + """ + Base error for all errors in the service. + + Some exceptions do not extend from this class, including + synthetic, implicit, and shared exception types. + """ @dataclass(kw_only=True) class ComplexError(ServiceError, _SerdeShape): + """This error is thrown when a request is invalid.""" + top_level: str | None = ... nested: ComplexNestedErrorData | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ComplexNestedErrorData(_SerdeShape): + """Dataclass for ComplexNestedErrorData structure.""" + foo: str | None = ... @dataclass(kw_only=True) class DatetimeOffsetsInput(_SerdeShape): - pass + """Dataclass for DatetimeOffsetsInput structure.""" @dataclass(kw_only=True) class DatetimeOffsetsOutput(_SerdeShape): + """Dataclass for DatetimeOffsetsOutput structure.""" + datetime_: datetime | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EmptyInputAndEmptyOutputInput(_SerdeShape): - pass + """Dataclass for EmptyInputAndEmptyOutputInput structure.""" @dataclass(kw_only=True) class EmptyInputAndEmptyOutputOutput(_SerdeShape): + """Dataclass for EmptyInputAndEmptyOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointOperationInput(_SerdeShape): - pass + """Dataclass for EndpointOperationInput structure.""" @dataclass(kw_only=True) class EndpointOperationOutput(_SerdeShape): + """Dataclass for EndpointOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationInput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationInput structure.""" + label: str | None = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationOutput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FractionalSecondsInput(_SerdeShape): - pass + """Dataclass for FractionalSecondsInput structure.""" @dataclass(kw_only=True) class FractionalSecondsOutput(_SerdeShape): + """Dataclass for FractionalSecondsOutput structure.""" + datetime_: datetime | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class GreetingWithErrorsInput(_SerdeShape): - pass + """Dataclass for GreetingWithErrorsInput structure.""" @dataclass(kw_only=True) class GreetingWithErrorsOutput(_SerdeShape): + """Dataclass for GreetingWithErrorsOutput structure.""" + greeting: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HostWithPathOperationInput(_SerdeShape): - pass + """Dataclass for HostWithPathOperationInput structure.""" @dataclass(kw_only=True) class HostWithPathOperationOutput(_SerdeShape): + """Dataclass for HostWithPathOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class IgnoresWrappingXmlNameInput(_SerdeShape): - pass + """Dataclass for IgnoresWrappingXmlNameInput structure.""" @dataclass(kw_only=True) class IgnoresWrappingXmlNameOutput(_SerdeShape): + """Dataclass for IgnoresWrappingXmlNameOutput structure.""" + foo: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class InvalidGreeting(ServiceError, _SerdeShape): + """This error is thrown when an invalid greeting value is provided.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NestedStructuresInput(_SerdeShape): + """Dataclass for NestedStructuresInput structure.""" + nested: StructArg | None = ... @dataclass(kw_only=True) class NestedStructuresOutput(_SerdeShape): + """Dataclass for NestedStructuresOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NestedStructWithList(_SerdeShape): + """Dataclass for NestedStructWithList structure.""" + list_arg: list[str] | None = ... @dataclass(kw_only=True) class NoInputAndOutputInput(_SerdeShape): - pass + """Dataclass for NoInputAndOutputInput structure.""" @dataclass(kw_only=True) class NoInputAndOutputOutput(_SerdeShape): + """Dataclass for NoInputAndOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class PutWithContentEncodingInput(_SerdeShape): + """Dataclass for PutWithContentEncodingInput structure.""" + encoding: str | None = ... data: str | None = ... @dataclass(kw_only=True) class PutWithContentEncodingOutput(_SerdeShape): + """Dataclass for PutWithContentEncodingOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryIdempotencyTokenAutoFillInput(_SerdeShape): + """Dataclass for QueryIdempotencyTokenAutoFillInput structure.""" + token: str | None = ... @dataclass(kw_only=True) class QueryIdempotencyTokenAutoFillOutput(_SerdeShape): + """Dataclass for QueryIdempotencyTokenAutoFillOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryListsInput(_SerdeShape): + """Dataclass for QueryListsInput structure.""" + list_arg: list[str] | None = ... complex_list_arg: list[GreetingStruct] | None = ... list_arg_with_xml_name_member: list[str] | None = ... @@ -149,39 +197,53 @@ class QueryListsInput(_SerdeShape): @dataclass(kw_only=True) class QueryListsOutput(_SerdeShape): + """Dataclass for QueryListsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryTimestampsInput(_SerdeShape): + """Dataclass for QueryTimestampsInput structure.""" + normal_format: datetime | None = ... epoch_member: datetime | None = ... epoch_target: datetime | None = ... @dataclass(kw_only=True) class QueryTimestampsOutput(_SerdeShape): + """Dataclass for QueryTimestampsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class RecursiveXmlShapesInput(_SerdeShape): - pass + """Dataclass for RecursiveXmlShapesInput structure.""" @dataclass(kw_only=True) class RecursiveXmlShapesOutput(_SerdeShape): + """Dataclass for RecursiveXmlShapesOutput structure.""" + nested: RecursiveXmlShapesOutputNested1 | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class RecursiveXmlShapesOutputNested1(_SerdeShape): + """Dataclass for RecursiveXmlShapesOutputNested1 structure.""" + foo: str | None = ... nested: RecursiveXmlShapesOutputNested2 | None = ... @dataclass(kw_only=True) class RecursiveXmlShapesOutputNested2(_SerdeShape): + """Dataclass for RecursiveXmlShapesOutputNested2 structure.""" + bar: str | None = ... recursive_member: RecursiveXmlShapesOutputNested1 | None = ... @dataclass(kw_only=True) class SimpleInputParamsInput(_SerdeShape): + """Dataclass for SimpleInputParamsInput structure.""" + foo: str | None = ... bar: str | None = ... baz: bool | None = ... @@ -199,14 +261,18 @@ class SimpleInputParamsInput(_SerdeShape): @dataclass(kw_only=True) class SimpleInputParamsOutput(_SerdeShape): + """Dataclass for SimpleInputParamsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class SimpleScalarXmlPropertiesInput(_SerdeShape): - pass + """Dataclass for SimpleScalarXmlPropertiesInput structure.""" @dataclass(kw_only=True) class SimpleScalarXmlPropertiesOutput(_SerdeShape): + """Dataclass for SimpleScalarXmlPropertiesOutput structure.""" + string_value: str | None = ... empty_string_value: str | None = ... true_boolean_value: bool | None = ... @@ -221,39 +287,49 @@ class SimpleScalarXmlPropertiesOutput(_SerdeShape): @dataclass(kw_only=True) class StructArg(_SerdeShape): + """Dataclass for StructArg structure.""" + string_arg: str | None = ... other_arg: bool | None = ... recursive_arg: StructArg | None = ... @dataclass(kw_only=True) class StructureListMember(_SerdeShape): + """Dataclass for StructureListMember structure.""" + a: str | None = ... b: str | None = ... @dataclass(kw_only=True) class XmlBlobsInput(_SerdeShape): - pass + """Dataclass for XmlBlobsInput structure.""" @dataclass(kw_only=True) class XmlBlobsOperationOutput(_SerdeShape): + """Dataclass for XmlBlobsOperationOutput structure.""" + data: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlEmptyBlobsInput(_SerdeShape): - pass + """Dataclass for XmlEmptyBlobsInput structure.""" @dataclass(kw_only=True) class XmlEmptyBlobsOutput(_SerdeShape): + """Dataclass for XmlEmptyBlobsOutput structure.""" + data: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlEmptyListsInput(_SerdeShape): - pass + """Dataclass for XmlEmptyListsInput structure.""" @dataclass(kw_only=True) class XmlEmptyListsOutput(_SerdeShape): + """Dataclass for XmlEmptyListsOutput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -262,6 +338,7 @@ class XmlEmptyListsOutput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" renamed_list_members: list[str] | None = ... flattened_list: list[str] | None = ... flattened_list2: list[str] | None = ... @@ -272,10 +349,12 @@ class XmlEmptyListsOutput(_SerdeShape): @dataclass(kw_only=True) class XmlEnumsInput(_SerdeShape): - pass + """Dataclass for XmlEnumsInput structure.""" @dataclass(kw_only=True) class XmlEnumsOutput(_SerdeShape): + """Dataclass for XmlEnumsOutput structure.""" + foo_enum1: str | None = ... foo_enum2: str | None = ... foo_enum3: str | None = ... @@ -286,10 +365,12 @@ class XmlEnumsOutput(_SerdeShape): @dataclass(kw_only=True) class XmlIntEnumsInput(_SerdeShape): - pass + """Dataclass for XmlIntEnumsInput structure.""" @dataclass(kw_only=True) class XmlIntEnumsOutput(_SerdeShape): + """Dataclass for XmlIntEnumsOutput structure.""" + int_enum1: int | None = ... int_enum2: int | None = ... int_enum3: int | None = ... @@ -300,10 +381,12 @@ class XmlIntEnumsOutput(_SerdeShape): @dataclass(kw_only=True) class XmlListsInput(_SerdeShape): - pass + """Dataclass for XmlListsInput structure.""" @dataclass(kw_only=True) class XmlListsOperationOutput(_SerdeShape): + """Dataclass for XmlListsOperationOutput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -312,6 +395,7 @@ class XmlListsOperationOutput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" renamed_list_members: list[str] | None = ... flattened_list: list[str] | None = ... flattened_list2: list[str] | None = ... @@ -322,24 +406,30 @@ class XmlListsOperationOutput(_SerdeShape): @dataclass(kw_only=True) class XmlNamespaceNested(_SerdeShape): + """Dataclass for XmlNamespaceNested structure.""" + foo: str | None = ... values: list[str] | None = ... @dataclass(kw_only=True) class XmlNamespacesInput(_SerdeShape): - pass + """Dataclass for XmlNamespacesInput structure.""" @dataclass(kw_only=True) class XmlNamespacesOutput(_SerdeShape): + """Dataclass for XmlNamespacesOutput structure.""" + nested: XmlNamespaceNested | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlTimestampsInput(_SerdeShape): - pass + """Dataclass for XmlTimestampsInput structure.""" @dataclass(kw_only=True) class XmlTimestampsOutput(_SerdeShape): + """Dataclass for XmlTimestampsOutput structure.""" + normal: datetime | None = ... date_time: datetime | None = ... date_time_on_target: datetime | None = ... @@ -358,6 +448,8 @@ class FooEnum(UnknownEnumMixin, StrEnum): @dataclass(kw_only=True) class GreetingStruct(_SerdeShape): + """Dataclass for GreetingStruct structure.""" + hi: str | None = ... class IntegerEnum(UnknownEnumMixin, IntEnum): diff --git a/codegen-output/rest-json-1/src/restjson/models.pyi b/codegen-output/rest-json-1/src/restjson/models.pyi index b383142f5..7e56c71fb 100644 --- a/codegen-output/rest-json-1/src/restjson/models.pyi +++ b/codegen-output/rest-json-1/src/restjson/models.pyi @@ -20,10 +20,18 @@ class _SerdeShape: @classmethod def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ... -class ServiceError(ModeledError): ... +class ServiceError(ModeledError): + """ + Base error for all errors in the service. + + Some exceptions do not extend from this class, including + synthetic, implicit, and shared exception types. + """ @dataclass(kw_only=True) class AllQueryStringTypesInput(_SerdeShape): + """Dataclass for AllQueryStringTypesInput structure.""" + query_string: str | None = ... query_string_list: list[str] | None = ... query_string_set: list[str] | None = ... @@ -48,18 +56,26 @@ class AllQueryStringTypesInput(_SerdeShape): @dataclass(kw_only=True) class AllQueryStringTypesOutput(_SerdeShape): + """Dataclass for AllQueryStringTypesOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class BlobPayloadEvent(_SerdeShape): + """Dataclass for BlobPayloadEvent structure.""" + payload: bytes | None = ... @dataclass(kw_only=True) class ClientOptionalDefaults(_SerdeShape): + """Dataclass for ClientOptionalDefaults structure.""" + member: int | None = ... @dataclass(kw_only=True) class ComplexError(ServiceError, _SerdeShape): + """This error is thrown when a request is invalid.""" + header: str | None = ... top_level: str | None = ... nested: ComplexNestedErrorData | None = ... @@ -67,44 +83,62 @@ class ComplexError(ServiceError, _SerdeShape): @dataclass(kw_only=True) class ComplexNestedErrorData(_SerdeShape): + """Dataclass for ComplexNestedErrorData structure.""" + foo: str | None = ... @dataclass(kw_only=True) class ConstantAndVariableQueryStringInput(_SerdeShape): + """Dataclass for ConstantAndVariableQueryStringInput structure.""" + baz: str | None = ... maybe_set: str | None = ... @dataclass(kw_only=True) class ConstantAndVariableQueryStringOutput(_SerdeShape): + """Dataclass for ConstantAndVariableQueryStringOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ConstantQueryStringInput(_SerdeShape): + """Dataclass for ConstantQueryStringInput structure.""" + hello: str | None = ... @dataclass(kw_only=True) class ConstantQueryStringOutput(_SerdeShape): + """Dataclass for ConstantQueryStringOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ContentTypeParametersInput(_SerdeShape): + """Dataclass for ContentTypeParametersInput structure.""" + value: int | None = ... @dataclass(kw_only=True) class ContentTypeParametersOutput(_SerdeShape): + """Dataclass for ContentTypeParametersOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class DatetimeOffsetsInput(_SerdeShape): - pass + """Dataclass for DatetimeOffsetsInput structure.""" @dataclass(kw_only=True) class DatetimeOffsetsOutput(_SerdeShape): + """Dataclass for DatetimeOffsetsOutput structure.""" + datetime_: datetime | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class Defaults(_SerdeShape): + """Dataclass for Defaults structure.""" + default_string: str | None = ... default_boolean: bool | None = ... default_list: list[str] | None = ... @@ -136,94 +170,130 @@ class Defaults(_SerdeShape): @dataclass(kw_only=True) class Dialog(_SerdeShape): + """Dataclass for Dialog structure.""" + language: str | None = ... greeting: str | None = ... farewell: Farewell | None = ... @dataclass(kw_only=True) class DocumentTypeAsMapValueInput(_SerdeShape): + """Dataclass for DocumentTypeAsMapValueInput structure.""" + doc_valued_map: dict[str, Document] | None = ... @dataclass(kw_only=True) class DocumentTypeAsMapValueOutput(_SerdeShape): + """Dataclass for DocumentTypeAsMapValueOutput structure.""" + doc_valued_map: dict[str, Document] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class DocumentTypeAsPayloadInput(_SerdeShape): + """Dataclass for DocumentTypeAsPayloadInput structure.""" + document_value: Document | None = ... @dataclass(kw_only=True) class DocumentTypeAsPayloadOutput(_SerdeShape): + """Dataclass for DocumentTypeAsPayloadOutput structure.""" + document_value: Document | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class DocumentTypeInput(_SerdeShape): + """Dataclass for DocumentTypeInput structure.""" + string_value: str | None = ... document_value: Document | None = ... @dataclass(kw_only=True) class DocumentTypeOutput(_SerdeShape): + """Dataclass for DocumentTypeOutput structure.""" + string_value: str | None = ... document_value: Document | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class DuplexStreamInput(_SerdeShape): + """Dataclass for DuplexStreamInput structure.""" + stream: EventStream | None = ... @dataclass(kw_only=True) class DuplexStreamOutput(_SerdeShape): + """Dataclass for DuplexStreamOutput structure.""" + stream: EventStream | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class DuplexStreamWithDistinctStreamsInput(_SerdeShape): + """Dataclass for DuplexStreamWithDistinctStreamsInput structure.""" + stream: EventStream | None = ... @dataclass(kw_only=True) class DuplexStreamWithDistinctStreamsOutput(_SerdeShape): + """Dataclass for DuplexStreamWithDistinctStreamsOutput structure.""" + stream: SingletonEventStream | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class DuplexStreamWithInitialMessagesInput(_SerdeShape): + """Dataclass for DuplexStreamWithInitialMessagesInput structure.""" + initial_request_member: str | None = ... stream: EventStream | None = ... @dataclass(kw_only=True) class DuplexStreamWithInitialMessagesOutput(_SerdeShape): + """Dataclass for DuplexStreamWithInitialMessagesOutput structure.""" + initial_response_member: str stream: EventStream | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EmptyInputAndEmptyOutputInput(_SerdeShape): - pass + """Dataclass for EmptyInputAndEmptyOutputInput structure.""" @dataclass(kw_only=True) class EmptyInputAndEmptyOutputOutput(_SerdeShape): + """Dataclass for EmptyInputAndEmptyOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointOperationInput(_SerdeShape): - pass + """Dataclass for EndpointOperationInput structure.""" @dataclass(kw_only=True) class EndpointOperationOutput(_SerdeShape): + """Dataclass for EndpointOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationInput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationInput structure.""" + label: str | None = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationOutput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ErrorEvent(ServiceError, _SerdeShape): + """Dataclass for ErrorEvent structure.""" + response_metadata: ResponseMetadata = ... @dataclass @@ -260,6 +330,12 @@ class EventStreamError(_SerdeShape): @dataclass class EventStreamUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str EventStream = Union[ @@ -279,42 +355,59 @@ class _EventStreamDeserializer: @dataclass(kw_only=True) class Farewell(_SerdeShape): + """Dataclass for Farewell structure.""" + phrase: str | None = ... @dataclass(kw_only=True) class FooError(ServiceError, _SerdeShape): + """ + This error has test cases that test some of the dark corners of Amazon + service framework history. It should only be implemented by clients. + """ + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FractionalSecondsInput(_SerdeShape): - pass + """Dataclass for FractionalSecondsInput structure.""" @dataclass(kw_only=True) class FractionalSecondsOutput(_SerdeShape): + """Dataclass for FractionalSecondsOutput structure.""" + datetime_: datetime | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class GreetingWithErrorsInput(_SerdeShape): - pass + """Dataclass for GreetingWithErrorsInput structure.""" @dataclass(kw_only=True) class GreetingWithErrorsOutput(_SerdeShape): + """Dataclass for GreetingWithErrorsOutput structure.""" + greeting: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HeadersAndExplicitPayloadEvent(_SerdeShape): + """Dataclass for HeadersAndExplicitPayloadEvent structure.""" + header: str | None = ... payload: PayloadStructure | None = ... @dataclass(kw_only=True) class HeadersAndImplicitPayloadEvent(_SerdeShape): + """Dataclass for HeadersAndImplicitPayloadEvent structure.""" + header: str | None = ... payload: str | None = ... @dataclass(kw_only=True) class HeadersEvent(_SerdeShape): + """Dataclass for HeadersEvent structure.""" + boolean_header: bool | None = ... byte_header: int | None = ... short_header: int | None = ... @@ -326,129 +419,179 @@ class HeadersEvent(_SerdeShape): @dataclass(kw_only=True) class HostWithPathOperationInput(_SerdeShape): - pass + """Dataclass for HostWithPathOperationInput structure.""" @dataclass(kw_only=True) class HostWithPathOperationOutput(_SerdeShape): + """Dataclass for HostWithPathOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpChecksumRequiredInput(_SerdeShape): + """Dataclass for HttpChecksumRequiredInput structure.""" + foo: str | None = ... @dataclass(kw_only=True) class HttpChecksumRequiredOutput(_SerdeShape): + """Dataclass for HttpChecksumRequiredOutput structure.""" + foo: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpEmptyPrefixHeadersInput(_SerdeShape): + """Dataclass for HttpEmptyPrefixHeadersInput structure.""" + prefix_headers: dict[str, str] | None = ... specific_header: str | None = ... @dataclass(kw_only=True) class HttpEmptyPrefixHeadersOutput(_SerdeShape): + """Dataclass for HttpEmptyPrefixHeadersOutput structure.""" + prefix_headers: dict[str, str] | None = ... specific_header: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpEnumPayloadInput(_SerdeShape): + """Dataclass for HttpEnumPayloadInput structure.""" + payload: str | None = ... @dataclass(kw_only=True) class HttpEnumPayloadOutput(_SerdeShape): + """Dataclass for HttpEnumPayloadOutput structure.""" + payload: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadTraitsInput(_SerdeShape): + """Dataclass for HttpPayloadTraitsInput structure.""" + foo: str | None = ... blob: bytes | None = ... @dataclass(kw_only=True) class HttpPayloadTraitsOutput(_SerdeShape): + """Dataclass for HttpPayloadTraitsOutput structure.""" + foo: str | None = ... blob: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadTraitsWithMediaTypeInput(_SerdeShape): + """Dataclass for HttpPayloadTraitsWithMediaTypeInput structure.""" + foo: str | None = ... blob: bytes | None = ... @dataclass(kw_only=True) class HttpPayloadTraitsWithMediaTypeOutput(_SerdeShape): + """Dataclass for HttpPayloadTraitsWithMediaTypeOutput structure.""" + foo: str | None = ... blob: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadWithStructureInput(_SerdeShape): + """Dataclass for HttpPayloadWithStructureInput structure.""" + nested: NestedPayload | None = ... @dataclass(kw_only=True) class HttpPayloadWithStructureOutput(_SerdeShape): + """Dataclass for HttpPayloadWithStructureOutput structure.""" + nested: NestedPayload | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadWithUnionInput(_SerdeShape): + """Dataclass for HttpPayloadWithUnionInput structure.""" + nested: UnionPayload | None = ... @dataclass(kw_only=True) class HttpPayloadWithUnionOutput(_SerdeShape): + """Dataclass for HttpPayloadWithUnionOutput structure.""" + nested: UnionPayload | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPrefixHeadersInput(_SerdeShape): + """Dataclass for HttpPrefixHeadersInput structure.""" + foo: str | None = ... foo_map: dict[str, str] | None = ... @dataclass(kw_only=True) class HttpPrefixHeadersInResponseInput(_SerdeShape): - pass + """Dataclass for HttpPrefixHeadersInResponseInput structure.""" @dataclass(kw_only=True) class HttpPrefixHeadersInResponseOutput(_SerdeShape): + """Dataclass for HttpPrefixHeadersInResponseOutput structure.""" + prefix_headers: dict[str, str] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPrefixHeadersOutput(_SerdeShape): + """Dataclass for HttpPrefixHeadersOutput structure.""" + foo: str | None = ... foo_map: dict[str, str] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpQueryParamsOnlyOperationInput(_SerdeShape): + """Dataclass for HttpQueryParamsOnlyOperationInput structure.""" + query_map: dict[str, str] | None = ... @dataclass(kw_only=True) class HttpQueryParamsOnlyOperationOutput(_SerdeShape): + """Dataclass for HttpQueryParamsOnlyOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpRequestWithFloatLabelsInput(_SerdeShape): + """Dataclass for HttpRequestWithFloatLabelsInput structure.""" + float_: float | None = ... double: float | None = ... @dataclass(kw_only=True) class HttpRequestWithFloatLabelsOutput(_SerdeShape): + """Dataclass for HttpRequestWithFloatLabelsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpRequestWithGreedyLabelInPathInput(_SerdeShape): + """Dataclass for HttpRequestWithGreedyLabelInPathInput structure.""" + foo: str | None = ... baz: str | None = ... @dataclass(kw_only=True) class HttpRequestWithGreedyLabelInPathOutput(_SerdeShape): + """Dataclass for HttpRequestWithGreedyLabelInPathOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpRequestWithLabelsAndTimestampFormatInput(_SerdeShape): + """Dataclass for HttpRequestWithLabelsAndTimestampFormatInput structure.""" + member_epoch_seconds: datetime | None = ... member_http_date: datetime | None = ... member_date_time: datetime | None = ... @@ -459,10 +602,14 @@ class HttpRequestWithLabelsAndTimestampFormatInput(_SerdeShape): @dataclass(kw_only=True) class HttpRequestWithLabelsAndTimestampFormatOutput(_SerdeShape): + """Dataclass for HttpRequestWithLabelsAndTimestampFormatOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpRequestWithLabelsInput(_SerdeShape): + """Dataclass for HttpRequestWithLabelsInput structure.""" + string: str | None = ... short: int | None = ... integer: int | None = ... @@ -470,49 +617,70 @@ class HttpRequestWithLabelsInput(_SerdeShape): float_: float | None = ... double: float | None = ... boolean: bool | None = ... + """Serialized in the path as true or false.""" timestamp: datetime | None = ... + """ + Note that this member has no format, so it's serialized as an RFC 3399 + date-time. + """ @dataclass(kw_only=True) class HttpRequestWithLabelsOutput(_SerdeShape): + """Dataclass for HttpRequestWithLabelsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpRequestWithRegexLiteralInput(_SerdeShape): + """Dataclass for HttpRequestWithRegexLiteralInput structure.""" + str_: str | None = ... @dataclass(kw_only=True) class HttpRequestWithRegexLiteralOutput(_SerdeShape): + """Dataclass for HttpRequestWithRegexLiteralOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpResponseCodeInput(_SerdeShape): - pass + """Dataclass for HttpResponseCodeInput structure.""" @dataclass(kw_only=True) class HttpResponseCodeOutput(_SerdeShape): + """Dataclass for HttpResponseCodeOutput structure.""" + status: int | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpStringPayloadInput(_SerdeShape): + """Dataclass for HttpStringPayloadInput structure.""" + payload: str | None = ... @dataclass(kw_only=True) class HttpStringPayloadOutput(_SerdeShape): + """Dataclass for HttpStringPayloadOutput structure.""" + payload: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class IgnoreQueryParamsInResponseInput(_SerdeShape): - pass + """Dataclass for IgnoreQueryParamsInResponseInput structure.""" @dataclass(kw_only=True) class IgnoreQueryParamsInResponseOutput(_SerdeShape): + """Dataclass for IgnoreQueryParamsInResponseOutput structure.""" + baz: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class InputAndOutputWithHeadersInput(_SerdeShape): + """Dataclass for InputAndOutputWithHeadersInput structure.""" + header_string: str | None = ... header_byte: int | None = ... header_short: int | None = ... @@ -534,6 +702,8 @@ class InputAndOutputWithHeadersInput(_SerdeShape): @dataclass(kw_only=True) class InputAndOutputWithHeadersOutput(_SerdeShape): + """Dataclass for InputAndOutputWithHeadersOutput structure.""" + header_string: str | None = ... header_byte: int | None = ... header_short: int | None = ... @@ -556,36 +726,52 @@ class InputAndOutputWithHeadersOutput(_SerdeShape): @dataclass(kw_only=True) class InputStreamInput(_SerdeShape): + """Dataclass for InputStreamInput structure.""" + stream: EventStream | None = ... @dataclass(kw_only=True) class InputStreamOutput(_SerdeShape): + """Dataclass for InputStreamOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class InputStreamWithInitialRequestInput(_SerdeShape): + """Dataclass for InputStreamWithInitialRequestInput structure.""" + initial_request_member: str | None = ... stream: EventStream | None = ... @dataclass(kw_only=True) class InputStreamWithInitialRequestOutput(_SerdeShape): + """Dataclass for InputStreamWithInitialRequestOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class InvalidGreeting(ServiceError, _SerdeShape): + """This error is thrown when an invalid greeting value is provided.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class JsonBlobsInput(_SerdeShape): + """Dataclass for JsonBlobsInput structure.""" + data: bytes | None = ... @dataclass(kw_only=True) class JsonBlobsOutput(_SerdeShape): + """Dataclass for JsonBlobsOutput structure.""" + data: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class JsonEnumsInput(_SerdeShape): + """Dataclass for JsonEnumsInput structure.""" + foo_enum1: str | None = ... foo_enum2: str | None = ... foo_enum3: str | None = ... @@ -595,6 +781,8 @@ class JsonEnumsInput(_SerdeShape): @dataclass(kw_only=True) class JsonEnumsOutput(_SerdeShape): + """Dataclass for JsonEnumsOutput structure.""" + foo_enum1: str | None = ... foo_enum2: str | None = ... foo_enum3: str | None = ... @@ -605,6 +793,8 @@ class JsonEnumsOutput(_SerdeShape): @dataclass(kw_only=True) class JsonIntEnumsInput(_SerdeShape): + """Dataclass for JsonIntEnumsInput structure.""" + integer_enum1: int | None = ... integer_enum2: int | None = ... integer_enum3: int | None = ... @@ -614,6 +804,8 @@ class JsonIntEnumsInput(_SerdeShape): @dataclass(kw_only=True) class JsonIntEnumsOutput(_SerdeShape): + """Dataclass for JsonIntEnumsOutput structure.""" + integer_enum1: int | None = ... integer_enum2: int | None = ... integer_enum3: int | None = ... @@ -624,6 +816,8 @@ class JsonIntEnumsOutput(_SerdeShape): @dataclass(kw_only=True) class JsonListsInput(_SerdeShape): + """Dataclass for JsonListsInput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -632,10 +826,13 @@ class JsonListsInput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" structure_list: list[StructureListMember] | None = ... @dataclass(kw_only=True) class JsonListsOutput(_SerdeShape): + """Dataclass for JsonListsOutput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -644,11 +841,14 @@ class JsonListsOutput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" structure_list: list[StructureListMember] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class JsonMapsInput(_SerdeShape): + """Dataclass for JsonMapsInput structure.""" + dense_struct_map: dict[str, GreetingStruct] | None = ... dense_number_map: dict[str, int] | None = ... dense_boolean_map: dict[str, bool] | None = ... @@ -657,6 +857,8 @@ class JsonMapsInput(_SerdeShape): @dataclass(kw_only=True) class JsonMapsOutput(_SerdeShape): + """Dataclass for JsonMapsOutput structure.""" + dense_struct_map: dict[str, GreetingStruct] | None = ... dense_number_map: dict[str, int] | None = ... dense_boolean_map: dict[str, bool] | None = ... @@ -666,6 +868,8 @@ class JsonMapsOutput(_SerdeShape): @dataclass(kw_only=True) class JsonTimestampsInput(_SerdeShape): + """Dataclass for JsonTimestampsInput structure.""" + normal: datetime | None = ... date_time: datetime | None = ... date_time_on_target: datetime | None = ... @@ -676,6 +880,8 @@ class JsonTimestampsInput(_SerdeShape): @dataclass(kw_only=True) class JsonTimestampsOutput(_SerdeShape): + """Dataclass for JsonTimestampsOutput structure.""" + normal: datetime | None = ... date_time: datetime | None = ... date_time_on_target: datetime | None = ... @@ -687,50 +893,68 @@ class JsonTimestampsOutput(_SerdeShape): @dataclass(kw_only=True) class JsonUnionsInput(_SerdeShape): + """A shared structure that contains a single union member.""" + contents: MyUnion | None = ... + """A union with a representative set of types for members.""" @dataclass(kw_only=True) class JsonUnionsOutput(_SerdeShape): + """A shared structure that contains a single union member.""" + contents: MyUnion | None = ... + """A union with a representative set of types for members.""" response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedAcceptWithBodyInput(_SerdeShape): - pass + """Dataclass for MalformedAcceptWithBodyInput structure.""" @dataclass(kw_only=True) class MalformedAcceptWithBodyOutput(_SerdeShape): + """Dataclass for MalformedAcceptWithBodyOutput structure.""" + hi: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedAcceptWithGenericStringInput(_SerdeShape): - pass + """Dataclass for MalformedAcceptWithGenericStringInput structure.""" @dataclass(kw_only=True) class MalformedAcceptWithGenericStringOutput(_SerdeShape): + """Dataclass for MalformedAcceptWithGenericStringOutput structure.""" + payload: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedAcceptWithPayloadInput(_SerdeShape): - pass + """Dataclass for MalformedAcceptWithPayloadInput structure.""" @dataclass(kw_only=True) class MalformedAcceptWithPayloadOutput(_SerdeShape): + """Dataclass for MalformedAcceptWithPayloadOutput structure.""" + payload: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedBlobInput(_SerdeShape): + """Dataclass for MalformedBlobInput structure.""" + blob: bytes | None = ... @dataclass(kw_only=True) class MalformedBlobOutput(_SerdeShape): + """Dataclass for MalformedBlobOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedBooleanInput(_SerdeShape): + """Dataclass for MalformedBooleanInput structure.""" + boolean_in_body: bool | None = ... boolean_in_path: bool | None = ... boolean_in_query: bool | None = ... @@ -738,10 +962,14 @@ class MalformedBooleanInput(_SerdeShape): @dataclass(kw_only=True) class MalformedBooleanOutput(_SerdeShape): + """Dataclass for MalformedBooleanOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedByteInput(_SerdeShape): + """Dataclass for MalformedByteInput structure.""" + byte_in_body: int | None = ... byte_in_path: int | None = ... byte_in_query: int | None = ... @@ -749,50 +977,72 @@ class MalformedByteInput(_SerdeShape): @dataclass(kw_only=True) class MalformedByteOutput(_SerdeShape): + """Dataclass for MalformedByteOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedContentTypeWithBodyInput(_SerdeShape): + """Dataclass for MalformedContentTypeWithBodyInput structure.""" + hi: str | None = ... @dataclass(kw_only=True) class MalformedContentTypeWithBodyOutput(_SerdeShape): + """Dataclass for MalformedContentTypeWithBodyOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedContentTypeWithGenericStringInput(_SerdeShape): + """Dataclass for MalformedContentTypeWithGenericStringInput structure.""" + payload: str | None = ... @dataclass(kw_only=True) class MalformedContentTypeWithGenericStringOutput(_SerdeShape): + """Dataclass for MalformedContentTypeWithGenericStringOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedContentTypeWithoutBodyEmptyInputInput(_SerdeShape): + """Dataclass for MalformedContentTypeWithoutBodyEmptyInputInput structure.""" + header: str | None = ... @dataclass(kw_only=True) class MalformedContentTypeWithoutBodyEmptyInputOutput(_SerdeShape): + """Dataclass for MalformedContentTypeWithoutBodyEmptyInputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedContentTypeWithoutBodyInput(_SerdeShape): - pass + """Dataclass for MalformedContentTypeWithoutBodyInput structure.""" @dataclass(kw_only=True) class MalformedContentTypeWithoutBodyOutput(_SerdeShape): + """Dataclass for MalformedContentTypeWithoutBodyOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedContentTypeWithPayloadInput(_SerdeShape): + """Dataclass for MalformedContentTypeWithPayloadInput structure.""" + payload: bytes | None = ... @dataclass(kw_only=True) class MalformedContentTypeWithPayloadOutput(_SerdeShape): + """Dataclass for MalformedContentTypeWithPayloadOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedDoubleInput(_SerdeShape): + """Dataclass for MalformedDoubleInput structure.""" + double_in_body: float | None = ... double_in_path: float | None = ... double_in_query: float | None = ... @@ -800,10 +1050,14 @@ class MalformedDoubleInput(_SerdeShape): @dataclass(kw_only=True) class MalformedDoubleOutput(_SerdeShape): + """Dataclass for MalformedDoubleOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedFloatInput(_SerdeShape): + """Dataclass for MalformedFloatInput structure.""" + float_in_body: float | None = ... float_in_path: float | None = ... float_in_query: float | None = ... @@ -811,10 +1065,14 @@ class MalformedFloatInput(_SerdeShape): @dataclass(kw_only=True) class MalformedFloatOutput(_SerdeShape): + """Dataclass for MalformedFloatOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedIntegerInput(_SerdeShape): + """Dataclass for MalformedIntegerInput structure.""" + integer_in_body: int | None = ... integer_in_path: int | None = ... integer_in_query: int | None = ... @@ -822,18 +1080,26 @@ class MalformedIntegerInput(_SerdeShape): @dataclass(kw_only=True) class MalformedIntegerOutput(_SerdeShape): + """Dataclass for MalformedIntegerOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedListInput(_SerdeShape): + """Dataclass for MalformedListInput structure.""" + body_list: list[str] | None = ... @dataclass(kw_only=True) class MalformedListOutput(_SerdeShape): + """Dataclass for MalformedListOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedLongInput(_SerdeShape): + """Dataclass for MalformedLongInput structure.""" + long_in_body: int | None = ... long_in_path: int | None = ... long_in_query: int | None = ... @@ -841,27 +1107,39 @@ class MalformedLongInput(_SerdeShape): @dataclass(kw_only=True) class MalformedLongOutput(_SerdeShape): + """Dataclass for MalformedLongOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedMapInput(_SerdeShape): + """Dataclass for MalformedMapInput structure.""" + body_map: dict[str, str] | None = ... @dataclass(kw_only=True) class MalformedMapOutput(_SerdeShape): + """Dataclass for MalformedMapOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedRequestBodyInput(_SerdeShape): + """Dataclass for MalformedRequestBodyInput structure.""" + int_: int | None = ... float_: float | None = ... @dataclass(kw_only=True) class MalformedRequestBodyOutput(_SerdeShape): + """Dataclass for MalformedRequestBodyOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedShortInput(_SerdeShape): + """Dataclass for MalformedShortInput structure.""" + short_in_body: int | None = ... short_in_path: int | None = ... short_in_query: int | None = ... @@ -869,126 +1147,188 @@ class MalformedShortInput(_SerdeShape): @dataclass(kw_only=True) class MalformedShortOutput(_SerdeShape): + """Dataclass for MalformedShortOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedStringInput(_SerdeShape): + """Dataclass for MalformedStringInput structure.""" + blob: str | JsonString | None = ... @dataclass(kw_only=True) class MalformedStringOutput(_SerdeShape): + """Dataclass for MalformedStringOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampBodyDateTimeInput(_SerdeShape): + """Dataclass for MalformedTimestampBodyDateTimeInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampBodyDateTimeOutput(_SerdeShape): + """Dataclass for MalformedTimestampBodyDateTimeOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampBodyDefaultInput(_SerdeShape): + """Dataclass for MalformedTimestampBodyDefaultInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampBodyDefaultOutput(_SerdeShape): + """Dataclass for MalformedTimestampBodyDefaultOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampBodyHttpDateInput(_SerdeShape): + """Dataclass for MalformedTimestampBodyHttpDateInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampBodyHttpDateOutput(_SerdeShape): + """Dataclass for MalformedTimestampBodyHttpDateOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampHeaderDateTimeInput(_SerdeShape): + """Dataclass for MalformedTimestampHeaderDateTimeInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampHeaderDateTimeOutput(_SerdeShape): + """Dataclass for MalformedTimestampHeaderDateTimeOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampHeaderDefaultInput(_SerdeShape): + """Dataclass for MalformedTimestampHeaderDefaultInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampHeaderDefaultOutput(_SerdeShape): + """Dataclass for MalformedTimestampHeaderDefaultOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampHeaderEpochInput(_SerdeShape): + """Dataclass for MalformedTimestampHeaderEpochInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampHeaderEpochOutput(_SerdeShape): + """Dataclass for MalformedTimestampHeaderEpochOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampPathDefaultInput(_SerdeShape): + """Dataclass for MalformedTimestampPathDefaultInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampPathDefaultOutput(_SerdeShape): + """Dataclass for MalformedTimestampPathDefaultOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampPathEpochInput(_SerdeShape): + """Dataclass for MalformedTimestampPathEpochInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampPathEpochOutput(_SerdeShape): + """Dataclass for MalformedTimestampPathEpochOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampPathHttpDateInput(_SerdeShape): + """Dataclass for MalformedTimestampPathHttpDateInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampPathHttpDateOutput(_SerdeShape): + """Dataclass for MalformedTimestampPathHttpDateOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampQueryDefaultInput(_SerdeShape): + """Dataclass for MalformedTimestampQueryDefaultInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampQueryDefaultOutput(_SerdeShape): + """Dataclass for MalformedTimestampQueryDefaultOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampQueryEpochInput(_SerdeShape): + """Dataclass for MalformedTimestampQueryEpochInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampQueryEpochOutput(_SerdeShape): + """Dataclass for MalformedTimestampQueryEpochOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedTimestampQueryHttpDateInput(_SerdeShape): + """Dataclass for MalformedTimestampQueryHttpDateInput structure.""" + timestamp: datetime | None = ... @dataclass(kw_only=True) class MalformedTimestampQueryHttpDateOutput(_SerdeShape): + """Dataclass for MalformedTimestampQueryHttpDateOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MalformedUnionInput(_SerdeShape): + """Dataclass for MalformedUnionInput structure.""" + union: SimpleUnion | None = ... @dataclass(kw_only=True) class MalformedUnionOutput(_SerdeShape): + """Dataclass for MalformedUnionOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class MediaTypeHeaderInput(_SerdeShape): + """Dataclass for MediaTypeHeaderInput structure.""" + json: str | JsonString | None = ... @dataclass(kw_only=True) class MediaTypeHeaderOutput(_SerdeShape): + """Dataclass for MediaTypeHeaderOutput structure.""" + json: str | JsonString | None = ... response_metadata: ResponseMetadata = ... @@ -1034,10 +1374,18 @@ class MyUnionRenamedStructureValue(_SerdeShape): @dataclass class MyUnionUnionValue(_SerdeShape): + """A union used to test unions nested inside unions.""" + value: NestedUnion @dataclass class MyUnionUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str MyUnion = Union[ @@ -1054,12 +1402,15 @@ MyUnion = Union[ | MyUnionUnionValue | MyUnionUnknown ] +"""A union with a representative set of types for members.""" class _MyUnionDeserializer: def deserialize(self, deserializer: ShapeDeserializer) -> MyUnion: ... @dataclass(kw_only=True) class NestedPayload(_SerdeShape): + """Dataclass for NestedPayload structure.""" + greeting: str | None = ... name: str | None = ... @@ -1069,37 +1420,52 @@ class NestedUnionStringValue(_SerdeShape): @dataclass class NestedUnionUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str NestedUnion = Union[NestedUnionStringValue | NestedUnionUnknown] +"""A union used to test unions nested inside unions.""" class _NestedUnionDeserializer: def deserialize(self, deserializer: ShapeDeserializer) -> NestedUnion: ... @dataclass(kw_only=True) class NoInputAndNoOutputInput(_SerdeShape): - pass + """Dataclass for NoInputAndNoOutputInput structure.""" @dataclass(kw_only=True) class NoInputAndNoOutputOutput(_SerdeShape): + """Dataclass for NoInputAndNoOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NoInputAndOutputInput(_SerdeShape): - pass + """Dataclass for NoInputAndOutputInput structure.""" @dataclass(kw_only=True) class NoInputAndOutputOutput(_SerdeShape): + """Dataclass for NoInputAndOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NullAndEmptyHeadersClientInput(_SerdeShape): + """Dataclass for NullAndEmptyHeadersClientInput structure.""" + a: str | None = ... b: str | None = ... c: list[str] | None = ... @dataclass(kw_only=True) class NullAndEmptyHeadersClientOutput(_SerdeShape): + """Dataclass for NullAndEmptyHeadersClientOutput structure.""" + a: str | None = ... b: str | None = ... c: list[str] | None = ... @@ -1107,12 +1473,16 @@ class NullAndEmptyHeadersClientOutput(_SerdeShape): @dataclass(kw_only=True) class NullAndEmptyHeadersServerInput(_SerdeShape): + """Dataclass for NullAndEmptyHeadersServerInput structure.""" + a: str | None = ... b: str | None = ... c: list[str] | None = ... @dataclass(kw_only=True) class NullAndEmptyHeadersServerOutput(_SerdeShape): + """Dataclass for NullAndEmptyHeadersServerOutput structure.""" + a: str | None = ... b: str | None = ... c: list[str] | None = ... @@ -1120,15 +1490,21 @@ class NullAndEmptyHeadersServerOutput(_SerdeShape): @dataclass(kw_only=True) class OmitsNullSerializesEmptyStringInput(_SerdeShape): + """Dataclass for OmitsNullSerializesEmptyStringInput structure.""" + null_value: str | None = ... empty_string: str | None = ... @dataclass(kw_only=True) class OmitsNullSerializesEmptyStringOutput(_SerdeShape): + """Dataclass for OmitsNullSerializesEmptyStringOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class OmitsSerializingEmptyListsInput(_SerdeShape): + """Dataclass for OmitsSerializingEmptyListsInput structure.""" + query_string_list: list[str] | None = ... query_integer_list: list[int] | None = ... query_double_list: list[float] | None = ... @@ -1139,10 +1515,14 @@ class OmitsSerializingEmptyListsInput(_SerdeShape): @dataclass(kw_only=True) class OmitsSerializingEmptyListsOutput(_SerdeShape): + """Dataclass for OmitsSerializingEmptyListsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class OperationWithDefaultsInput(_SerdeShape): + """Dataclass for OperationWithDefaultsInput structure.""" + defaults: Defaults | None = ... client_optional_defaults: ClientOptionalDefaults | None = ... top_level_default: str | None = ... @@ -1150,6 +1530,8 @@ class OperationWithDefaultsInput(_SerdeShape): @dataclass(kw_only=True) class OperationWithDefaultsOutput(_SerdeShape): + """Dataclass for OperationWithDefaultsOutput structure.""" + default_string: str | None = ... default_boolean: bool | None = ... default_list: list[str] | None = ... @@ -1182,10 +1564,14 @@ class OperationWithDefaultsOutput(_SerdeShape): @dataclass(kw_only=True) class OperationWithNestedStructureInput(_SerdeShape): + """Dataclass for OperationWithNestedStructureInput structure.""" + top_level: TopLevel | None = ... @dataclass(kw_only=True) class OperationWithNestedStructureOutput(_SerdeShape): + """Dataclass for OperationWithNestedStructureOutput structure.""" + dialog: Dialog dialog_list: list[Dialog] | None = ... dialog_map: dict[str, Dialog] | None = ... @@ -1193,29 +1579,37 @@ class OperationWithNestedStructureOutput(_SerdeShape): @dataclass(kw_only=True) class OutputStreamInput(_SerdeShape): - pass + """Dataclass for OutputStreamInput structure.""" @dataclass(kw_only=True) class OutputStreamOutput(_SerdeShape): + """Dataclass for OutputStreamOutput structure.""" + stream: EventStream | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class OutputStreamWithInitialResponseInput(_SerdeShape): - pass + """Dataclass for OutputStreamWithInitialResponseInput structure.""" @dataclass(kw_only=True) class OutputStreamWithInitialResponseOutput(_SerdeShape): + """Dataclass for OutputStreamWithInitialResponseOutput structure.""" + initial_response_member: str stream: EventStream | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class PayloadConfig(_SerdeShape): + """Dataclass for PayloadConfig structure.""" + data: int | None = ... @dataclass(kw_only=True) class PayloadStructure(_SerdeShape): + """Dataclass for PayloadStructure structure.""" + structure_member: str | None = ... @dataclass @@ -1224,6 +1618,12 @@ class PayloadUnionUnionMember(_SerdeShape): @dataclass class PayloadUnionUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str PayloadUnion = Union[PayloadUnionUnionMember | PayloadUnionUnknown] @@ -1233,10 +1633,18 @@ class _PayloadUnionDeserializer: @dataclass class PlayerActionQuit(_SerdeShape): + """Quit the game.""" + value: Unit @dataclass class PlayerActionUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str PlayerAction = Union[PlayerActionQuit | PlayerActionUnknown] @@ -1246,99 +1654,139 @@ class _PlayerActionDeserializer: @dataclass(kw_only=True) class PostPlayerActionInput(_SerdeShape): + """Dataclass for PostPlayerActionInput structure.""" + action: PlayerAction | None = ... @dataclass(kw_only=True) class PostPlayerActionOutput(_SerdeShape): + """Dataclass for PostPlayerActionOutput structure.""" + action: PlayerAction response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class PostUnionWithJsonNameInput(_SerdeShape): + """Dataclass for PostUnionWithJsonNameInput structure.""" + value: UnionWithJsonName | None = ... @dataclass(kw_only=True) class PostUnionWithJsonNameOutput(_SerdeShape): + """Dataclass for PostUnionWithJsonNameOutput structure.""" + value: UnionWithJsonName response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class PutWithContentEncodingInput(_SerdeShape): + """Dataclass for PutWithContentEncodingInput structure.""" + encoding: str | None = ... data: str | None = ... @dataclass(kw_only=True) class PutWithContentEncodingOutput(_SerdeShape): + """Dataclass for PutWithContentEncodingOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryIdempotencyTokenAutoFillInput(_SerdeShape): + """Dataclass for QueryIdempotencyTokenAutoFillInput structure.""" + token: str | None = ... @dataclass(kw_only=True) class QueryIdempotencyTokenAutoFillOutput(_SerdeShape): + """Dataclass for QueryIdempotencyTokenAutoFillOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryParamsAsStringListMapInput(_SerdeShape): + """Dataclass for QueryParamsAsStringListMapInput structure.""" + qux: str | None = ... foo: dict[str, list[str]] | None = ... @dataclass(kw_only=True) class QueryParamsAsStringListMapOutput(_SerdeShape): + """Dataclass for QueryParamsAsStringListMapOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryPrecedenceInput(_SerdeShape): + """Dataclass for QueryPrecedenceInput structure.""" + foo: str | None = ... baz: dict[str, str] | None = ... @dataclass(kw_only=True) class QueryPrecedenceOutput(_SerdeShape): + """Dataclass for QueryPrecedenceOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class RecursiveShapesInput(_SerdeShape): + """Dataclass for RecursiveShapesInput structure.""" + nested: RecursiveShapesInputOutputNested1 | None = ... @dataclass(kw_only=True) class RecursiveShapesInputOutputNested1(_SerdeShape): + """Dataclass for RecursiveShapesInputOutputNested1 structure.""" + foo: str | None = ... nested: RecursiveShapesInputOutputNested2 | None = ... @dataclass(kw_only=True) class RecursiveShapesInputOutputNested2(_SerdeShape): + """Dataclass for RecursiveShapesInputOutputNested2 structure.""" + bar: str | None = ... recursive_member: RecursiveShapesInputOutputNested1 | None = ... @dataclass(kw_only=True) class RecursiveShapesOutput(_SerdeShape): + """Dataclass for RecursiveShapesOutput structure.""" + nested: RecursiveShapesInputOutputNested1 | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ResponseCodeHttpFallbackInput(_SerdeShape): - pass + """Dataclass for ResponseCodeHttpFallbackInput structure.""" @dataclass(kw_only=True) class ResponseCodeHttpFallbackOutput(_SerdeShape): + """Dataclass for ResponseCodeHttpFallbackOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ResponseCodeRequiredInput(_SerdeShape): - pass + """Dataclass for ResponseCodeRequiredInput structure.""" @dataclass(kw_only=True) class ResponseCodeRequiredOutput(_SerdeShape): + """Dataclass for ResponseCodeRequiredOutput structure.""" + response_code: int response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ServiceUnavailableError(ServiceError, _SerdeShape): + """Dataclass for ServiceUnavailableError structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class SimpleScalarPropertiesInput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesInput structure.""" + foo: str | None = ... string_value: str | None = ... true_boolean_value: bool | None = ... @@ -1352,6 +1800,8 @@ class SimpleScalarPropertiesInput(_SerdeShape): @dataclass(kw_only=True) class SimpleScalarPropertiesOutput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesOutput structure.""" + foo: str | None = ... string_value: str | None = ... true_boolean_value: bool | None = ... @@ -1374,6 +1824,12 @@ class SimpleUnionString(_SerdeShape): @dataclass class SimpleUnionUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str SimpleUnion = Union[SimpleUnionInt | SimpleUnionString | SimpleUnionUnknown] @@ -1383,6 +1839,8 @@ class _SimpleUnionDeserializer: @dataclass(kw_only=True) class SingletonEvent(_SerdeShape): + """Dataclass for SingletonEvent structure.""" + value: str | None = ... @dataclass @@ -1391,6 +1849,12 @@ class SingletonEventStreamSingleton(_SerdeShape): @dataclass class SingletonEventStreamUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str SingletonEventStream = Union[ @@ -1402,17 +1866,23 @@ class _SingletonEventStreamDeserializer: @dataclass(kw_only=True) class SparseJsonListsInput(_SerdeShape): + """Dataclass for SparseJsonListsInput structure.""" + sparse_string_list: list[str | None] | None = ... sparse_short_list: list[int | None] | None = ... @dataclass(kw_only=True) class SparseJsonListsOutput(_SerdeShape): + """Dataclass for SparseJsonListsOutput structure.""" + sparse_string_list: list[str | None] | None = ... sparse_short_list: list[int | None] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class SparseJsonMapsInput(_SerdeShape): + """Dataclass for SparseJsonMapsInput structure.""" + sparse_struct_map: dict[str, GreetingStruct | None] | None = ... sparse_number_map: dict[str, int | None] | None = ... sparse_boolean_map: dict[str, bool | None] | None = ... @@ -1421,6 +1891,8 @@ class SparseJsonMapsInput(_SerdeShape): @dataclass(kw_only=True) class SparseJsonMapsOutput(_SerdeShape): + """Dataclass for SparseJsonMapsOutput structure.""" + sparse_struct_map: dict[str, GreetingStruct | None] | None = ... sparse_number_map: dict[str, int | None] | None = ... sparse_boolean_map: dict[str, bool | None] | None = ... @@ -1430,31 +1902,43 @@ class SparseJsonMapsOutput(_SerdeShape): @dataclass(kw_only=True) class StreamingTraitsInput(_SerdeShape): + """Dataclass for StreamingTraitsInput structure.""" + foo: str | None = ... blob: StreamingBlob | None = ... @dataclass(kw_only=True) class StreamingTraitsOutput(_SerdeShape): + """Dataclass for StreamingTraitsOutput structure.""" + foo: str | None = ... blob: StreamingBlob | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class StreamingTraitsRequireLengthInput(_SerdeShape): + """Dataclass for StreamingTraitsRequireLengthInput structure.""" + foo: str | None = ... blob: StreamingBlob | None = ... @dataclass(kw_only=True) class StreamingTraitsRequireLengthOutput(_SerdeShape): + """Dataclass for StreamingTraitsRequireLengthOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class StreamingTraitsWithMediaTypeInput(_SerdeShape): + """Dataclass for StreamingTraitsWithMediaTypeInput structure.""" + foo: str | None = ... blob: StreamingBlob | None = ... @dataclass(kw_only=True) class StreamingTraitsWithMediaTypeOutput(_SerdeShape): + """Dataclass for StreamingTraitsWithMediaTypeOutput structure.""" + foo: str | None = ... blob: StreamingBlob | None = ... response_metadata: ResponseMetadata = ... @@ -1464,30 +1948,42 @@ class StringEnum(UnknownEnumMixin, StrEnum): @dataclass(kw_only=True) class StringPayloadEvent(_SerdeShape): + """Dataclass for StringPayloadEvent structure.""" + payload: str | None = ... @dataclass(kw_only=True) class StructureListMember(_SerdeShape): + """Dataclass for StructureListMember structure.""" + a: str | None = ... b: str | None = ... @dataclass(kw_only=True) class StructurePayloadEvent(_SerdeShape): + """Dataclass for StructurePayloadEvent structure.""" + payload: PayloadStructure | None = ... @dataclass(kw_only=True) class TestBodyStructureInput(_SerdeShape): + """Dataclass for TestBodyStructureInput structure.""" + test_id: str | None = ... test_config: TestConfig | None = ... @dataclass(kw_only=True) class TestBodyStructureOutput(_SerdeShape): + """Dataclass for TestBodyStructureOutput structure.""" + test_id: str | None = ... test_config: TestConfig | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class TestConfig(_SerdeShape): + """Dataclass for TestConfig structure.""" + timeout: int | None = ... class TestEnum(UnknownEnumMixin, StrEnum): @@ -1497,19 +1993,25 @@ class TestEnum(UnknownEnumMixin, StrEnum): @dataclass(kw_only=True) class TestGetNoInputNoPayloadInput(_SerdeShape): - pass + """Dataclass for TestGetNoInputNoPayloadInput structure.""" @dataclass(kw_only=True) class TestGetNoInputNoPayloadOutput(_SerdeShape): + """Dataclass for TestGetNoInputNoPayloadOutput structure.""" + test_id: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class TestGetNoPayloadInput(_SerdeShape): + """Dataclass for TestGetNoPayloadInput structure.""" + test_id: str | None = ... @dataclass(kw_only=True) class TestGetNoPayloadOutput(_SerdeShape): + """Dataclass for TestGetNoPayloadOutput structure.""" + test_id: str | None = ... response_metadata: ResponseMetadata = ... @@ -1519,46 +2021,62 @@ class TestIntEnum(UnknownEnumMixin, IntEnum): @dataclass(kw_only=True) class TestPayloadBlobInput(_SerdeShape): + """Dataclass for TestPayloadBlobInput structure.""" + content_type: str | None = ... data: bytes | None = ... @dataclass(kw_only=True) class TestPayloadBlobOutput(_SerdeShape): + """Dataclass for TestPayloadBlobOutput structure.""" + content_type: str | None = ... data: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class TestPayloadStructureInput(_SerdeShape): + """Dataclass for TestPayloadStructureInput structure.""" + test_id: str | None = ... payload_config: PayloadConfig | None = ... @dataclass(kw_only=True) class TestPayloadStructureOutput(_SerdeShape): + """Dataclass for TestPayloadStructureOutput structure.""" + test_id: str | None = ... payload_config: PayloadConfig | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class TestPostNoInputNoPayloadInput(_SerdeShape): - pass + """Dataclass for TestPostNoInputNoPayloadInput structure.""" @dataclass(kw_only=True) class TestPostNoInputNoPayloadOutput(_SerdeShape): + """Dataclass for TestPostNoInputNoPayloadOutput structure.""" + test_id: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class TestPostNoPayloadInput(_SerdeShape): + """Dataclass for TestPostNoPayloadInput structure.""" + test_id: str | None = ... @dataclass(kw_only=True) class TestPostNoPayloadOutput(_SerdeShape): + """Dataclass for TestPostNoPayloadOutput structure.""" + test_id: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class TimestampFormatHeadersInput(_SerdeShape): + """Dataclass for TimestampFormatHeadersInput structure.""" + member_epoch_seconds: datetime | None = ... member_http_date: datetime | None = ... member_date_time: datetime | None = ... @@ -1569,6 +2087,8 @@ class TimestampFormatHeadersInput(_SerdeShape): @dataclass(kw_only=True) class TimestampFormatHeadersOutput(_SerdeShape): + """Dataclass for TimestampFormatHeadersOutput structure.""" + member_epoch_seconds: datetime | None = ... member_http_date: datetime | None = ... member_date_time: datetime | None = ... @@ -1580,6 +2100,8 @@ class TimestampFormatHeadersOutput(_SerdeShape): @dataclass(kw_only=True) class TopLevel(_SerdeShape): + """Dataclass for TopLevel structure.""" + dialog: Dialog dialog_list: list[Dialog] | None = ... dialog_map: dict[str, Dialog] | None = ... @@ -1590,6 +2112,12 @@ class UnionPayloadGreeting(_SerdeShape): @dataclass class UnionPayloadUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str UnionPayload = Union[UnionPayloadGreeting | UnionPayloadUnknown] @@ -1599,6 +2127,8 @@ class _UnionPayloadDeserializer: @dataclass(kw_only=True) class UnionPayloadEvent(_SerdeShape): + """Dataclass for UnionPayloadEvent structure.""" + payload: PayloadUnion | None = ... @dataclass @@ -1615,6 +2145,12 @@ class UnionWithJsonNameBaz(_SerdeShape): @dataclass class UnionWithJsonNameUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str UnionWithJsonName = Union[ @@ -1629,14 +2165,18 @@ class _UnionWithJsonNameDeserializer: @dataclass(kw_only=True) class UnitInputAndOutputInput(_SerdeShape): - pass + """Dataclass for UnitInputAndOutputInput structure.""" @dataclass(kw_only=True) class UnitInputAndOutputOutput(_SerdeShape): + """Dataclass for UnitInputAndOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class RenamedGreeting(_SerdeShape): + """Dataclass for GreetingStruct structure.""" + salutation: str | None = ... class FooEnum(UnknownEnumMixin, StrEnum): @@ -1648,6 +2188,8 @@ class FooEnum(UnknownEnumMixin, StrEnum): @dataclass(kw_only=True) class GreetingStruct(_SerdeShape): + """Dataclass for GreetingStruct structure.""" + hi: str | None = ... class IntegerEnum(UnknownEnumMixin, IntEnum): @@ -1657,7 +2199,7 @@ class IntegerEnum(UnknownEnumMixin, IntEnum): @dataclass(kw_only=True) class Unit(_SerdeShape): - pass + """Dataclass for Unit structure.""" ALL_QUERY_STRING_TYPES: APIOperation[ AllQueryStringTypesInput, AllQueryStringTypesOutput diff --git a/codegen-output/rest-xml-with-namespace/src/restxmlwithnamespace/models.pyi b/codegen-output/rest-xml-with-namespace/src/restxmlwithnamespace/models.pyi index 9f00cc917..e7861e3f9 100644 --- a/codegen-output/rest-xml-with-namespace/src/restxmlwithnamespace/models.pyi +++ b/codegen-output/rest-xml-with-namespace/src/restxmlwithnamespace/models.pyi @@ -15,14 +15,24 @@ class _SerdeShape: @classmethod def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ... -class ServiceError(ModeledError): ... +class ServiceError(ModeledError): + """ + Base error for all errors in the service. + + Some exceptions do not extend from this class, including + synthetic, implicit, and shared exception types. + """ @dataclass(kw_only=True) class NestedWithNamespace(_SerdeShape): + """Dataclass for NestedWithNamespace structure.""" + attr_field: str | None = ... @dataclass(kw_only=True) class SimpleScalarPropertiesInput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesInput structure.""" + foo: str | None = ... string_value: str | None = ... true_boolean_value: bool | None = ... @@ -37,6 +47,8 @@ class SimpleScalarPropertiesInput(_SerdeShape): @dataclass(kw_only=True) class SimpleScalarPropertiesOutput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesOutput structure.""" + foo: str | None = ... string_value: str | None = ... true_boolean_value: bool | None = ... diff --git a/codegen-output/rest-xml/src/restxml/models.pyi b/codegen-output/rest-xml/src/restxml/models.pyi index 5407b06f5..db29eac50 100644 --- a/codegen-output/rest-xml/src/restxml/models.pyi +++ b/codegen-output/rest-xml/src/restxml/models.pyi @@ -18,10 +18,18 @@ class _SerdeShape: @classmethod def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ... -class ServiceError(ModeledError): ... +class ServiceError(ModeledError): + """ + Base error for all errors in the service. + + Some exceptions do not extend from this class, including + synthetic, implicit, and shared exception types. + """ @dataclass(kw_only=True) class AllQueryStringTypesInput(_SerdeShape): + """Dataclass for AllQueryStringTypesInput structure.""" + query_string: str | None = ... query_string_list: list[str] | None = ... query_string_set: list[str] | None = ... @@ -46,19 +54,27 @@ class AllQueryStringTypesInput(_SerdeShape): @dataclass(kw_only=True) class AllQueryStringTypesOutput(_SerdeShape): + """Dataclass for AllQueryStringTypesOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class BodyWithXmlNameInput(_SerdeShape): + """Dataclass for BodyWithXmlNameInput structure.""" + nested: PayloadWithXmlName | None = ... @dataclass(kw_only=True) class BodyWithXmlNameOutput(_SerdeShape): + """Dataclass for BodyWithXmlNameOutput structure.""" + nested: PayloadWithXmlName | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ComplexError(ServiceError, _SerdeShape): + """This error is thrown when a request is invalid.""" + header: str | None = ... top_level: str | None = ... nested: ComplexNestedErrorData | None = ... @@ -66,246 +82,342 @@ class ComplexError(ServiceError, _SerdeShape): @dataclass(kw_only=True) class ComplexNestedErrorData(_SerdeShape): + """Dataclass for ComplexNestedErrorData structure.""" + foo: str | None = ... @dataclass(kw_only=True) class ConstantAndVariableQueryStringInput(_SerdeShape): + """Dataclass for ConstantAndVariableQueryStringInput structure.""" + baz: str | None = ... maybe_set: str | None = ... @dataclass(kw_only=True) class ConstantAndVariableQueryStringOutput(_SerdeShape): + """Dataclass for ConstantAndVariableQueryStringOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ConstantQueryStringInput(_SerdeShape): + """Dataclass for ConstantQueryStringInput structure.""" + hello: str | None = ... @dataclass(kw_only=True) class ConstantQueryStringOutput(_SerdeShape): + """Dataclass for ConstantQueryStringOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ContentTypeParametersInput(_SerdeShape): + """Dataclass for ContentTypeParametersInput structure.""" + value: int | None = ... @dataclass(kw_only=True) class ContentTypeParametersOutput(_SerdeShape): + """Dataclass for ContentTypeParametersOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class DatetimeOffsetsInput(_SerdeShape): - pass + """Dataclass for DatetimeOffsetsInput structure.""" @dataclass(kw_only=True) class DatetimeOffsetsOutput(_SerdeShape): + """Dataclass for DatetimeOffsetsOutput structure.""" + datetime_: datetime | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EmptyInputAndEmptyOutputInput(_SerdeShape): - pass + """Dataclass for EmptyInputAndEmptyOutputInput structure.""" @dataclass(kw_only=True) class EmptyInputAndEmptyOutputOutput(_SerdeShape): + """Dataclass for EmptyInputAndEmptyOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointOperationInput(_SerdeShape): - pass + """Dataclass for EndpointOperationInput structure.""" @dataclass(kw_only=True) class EndpointOperationOutput(_SerdeShape): + """Dataclass for EndpointOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointWithHostLabelHeaderOperationInput(_SerdeShape): + """Dataclass for EndpointWithHostLabelHeaderOperationInput structure.""" + account_id: str | None = ... @dataclass(kw_only=True) class EndpointWithHostLabelHeaderOperationOutput(_SerdeShape): + """Dataclass for EndpointWithHostLabelHeaderOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationInput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationInput structure.""" + label: str | None = ... @dataclass(kw_only=True) class EndpointWithHostLabelOperationOutput(_SerdeShape): + """Dataclass for EndpointWithHostLabelOperationOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FlattenedXmlMapInput(_SerdeShape): + """Dataclass for FlattenedXmlMapInput structure.""" + my_map: dict[str, str] | None = ... @dataclass(kw_only=True) class FlattenedXmlMapOutput(_SerdeShape): + """Dataclass for FlattenedXmlMapOutput structure.""" + my_map: dict[str, str] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FlattenedXmlMapWithXmlNameInput(_SerdeShape): + """Dataclass for FlattenedXmlMapWithXmlNameInput structure.""" + my_map: dict[str, str] | None = ... @dataclass(kw_only=True) class FlattenedXmlMapWithXmlNameOutput(_SerdeShape): + """Dataclass for FlattenedXmlMapWithXmlNameOutput structure.""" + my_map: dict[str, str] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FlattenedXmlMapWithXmlNamespaceInput(_SerdeShape): - pass + """Dataclass for FlattenedXmlMapWithXmlNamespaceInput structure.""" @dataclass(kw_only=True) class FlattenedXmlMapWithXmlNamespaceOutput(_SerdeShape): + """Dataclass for FlattenedXmlMapWithXmlNamespaceOutput structure.""" + my_map: dict[str, str] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FractionalSecondsInput(_SerdeShape): - pass + """Dataclass for FractionalSecondsInput structure.""" @dataclass(kw_only=True) class FractionalSecondsOutput(_SerdeShape): + """Dataclass for FractionalSecondsOutput structure.""" + datetime_: datetime | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class GreetingWithErrorsInput(_SerdeShape): - pass + """Dataclass for GreetingWithErrorsInput structure.""" @dataclass(kw_only=True) class GreetingWithErrorsOutput(_SerdeShape): + """Dataclass for GreetingWithErrorsOutput structure.""" + greeting: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpEmptyPrefixHeadersInput(_SerdeShape): + """Dataclass for HttpEmptyPrefixHeadersInput structure.""" + prefix_headers: dict[str, str] | None = ... specific_header: str | None = ... @dataclass(kw_only=True) class HttpEmptyPrefixHeadersOutput(_SerdeShape): + """Dataclass for HttpEmptyPrefixHeadersOutput structure.""" + prefix_headers: dict[str, str] | None = ... specific_header: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpEnumPayloadInput(_SerdeShape): + """Dataclass for HttpEnumPayloadInput structure.""" + payload: str | None = ... @dataclass(kw_only=True) class HttpEnumPayloadOutput(_SerdeShape): + """Dataclass for HttpEnumPayloadOutput structure.""" + payload: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadTraitsInput(_SerdeShape): + """Dataclass for HttpPayloadTraitsInput structure.""" + foo: str | None = ... blob: bytes | None = ... @dataclass(kw_only=True) class HttpPayloadTraitsOutput(_SerdeShape): + """Dataclass for HttpPayloadTraitsOutput structure.""" + foo: str | None = ... blob: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadTraitsWithMediaTypeInput(_SerdeShape): + """Dataclass for HttpPayloadTraitsWithMediaTypeInput structure.""" + foo: str | None = ... blob: bytes | None = ... @dataclass(kw_only=True) class HttpPayloadTraitsWithMediaTypeOutput(_SerdeShape): + """Dataclass for HttpPayloadTraitsWithMediaTypeOutput structure.""" + foo: str | None = ... blob: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadWithMemberXmlNameInput(_SerdeShape): + """Dataclass for HttpPayloadWithMemberXmlNameInput structure.""" + nested: PayloadWithXmlName | None = ... @dataclass(kw_only=True) class HttpPayloadWithMemberXmlNameOutput(_SerdeShape): + """Dataclass for HttpPayloadWithMemberXmlNameOutput structure.""" + nested: PayloadWithXmlName | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadWithStructureInput(_SerdeShape): + """Dataclass for HttpPayloadWithStructureInput structure.""" + nested: NestedPayload | None = ... @dataclass(kw_only=True) class HttpPayloadWithStructureOutput(_SerdeShape): + """Dataclass for HttpPayloadWithStructureOutput structure.""" + nested: NestedPayload | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadWithUnionInput(_SerdeShape): + """Dataclass for HttpPayloadWithUnionInput structure.""" + nested: UnionPayload | None = ... @dataclass(kw_only=True) class HttpPayloadWithUnionOutput(_SerdeShape): + """Dataclass for HttpPayloadWithUnionOutput structure.""" + nested: UnionPayload | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadWithXmlNameInput(_SerdeShape): + """Dataclass for HttpPayloadWithXmlNameInput structure.""" + nested: PayloadWithXmlName | None = ... @dataclass(kw_only=True) class HttpPayloadWithXmlNameOutput(_SerdeShape): + """Dataclass for HttpPayloadWithXmlNameOutput structure.""" + nested: PayloadWithXmlName | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadWithXmlNamespaceAndPrefixInput(_SerdeShape): + """Dataclass for HttpPayloadWithXmlNamespaceAndPrefixInput structure.""" + nested: PayloadWithXmlNamespaceAndPrefix | None = ... @dataclass(kw_only=True) class HttpPayloadWithXmlNamespaceAndPrefixOutput(_SerdeShape): + """Dataclass for HttpPayloadWithXmlNamespaceAndPrefixOutput structure.""" + nested: PayloadWithXmlNamespaceAndPrefix | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPayloadWithXmlNamespaceInput(_SerdeShape): + """Dataclass for HttpPayloadWithXmlNamespaceInput structure.""" + nested: PayloadWithXmlNamespace | None = ... @dataclass(kw_only=True) class HttpPayloadWithXmlNamespaceOutput(_SerdeShape): + """Dataclass for HttpPayloadWithXmlNamespaceOutput structure.""" + nested: PayloadWithXmlNamespace | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpPrefixHeadersInput(_SerdeShape): + """Dataclass for HttpPrefixHeadersInput structure.""" + foo: str | None = ... foo_map: dict[str, str] | None = ... @dataclass(kw_only=True) class HttpPrefixHeadersOutput(_SerdeShape): + """Dataclass for HttpPrefixHeadersOutput structure.""" + foo: str | None = ... foo_map: dict[str, str] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpRequestWithFloatLabelsInput(_SerdeShape): + """Dataclass for HttpRequestWithFloatLabelsInput structure.""" + float_: float | None = ... double: float | None = ... @dataclass(kw_only=True) class HttpRequestWithFloatLabelsOutput(_SerdeShape): + """Dataclass for HttpRequestWithFloatLabelsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpRequestWithGreedyLabelInPathInput(_SerdeShape): + """Dataclass for HttpRequestWithGreedyLabelInPathInput structure.""" + foo: str | None = ... baz: str | None = ... @dataclass(kw_only=True) class HttpRequestWithGreedyLabelInPathOutput(_SerdeShape): + """Dataclass for HttpRequestWithGreedyLabelInPathOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpRequestWithLabelsAndTimestampFormatInput(_SerdeShape): + """Dataclass for HttpRequestWithLabelsAndTimestampFormatInput structure.""" + member_epoch_seconds: datetime | None = ... member_http_date: datetime | None = ... member_date_time: datetime | None = ... @@ -316,10 +428,14 @@ class HttpRequestWithLabelsAndTimestampFormatInput(_SerdeShape): @dataclass(kw_only=True) class HttpRequestWithLabelsAndTimestampFormatOutput(_SerdeShape): + """Dataclass for HttpRequestWithLabelsAndTimestampFormatOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpRequestWithLabelsInput(_SerdeShape): + """Dataclass for HttpRequestWithLabelsInput structure.""" + string: str | None = ... short: int | None = ... integer: int | None = ... @@ -327,41 +443,58 @@ class HttpRequestWithLabelsInput(_SerdeShape): float_: float | None = ... double: float | None = ... boolean: bool | None = ... + """Serialized in the path as true or false.""" timestamp: datetime | None = ... + """ + Note that this member has no format, so it's serialized as an RFC 3399 + date-time. + """ @dataclass(kw_only=True) class HttpRequestWithLabelsOutput(_SerdeShape): + """Dataclass for HttpRequestWithLabelsOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpResponseCodeInput(_SerdeShape): - pass + """Dataclass for HttpResponseCodeInput structure.""" @dataclass(kw_only=True) class HttpResponseCodeOutput(_SerdeShape): + """Dataclass for HttpResponseCodeOutput structure.""" + status: int | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class HttpStringPayloadInput(_SerdeShape): + """Dataclass for HttpStringPayloadInput structure.""" + payload: str | None = ... @dataclass(kw_only=True) class HttpStringPayloadOutput(_SerdeShape): + """Dataclass for HttpStringPayloadOutput structure.""" + payload: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class IgnoreQueryParamsInResponseInput(_SerdeShape): - pass + """Dataclass for IgnoreQueryParamsInResponseInput structure.""" @dataclass(kw_only=True) class IgnoreQueryParamsInResponseOutput(_SerdeShape): + """Dataclass for IgnoreQueryParamsInResponseOutput structure.""" + baz: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class InputAndOutputWithHeadersInput(_SerdeShape): + """Dataclass for InputAndOutputWithHeadersInput structure.""" + header_string: str | None = ... header_byte: int | None = ... header_short: int | None = ... @@ -381,6 +514,8 @@ class InputAndOutputWithHeadersInput(_SerdeShape): @dataclass(kw_only=True) class InputAndOutputWithHeadersOutput(_SerdeShape): + """Dataclass for InputAndOutputWithHeadersOutput structure.""" + header_string: str | None = ... header_byte: int | None = ... header_short: int | None = ... @@ -401,57 +536,77 @@ class InputAndOutputWithHeadersOutput(_SerdeShape): @dataclass(kw_only=True) class InvalidGreeting(ServiceError, _SerdeShape): + """This error is thrown when an invalid greeting value is provided.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NestedPayload(_SerdeShape): + """Dataclass for NestedPayload structure.""" + greeting: str | None = ... name: str | None = ... @dataclass(kw_only=True) class NestedXmlMapsInput(_SerdeShape): + """Dataclass for NestedXmlMapsInput structure.""" + nested_map: dict[str, dict[str, str]] | None = ... flat_nested_map: dict[str, dict[str, str]] | None = ... @dataclass(kw_only=True) class NestedXmlMapsOutput(_SerdeShape): + """Dataclass for NestedXmlMapsOutput structure.""" + nested_map: dict[str, dict[str, str]] | None = ... flat_nested_map: dict[str, dict[str, str]] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NestedXmlMapWithXmlNameInput(_SerdeShape): + """Dataclass for NestedXmlMapWithXmlNameInput structure.""" + nested_xml_map_with_xml_name_map: dict[str, dict[str, str]] | None = ... @dataclass(kw_only=True) class NestedXmlMapWithXmlNameOutput(_SerdeShape): + """Dataclass for NestedXmlMapWithXmlNameOutput structure.""" + nested_xml_map_with_xml_name_map: dict[str, dict[str, str]] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NoInputAndNoOutputInput(_SerdeShape): - pass + """Dataclass for NoInputAndNoOutputInput structure.""" @dataclass(kw_only=True) class NoInputAndNoOutputOutput(_SerdeShape): + """Dataclass for NoInputAndNoOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NoInputAndOutputInput(_SerdeShape): - pass + """Dataclass for NoInputAndOutputInput structure.""" @dataclass(kw_only=True) class NoInputAndOutputOutput(_SerdeShape): + """Dataclass for NoInputAndOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NullAndEmptyHeadersClientInput(_SerdeShape): + """Dataclass for NullAndEmptyHeadersClientInput structure.""" + a: str | None = ... b: str | None = ... c: list[str] | None = ... @dataclass(kw_only=True) class NullAndEmptyHeadersClientOutput(_SerdeShape): + """Dataclass for NullAndEmptyHeadersClientOutput structure.""" + a: str | None = ... b: str | None = ... c: list[str] | None = ... @@ -459,12 +614,16 @@ class NullAndEmptyHeadersClientOutput(_SerdeShape): @dataclass(kw_only=True) class NullAndEmptyHeadersServerInput(_SerdeShape): + """Dataclass for NullAndEmptyHeadersServerInput structure.""" + a: str | None = ... b: str | None = ... c: list[str] | None = ... @dataclass(kw_only=True) class NullAndEmptyHeadersServerOutput(_SerdeShape): + """Dataclass for NullAndEmptyHeadersServerOutput structure.""" + a: str | None = ... b: str | None = ... c: list[str] | None = ... @@ -472,81 +631,117 @@ class NullAndEmptyHeadersServerOutput(_SerdeShape): @dataclass(kw_only=True) class OmitsNullSerializesEmptyStringInput(_SerdeShape): + """Dataclass for OmitsNullSerializesEmptyStringInput structure.""" + null_value: str | None = ... empty_string: str | None = ... @dataclass(kw_only=True) class OmitsNullSerializesEmptyStringOutput(_SerdeShape): + """Dataclass for OmitsNullSerializesEmptyStringOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class PayloadWithXmlName(_SerdeShape): + """Dataclass for PayloadWithXmlName structure.""" + name: str | None = ... @dataclass(kw_only=True) class PayloadWithXmlNamespace(_SerdeShape): + """Dataclass for PayloadWithXmlNamespace structure.""" + name: str | None = ... @dataclass(kw_only=True) class PayloadWithXmlNamespaceAndPrefix(_SerdeShape): + """Dataclass for PayloadWithXmlNamespaceAndPrefix structure.""" + name: str | None = ... @dataclass(kw_only=True) class PutWithContentEncodingInput(_SerdeShape): + """Dataclass for PutWithContentEncodingInput structure.""" + encoding: str | None = ... data: str | None = ... @dataclass(kw_only=True) class PutWithContentEncodingOutput(_SerdeShape): + """Dataclass for PutWithContentEncodingOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryIdempotencyTokenAutoFillInput(_SerdeShape): + """Dataclass for QueryIdempotencyTokenAutoFillInput structure.""" + token: str | None = ... @dataclass(kw_only=True) class QueryIdempotencyTokenAutoFillOutput(_SerdeShape): + """Dataclass for QueryIdempotencyTokenAutoFillOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryParamsAsStringListMapInput(_SerdeShape): + """Dataclass for QueryParamsAsStringListMapInput structure.""" + qux: str | None = ... foo: dict[str, list[str]] | None = ... @dataclass(kw_only=True) class QueryParamsAsStringListMapOutput(_SerdeShape): + """Dataclass for QueryParamsAsStringListMapOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class QueryPrecedenceInput(_SerdeShape): + """Dataclass for QueryPrecedenceInput structure.""" + foo: str | None = ... baz: dict[str, str] | None = ... @dataclass(kw_only=True) class QueryPrecedenceOutput(_SerdeShape): + """Dataclass for QueryPrecedenceOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class RecursiveShapesInput(_SerdeShape): + """Dataclass for RecursiveShapesInput structure.""" + nested: RecursiveShapesInputOutputNested1 | None = ... @dataclass(kw_only=True) class RecursiveShapesInputOutputNested1(_SerdeShape): + """Dataclass for RecursiveShapesInputOutputNested1 structure.""" + foo: str | None = ... nested: RecursiveShapesInputOutputNested2 | None = ... @dataclass(kw_only=True) class RecursiveShapesInputOutputNested2(_SerdeShape): + """Dataclass for RecursiveShapesInputOutputNested2 structure.""" + bar: str | None = ... recursive_member: RecursiveShapesInputOutputNested1 | None = ... @dataclass(kw_only=True) class RecursiveShapesOutput(_SerdeShape): + """Dataclass for RecursiveShapesOutput structure.""" + nested: RecursiveShapesInputOutputNested1 | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class SimpleScalarPropertiesInput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesInput structure.""" + foo: str | None = ... string_value: str | None = ... true_boolean_value: bool | None = ... @@ -560,6 +755,8 @@ class SimpleScalarPropertiesInput(_SerdeShape): @dataclass(kw_only=True) class SimpleScalarPropertiesOutput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesOutput structure.""" + foo: str | None = ... string_value: str | None = ... true_boolean_value: bool | None = ... @@ -577,11 +774,15 @@ class StringEnum(UnknownEnumMixin, StrEnum): @dataclass(kw_only=True) class StructureListMember(_SerdeShape): + """Dataclass for StructureListMember structure.""" + a: str | None = ... b: str | None = ... @dataclass(kw_only=True) class TimestampFormatHeadersInput(_SerdeShape): + """Dataclass for TimestampFormatHeadersInput structure.""" + member_epoch_seconds: datetime | None = ... member_http_date: datetime | None = ... member_date_time: datetime | None = ... @@ -592,6 +793,8 @@ class TimestampFormatHeadersInput(_SerdeShape): @dataclass(kw_only=True) class TimestampFormatHeadersOutput(_SerdeShape): + """Dataclass for TimestampFormatHeadersOutput structure.""" + member_epoch_seconds: datetime | None = ... member_http_date: datetime | None = ... member_date_time: datetime | None = ... @@ -607,6 +810,12 @@ class UnionPayloadGreeting(_SerdeShape): @dataclass class UnionPayloadUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str UnionPayload = Union[UnionPayloadGreeting | UnionPayloadUnknown] @@ -616,75 +825,105 @@ class _UnionPayloadDeserializer: @dataclass(kw_only=True) class XmlAttributesInMiddleInput(_SerdeShape): + """Dataclass for XmlAttributesInMiddleInput structure.""" + payload: XmlAttributesInMiddlePayloadRequest | None = ... @dataclass(kw_only=True) class XmlAttributesInMiddleOutput(_SerdeShape): + """Dataclass for XmlAttributesInMiddleOutput structure.""" + payload: XmlAttributesInMiddlePayloadResponse | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlAttributesInMiddlePayloadRequest(_SerdeShape): + """Dataclass for XmlAttributesInMiddlePayloadRequest structure.""" + foo: str | None = ... attr: str | None = ... baz: str | None = ... @dataclass(kw_only=True) class XmlAttributesInMiddlePayloadResponse(_SerdeShape): + """Dataclass for XmlAttributesInMiddlePayloadResponse structure.""" + foo: str | None = ... attr: str | None = ... baz: str | None = ... @dataclass(kw_only=True) class XmlAttributesInput(_SerdeShape): + """Dataclass for XmlAttributesInput structure.""" + foo: str | None = ... attr: str | None = ... @dataclass(kw_only=True) class XmlAttributesOnPayloadInput(_SerdeShape): + """Dataclass for XmlAttributesOnPayloadInput structure.""" + payload: XmlAttributesPayloadRequest | None = ... @dataclass(kw_only=True) class XmlAttributesOnPayloadOutput(_SerdeShape): + """Dataclass for XmlAttributesOnPayloadOutput structure.""" + payload: XmlAttributesPayloadResponse | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlAttributesOutput(_SerdeShape): + """Dataclass for XmlAttributesOutput structure.""" + foo: str | None = ... attr: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlAttributesPayloadRequest(_SerdeShape): + """Dataclass for XmlAttributesPayloadRequest structure.""" + foo: str | None = ... attr: str | None = ... @dataclass(kw_only=True) class XmlAttributesPayloadResponse(_SerdeShape): + """Dataclass for XmlAttributesPayloadResponse structure.""" + foo: str | None = ... attr: str | None = ... @dataclass(kw_only=True) class XmlBlobsInput(_SerdeShape): + """Dataclass for XmlBlobsInput structure.""" + data: bytes | None = ... @dataclass(kw_only=True) class XmlBlobsOutput(_SerdeShape): + """Dataclass for XmlBlobsOutput structure.""" + data: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlEmptyBlobsInput(_SerdeShape): + """Dataclass for XmlEmptyBlobsInput structure.""" + data: bytes | None = ... @dataclass(kw_only=True) class XmlEmptyBlobsOutput(_SerdeShape): + """Dataclass for XmlEmptyBlobsOutput structure.""" + data: bytes | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlEmptyListsInput(_SerdeShape): + """Dataclass for XmlEmptyListsInput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -693,6 +932,7 @@ class XmlEmptyListsInput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" renamed_list_members: list[str] | None = ... flattened_list: list[str] | None = ... flattened_list2: list[str] | None = ... @@ -703,6 +943,8 @@ class XmlEmptyListsInput(_SerdeShape): @dataclass(kw_only=True) class XmlEmptyListsOutput(_SerdeShape): + """Dataclass for XmlEmptyListsOutput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -711,6 +953,7 @@ class XmlEmptyListsOutput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" renamed_list_members: list[str] | None = ... flattened_list: list[str] | None = ... flattened_list2: list[str] | None = ... @@ -722,24 +965,34 @@ class XmlEmptyListsOutput(_SerdeShape): @dataclass(kw_only=True) class XmlEmptyMapsInput(_SerdeShape): + """Dataclass for XmlEmptyMapsInput structure.""" + my_map: dict[str, GreetingStruct] | None = ... @dataclass(kw_only=True) class XmlEmptyMapsOutput(_SerdeShape): + """Dataclass for XmlEmptyMapsOutput structure.""" + my_map: dict[str, GreetingStruct] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlEmptyStringsInput(_SerdeShape): + """Dataclass for XmlEmptyStringsInput structure.""" + empty_string: str | None = ... @dataclass(kw_only=True) class XmlEmptyStringsOutput(_SerdeShape): + """Dataclass for XmlEmptyStringsOutput structure.""" + empty_string: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlEnumsInput(_SerdeShape): + """Dataclass for XmlEnumsInput structure.""" + foo_enum1: str | None = ... foo_enum2: str | None = ... foo_enum3: str | None = ... @@ -749,6 +1002,8 @@ class XmlEnumsInput(_SerdeShape): @dataclass(kw_only=True) class XmlEnumsOutput(_SerdeShape): + """Dataclass for XmlEnumsOutput structure.""" + foo_enum1: str | None = ... foo_enum2: str | None = ... foo_enum3: str | None = ... @@ -759,6 +1014,8 @@ class XmlEnumsOutput(_SerdeShape): @dataclass(kw_only=True) class XmlIntEnumsInput(_SerdeShape): + """Dataclass for XmlIntEnumsInput structure.""" + int_enum1: int | None = ... int_enum2: int | None = ... int_enum3: int | None = ... @@ -768,6 +1025,8 @@ class XmlIntEnumsInput(_SerdeShape): @dataclass(kw_only=True) class XmlIntEnumsOutput(_SerdeShape): + """Dataclass for XmlIntEnumsOutput structure.""" + int_enum1: int | None = ... int_enum2: int | None = ... int_enum3: int | None = ... @@ -778,6 +1037,8 @@ class XmlIntEnumsOutput(_SerdeShape): @dataclass(kw_only=True) class XmlListsInput(_SerdeShape): + """Dataclass for XmlListsInput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -786,6 +1047,7 @@ class XmlListsInput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" renamed_list_members: list[str] | None = ... flattened_list: list[str] | None = ... flattened_list2: list[str] | None = ... @@ -796,6 +1058,8 @@ class XmlListsInput(_SerdeShape): @dataclass(kw_only=True) class XmlListsOutput(_SerdeShape): + """Dataclass for XmlListsOutput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -804,6 +1068,7 @@ class XmlListsOutput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" renamed_list_members: list[str] | None = ... flattened_list: list[str] | None = ... flattened_list2: list[str] | None = ... @@ -815,47 +1080,67 @@ class XmlListsOutput(_SerdeShape): @dataclass(kw_only=True) class XmlMapsInput(_SerdeShape): + """Dataclass for XmlMapsInput structure.""" + my_map: dict[str, GreetingStruct] | None = ... @dataclass(kw_only=True) class XmlMapsOutput(_SerdeShape): + """Dataclass for XmlMapsOutput structure.""" + my_map: dict[str, GreetingStruct] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlMapsXmlNameInput(_SerdeShape): + """Dataclass for XmlMapsXmlNameInput structure.""" + my_map: dict[str, GreetingStruct] | None = ... @dataclass(kw_only=True) class XmlMapsXmlNameOutput(_SerdeShape): + """Dataclass for XmlMapsXmlNameOutput structure.""" + my_map: dict[str, GreetingStruct] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlMapWithXmlNamespaceInput(_SerdeShape): + """Dataclass for XmlMapWithXmlNamespaceInput structure.""" + my_map: dict[str, str] | None = ... @dataclass(kw_only=True) class XmlMapWithXmlNamespaceOutput(_SerdeShape): + """Dataclass for XmlMapWithXmlNamespaceOutput structure.""" + my_map: dict[str, str] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlNamespaceNested(_SerdeShape): + """Dataclass for XmlNamespaceNested structure.""" + foo: str | None = ... values: list[str] | None = ... @dataclass(kw_only=True) class XmlNamespacesInput(_SerdeShape): + """Dataclass for XmlNamespacesInput structure.""" + nested: XmlNamespaceNested | None = ... @dataclass(kw_only=True) class XmlNamespacesOutput(_SerdeShape): + """Dataclass for XmlNamespacesOutput structure.""" + nested: XmlNamespaceNested | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class XmlNestedUnionStruct(_SerdeShape): + """Dataclass for XmlNestedUnionStruct structure.""" + string_value: str | None = ... boolean_value: bool | None = ... byte_value: int | None = ... @@ -867,6 +1152,8 @@ class XmlNestedUnionStruct(_SerdeShape): @dataclass(kw_only=True) class XmlTimestampsInput(_SerdeShape): + """Dataclass for XmlTimestampsInput structure.""" + normal: datetime | None = ... date_time: datetime | None = ... date_time_on_target: datetime | None = ... @@ -877,6 +1164,8 @@ class XmlTimestampsInput(_SerdeShape): @dataclass(kw_only=True) class XmlTimestampsOutput(_SerdeShape): + """Dataclass for XmlTimestampsOutput structure.""" + normal: datetime | None = ... date_time: datetime | None = ... date_time_on_target: datetime | None = ... @@ -928,6 +1217,12 @@ class XmlUnionShapeStructValue(_SerdeShape): @dataclass class XmlUnionShapeUnknown(_SerdeShape): + """ + Represents an unknown variant. If you receive this value, you will need + to update your library to receive the parsed value. This value may not + be deliberately sent. + """ + tag: str XmlUnionShape = Union[ @@ -949,10 +1244,14 @@ class _XmlUnionShapeDeserializer: @dataclass(kw_only=True) class XmlUnionsInput(_SerdeShape): + """Dataclass for XmlUnionsInput structure.""" + union_value: XmlUnionShape | None = ... @dataclass(kw_only=True) class XmlUnionsOutput(_SerdeShape): + """Dataclass for XmlUnionsOutput structure.""" + union_value: XmlUnionShape | None = ... response_metadata: ResponseMetadata = ... @@ -965,6 +1264,8 @@ class FooEnum(UnknownEnumMixin, StrEnum): @dataclass(kw_only=True) class GreetingStruct(_SerdeShape): + """Dataclass for GreetingStruct structure.""" + hi: str | None = ... class IntegerEnum(UnknownEnumMixin, IntEnum): diff --git a/codegen-output/rpcv2-cbor/src/rpcv2cbor/models.pyi b/codegen-output/rpcv2-cbor/src/rpcv2cbor/models.pyi index 434d4c79f..0ea2989d1 100644 --- a/codegen-output/rpcv2-cbor/src/rpcv2cbor/models.pyi +++ b/codegen-output/rpcv2-cbor/src/rpcv2cbor/models.pyi @@ -18,34 +18,66 @@ class _SerdeShape: @classmethod def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ... -class ServiceError(ModeledError): ... +class ServiceError(ModeledError): + """ + Base error for all errors in the service. + + Some exceptions do not extend from this class, including + synthetic, implicit, and shared exception types. + """ @dataclass(kw_only=True) class ValidationException(ServiceError, _SerdeShape): + """ + A standard error for input validation failures. This should be thrown by + services when a member of the input structure falls outside of the + modeled or documented constraints. + """ + field_list: list[ValidationExceptionField] | None = ... + """ + A list of specific failures encountered while validating the input. A + member can appear in this list more than once if it failed to satisfy + multiple constraints. + """ response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ValidationExceptionField(_SerdeShape): + """Describes one specific validation failure for an input member.""" + path: str + """ + A JSONPointer expression to the structure member whose value failed to + satisfy the modeled constraints. + """ message: str + """A detailed description of the validation failure.""" @dataclass(kw_only=True) class ClientOptionalDefaults(_SerdeShape): + """Dataclass for ClientOptionalDefaults structure.""" + member: int | None = ... @dataclass(kw_only=True) class ComplexError(ServiceError, _SerdeShape): + """This error is thrown when a request is invalid.""" + top_level: str | None = ... nested: ComplexNestedErrorData | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class ComplexNestedErrorData(_SerdeShape): + """Dataclass for ComplexNestedErrorData structure.""" + foo: str | None = ... @dataclass(kw_only=True) class Defaults(_SerdeShape): + """Dataclass for Defaults structure.""" + default_string: str | None = ... default_boolean: bool | None = ... default_list: list[str] | None = ... @@ -72,53 +104,67 @@ class Defaults(_SerdeShape): @dataclass(kw_only=True) class EmptyInputOutputInput(_SerdeShape): - pass + """Dataclass for EmptyInputOutputInput structure.""" @dataclass(kw_only=True) class EmptyInputOutputOutput(_SerdeShape): + """Dataclass for EmptyInputOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class Float16Input(_SerdeShape): - pass + """Dataclass for Float16Input structure.""" @dataclass(kw_only=True) class Float16Output(_SerdeShape): + """Dataclass for Float16Output structure.""" + value: float | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class FractionalSecondsInput(_SerdeShape): - pass + """Dataclass for FractionalSecondsInput structure.""" @dataclass(kw_only=True) class FractionalSecondsOutput(_SerdeShape): + """Dataclass for FractionalSecondsOutput structure.""" + datetime_: datetime | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class GreetingWithErrorsInput(_SerdeShape): - pass + """Dataclass for GreetingWithErrorsInput structure.""" @dataclass(kw_only=True) class GreetingWithErrorsOutput(_SerdeShape): + """Dataclass for GreetingWithErrorsOutput structure.""" + greeting: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class InvalidGreeting(ServiceError, _SerdeShape): + """This error is thrown when an invalid greeting value is provided.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class NoInputOutputInput(_SerdeShape): - pass + """Dataclass for NoInputOutputInput structure.""" @dataclass(kw_only=True) class NoInputOutputOutput(_SerdeShape): + """Dataclass for NoInputOutputOutput structure.""" + response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class OperationWithDefaultsInput(_SerdeShape): + """Dataclass for OperationWithDefaultsInput structure.""" + defaults: Defaults | None = ... client_optional_defaults: ClientOptionalDefaults | None = ... top_level_default: str | None = ... @@ -126,6 +172,8 @@ class OperationWithDefaultsInput(_SerdeShape): @dataclass(kw_only=True) class OperationWithDefaultsOutput(_SerdeShape): + """Dataclass for OperationWithDefaultsOutput structure.""" + default_string: str | None = ... default_boolean: bool | None = ... default_list: list[str] | None = ... @@ -153,34 +201,48 @@ class OperationWithDefaultsOutput(_SerdeShape): @dataclass(kw_only=True) class OptionalInputOutputInput(_SerdeShape): + """Dataclass for OptionalInputOutputInput structure.""" + value: str | None = ... @dataclass(kw_only=True) class OptionalInputOutputOutput(_SerdeShape): + """Dataclass for OptionalInputOutputOutput structure.""" + value: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class RecursiveShapesInput(_SerdeShape): + """Dataclass for RecursiveShapesInput structure.""" + nested: RecursiveShapesInputOutputNested1 | None = ... @dataclass(kw_only=True) class RecursiveShapesInputOutputNested1(_SerdeShape): + """Dataclass for RecursiveShapesInputOutputNested1 structure.""" + foo: str | None = ... nested: RecursiveShapesInputOutputNested2 | None = ... @dataclass(kw_only=True) class RecursiveShapesInputOutputNested2(_SerdeShape): + """Dataclass for RecursiveShapesInputOutputNested2 structure.""" + bar: str | None = ... recursive_member: RecursiveShapesInputOutputNested1 | None = ... @dataclass(kw_only=True) class RecursiveShapesOutput(_SerdeShape): + """Dataclass for RecursiveShapesOutput structure.""" + nested: RecursiveShapesInputOutputNested1 | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class RpcV2CborDenseMapsInput(_SerdeShape): + """Dataclass for RpcV2CborDenseMapsInput structure.""" + dense_struct_map: dict[str, GreetingStruct] | None = ... dense_number_map: dict[str, int] | None = ... dense_boolean_map: dict[str, bool] | None = ... @@ -189,6 +251,8 @@ class RpcV2CborDenseMapsInput(_SerdeShape): @dataclass(kw_only=True) class RpcV2CborDenseMapsOutput(_SerdeShape): + """Dataclass for RpcV2CborDenseMapsOutput structure.""" + dense_struct_map: dict[str, GreetingStruct] | None = ... dense_number_map: dict[str, int] | None = ... dense_boolean_map: dict[str, bool] | None = ... @@ -198,6 +262,8 @@ class RpcV2CborDenseMapsOutput(_SerdeShape): @dataclass(kw_only=True) class RpcV2CborListsInput(_SerdeShape): + """Dataclass for RpcV2CborListsInput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -206,11 +272,14 @@ class RpcV2CborListsInput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" structure_list: list[StructureListMember] | None = ... blob_list: list[bytes] | None = ... @dataclass(kw_only=True) class RpcV2CborListsOutput(_SerdeShape): + """Dataclass for RpcV2CborListsOutput structure.""" + string_list: list[str] | None = ... string_set: list[str] | None = ... integer_list: list[int] | None = ... @@ -219,6 +288,7 @@ class RpcV2CborListsOutput(_SerdeShape): enum_list: list[str] | None = ... int_enum_list: list[int] | None = ... nested_string_list: list[list[str]] | None = ... + """A list of lists of strings.""" structure_list: list[StructureListMember] | None = ... blob_list: list[bytes] | None = ... response_metadata: ResponseMetadata = ... @@ -229,6 +299,15 @@ class RpcV2CborNestedUnionStringValue(_SerdeShape): @dataclass class RpcV2CborNestedUnionUnknown(_SerdeShape): + """ + Represents an unknown variant. + + If you receive this value, you will need to update your library to + receive the parsed value. + + This value may not be deliberately sent. + """ + tag: str RpcV2CborNestedUnion = Union[ @@ -240,6 +319,8 @@ class _RpcV2CborNestedUnionDeserializer: @dataclass(kw_only=True) class RpcV2CborSparseMapsInput(_SerdeShape): + """Dataclass for RpcV2CborSparseMapsInput structure.""" + sparse_struct_map: dict[str, GreetingStruct | None] | None = ... sparse_number_map: dict[str, int | None] | None = ... sparse_boolean_map: dict[str, bool | None] | None = ... @@ -248,6 +329,8 @@ class RpcV2CborSparseMapsInput(_SerdeShape): @dataclass(kw_only=True) class RpcV2CborSparseMapsOutput(_SerdeShape): + """Dataclass for RpcV2CborSparseMapsOutput structure.""" + sparse_struct_map: dict[str, GreetingStruct | None] | None = ... sparse_number_map: dict[str, int | None] | None = ... sparse_boolean_map: dict[str, bool | None] | None = ... @@ -265,6 +348,15 @@ class RpcV2CborUnionUnionValue(_SerdeShape): @dataclass class RpcV2CborUnionUnknown(_SerdeShape): + """ + Represents an unknown variant. + + If you receive this value, you will need to update your library to + receive the parsed value. + + This value may not be deliberately sent. + """ + tag: str RpcV2CborUnion = Union[ @@ -276,17 +368,23 @@ class _RpcV2CborUnionDeserializer: @dataclass(kw_only=True) class RpcV2CborUnionsInput(_SerdeShape): + """Dataclass for RpcV2CborUnionsInput structure.""" + contents: RpcV2CborUnion | None = ... other_value: str | None = ... @dataclass(kw_only=True) class RpcV2CborUnionsOutput(_SerdeShape): + """Dataclass for RpcV2CborUnionsOutput structure.""" + contents: RpcV2CborUnion | None = ... other_value: str | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class SimpleScalarPropertiesInput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesInput structure.""" + true_boolean_value: bool | None = ... false_boolean_value: bool | None = ... byte_value: int | None = ... @@ -300,6 +398,8 @@ class SimpleScalarPropertiesInput(_SerdeShape): @dataclass(kw_only=True) class SimpleScalarPropertiesOutput(_SerdeShape): + """Dataclass for SimpleScalarPropertiesOutput structure.""" + true_boolean_value: bool | None = ... false_boolean_value: bool | None = ... byte_value: int | None = ... @@ -314,17 +414,23 @@ class SimpleScalarPropertiesOutput(_SerdeShape): @dataclass(kw_only=True) class SparseNullsOperationInput(_SerdeShape): + """Dataclass for SparseNullsOperationInput structure.""" + sparse_string_list: list[str | None] | None = ... sparse_string_map: dict[str, str | None] | None = ... @dataclass(kw_only=True) class SparseNullsOperationOutput(_SerdeShape): + """Dataclass for SparseNullsOperationOutput structure.""" + sparse_string_list: list[str | None] | None = ... sparse_string_map: dict[str, str | None] | None = ... response_metadata: ResponseMetadata = ... @dataclass(kw_only=True) class StructureListMember(_SerdeShape): + """Dataclass for StructureListMember structure.""" + a: str | None = ... b: str | None = ... @@ -346,6 +452,8 @@ class FooEnum(UnknownEnumMixin, StrEnum): @dataclass(kw_only=True) class GreetingStruct(_SerdeShape): + """Dataclass for GreetingStruct structure.""" + hi: str | None = ... class IntegerEnum(UnknownEnumMixin, IntEnum): diff --git a/codegen/core/src/main/java/software/amazon/smithy/python/codegen/generators/ModelStubGenerator.java b/codegen/core/src/main/java/software/amazon/smithy/python/codegen/generators/ModelStubGenerator.java index 90486e97d..c40cae1c5 100644 --- a/codegen/core/src/main/java/software/amazon/smithy/python/codegen/generators/ModelStubGenerator.java +++ b/codegen/core/src/main/java/software/amazon/smithy/python/codegen/generators/ModelStubGenerator.java @@ -16,6 +16,7 @@ import software.amazon.smithy.model.shapes.Shape; import software.amazon.smithy.model.shapes.StructureShape; import software.amazon.smithy.model.shapes.UnionShape; +import software.amazon.smithy.model.traits.DocumentationTrait; import software.amazon.smithy.model.traits.EnumValueTrait; import software.amazon.smithy.model.traits.ErrorTrait; import software.amazon.smithy.python.codegen.CodegenUtils; @@ -75,7 +76,12 @@ def serialize_members(self, serializer: ShapeSerializer) -> None: ... def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ... class ServiceError(ModeledError): - ... + \""" + Base error for all errors in the service. + + Some exceptions do not extend from this class, including + synthetic, implicit, and shared exception types. + \""" """); for (var shape : shapes) { @@ -106,12 +112,12 @@ private void writeStruct(PythonWriter writer, StructureShape shape) { : "(_SerdeShape)"; var index = NullableIndex.of(model); writer.openBlock("@dataclass(kw_only=True)\nclass $L$L:", "", name, base, () -> { + writeShapeDocs(writer, shape, "Dataclass for " + shape.getId().getName() + " structure."); var members = shape.members() .stream() .filter(m -> !CodegenUtils.isErrorMessage(model, m)) .toList(); if (members.isEmpty() && !carriesResponseMetadata(shape)) { - writer.write("pass"); return; } for (var member : members) { @@ -123,6 +129,7 @@ private void writeStruct(PythonWriter writer, StructureShape shape) { } else { writer.write("$L: $T | None = ...", memberName, memberTypeSymbol(member)); } + writeMemberDocs(writer, member); } if (carriesResponseMetadata(shape)) { writer.write("response_metadata: $T = ...", RuntimeTypes.RESPONSE_METADATA); @@ -131,6 +138,20 @@ private void writeStruct(PythonWriter writer, StructureShape shape) { writer.write(""); } + // The runtime attaches the DocumentationTrait text at build time; the stub is the + // only surface IDEs/pyright read, so docstrings must be emitted here too. + private void writeShapeDocs(PythonWriter writer, Shape shape, String fallback) { + var docs = shape.getTrait(DocumentationTrait.class) + .map(DocumentationTrait::getValue) + .orElse(fallback); + writer.writeDocs(docs, context); + } + + private void writeMemberDocs(PythonWriter writer, MemberShape member) { + member.getMemberTrait(model, DocumentationTrait.class) + .ifPresent(trait -> writer.writeDocs(trait.getValue(), context)); + } + private boolean carriesResponseMetadata(Shape shape) { return shape.hasTrait(ErrorTrait.class) || OperationIndex.of(model).isOutputStructure(shape); } @@ -150,7 +171,10 @@ private void writeUnion(PythonWriter writer, UnionShape shape) { "@dataclass\nclass $L(_SerdeShape):", "", variantName, - () -> writer.write("value: $T", valueTypeSymbol(target))); + () -> { + writeMemberDocs(writer, member); + writer.write("value: $T", valueTypeSymbol(target)); + }); writer.write(""); } var unknownSymbol = parentSymbol.expectProperty(SymbolProperties.UNION_UNKNOWN); @@ -160,10 +184,21 @@ private void writeUnion(PythonWriter writer, UnionShape shape) { "@dataclass\nclass $L(_SerdeShape):", "", unknownName, - () -> writer.write("tag: str")); + () -> { + writer.writeDocs(""" + Represents an unknown variant. + + If you receive this value, you will need to update your library to receive the \ + parsed value. + + This value may not be deliberately sent.""", context); + writer.write("tag: str"); + }); writer.write(""); variantNames.add(unknownName); writer.write("$L = Union[$L]", parentName, String.join(" | ", variantNames)); + shape.getTrait(DocumentationTrait.class) + .ifPresent(trait -> writer.writeDocs(trait.getValue(), context)); writer.write(""); // The runtime builds a `_Deserializer().deserialize(d)` helper for event- // stream unions; declare it so client.py's event-stream wiring type-checks. @@ -198,10 +233,13 @@ private void writeEnum(PythonWriter writer, EnumShape shape) { writer.addLocallyDefinedSymbol(enumSymbol); writer.addStdlibImport("enum", "StrEnum"); writer.openBlock("class $L($T, StrEnum):", "", name, RuntimeTypes.UNKNOWN_ENUM_MIXIN, () -> { + shape.getTrait(DocumentationTrait.class) + .ifPresent(trait -> writer.writeDocs(trait.getValue(), context)); for (var member : shape.members()) { var memberName = symbolProvider.toMemberName(member); var value = member.expectTrait(EnumValueTrait.class).expectStringValue(); writer.write("$L = $S", memberName, value); + writeMemberDocs(writer, member); } }); writer.write(""); @@ -217,10 +255,13 @@ private void writeIntEnum(PythonWriter writer, software.amazon.smithy.model.shap enumSymbol.getName(), RuntimeTypes.UNKNOWN_ENUM_MIXIN, () -> { + shape.getTrait(DocumentationTrait.class) + .ifPresent(trait -> writer.writeDocs(trait.getValue(), context)); for (var member : shape.members()) { var memberName = symbolProvider.toMemberName(member); var value = member.expectTrait(EnumValueTrait.class).expectIntValue(); writer.write("$L = $L", memberName, value); + writeMemberDocs(writer, member); } }); writer.write(""); diff --git a/packages/smithy-core/.changes/next-release/smithy-core-bugfix-a92663f9441f40caa2f95e18002fa6cf.json b/packages/smithy-core/.changes/next-release/smithy-core-bugfix-a92663f9441f40caa2f95e18002fa6cf.json new file mode 100644 index 000000000..fd436fcb5 --- /dev/null +++ b/packages/smithy-core/.changes/next-release/smithy-core-bugfix-a92663f9441f40caa2f95e18002fa6cf.json @@ -0,0 +1,4 @@ +{ + "type": "bugfix", + "description": "Restored docstrings on generated model classes, members, enums, and unions, which were dropped from the type stub when model classes became lazily loaded." +} \ No newline at end of file