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

aws.api

package aws.api

Members list

Type members

Classlikes

final case class Arn(template: String, absolute: Option[Boolean], noRegion: Option[Boolean], noAccount: Option[Boolean])

Specifies an ARN template for the resource.

Specifies an ARN template for the resource.

Value parameters

absolute

Set to true to indicate that the ARN template contains a fully-formed ARN that does not need to be merged with the service. This type of ARN MUST be used when the identifier of a resource is an ARN or is based on the ARN identifier of a parent resource.

noAccount

Set to true to specify that the ARN does not contain an account ID. If not set, or if set to false, the resolved ARN will contain a placeholder for the customer account ID. This can only be set to true if absolute is not set or is false.

noRegion

Set to true to specify that the ARN does not contain a region. If not set, or if set to false, the resolved ARN will contain a placeholder for the region. This can only be set to true if absolute is not set or is false.

template

Defines the ARN template. The provided string contains URI-template style label placeholders that contain the name of one of the identifiers defined in the identifiers property of the resource. These labels can be substituted at runtime with the actual identifiers of the resource. Every identifier name of the resource MUST have corresponding label of the same name. Note that percent-encoding is not performed on these placeholder values; they are to be replaced literally. For relative ARN templates that have not set absolute to true, the template string contains only the resource part of the ARN (for example, foo/{MyResourceId}). Relative ARNs MUST NOT start with "/".

Attributes

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

Attributes

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

A string representing a service's ARN namespace.

A string representing a service's ARN namespace.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
final case class ArnReference(_type: Option[String], resource: Option[String], service: Option[String])

Marks a string as containing an ARN.

Marks a string as containing an ARN.

Value parameters

resource

An absolute shape ID that references the Smithy resource type contained in the ARN (e.g., com.foo#SomeResource). The targeted resource is not required to be found in the model, allowing for external shapes to be referenced without needing to take on an additional dependency. If the shape is found in the model, it MUST target a resource shape, and the resource MUST be found within the closure of the referenced service shape.

service

The Smithy service absolute shape ID that is referenced by the ARN. The targeted service is not required to be found in the model, allowing for external shapes to be referenced without needing to take on an additional dependency.

type

The AWS CloudFormation resource type contained in the ARN.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[ArnReference]
trait Has[ArnReference]
trait ShapeTag[ArnReference]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class ClientDiscoveredEndpoint(required: Boolean)

Indicates that the target operation should use the client's endpoint discovery logic.

Indicates that the target operation should use the client's endpoint discovery logic.

Value parameters

required

This field denotes whether or not this operation requires the use of a specific endpoint. If this field is false, the standard regional endpoint for a service can handle this request. The client will start sending requests to the standard regional endpoint while working to discover a more specific endpoint.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[ClientDiscoveredEndpoint]
trait ShapeTag[ClientDiscoveredEndpoint]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class ClientEndpointDiscovery(operation: ShapeId, error: Option[ShapeId])

Configures endpoint discovery for the service.

Configures endpoint discovery for the service.

Value parameters

error

Indicates the error that tells clients that the endpoint they are using is no longer valid. This error MUST be bound to any operation bound to the service which is marked with the aws.api#clientDiscoveredEndpoint trait.

operation

Indicates the operation that clients should use to discover endpoints for the service.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[ClientEndpointDiscovery]
trait ShapeTag[ClientEndpointDiscovery]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class ClientEndpointDiscoveryId()

Indicates members of the operation input which should be use to discover endpoints.

Indicates members of the operation input which should be use to discover endpoints.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[ClientEndpointDiscoveryId]
trait ShapeTag[ClientEndpointDiscoveryId]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object CloudFormationName extends Newtype[String]

A string representing a CloudFormation service name.

A string representing a CloudFormation service name.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
final case class ControlPlane()

Defines a service, resource, or operation as operating on the control plane.

Defines a service, resource, or operation as operating on the control plane.

Attributes

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

Attributes

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

Designates the target as containing data of a known classification level.

Designates the target as containing data of a known classification level.

Value parameters

CUSTOMER_ACCOUNT_INFORMATION

Account information means information about customers that customers provide to AWS in connection with the creation or administration of customers’ accounts.

CUSTOMER_CONTENT

Customer content means any software (including machine images), data, text, audio, video or images that customers or any customer end user transfers to AWS for processing, storage or hosting by AWS services in connection with the customer’s accounts and any computational results that customers or any customer end user derive from the foregoing through their use of AWS services.

PERMISSIONS_DATA

Designates security and access roles, rules, usage policies, and permissions.

SERVICE_ATTRIBUTES

Service Attributes means service usage data related to a customer’s account, such as resource identifiers, metadata tags, security and access roles, rules, usage policies, permissions, usage statistics, logging data, and analytics.

TAG_DATA

Designates metadata tags applied to AWS resources.

Attributes

Companion
object
Supertypes
class Value
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object CUSTOMER_CONTENT.type
object PERMISSIONS_DATA.type
object SERVICE_ATTRIBUTES.type
object TAG_DATA.type
object Data extends Enumeration[Data], Companion[Data]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait Enumeration[Data]
trait Companion[Data]
trait Has[Data]
trait ShapeTag[Data]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Data.type
final case class DataPlane()

Defines a service, resource, or operation as operating on the data plane.

Defines a service, resource, or operation as operating on the data plane.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[DataPlane]
trait Has[DataPlane]
trait ShapeTag[DataPlane]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
DataPlane.type
final case class Service(sdkId: String, arnNamespace: Option[ArnNamespace], cloudFormationName: Option[CloudFormationName], cloudTrailEventSource: Option[String], docId: Option[String], endpointPrefix: Option[String])

An AWS service is defined using the aws.api#service trait. This trait provides information about the service like the name used to generate AWS SDK client classes and the namespace used in ARNs.

An AWS service is defined using the aws.api#service trait. This trait provides information about the service like the name used to generate AWS SDK client classes and the namespace used in ARNs.

Value parameters

arnNamespace

The arnNamespace property is a string value that defines the ARN service namespace of the service (e.g., "apigateway"). This value is used in ARNs assigned to resources in the service. If not set, this value defaults to the lowercase name of the service shape.

cloudFormationName

The cloudFormationName property is a string value that specifies the AWS CloudFormation service name (e.g., ApiGateway). When not set, this value defaults to the name of the service shape. This value is part of the CloudFormation resource type name that is automatically assigned to resources in the service (e.g., AWS::<NAME>::resourceName).

cloudTrailEventSource

The cloudTrailEventSource property is a string value that defines the AWS customer-facing eventSource property contained in CloudTrail event records emitted by the service. If not specified, this value defaults to the arnNamespace plus .amazonaws.com.

docId

The docId property is a string value that defines the identifier used to implemention linking between service and SDK documentation for AWS services. If not specified, this value defaults to the sdkId in lower case plus the service version property, separated by dashes.

endpointPrefix

The endpointPrefix property is a string value that identifies which endpoint in a given region should be used to connect to the service. For example, most services in the AWS standard partition have endpoints which follow the format: {endpointPrefix}.{region}.amazonaws.com. A service with the endpoint prefix example in the region us-west-2 might have the endpoint example.us-west-2.amazonaws.com. This value is not unique across services and is subject to change. Therefore, it MUST NOT be used for client naming or for any other purpose that requires a static, unique identifier. sdkId should be used for those purposes. Additionally, this value can be used to attempt to resolve endpoints.

sdkId

The sdkId property is a required string value that specifies the AWS SDK service ID (e.g., "API Gateway"). This value is used for generating client names in SDKs and for linking between services.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Service]
trait Has[Service]
trait ShapeTag[Service]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Service.type
final case class TagEnabled(disableDefaultOperations: Option[Boolean])

Annotates a service as having tagging on 1 or more resources and associated APIs to perform CRUD operations on those tags

Annotates a service as having tagging on 1 or more resources and associated APIs to perform CRUD operations on those tags

Value parameters

disableDefaultOperations

The disableDefaultOperations property is a boolean value that specifies if the service does not have the standard tag operations supporting all resources on the service. Default value is false

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[TagEnabled]
trait Has[TagEnabled]
trait ShapeTag[TagEnabled]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
TagEnabled.type
object TagOperationReference extends Newtype[ShapeId]

Points to an operation designated for a tagging APi

Points to an operation designated for a tagging APi

Attributes

Supertypes
class Newtype[ShapeId]
trait HasId
class Object
trait Matchable
class Any
Self type
final case class Taggable(property: Option[String], apiConfig: Option[TaggableApiConfig], disableSystemTags: Option[Boolean])

Indicates a resource supports CRUD operations for tags. Either through resource lifecycle or instance operations or tagging operations on the service.

Indicates a resource supports CRUD operations for tags. Either through resource lifecycle or instance operations or tagging operations on the service.

Value parameters

apiConfig

Specifies configuration for resource specific tagging APIs if the resource has them.

disableSystemTags

Flag indicating if the resource is not able to carry AWS system level. Used by service principals. Default value is false

property

The property property is a string value that identifies which resource property represents tags for the resource.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Taggable]
trait Has[Taggable]
trait ShapeTag[Taggable]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Taggable.type
final case class TaggableApiConfig(tagApi: TagOperationReference, untagApi: TagOperationReference, listTagsApi: TagOperationReference)

Structure representing the configuration of resource specific tagging APIs

Structure representing the configuration of resource specific tagging APIs

Value parameters

listTagsApi

The listTagsApi property is a string value that references a non- instance operation which gets the current tags on the resource.

tagApi

The tagApi property is a string value that references a non-instance or create operation that creates or updates tags on the resource.

untagApi

The untagApi property is a string value that references a non-instance operation that removes tags on the resource.

Attributes

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

Attributes

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

Types

type ArnNamespace = Type

A string representing a service's ARN namespace.

A string representing a service's ARN namespace.

Attributes

type CloudFormationName = Type

A string representing a CloudFormation service name.

A string representing a CloudFormation service name.

Attributes

type TagOperationReference = Type

Points to an operation designated for a tagging APi

Points to an operation designated for a tagging APi

Attributes

Generated with