aws-kernel
API
Generated with
aws-kernel/aws/aws.protocols

aws.protocols

package aws.protocols

Members list

Type members

Classlikes

final case class AwsJson1_0(http: Option[List[String]], eventStreamHttp: Option[List[String]]) extends HttpConfiguration

An RPC-based protocol that sends JSON payloads. This protocol does not use HTTP binding traits.

An RPC-based protocol that sends JSON payloads. This protocol does not use HTTP binding traits.

Value parameters

eventStreamHttp

The priority ordered list of supported HTTP protocol versions that are required when using event streams with the service. If not set, this value defaults to the value of the http member. Any entry in eventStreamHttp MUST also appear in http.

http

The priority ordered list of supported HTTP protocol versions.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AwsJson1_0 extends Companion[AwsJson1_0]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[AwsJson1_0]
trait Has[AwsJson1_0]
trait ShapeTag[AwsJson1_0]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
AwsJson1_0.type
final case class AwsJson1_1(http: Option[List[String]], eventStreamHttp: Option[List[String]]) extends HttpConfiguration

An RPC-based protocol that sends JSON payloads. This protocol does not use HTTP binding traits.

An RPC-based protocol that sends JSON payloads. This protocol does not use HTTP binding traits.

Value parameters

eventStreamHttp

The priority ordered list of supported HTTP protocol versions that are required when using event streams with the service. If not set, this value defaults to the value of the http member. Any entry in eventStreamHttp MUST also appear in http.

http

The priority ordered list of supported HTTP protocol versions.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AwsJson1_1 extends Companion[AwsJson1_1]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[AwsJson1_1]
trait Has[AwsJson1_1]
trait ShapeTag[AwsJson1_1]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
AwsJson1_1.type
object AwsQuery extends Companion[AwsQuery]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[AwsQuery]
trait Has[AwsQuery]
trait ShapeTag[AwsQuery]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
AwsQuery.type
final case class AwsQueryCompatible()

Enable backward compatibility when migrating from awsQuery to awsJson protocol

Enable backward compatibility when migrating from awsQuery to awsJson protocol

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AwsQueryCompatible extends Companion[AwsQueryCompatible]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[AwsQueryCompatible]
trait Has[AwsQueryCompatible]
trait ShapeTag[AwsQueryCompatible]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class AwsQueryError(code: String, httpResponseCode: Int)

Provides the value in the 'Code' distinguishing field and HTTP response code for an operation error.

Provides the value in the 'Code' distinguishing field and HTTP response code for an operation error.

Value parameters

code

The value used to distinguish this error shape during serialization.

httpResponseCode

The HTTP response code used on a response containing this error shape.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AwsQueryError extends Companion[AwsQueryError]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[AwsQueryError]
trait Has[AwsQueryError]
trait ShapeTag[AwsQueryError]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class ChecksumAlgorithm(_value: String, _name: String, _intValue: Int, _hints: Hints) extends Value

Value parameters

CRC32

CRC32

CRC32C

CRC32C

SHA1

SHA1

SHA256

SHA256

Attributes

Companion
object
Supertypes
class Value
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object CRC32.type
object CRC32C.type
object SHA1.type
object SHA256.type
object ChecksumAlgorithm extends Enumeration[ChecksumAlgorithm], Companion[ChecksumAlgorithm]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait Enumeration[ChecksumAlgorithm]
trait Companion[ChecksumAlgorithm]
trait Has[ChecksumAlgorithm]
trait ShapeTag[ChecksumAlgorithm]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object ChecksumAlgorithmSet extends Newtype[Set[ChecksumAlgorithm]]

Attributes

Supertypes
class Newtype[Set[ChecksumAlgorithm]]
trait HasId
class Object
trait Matchable
class Any
Self type
object Ec2Query extends Companion[Ec2Query]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Ec2Query]
trait Has[Ec2Query]
trait ShapeTag[Ec2Query]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Ec2Query.type
object Ec2QueryName extends Newtype[String]

Indicates the serialized name of a structure member when that structure is serialized for the input of an EC2 operation.

Indicates the serialized name of a structure member when that structure is serialized for the input of an EC2 operation.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
final case class HttpChecksum(requestAlgorithmMember: Option[String], requestChecksumRequired: Option[Boolean], requestValidationModeMember: Option[String], responseAlgorithms: Option[Set[ChecksumAlgorithm]])

Indicates that an operation supports checksum validation.

Indicates that an operation supports checksum validation.

Value parameters

requestAlgorithmMember

Defines a top-level operation input member that is used to configure request checksum behavior.

requestChecksumRequired

Indicates an operation requires a checksum in its HTTP request.

requestValidationModeMember

Defines a top-level operation input member used to opt-in to response checksum validation.

responseAlgorithms

Defines the checksum algorithms clients should look for when performing HTTP response checksum validation.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpChecksum extends Companion[HttpChecksum]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[HttpChecksum]
trait Has[HttpChecksum]
trait ShapeTag[HttpChecksum]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
trait HttpConfiguration

Contains HTTP protocol configuration for HTTP-based protocols.

Contains HTTP protocol configuration for HTTP-based protocols.

Value parameters

eventStreamHttp

The priority ordered list of supported HTTP protocol versions that are required when using event streams with the service. If not set, this value defaults to the value of the http member. Any entry in eventStreamHttp MUST also appear in http.

http

The priority ordered list of supported HTTP protocol versions.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AwsJson1_0
class AwsJson1_1
class RestJson1
class RestXml
final case class RestJson1(http: Option[List[String]], eventStreamHttp: Option[List[String]]) extends HttpConfiguration

A RESTful protocol that sends JSON in structured payloads.

A RESTful protocol that sends JSON in structured payloads.

Value parameters

eventStreamHttp

The priority ordered list of supported HTTP protocol versions that are required when using event streams with the service. If not set, this value defaults to the value of the http member. Any entry in eventStreamHttp MUST also appear in http.

http

The priority ordered list of supported HTTP protocol versions.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RestJson1 extends Companion[RestJson1]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[RestJson1]
trait Has[RestJson1]
trait ShapeTag[RestJson1]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
RestJson1.type
object RestXml extends Companion[RestXml]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[RestXml]
trait Has[RestXml]
trait ShapeTag[RestXml]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
RestXml.type
object StringList extends Newtype[List[String]]

Attributes

Supertypes
class Newtype[List[String]]
trait HasId
class Object
trait Matchable
class Any
Self type
StringList.type

Deprecated classlikes

final case class AwsQuery()

An RPC-based protocol that sends 'POST' requests in the body as x-www-form-urlencoded strings and responses in XML documents. This protocol does not use HTTP binding traits.

An RPC-based protocol that sends 'POST' requests in the body as x-www-form-urlencoded strings and responses in XML documents. This protocol does not use HTTP binding traits.

Attributes

Companion
object
Deprecated
[Since version N/A] N/A
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Ec2Query()

An RPC-based protocol that sends 'POST' requests in the body as Amazon EC2 formatted x-www-form-urlencoded strings and responses in XML documents. This protocol does not use HTTP binding traits.

An RPC-based protocol that sends 'POST' requests in the body as Amazon EC2 formatted x-www-form-urlencoded strings and responses in XML documents. This protocol does not use HTTP binding traits.

Attributes

Companion
object
Deprecated
[Since version N/A] N/A
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class RestXml(http: Option[List[String]], eventStreamHttp: Option[List[String]], noErrorWrapping: Option[Boolean]) extends HttpConfiguration

A RESTful protocol that sends XML in structured payloads.

A RESTful protocol that sends XML in structured payloads.

Value parameters

eventStreamHttp

The priority ordered list of supported HTTP protocol versions that are required when using event streams with the service. If not set, this value defaults to the value of the http member. Any entry in eventStreamHttp MUST also appear in http.

http

The priority ordered list of supported HTTP protocol versions.

noErrorWrapping

Disables the serialization wrapping of error properties in an 'Error' XML element.

Attributes

Companion
object
Deprecated
[Since version N/A] N/A
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Types

type ChecksumAlgorithmSet = Type
type Ec2QueryName = Type

Indicates the serialized name of a structure member when that structure is serialized for the input of an EC2 operation.

Indicates the serialized name of a structure member when that structure is serialized for the input of an EC2 operation.

Attributes

type StringList = Type
Generated with