diff --git a/CHANGELOG.md b/CHANGELOG.md index df2b67f9920..2572d571042 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,17 @@ +Release v1.43.10 (2022-03-02) +=== + +### Service Client Updates +* `service/athena`: Updates service API and documentation + * This release adds support for S3 Object Ownership by allowing the S3 bucket owner full control canned ACL to be set when Athena writes query results to S3 buckets. +* `service/cloudtrail`: Updates service API and documentation + * Add bytesScanned field into responses of DescribeQuery and GetQueryResults. +* `service/ecr`: Updates service API and documentation + * This release adds support for tracking images lastRecordedPullTime. +* `service/gamelift`: Updates service documentation + * Minor updates to address errors. +* `service/keyspaces`: Updates service API, documentation, waiters, paginators, and examples + Release v1.43.9 (2022-03-01) === diff --git a/aws/version.go b/aws/version.go index 1ca7e2c3c08..5712d7122d0 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.43.9" +const SDKVersion = "1.43.10" diff --git a/models/apis/athena/2017-05-18/api-2.json b/models/apis/athena/2017-05-18/api-2.json index c3c27d4601f..3cd50734060 100644 --- a/models/apis/athena/2017-05-18/api-2.json +++ b/models/apis/athena/2017-05-18/api-2.json @@ -486,6 +486,13 @@ } }, "shapes":{ + "AclConfiguration":{ + "type":"structure", + "required":["S3AclOption"], + "members":{ + "S3AclOption":{"shape":"S3AclOption"} + } + }, "AmazonResourceName":{ "type":"string", "max":1011, @@ -1345,7 +1352,8 @@ "members":{ "OutputLocation":{"shape":"String"}, "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, - "ExpectedBucketOwner":{"shape":"String"} + "ExpectedBucketOwner":{"shape":"String"}, + "AclConfiguration":{"shape":"AclConfiguration"} } }, "ResultConfigurationUpdates":{ @@ -1356,7 +1364,9 @@ "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, "RemoveEncryptionConfiguration":{"shape":"BoxedBoolean"}, "ExpectedBucketOwner":{"shape":"String"}, - "RemoveExpectedBucketOwner":{"shape":"BoxedBoolean"} + "RemoveExpectedBucketOwner":{"shape":"BoxedBoolean"}, + "AclConfiguration":{"shape":"AclConfiguration"}, + "RemoveAclConfiguration":{"shape":"BoxedBoolean"} } }, "ResultSet":{ @@ -1382,6 +1392,10 @@ "type":"list", "member":{"shape":"Row"} }, + "S3AclOption":{ + "type":"string", + "enum":["BUCKET_OWNER_FULL_CONTROL"] + }, "StartQueryExecutionInput":{ "type":"structure", "required":["QueryString"], diff --git a/models/apis/athena/2017-05-18/docs-2.json b/models/apis/athena/2017-05-18/docs-2.json index c3ee8057092..40a85e83b1c 100644 --- a/models/apis/athena/2017-05-18/docs-2.json +++ b/models/apis/athena/2017-05-18/docs-2.json @@ -39,6 +39,13 @@ "UpdateWorkGroup": "
Updates the workgroup with the specified name. The workgroup's name cannot be changed.
" }, "shapes": { + "AclConfiguration": { + "base": "Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. When Athena stores query results in Amazon S3, the canned ACL is set with the x-amz-acl
request header. For more information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User Guide.
Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL
. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.
The ACL configuration for the query results.
" + } + }, "AmazonResourceName": { "base": null, "refs": { @@ -87,6 +94,7 @@ "ResultConfigurationUpdates$RemoveOutputLocation": "If set to \"true\", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the OutputLocation
in ResultConfigurationUpdates
(the client-side setting), the OutputLocation
in the workgroup's ResultConfiguration
will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
If set to \"true\", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the EncryptionConfiguration
in ResultConfigurationUpdates
(the client-side setting), the EncryptionConfiguration
in the workgroup's ResultConfiguration
will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
If set to \"true\", removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner. If set to \"false\" or not set, and a value is present in the ExpectedBucketOwner
in ResultConfigurationUpdates
(the client-side setting), the ExpectedBucketOwner
in the workgroup's ResultConfiguration
is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
If set to true
, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to false
or not set, and a value is present in the AclConfiguration
of ResultConfigurationUpdates
, the AclConfiguration
in the workgroup's ResultConfiguration
is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
", "WorkGroupConfiguration$PublishCloudWatchMetricsEnabled": "Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
", "WorkGroupConfiguration$RequesterPaysEnabled": "If set to true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false
, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false
. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.
The rows in the table.
" } }, + "S3AclOption": { + "base": null, + "refs": { + "AclConfiguration$S3AclOption": "The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL
. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.
This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.
As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.
See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.
", "operations": { "AddTags": "Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all Amazon Web Services Regions only from the Region in which the trail was created (also known as its home region).
", - "CancelQuery": "Cancels a query if the query is not in a terminated state, such as CANCELLED
, FAILED
or FINISHED
. You must specify an ARN value for EventDataStore
. The ID of the query that you want to cancel is also required. When you run CancelQuery
, the query status might show as CANCELLED
even if the operation is not yet finished.
Cancels a query if the query is not in a terminated state, such as CANCELLED
, FAILED
, TIMED_OUT
, or FINISHED
. You must specify an ARN value for EventDataStore
. The ID of the query that you want to cancel is also required. When you run CancelQuery
, the query status might show as CANCELLED
even if the operation is not yet finished.
Creates a new event data store.
", "CreateTrail": "Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
", "DeleteEventDataStore": "Disables the event data store specified by EventDataStore
, which accepts an event data store ARN. After you run DeleteEventDataStore
, the event data store enters a PENDING_DELETION
state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled
must be set to False
on the event data store; this operation cannot work if TerminationProtectionEnabled
is True
.
After you run DeleteEventDataStore
on an event data store, you cannot run ListQueries
, DescribeQuery
, or GetQueryResults
on queries that are using an event data store in a PENDING_DELETION
state. An event data store in the PENDING_DELETION
state does not incur costs.
Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.
", "ListEventDataStores": "Returns information about all event data stores in the account, in the current region.
", "ListPublicKeys": "Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
CloudTrail uses different private and public key pairs per region. Each digest file is signed with a private key unique to its region. When you validate a digest file from a specific region, you must look in the same region for its corresponding public key.
Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore
. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime
and EndTime
parameters, and a QueryStatus
value. Valid values for QueryStatus
include QUEUED
, RUNNING
, FINISHED
, FAILED
, or CANCELLED
.
Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore
. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime
and EndTime
parameters, and a QueryStatus
value. Valid values for QueryStatus
include QUEUED
, RUNNING
, FINISHED
, FAILED
, TIMED_OUT
, or CANCELLED
.
Lists the tags for the trail in the current region.
", "ListTrails": "Lists trails that are in the current account.
", "LookupEvents": "Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:
Amazon Web Services access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
The specified query cannot be canceled because it is in the FINISHED
, FAILED
, or CANCELLED
state.
The specified query cannot be canceled because it is in the FINISHED
, FAILED
, TIMED_OUT
, or CANCELLED
state.
The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.
", "QueryStatisticsForDescribeQuery$EventsMatched": "The number of events that matched a query.
", - "QueryStatisticsForDescribeQuery$EventsScanned": "The number of events that the query scanned in the event data store.
" + "QueryStatisticsForDescribeQuery$EventsScanned": "The number of events that the query scanned in the event data store.
", + "QueryStatisticsForDescribeQuery$BytesScanned": "The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.
" } }, "LookupAttribute": { @@ -922,10 +924,10 @@ "base": null, "refs": { "CancelQueryResponse$QueryStatus": "Shows the status of a query after a CancelQuery
request. Typically, the values shown are either RUNNING
or CANCELLED
.
The status of a query. Values for QueryStatus
include QUEUED
, RUNNING
, FINISHED
, FAILED
, or CANCELLED
The status of the query. Values include QUEUED
, RUNNING
, FINISHED
, FAILED
, or CANCELLED
.
The status of queries that you want to return in results. Valid values for QueryStatus
include QUEUED
, RUNNING
, FINISHED
, FAILED
, or CANCELLED
.
The status of the query. This can be QUEUED
, RUNNING
, FINISHED
, FAILED
, or CANCELLED
.
The status of a query. Values for QueryStatus
include QUEUED
, RUNNING
, FINISHED
, FAILED
, TIMED_OUT
, or CANCELLED
The status of the query. Values include QUEUED
, RUNNING
, FINISHED
, FAILED
, TIMED_OUT
, or CANCELLED
.
The status of queries that you want to return in results. Valid values for QueryStatus
include QUEUED
, RUNNING
, FINISHED
, FAILED
, TIMED_OUT
, or CANCELLED
.
The status of the query. This can be QUEUED
, RUNNING
, FINISHED
, FAILED
, TIMED_OUT
, or CANCELLED
.
Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the tagStatus
filter and specifying either TAGGED
, UNTAGGED
or ANY
. For example, you can filter your results to return only UNTAGGED
images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED
images to list all of the tags in your repository.
List the tags for an Amazon ECR resource.
", "PutImage": "Creates or updates the image manifest and tags associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
Updates the image scanning configuration for the specified repository.
", + "PutImageScanningConfiguration": "The PutImageScanningConfiguration
API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration.
Updates the image scanning configuration for the specified repository.
", "PutImageTagMutability": "Updates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.
", "PutLifecyclePolicy": "Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
", "PutRegistryPolicy": "Creates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.
", @@ -1256,6 +1256,12 @@ "Recommendation$text": "The recommended course of action to remediate the finding.
" } }, + "RecordedPullTimestamp": { + "base": null, + "refs": { + "ImageDetail$lastRecordedPullTime": "The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded the last image pull.
Amazon ECR refreshes the last image pull timestamp at least once every 24 hours. For example, if you pull an image once a day then the lastRecordedPullTime
timestamp will indicate the exact time that the image was last pulled. However, if you pull an image once an hour, because Amazon ECR refreshes the lastRecordedPullTime
timestamp at least once every 24 hours, the result may not be the exact time that the image was last pulled.
The frequency that scans are performed at for a private registry.
", + "RegistryScanningRule$scanFrequency": "The frequency that scans are performed at for a private registry. When the ENHANCED
scan type is specified, the supported scan frequencies are CONTINUOUS_SCAN
and SCAN_ON_PUSH
. When the BASIC
scan type is specified, the SCAN_ON_PUSH
and MANUAL
scan frequencies are supported.
The scan frequency for the repository.
" } }, @@ -1657,7 +1663,7 @@ "ScanType": { "base": null, "refs": { - "PutRegistryScanningConfigurationRequest$scanType": "The scanning type to set for the registry.
By default, the BASIC
scan type is used. When basic scanning is set, you may specify filters to determine which individual repositories, or all repositories, are scanned when new images are pushed. Alternatively, you can do manual scans of images with basic scanning.
When the ENHANCED
scan type is set, Amazon Inspector provides automated, continuous scanning of all repositories in your registry.
The scanning type to set for the registry.
When a registry scanning configuration is not defined, by default the BASIC
scan type is used. When basic scanning is used, you may specify filters to determine which individual repositories, or all repositories, are scanned when new images are pushed to those repositories. Alternatively, you can do manual scans of images with basic scanning.
When the ENHANCED
scan type is set, Amazon Inspector provides automated vulnerability scanning. You may choose between continuous scanning or scan on push and you may specify filters to determine which individual repositories, or all repositories, are scanned.
The type of scanning configured for the registry.
" } }, @@ -1793,7 +1799,7 @@ } }, "Tag": { - "base": "The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
", + "base": "The metadata to apply to a resource to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
", "refs": { "TagList$member": null } @@ -1841,7 +1847,7 @@ "TagValue": { "base": null, "refs": { - "Tag$Value": "The optional part of a key-value pair that make up a tag. A value
acts as a descriptor within a tag category (key).
A value
acts as a descriptor within a tag category (key).
This operation is used with the GameLift FleetIQ solution and game server groups.
Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.
To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.
Learn more
Related actions
RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task
", "DescribeAlias": "Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias
.
To get alias properties, specify the alias ID. If successful, the requested alias record is returned.
Related actions
CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task
", "DescribeBuild": "Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.
Learn more
Related actions
CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task
", - "DescribeEC2InstanceLimits": "The GameLift service limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your GameLift fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.
Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:
Request specifies the Region ap-northeast-1
with no location. The result is limits and usage data on all instance types that are deployed in us-east-2
, by all of the fleets that reside in ap-northeast-1
.
Request specifies the Region us-east-1
with location ca-central-1
. The result is limits and usage data on all instance types that are deployed in ca-central-1
, by all of the fleets that reside in us-east-2
. These limits do not affect fleets in any other Regions that deploy instances to ca-central-1
.
Request specifies the Region eu-west-1
with location ca-central-1
. The result is limits and usage data on all instance types that are deployed in ca-central-1
, by all of the fleets that reside in eu-west-1
.
This operation can be used in the following ways:
To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.
To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.
If successful, an EC2InstanceLimits
object is returned with limits and usage data for each requested instance type.
Learn more
Related actions
CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task
", + "DescribeEC2InstanceLimits": "Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your GameLift fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.
Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:
Request specifies the Region ap-northeast-1
with no location. The result is limits and usage data on all instance types that are deployed in us-east-2
, by all of the fleets that reside in ap-northeast-1
.
Request specifies the Region us-east-1
with location ca-central-1
. The result is limits and usage data on all instance types that are deployed in ca-central-1
, by all of the fleets that reside in us-east-2
. These limits do not affect fleets in any other Regions that deploy instances to ca-central-1
.
Request specifies the Region eu-west-1
with location ca-central-1
. The result is limits and usage data on all instance types that are deployed in ca-central-1
, by all of the fleets that reside in eu-west-1
.
This operation can be used in the following ways:
To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.
To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.
If successful, an EC2InstanceLimits
object is returned with limits and usage data for each requested instance type.
Learn more
Related actions
CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task
", "DescribeFleetAttributes": "Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.
This operation can be used in the following ways:
To get attributes for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetAttributes
object is returned for each fleet requested, unless the fleet identifier is not found.
Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.
Learn more
Related actions
ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task
", "DescribeFleetCapacity": "Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationCapacity to get capacity settings for a fleet's remote locations.
This operation can be used in the following ways:
To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get capacity data for all fleets, do not provide a fleet identifier.
When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object includes a Location
property, which is set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects are returned only for fleets that currently exist.
Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
Related actions
ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task
", "DescribeFleetEvents": "Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.
You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a collection of event log entries matching the request are returned.
Learn more
Related actions
ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task
", @@ -50,7 +50,7 @@ "DescribeGameSessionQueues": "Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.
Learn more
Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task
", "DescribeGameSessions": "Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve the protection policy for game sessions, use DescribeGameSessionDetails.
This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessions
should only be used for games in development with low game session usage.
This operation can be used in the following ways:
To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.
To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a GameSession
object is returned for each game session that matches the request.
This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously poling ticket status with DescribeGameSessions should only be used for games in development with low matchmaking usage.
Available in Amazon Web Services Local.
Learn more
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", "DescribeInstances": "Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
This operation can be used in the following ways:
To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.
To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.
To get information on a specific instance in a fleet, provide the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, an Instance
object is returned for each requested instance. Instances are not returned in any particular order.
Learn more
Remotely Access Fleet Instances
Related actions
DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits | All APIs by task
", - "DescribeMatchmaking": "Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session.
To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.
This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously poling ticket status with DescribeMatchmaking should only be used for games in development with low matchmaking usage.
Learn more
Add FlexMatch to a game client
Set Up FlexMatch event notification
Related actions
StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task
", + "DescribeMatchmaking": "Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session.
To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.
This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously polling ticket status with DescribeMatchmaking should only be used for games in development with low matchmaking usage.
Learn more
Add FlexMatch to a game client
Set Up FlexMatch event notification
Related actions
StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task
", "DescribeMatchmakingConfigurations": "Retrieves the details of FlexMatch matchmaking configurations.
This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.
Learn more
Setting up FlexMatch matchmakers
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
", "DescribeMatchmakingRuleSets": "Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.
Learn more
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
", "DescribePlayerSessions": "Retrieves properties for one or more player sessions.
This action can be used in the following ways:
To retrieve a specific player session, provide the player session ID only.
To retrieve all player sessions in a game session, provide the game session ID only.
To retrieve all player sessions for a specific player, provide a player ID only.
To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a PlayerSession
object is returned for each session that matches the request.
Available in Amazon Web Services Local.
Related actions
CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task
", diff --git a/models/apis/keyspaces/2022-02-10/api-2.json b/models/apis/keyspaces/2022-02-10/api-2.json new file mode 100644 index 00000000000..d132d5ca452 --- /dev/null +++ b/models/apis/keyspaces/2022-02-10/api-2.json @@ -0,0 +1,802 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-02-10", + "endpointPrefix":"cassandra", + "jsonVersion":"1.0", + "protocol":"json", + "serviceFullName":"Amazon Keyspaces", + "serviceId":"Keyspaces", + "signatureVersion":"v4", + "signingName":"cassandra", + "targetPrefix":"KeyspacesService", + "uid":"keyspaces-2022-02-10" + }, + "operations":{ + "CreateKeyspace":{ + "name":"CreateKeyspace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyspaceRequest"}, + "output":{"shape":"CreateKeyspaceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"} + ] + }, + "CreateTable":{ + "name":"CreateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTableRequest"}, + "output":{"shape":"CreateTableResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeleteKeyspace":{ + "name":"DeleteKeyspace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeyspaceRequest"}, + "output":{"shape":"DeleteKeyspaceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeleteTable":{ + "name":"DeleteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTableRequest"}, + "output":{"shape":"DeleteTableResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "GetKeyspace":{ + "name":"GetKeyspace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetKeyspaceRequest"}, + "output":{"shape":"GetKeyspaceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "GetTable":{ + "name":"GetTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTableRequest"}, + "output":{"shape":"GetTableResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "ListKeyspaces":{ + "name":"ListKeyspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListKeyspacesRequest"}, + "output":{"shape":"ListKeyspacesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "ListTables":{ + "name":"ListTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTablesRequest"}, + "output":{"shape":"ListTablesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "RestoreTable":{ + "name":"RestoreTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreTableRequest"}, + "output":{"shape":"RestoreTableResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UpdateTable":{ + "name":"UpdateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTableRequest"}, + "output":{"shape":"UpdateTableResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + } + }, + "shapes":{ + "ARN":{ + "type":"string", + "max":1000, + "min":20, + "pattern":"arn:(aws[a-zA-Z0-9-]*):cassandra:.+.*" + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "exception":true + }, + "CapacitySpecification":{ + "type":"structure", + "required":["throughputMode"], + "members":{ + "throughputMode":{"shape":"ThroughputMode"}, + "readCapacityUnits":{"shape":"CapacityUnits"}, + "writeCapacityUnits":{"shape":"CapacityUnits"} + } + }, + "CapacitySpecificationSummary":{ + "type":"structure", + "required":["throughputMode"], + "members":{ + "throughputMode":{"shape":"ThroughputMode"}, + "readCapacityUnits":{"shape":"CapacityUnits"}, + "writeCapacityUnits":{"shape":"CapacityUnits"}, + "lastUpdateToPayPerRequestTimestamp":{"shape":"Timestamp"} + } + }, + "CapacityUnits":{ + "type":"long", + "box":true, + "min":1 + }, + "ClusteringKey":{ + "type":"structure", + "required":[ + "name", + "orderBy" + ], + "members":{ + "name":{"shape":"GenericString"}, + "orderBy":{"shape":"SortOrder"} + } + }, + "ClusteringKeyList":{ + "type":"list", + "member":{"shape":"ClusteringKey"} + }, + "ColumnDefinition":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{"shape":"GenericString"}, + "type":{"shape":"GenericString"} + } + }, + "ColumnDefinitionList":{ + "type":"list", + "member":{"shape":"ColumnDefinition"}, + "min":1 + }, + "Comment":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + } + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "exception":true + }, + "CreateKeyspaceRequest":{ + "type":"structure", + "required":["keyspaceName"], + "members":{ + "keyspaceName":{"shape":"KeyspaceName"}, + "tags":{"shape":"TagList"} + } + }, + "CreateKeyspaceResponse":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{"shape":"ARN"} + } + }, + "CreateTableRequest":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName", + "schemaDefinition" + ], + "members":{ + "keyspaceName":{"shape":"KeyspaceName"}, + "tableName":{"shape":"TableName"}, + "schemaDefinition":{"shape":"SchemaDefinition"}, + "comment":{"shape":"Comment"}, + "capacitySpecification":{"shape":"CapacitySpecification"}, + "encryptionSpecification":{"shape":"EncryptionSpecification"}, + "pointInTimeRecovery":{"shape":"PointInTimeRecovery"}, + "ttl":{"shape":"TimeToLive"}, + "defaultTimeToLive":{"shape":"DefaultTimeToLive"}, + "tags":{"shape":"TagList"} + } + }, + "CreateTableResponse":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{"shape":"ARN"} + } + }, + "DefaultTimeToLive":{ + "type":"integer", + "box":true, + "max":630720000, + "min":1 + }, + "DeleteKeyspaceRequest":{ + "type":"structure", + "required":["keyspaceName"], + "members":{ + "keyspaceName":{"shape":"KeyspaceName"} + } + }, + "DeleteKeyspaceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTableRequest":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName" + ], + "members":{ + "keyspaceName":{"shape":"KeyspaceName"}, + "tableName":{"shape":"TableName"} + } + }, + "DeleteTableResponse":{ + "type":"structure", + "members":{ + } + }, + "EncryptionSpecification":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{"shape":"EncryptionType"}, + "kmsKeyIdentifier":{"shape":"kmsKeyARN"} + } + }, + "EncryptionType":{ + "type":"string", + "enum":[ + "CUSTOMER_MANAGED_KMS_KEY", + "AWS_OWNED_KMS_KEY" + ] + }, + "GenericString":{"type":"string"}, + "GetKeyspaceRequest":{ + "type":"structure", + "required":["keyspaceName"], + "members":{ + "keyspaceName":{"shape":"KeyspaceName"} + } + }, + "GetKeyspaceResponse":{ + "type":"structure", + "required":[ + "keyspaceName", + "resourceArn" + ], + "members":{ + "keyspaceName":{"shape":"KeyspaceName"}, + "resourceArn":{"shape":"ARN"} + } + }, + "GetTableRequest":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName" + ], + "members":{ + "keyspaceName":{"shape":"KeyspaceName"}, + "tableName":{"shape":"TableName"} + } + }, + "GetTableResponse":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName", + "resourceArn" + ], + "members":{ + "keyspaceName":{"shape":"KeyspaceName"}, + "tableName":{"shape":"TableName"}, + "resourceArn":{"shape":"ARN"}, + "creationTimestamp":{"shape":"Timestamp"}, + "status":{"shape":"TableStatus"}, + "schemaDefinition":{"shape":"SchemaDefinition"}, + "capacitySpecification":{"shape":"CapacitySpecificationSummary"}, + "encryptionSpecification":{"shape":"EncryptionSpecification"}, + "pointInTimeRecovery":{"shape":"PointInTimeRecoverySummary"}, + "ttl":{"shape":"TimeToLive"}, + "defaultTimeToLive":{"shape":"DefaultTimeToLive"}, + "comment":{"shape":"Comment"} + } + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "exception":true, + "fault":true + }, + "KeyspaceName":{ + "type":"string", + "max":48, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_]{1,47}" + }, + "KeyspaceSummary":{ + "type":"structure", + "required":[ + "keyspaceName", + "resourceArn" + ], + "members":{ + "keyspaceName":{"shape":"KeyspaceName"}, + "resourceArn":{"shape":"ARN"} + } + }, + "KeyspaceSummaryList":{ + "type":"list", + "member":{"shape":"KeyspaceSummary"} + }, + "ListKeyspacesRequest":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"NextToken"}, + "maxResults":{"shape":"MaxResults"} + } + }, + "ListKeyspacesResponse":{ + "type":"structure", + "required":["keyspaces"], + "members":{ + "nextToken":{"shape":"NextToken"}, + "keyspaces":{"shape":"KeyspaceSummaryList"} + } + }, + "ListTablesRequest":{ + "type":"structure", + "required":["keyspaceName"], + "members":{ + "nextToken":{"shape":"NextToken"}, + "maxResults":{"shape":"MaxResults"}, + "keyspaceName":{"shape":"KeyspaceName"} + } + }, + "ListTablesResponse":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"NextToken"}, + "tables":{"shape":"TableSummaryList"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{"shape":"ARN"}, + "nextToken":{"shape":"NextToken"}, + "maxResults":{"shape":"MaxResults"} + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"NextToken"}, + "tags":{"shape":"TagList"} + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1 + }, + "PartitionKey":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{"shape":"GenericString"} + } + }, + "PartitionKeyList":{ + "type":"list", + "member":{"shape":"PartitionKey"}, + "min":1 + }, + "PointInTimeRecovery":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{"shape":"PointInTimeRecoveryStatus"} + } + }, + "PointInTimeRecoveryStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "PointInTimeRecoverySummary":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{"shape":"PointInTimeRecoveryStatus"}, + "earliestRestorableTimestamp":{"shape":"Timestamp"} + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceArn":{"shape":"ARN"} + }, + "exception":true + }, + "RestoreTableRequest":{ + "type":"structure", + "required":[ + "sourceKeyspaceName", + "sourceTableName", + "targetKeyspaceName", + "targetTableName" + ], + "members":{ + "sourceKeyspaceName":{"shape":"KeyspaceName"}, + "sourceTableName":{"shape":"TableName"}, + "targetKeyspaceName":{"shape":"KeyspaceName"}, + "targetTableName":{"shape":"TableName"}, + "restoreTimestamp":{"shape":"Timestamp"}, + "capacitySpecificationOverride":{"shape":"CapacitySpecification"}, + "encryptionSpecificationOverride":{"shape":"EncryptionSpecification"}, + "pointInTimeRecoveryOverride":{"shape":"PointInTimeRecovery"}, + "tagsOverride":{"shape":"TagList"} + } + }, + "RestoreTableResponse":{ + "type":"structure", + "required":["restoredTableARN"], + "members":{ + "restoredTableARN":{"shape":"ARN"} + } + }, + "SchemaDefinition":{ + "type":"structure", + "required":[ + "allColumns", + "partitionKeys" + ], + "members":{ + "allColumns":{"shape":"ColumnDefinitionList"}, + "partitionKeys":{"shape":"PartitionKeyList"}, + "clusteringKeys":{"shape":"ClusteringKeyList"}, + "staticColumns":{"shape":"StaticColumnList"} + } + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "exception":true + }, + "SortOrder":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "StaticColumn":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{"shape":"GenericString"} + } + }, + "StaticColumnList":{ + "type":"list", + "member":{"shape":"StaticColumn"} + }, + "String":{"type":"string"}, + "TableName":{ + "type":"string", + "max":48, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_]{1,47}" + }, + "TableStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "CREATING", + "UPDATING", + "DELETING", + "DELETED", + "RESTORING", + "INACCESSIBLE_ENCRYPTION_CREDENTIALS" + ] + }, + "TableSummary":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName", + "resourceArn" + ], + "members":{ + "keyspaceName":{"shape":"KeyspaceName"}, + "tableName":{"shape":"TableName"}, + "resourceArn":{"shape":"ARN"} + } + }, + "TableSummaryList":{ + "type":"list", + "member":{"shape":"TableSummary"} + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":60, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{"shape":"ARN"}, + "tags":{"shape":"TagList"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "ThroughputMode":{ + "type":"string", + "enum":[ + "PAY_PER_REQUEST", + "PROVISIONED" + ] + }, + "TimeToLive":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{"shape":"TimeToLiveStatus"} + } + }, + "TimeToLiveStatus":{ + "type":"string", + "enum":["ENABLED"] + }, + "Timestamp":{"type":"timestamp"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{"shape":"ARN"}, + "tags":{"shape":"TagList"} + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateTableRequest":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName" + ], + "members":{ + "keyspaceName":{"shape":"KeyspaceName"}, + "tableName":{"shape":"TableName"}, + "addColumns":{"shape":"ColumnDefinitionList"}, + "capacitySpecification":{"shape":"CapacitySpecification"}, + "encryptionSpecification":{"shape":"EncryptionSpecification"}, + "pointInTimeRecovery":{"shape":"PointInTimeRecovery"}, + "ttl":{"shape":"TimeToLive"}, + "defaultTimeToLive":{"shape":"DefaultTimeToLive"} + } + }, + "UpdateTableResponse":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{"shape":"ARN"} + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "exception":true + }, + "kmsKeyARN":{ + "type":"string", + "max":5096, + "min":1 + } + } +} diff --git a/models/apis/keyspaces/2022-02-10/docs-2.json b/models/apis/keyspaces/2022-02-10/docs-2.json new file mode 100644 index 00000000000..b7348cf60c3 --- /dev/null +++ b/models/apis/keyspaces/2022-02-10/docs-2.json @@ -0,0 +1,502 @@ +{ + "version": "2.0", + "service": "Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.
<p>In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI. This API reference describes the supported DDL operations in detail. </p> <note> <p>For the list of all supported CQL APIs, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html">Supported Cassandra APIs, operations, and data types in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-apis.html">Amazon Web Services APIs</a> in the <i>General Reference</i>. </p> </note>
",
+ "operations": {
+ "CreateKeyspace": "The CreateKeyspace
operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.
CreateKeyspace
is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace
operation.
For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide.
", + "CreateTable": "The CreateTable
operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.
CreateTable
is an asynchronous operation. When the request is received, the status of the table is set to CREATING
. You can monitor the creation status of the new table by using the GetTable
operation, which returns the current status
of the table. You can start using a table when the status is ACTIVE
.
For more information, see Creating tables in the Amazon Keyspaces Developer Guide.
", + "DeleteKeyspace": "The DeleteKeyspace
operation deletes a keyspace and all of its tables.
The DeleteTable
operation deletes a table and all of its data. After a DeleteTable
request is received, the specified table is in the DELETING
state until Amazon Keyspaces completes the deletion. If the table is in the ACTIVE
state, you can delete it. If a table is either in the CREATING
or UPDATING
states, then Amazon Keyspaces returns a ResourceInUseException
. If the specified table does not exist, Amazon Keyspaces returns a ResourceNotFoundException
. If the table is already in the DELETING
state, no error is returned.
Returns the name and the Amazon Resource Name (ARN) of the specified table.
", + "GetTable": "Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.
", + "ListKeyspaces": "Returns a list of keyspaces.
", + "ListTables": "Returns a list of tables for a specified keyspace.
", + "ListTagsForResource": "Returns a list of all tags associated with the specified Amazon Keyspaces resource.
", + "RestoreTable": "Restores the specified table to the specified point in time within the earliest_restorable_timestamp
and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.
Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp (day:hour:minute:second)
to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.
In addition to the table's schema, data, and TTL settings, RestoreTable
restores the capacity mode, encryption, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.
You can also overwrite these settings during restore:
Read/write capacity mode
Provisioned throughput capacity settings
Point-in-time (PITR) settings
Tags
For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.
The following settings are not restored, and you must configure them manually for the new table.
Automatic scaling policies (for tables that use provisioned capacity mode)
Identity and Access Management (IAM) policies
Amazon CloudWatch metrics and alarms
Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
", + "UntagResource": "Removes the association of tags from a Amazon Keyspaces resource.
", + "UpdateTable": "Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.
" + }, + "shapes": { + "ARN": { + "base": null, + "refs": { + "CreateKeyspaceResponse$resourceArn": "The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
", + "CreateTableResponse$resourceArn": "The unique identifier of the table in the format of an Amazon Resource Name (ARN).
", + "GetKeyspaceResponse$resourceArn": "The ARN of the keyspace.
", + "GetTableResponse$resourceArn": "The Amazon Resource Name (ARN) of the specified table.
", + "KeyspaceSummary$resourceArn": "The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
", + "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
", + "ResourceNotFoundException$resourceArn": "The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.
", + "RestoreTableResponse$restoredTableARN": "The Amazon Resource Name (ARN) of the restored table.
", + "TableSummary$resourceArn": "The unique identifier of the table in the format of an Amazon Resource Name (ARN).
", + "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.
", + "UntagResourceRequest$resourceArn": "The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
", + "UpdateTableResponse$resourceArn": "The Amazon Resource Name (ARN) of the modified table.
" + } + }, + "AccessDeniedException": { + "base": "You do not have sufficient access to perform this action.
", + "refs": { + } + }, + "CapacitySpecification": { + "base": "Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables:
On-demand (default)
Provisioned
<p> The read/write capacity mode that you choose controls how you are charged for read and write throughput and how table throughput capacity is managed. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
",
+ "refs": {
+ "CreateTableRequest$capacitySpecification": "Specifies the read/write throughput capacity mode for the table. The options are:
throughputMode:PAY_PER_REQUEST
and
throughputMode:PROVISIONED
. The provisioned capacity mode requires readCapacityUnits
and writeCapacityUnits
as inputs.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
", + "RestoreTableRequest$capacitySpecificationOverride": "Specifies the read/write throughput capacity mode for the target table. The options are:
throughputMode:PAY_PER_REQUEST
and
throughputMode:PROVISIONED
. The provisioned capacity mode requires readCapacityUnits
and writeCapacityUnits
as inputs.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
", + "UpdateTableRequest$capacitySpecification": "Modifies the read/write throughput capacity mode for the table. The options are:
throughputMode:PAY_PER_REQUEST
and
throughputMode:PROVISIONED
. The provisioned capacity mode requires readCapacityUnits
and writeCapacityUnits
as inputs.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
" + } + }, + "CapacitySpecificationSummary": { + "base": "The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUEST
and
throughputMode:PROVISIONED
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
", + "refs": { + "GetTableResponse$capacitySpecification": "The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUEST
and
throughputMode:PROVISIONED
.
The throughput capacity specified for read
operations defined in read capacity units
(RCUs)
.
The throughput capacity specified for write
operations defined in write capacity units
(WCUs)
.
The throughput capacity specified for read
operations defined in read capacity units
(RCUs)
.
The throughput capacity specified for write
operations defined in write capacity units
(WCUs)
.
The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.
", + "refs": { + "ClusteringKeyList$member": null + } + }, + "ClusteringKeyList": { + "base": null, + "refs": { + "SchemaDefinition$clusteringKeys": "The columns that are part of the clustering key of the table.
" + } + }, + "ColumnDefinition": { + "base": "The names and data types of regular columns.
", + "refs": { + "ColumnDefinitionList$member": null + } + }, + "ColumnDefinitionList": { + "base": null, + "refs": { + "SchemaDefinition$allColumns": "The regular columns of the table.
", + "UpdateTableRequest$addColumns": "For each column to be added to the specified table:
name
- The name of the column.
type
- An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.
An optional comment that describes the table.
", + "refs": { + "CreateTableRequest$comment": "This parameter allows to enter a description of the table.
", + "GetTableResponse$comment": "The the description of the specified table.
" + } + }, + "ConflictException": { + "base": "Amazon Keyspaces could not complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
", + "refs": { + } + }, + "CreateKeyspaceRequest": { + "base": null, + "refs": { + } + }, + "CreateKeyspaceResponse": { + "base": null, + "refs": { + } + }, + "CreateTableRequest": { + "base": null, + "refs": { + } + }, + "CreateTableResponse": { + "base": null, + "refs": { + } + }, + "DefaultTimeToLive": { + "base": null, + "refs": { + "CreateTableRequest$defaultTimeToLive": "The default Time to Live setting in seconds for the table.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
", + "GetTableResponse$defaultTimeToLive": "The default Time to Live settings of the specified table.
", + "UpdateTableRequest$defaultTimeToLive": "The default Time to Live setting in seconds for the table.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
" + } + }, + "DeleteKeyspaceRequest": { + "base": null, + "refs": { + } + }, + "DeleteKeyspaceResponse": { + "base": null, + "refs": { + } + }, + "DeleteTableRequest": { + "base": null, + "refs": { + } + }, + "DeleteTableResponse": { + "base": null, + "refs": { + } + }, + "EncryptionSpecification": { + "base": "Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key. You can choose one of the following KMS keys (KMS keys):
Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge).
Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer managed key (KMS charges apply).
For more information about encryption at rest in Amazon Keyspaces, see Encryption at rest in the Amazon Keyspaces Developer Guide.
For more information about KMS, see KMS management service concepts in the Key Management Service Developer Guide.
", + "refs": { + "CreateTableRequest$encryptionSpecification": "Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):
<ul> <li> <p> <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> </li> <li> <p> <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p> </li> </ul> <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
",
+ "GetTableResponse$encryptionSpecification": "The encryption settings of the specified table.
", + "RestoreTableRequest$encryptionSpecificationOverride": "Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):
<ul> <li> <p> <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> </li> <li> <p> <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p> </li> </ul> <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
",
+ "UpdateTableRequest$encryptionSpecification": "Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):
<ul> <li> <p> <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> </li> <li> <p> <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p> </li> </ul> <p>The default is <code>AWS_OWNED_KMS_KEY</code>. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
"
+ }
+ },
+ "EncryptionType": {
+ "base": null,
+ "refs": {
+ "EncryptionSpecification$type": "The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):
type:AWS_OWNED_KMS_KEY
- This key is owned by Amazon Keyspaces.
type:CUSTOMER_MANAGED_KMS_KEY
- This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier
of the KMS key in Amazon Resource Name (ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
" + } + }, + "GenericString": { + "base": null, + "refs": { + "ClusteringKey$name": "The name(s) of the clustering column(s).
", + "ColumnDefinition$name": "The name of the column.
", + "ColumnDefinition$type": "The data type of the column. For a list of available data types, see Data types in the Amazon Keyspaces Developer Guide.
", + "PartitionKey$name": "The name(s) of the partition key column(s).
", + "StaticColumn$name": "The name of the static column.
" + } + }, + "GetKeyspaceRequest": { + "base": null, + "refs": { + } + }, + "GetKeyspaceResponse": { + "base": null, + "refs": { + } + }, + "GetTableRequest": { + "base": null, + "refs": { + } + }, + "GetTableResponse": { + "base": null, + "refs": { + } + }, + "InternalServerException": { + "base": "Amazon Keyspaces was unable to fully process this request because of an internal server error.
", + "refs": { + } + }, + "KeyspaceName": { + "base": null, + "refs": { + "CreateKeyspaceRequest$keyspaceName": "The name of the keyspace to be created.
", + "CreateTableRequest$keyspaceName": "The name of the keyspace that the table is going to be created in.
", + "DeleteKeyspaceRequest$keyspaceName": "The name of the keyspace to be deleted.
", + "DeleteTableRequest$keyspaceName": "The name of the keyspace of the to be deleted table.
", + "GetKeyspaceRequest$keyspaceName": "The name of the keyspace.
", + "GetKeyspaceResponse$keyspaceName": "The name of the keyspace.
", + "GetTableRequest$keyspaceName": "The name of the keyspace that the table is stored in.
", + "GetTableResponse$keyspaceName": "The name of the keyspace that the specified table is stored in.
", + "KeyspaceSummary$keyspaceName": "The name of the keyspace.
", + "ListTablesRequest$keyspaceName": "The name of the keyspace.
", + "RestoreTableRequest$sourceKeyspaceName": "The keyspace name of the source table.
", + "RestoreTableRequest$targetKeyspaceName": "The name of the target keyspace.
", + "TableSummary$keyspaceName": "The name of the keyspace that the table is stored in.
", + "UpdateTableRequest$keyspaceName": "The name of the keyspace the specified table is stored in.
" + } + }, + "KeyspaceSummary": { + "base": "Represents the properties of a keyspace.
", + "refs": { + "KeyspaceSummaryList$member": null + } + }, + "KeyspaceSummaryList": { + "base": null, + "refs": { + "ListKeyspacesResponse$keyspaces": "A list of keyspaces.
" + } + }, + "ListKeyspacesRequest": { + "base": null, + "refs": { + } + }, + "ListKeyspacesResponse": { + "base": null, + "refs": { + } + }, + "ListTablesRequest": { + "base": null, + "refs": { + } + }, + "ListTablesResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "MaxResults": { + "base": null, + "refs": { + "ListKeyspacesRequest$maxResults": "The total number of keyspaces to return in the output. If the total number of keyspaces available is more than the value specified, a NextToken
is provided in the output. To resume pagination, provide the NextToken
value as an argument of a subsequent API invocation.
The total number of tables to return in the output. If the total number of tables available is more than the value specified, a NextToken
is provided in the output. To resume pagination, provide the NextToken
value as an argument of a subsequent API invocation.
The total number of tags to return in the output. If the total number of tags available is more than the value specified, a NextToken
is provided in the output. To resume pagination, provide the NextToken
value as an argument of a subsequent API invocation.
The pagination token. To resume pagination, provide the NextToken
value as argument of a subsequent API invocation.
A token to specify where to start paginating. This is the NextToken
from a previously truncated response.
The pagination token. To resume pagination, provide the NextToken
value as an argument of a subsequent API invocation.
A token to specify where to start paginating. This is the NextToken
from a previously truncated response.
The pagination token. To resume pagination, provide the NextToken
value as argument of a subsequent API invocation.
A token to specify where to start paginating. This is the NextToken
from a previously truncated response.
The partition key portion of the primary key is required and determines how Amazon Keyspaces stores the data. The partition key can be a single column, or it can be a compound value composed of two or more columns.
", + "refs": { + "PartitionKeyList$member": null + } + }, + "PartitionKeyList": { + "base": null, + "refs": { + "SchemaDefinition$partitionKeys": "The columns that are part of the partition key of the table .
" + } + }, + "PointInTimeRecovery": { + "base": "Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from accidental write or delete operations by providing you continuous backups of your table data.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
", + "refs": { + "CreateTableRequest$pointInTimeRecovery": " Specifies if pointInTimeRecovery
is enabled or disabled for the table. The options are:
ENABLED
DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
", + "RestoreTableRequest$pointInTimeRecoveryOverride": " Specifies the pointInTimeRecovery
settings for the target table. The options are:
ENABLED
DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
", + "UpdateTableRequest$pointInTimeRecovery": " Modifies the pointInTimeRecovery
settings of the table. The options are:
ENABLED
DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
" + } + }, + "PointInTimeRecoveryStatus": { + "base": null, + "refs": { + "PointInTimeRecovery$status": "The options are:
ENABLED
DISABLED
Shows if point-in-time recovery is enabled or disabled for the specified table.
" + } + }, + "PointInTimeRecoverySummary": { + "base": "The point-in-time recovery status of the specified table.
", + "refs": { + "GetTableResponse$pointInTimeRecovery": "The point-in-time recovery status of the specified table.
" + } + }, + "ResourceNotFoundException": { + "base": "The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE
.
Describes the schema of the table.
", + "refs": { + "CreateTableRequest$schemaDefinition": "The schemaDefinition
consists of the following parameters.
For each column to be created:
name
- The name of the column.
type
- An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.
<p>The primary key of the table consists of the following columns:</p> <ul> <li> <p> <code>partitionKeys</code> - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data.</p> <ul> <li> <p> <i> <code>name</code> </i> - The name of each partition key column.</p> </li> </ul> </li> <li> <p> <code>clusteringKeys</code> - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.</p> <ul> <li> <p> <i> <code>name</code> </i> - The name of the clustering column. </p> </li> <li> <p> <i> <code>orderBy</code> </i> - Sets the ascendant (<code>ASC</code>) or descendant (<code>DESC</code>) order modifier.</p> </li> </ul> </li> </ul> <p>To define a column as static use <code> <i>staticColumns</i> </code> - Static columns store values that are shared by all rows in the same partition:</p> <ul> <li> <p> <i> <code>name</code> </i> - The name of the column.</p> </li> <li> <p> <code> <i>type</i> </code> - An Amazon Keyspaces data type.</p> </li> </ul>
",
+ "GetTableResponse$schemaDefinition": "The schema definition of the specified table.
" + } + }, + "ServiceQuotaExceededException": { + "base": "The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
", + "refs": { + } + }, + "SortOrder": { + "base": null, + "refs": { + "ClusteringKey$orderBy": "Sets the ascendant (ASC
) or descendant (DESC
) order modifier.
The static columns of the table. Static columns store values that are shared by all rows in the same partition.
", + "refs": { + "StaticColumnList$member": null + } + }, + "StaticColumnList": { + "base": null, + "refs": { + "SchemaDefinition$staticColumns": "The columns that have been defined as STATIC
. Static columns store values that are shared by all rows in the same partition.
An optional description of the table.
", + "ConflictException$message": null, + "InternalServerException$message": null, + "ResourceNotFoundException$message": null, + "ServiceQuotaExceededException$message": null, + "ValidationException$message": null + } + }, + "TableName": { + "base": null, + "refs": { + "CreateTableRequest$tableName": "The name of the table.
", + "DeleteTableRequest$tableName": "The name of the table to be deleted.
", + "GetTableRequest$tableName": "The name of the table.
", + "GetTableResponse$tableName": "The name of the specified table.
", + "RestoreTableRequest$sourceTableName": "The name of the source table.
", + "RestoreTableRequest$targetTableName": "The name of the target table.
", + "TableSummary$tableName": "The name of the table.
", + "UpdateTableRequest$tableName": "The name of the table.
" + } + }, + "TableStatus": { + "base": null, + "refs": { + "GetTableResponse$status": "The current status of the specified table.
" + } + }, + "TableSummary": { + "base": "Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN).
", + "refs": { + "TableSummaryList$member": null + } + }, + "TableSummaryList": { + "base": null, + "refs": { + "ListTablesResponse$tables": "A list of tables.
" + } + }, + "Tag": { + "base": "Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.
Amazon Web Services-assigned tag names and values are automatically assigned the aws:
prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user:
in the Cost Allocation Report. You cannot backdate the application of a tag.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$key": "The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
" + } + }, + "TagList": { + "base": null, + "refs": { + "CreateKeyspaceRequest$tags": "A list of key-value pair tags to be attached to the keyspace.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
", + "CreateTableRequest$tags": "A list of key-value pair tags to be attached to the resource.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
", + "ListTagsForResourceResponse$tags": "A list of tags.
", + "RestoreTableRequest$tagsOverride": "A list of key-value pair tags to be attached to the restored table.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
", + "TagResourceRequest$tags": "The tags to be assigned to the Amazon Keyspaces resource.
", + "UntagResourceRequest$tags": "A list of existing tags to be removed from the Amazon Keyspaces resource.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$value": "The value of the tag. Tag values are case-sensitive and can be null.
" + } + }, + "ThroughputMode": { + "base": null, + "refs": { + "CapacitySpecification$throughputMode": "The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUEST
and
throughputMode:PROVISIONED
. The provisioned capacity mode requires readCapacityUnits
and writeCapacityUnits
as inputs.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
", + "CapacitySpecificationSummary$throughputMode": "The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUEST
and
throughputMode:PROVISIONED
. The provisioned capacity mode requires readCapacityUnits
and writeCapacityUnits
as inputs.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
" + } + }, + "TimeToLive": { + "base": "Enable custom Time to Live (TTL) settings for rows and columns without setting a TTL default for the specified table.
For more information, see Enabling TTL on tables in the Amazon Keyspaces Developer Guide.
", + "refs": { + "CreateTableRequest$ttl": "Enables Time to Live custom settings for the table. The options are:
status:enabled
status:disabled
The default is status:disabled
. After ttl
is enabled, you can't disable it for the table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
", + "GetTableResponse$ttl": "The custom Time to Live settings of the specified table.
", + "UpdateTableRequest$ttl": "Modifies Time to Live custom settings for the table. The options are:
status:enabled
status:disabled
The default is status:disabled
. After ttl
is enabled, you can't disable it for the table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
" + } + }, + "TimeToLiveStatus": { + "base": null, + "refs": { + "TimeToLive$status": "Shows how to enable custom Time to Live (TTL) settings for the specified table.
" + } + }, + "Timestamp": { + "base": null, + "refs": { + "CapacitySpecificationSummary$lastUpdateToPayPerRequestTimestamp": "The timestamp of the last operation that changed the provisioned throughput capacity of a table.
", + "GetTableResponse$creationTimestamp": "The creation timestamp of the specified table.
", + "PointInTimeRecoverySummary$earliestRestorableTimestamp": "Specifies the earliest possible restore point of the table in ISO 8601 format.
", + "RestoreTableRequest$restoreTimestamp": "The restore timestamp in ISO 8601 format.
" + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "UpdateTableRequest": { + "base": null, + "refs": { + } + }, + "UpdateTableResponse": { + "base": null, + "refs": { + } + }, + "ValidationException": { + "base": "The operation failed due to an invalid or malformed request.
", + "refs": { + } + }, + "kmsKeyARN": { + "base": null, + "refs": { + "EncryptionSpecification$kmsKeyIdentifier": "The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN
.
The read/write capacity mode that you choose controls how you are +// charged for read and write throughput and how table throughput capacity +// is managed.
For more information, see Read/write +// capacity modes in the Amazon Keyspaces Developer Guide.
+type CapacitySpecification struct { + _ struct{} `type:"structure"` + + // The throughput capacity specified for read operations defined in read capacity + // units (RCUs). + ReadCapacityUnits *int64 `locationName:"readCapacityUnits" min:"1" type:"long"` + + // The read/write throughput capacity mode for a table. The options are: + // + // * throughputMode:PAY_PER_REQUEST and + // + // * throughputMode:PROVISIONED. The provisioned capacity mode requires readCapacityUnits + // and writeCapacityUnits as inputs. + // + // The default is throughput_mode:PAY_PER_REQUEST. + // + // For more information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) + // in the Amazon Keyspaces Developer Guide. + // + // ThroughputMode is a required field + ThroughputMode *string `locationName:"throughputMode" type:"string" required:"true" enum:"ThroughputMode"` + + // The throughput capacity specified for write operations defined in write capacity + // units (WCUs). + WriteCapacityUnits *int64 `locationName:"writeCapacityUnits" min:"1" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CapacitySpecification) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CapacitySpecification) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CapacitySpecification) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CapacitySpecification"} + if s.ReadCapacityUnits != nil && *s.ReadCapacityUnits < 1 { + invalidParams.Add(request.NewErrParamMinValue("ReadCapacityUnits", 1)) + } + if s.ThroughputMode == nil { + invalidParams.Add(request.NewErrParamRequired("ThroughputMode")) + } + if s.WriteCapacityUnits != nil && *s.WriteCapacityUnits < 1 { + invalidParams.Add(request.NewErrParamMinValue("WriteCapacityUnits", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetReadCapacityUnits sets the ReadCapacityUnits field's value. +func (s *CapacitySpecification) SetReadCapacityUnits(v int64) *CapacitySpecification { + s.ReadCapacityUnits = &v + return s +} + +// SetThroughputMode sets the ThroughputMode field's value. +func (s *CapacitySpecification) SetThroughputMode(v string) *CapacitySpecification { + s.ThroughputMode = &v + return s +} + +// SetWriteCapacityUnits sets the WriteCapacityUnits field's value. +func (s *CapacitySpecification) SetWriteCapacityUnits(v int64) *CapacitySpecification { + s.WriteCapacityUnits = &v + return s +} + +// The read/write throughput capacity mode for a table. The options are: +// +// * throughputMode:PAY_PER_REQUEST and +// +// * throughputMode:PROVISIONED. +// +// For more information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) +// in the Amazon Keyspaces Developer Guide. +type CapacitySpecificationSummary struct { + _ struct{} `type:"structure"` + + // The timestamp of the last operation that changed the provisioned throughput + // capacity of a table. + LastUpdateToPayPerRequestTimestamp *time.Time `locationName:"lastUpdateToPayPerRequestTimestamp" type:"timestamp"` + + // The throughput capacity specified for read operations defined in read capacity + // units (RCUs). + ReadCapacityUnits *int64 `locationName:"readCapacityUnits" min:"1" type:"long"` + + // The read/write throughput capacity mode for a table. The options are: + // + // * throughputMode:PAY_PER_REQUEST and + // + // * throughputMode:PROVISIONED. The provisioned capacity mode requires readCapacityUnits + // and writeCapacityUnits as inputs. + // + // The default is throughput_mode:PAY_PER_REQUEST. + // + // For more information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) + // in the Amazon Keyspaces Developer Guide. + // + // ThroughputMode is a required field + ThroughputMode *string `locationName:"throughputMode" type:"string" required:"true" enum:"ThroughputMode"` + + // The throughput capacity specified for write operations defined in write capacity + // units (WCUs). + WriteCapacityUnits *int64 `locationName:"writeCapacityUnits" min:"1" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CapacitySpecificationSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CapacitySpecificationSummary) GoString() string { + return s.String() +} + +// SetLastUpdateToPayPerRequestTimestamp sets the LastUpdateToPayPerRequestTimestamp field's value. +func (s *CapacitySpecificationSummary) SetLastUpdateToPayPerRequestTimestamp(v time.Time) *CapacitySpecificationSummary { + s.LastUpdateToPayPerRequestTimestamp = &v + return s +} + +// SetReadCapacityUnits sets the ReadCapacityUnits field's value. +func (s *CapacitySpecificationSummary) SetReadCapacityUnits(v int64) *CapacitySpecificationSummary { + s.ReadCapacityUnits = &v + return s +} + +// SetThroughputMode sets the ThroughputMode field's value. +func (s *CapacitySpecificationSummary) SetThroughputMode(v string) *CapacitySpecificationSummary { + s.ThroughputMode = &v + return s +} + +// SetWriteCapacityUnits sets the WriteCapacityUnits field's value. +func (s *CapacitySpecificationSummary) SetWriteCapacityUnits(v int64) *CapacitySpecificationSummary { + s.WriteCapacityUnits = &v + return s +} + +// The optional clustering column portion of your primary key determines how +// the data is clustered and sorted within each partition. +type ClusteringKey struct { + _ struct{} `type:"structure"` + + // The name(s) of the clustering column(s). + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // Sets the ascendant (ASC) or descendant (DESC) order modifier. + // + // OrderBy is a required field + OrderBy *string `locationName:"orderBy" type:"string" required:"true" enum:"SortOrder"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ClusteringKey) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ClusteringKey) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ClusteringKey) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ClusteringKey"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.OrderBy == nil { + invalidParams.Add(request.NewErrParamRequired("OrderBy")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *ClusteringKey) SetName(v string) *ClusteringKey { + s.Name = &v + return s +} + +// SetOrderBy sets the OrderBy field's value. +func (s *ClusteringKey) SetOrderBy(v string) *ClusteringKey { + s.OrderBy = &v + return s +} + +// The names and data types of regular columns. +type ColumnDefinition struct { + _ struct{} `type:"structure"` + + // The name of the column. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // The data type of the column. For a list of available data types, see Data + // types (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) + // in the Amazon Keyspaces Developer Guide. + // + // Type is a required field + Type *string `locationName:"type" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ColumnDefinition) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ColumnDefinition) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ColumnDefinition) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ColumnDefinition"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *ColumnDefinition) SetName(v string) *ColumnDefinition { + s.Name = &v + return s +} + +// SetType sets the Type field's value. +func (s *ColumnDefinition) SetType(v string) *ColumnDefinition { + s.Type = &v + return s +} + +// An optional comment that describes the table. +type Comment struct { + _ struct{} `type:"structure"` + + // An optional description of the table. + // + // Message is a required field + Message *string `locationName:"message" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Comment) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Comment) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Comment) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Comment"} + if s.Message == nil { + invalidParams.Add(request.NewErrParamRequired("Message")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMessage sets the Message field's value. +func (s *Comment) SetMessage(v string) *Comment { + s.Message = &v + return s +} + +// Amazon Keyspaces could not complete the requested action. This error may +// occur if you try to perform an action and the same or a different action +// is already in progress, or if you try to create a resource that already exists. +type ConflictException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) GoString() string { + return s.String() +} + +func newErrorConflictException(v protocol.ResponseMetadata) error { + return &ConflictException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ConflictException) Code() string { + return "ConflictException" +} + +// Message returns the exception's message. +func (s *ConflictException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ConflictException) OrigErr() error { + return nil +} + +func (s *ConflictException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ConflictException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ConflictException) RequestID() string { + return s.RespMetadata.RequestID +} + +type CreateKeyspaceInput struct { + _ struct{} `type:"structure"` + + // The name of the keyspace to be created. + // + // KeyspaceName is a required field + KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"` + + // A list of key-value pair tags to be attached to the keyspace. + // + // For more information, see Adding tags and labels to Amazon Keyspaces resources + // (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) + // in the Amazon Keyspaces Developer Guide. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateKeyspaceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateKeyspaceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateKeyspaceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateKeyspaceInput"} + if s.KeyspaceName == nil { + invalidParams.Add(request.NewErrParamRequired("KeyspaceName")) + } + if s.KeyspaceName != nil && len(*s.KeyspaceName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KeyspaceName", 1)) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKeyspaceName sets the KeyspaceName field's value. +func (s *CreateKeyspaceInput) SetKeyspaceName(v string) *CreateKeyspaceInput { + s.KeyspaceName = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateKeyspaceInput) SetTags(v []*Tag) *CreateKeyspaceInput { + s.Tags = v + return s +} + +type CreateKeyspaceOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the keyspace in the format of an Amazon Resource + // Name (ARN). + // + // ResourceArn is a required field + ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateKeyspaceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateKeyspaceOutput) GoString() string { + return s.String() +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *CreateKeyspaceOutput) SetResourceArn(v string) *CreateKeyspaceOutput { + s.ResourceArn = &v + return s +} + +type CreateTableInput struct { + _ struct{} `type:"structure"` + + // Specifies the read/write throughput capacity mode for the table. The options + // are: + // + // * throughputMode:PAY_PER_REQUEST and + // + // * throughputMode:PROVISIONED. The provisioned capacity mode requires readCapacityUnits + // and writeCapacityUnits as inputs. + // + // The default is throughput_mode:PAY_PER_REQUEST. + // + // For more information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) + // in the Amazon Keyspaces Developer Guide. + CapacitySpecification *CapacitySpecification `locationName:"capacitySpecification" type:"structure"` + + // This parameter allows to enter a description of the table. + Comment *Comment `locationName:"comment" type:"structure"` + + // The default Time to Live setting in seconds for the table. + // + // For more information, see Setting the default TTL value for a table (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl) + // in the Amazon Keyspaces Developer Guide. + DefaultTimeToLive *int64 `locationName:"defaultTimeToLive" min:"1" type:"integer"` + + // Specifies how the encryption key for encryption at rest is managed for the + // table. You can choose one of the following KMS key (KMS key): + // + // type:AWS_OWNED_KMS_KEY
- This key is owned
+ // by Amazon Keyspaces.
type:CUSTOMER_MANAGED_KMS_KEY
+ // - This key is stored in your account and is created, owned, and managed
+ // by you. This option requires the kms_key_identifier
of the
+ // KMS key in Amazon Resource Name (ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY
.
For more + // information, see Encryption + // at rest in the Amazon Keyspaces Developer Guide.
+ EncryptionSpecification *EncryptionSpecification `locationName:"encryptionSpecification" type:"structure"` + + // The name of the keyspace that the table is going to be created in. + // + // KeyspaceName is a required field + KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"` + + // Specifies if pointInTimeRecovery is enabled or disabled for the table. The + // options are: + // + // * ENABLED + // + // * DISABLED + // + // If it's not specified, the default is DISABLED. + // + // For more information, see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) + // in the Amazon Keyspaces Developer Guide. + PointInTimeRecovery *PointInTimeRecovery `locationName:"pointInTimeRecovery" type:"structure"` + + // The schemaDefinition consists of the following parameters. + // + // For each column to be created: + // + // * name - The name of the column. + // + // * type - An Amazon Keyspaces data type. For more information, see Data + // types (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) + // in the Amazon Keyspaces Developer Guide. + // + //The primary key of the table consists of the following columns:
+ // partitionKeys
- The partition key can be a
+ // single column, or it can be a compound value composed of two or more columns.
+ // The partition key portion of the primary key is required and determines
+ // how Amazon Keyspaces stores your data.
name
+ // - The name of each partition key column.
clusteringKeys
- The optional clustering column portion
+ // of your primary key determines how the data is clustered and sorted within
+ // each partition.
name
- The name
+ // of the clustering column.
orderBy
+ // - Sets the ascendant (ASC
) or descendant (DESC
)
+ // order modifier.
To define a column as static
+ // use staticColumns
- Static columns store values
+ // that are shared by all rows in the same partition:
+ // name
- The name of the column.
+ // type
- An Amazon Keyspaces data type.
type:AWS_OWNED_KMS_KEY
- This key is owned
+ // by Amazon Keyspaces.
type:CUSTOMER_MANAGED_KMS_KEY
+ // - This key is stored in your account and is created, owned, and managed
+ // by you. This option requires the kms_key_identifier
of the
+ // KMS key in Amazon Resource Name (ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY
.
For more + // information, see Encryption + // at rest in the Amazon Keyspaces Developer Guide.
+ EncryptionSpecificationOverride *EncryptionSpecification `locationName:"encryptionSpecificationOverride" type:"structure"` + + // Specifies the pointInTimeRecovery settings for the target table. The options + // are: + // + // * ENABLED + // + // * DISABLED + // + // If it's not specified, the default is DISABLED. + // + // For more information, see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) + // in the Amazon Keyspaces Developer Guide. + PointInTimeRecoveryOverride *PointInTimeRecovery `locationName:"pointInTimeRecoveryOverride" type:"structure"` + + // The restore timestamp in ISO 8601 format. + RestoreTimestamp *time.Time `locationName:"restoreTimestamp" type:"timestamp"` + + // The keyspace name of the source table. + // + // SourceKeyspaceName is a required field + SourceKeyspaceName *string `locationName:"sourceKeyspaceName" min:"1" type:"string" required:"true"` + + // The name of the source table. + // + // SourceTableName is a required field + SourceTableName *string `locationName:"sourceTableName" min:"1" type:"string" required:"true"` + + // A list of key-value pair tags to be attached to the restored table. + // + // For more information, see Adding tags and labels to Amazon Keyspaces resources + // (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) + // in the Amazon Keyspaces Developer Guide. + TagsOverride []*Tag `locationName:"tagsOverride" min:"1" type:"list"` + + // The name of the target keyspace. + // + // TargetKeyspaceName is a required field + TargetKeyspaceName *string `locationName:"targetKeyspaceName" min:"1" type:"string" required:"true"` + + // The name of the target table. + // + // TargetTableName is a required field + TargetTableName *string `locationName:"targetTableName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RestoreTableInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RestoreTableInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RestoreTableInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RestoreTableInput"} + if s.SourceKeyspaceName == nil { + invalidParams.Add(request.NewErrParamRequired("SourceKeyspaceName")) + } + if s.SourceKeyspaceName != nil && len(*s.SourceKeyspaceName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourceKeyspaceName", 1)) + } + if s.SourceTableName == nil { + invalidParams.Add(request.NewErrParamRequired("SourceTableName")) + } + if s.SourceTableName != nil && len(*s.SourceTableName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourceTableName", 1)) + } + if s.TagsOverride != nil && len(s.TagsOverride) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TagsOverride", 1)) + } + if s.TargetKeyspaceName == nil { + invalidParams.Add(request.NewErrParamRequired("TargetKeyspaceName")) + } + if s.TargetKeyspaceName != nil && len(*s.TargetKeyspaceName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TargetKeyspaceName", 1)) + } + if s.TargetTableName == nil { + invalidParams.Add(request.NewErrParamRequired("TargetTableName")) + } + if s.TargetTableName != nil && len(*s.TargetTableName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TargetTableName", 1)) + } + if s.CapacitySpecificationOverride != nil { + if err := s.CapacitySpecificationOverride.Validate(); err != nil { + invalidParams.AddNested("CapacitySpecificationOverride", err.(request.ErrInvalidParams)) + } + } + if s.EncryptionSpecificationOverride != nil { + if err := s.EncryptionSpecificationOverride.Validate(); err != nil { + invalidParams.AddNested("EncryptionSpecificationOverride", err.(request.ErrInvalidParams)) + } + } + if s.PointInTimeRecoveryOverride != nil { + if err := s.PointInTimeRecoveryOverride.Validate(); err != nil { + invalidParams.AddNested("PointInTimeRecoveryOverride", err.(request.ErrInvalidParams)) + } + } + if s.TagsOverride != nil { + for i, v := range s.TagsOverride { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "TagsOverride", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCapacitySpecificationOverride sets the CapacitySpecificationOverride field's value. +func (s *RestoreTableInput) SetCapacitySpecificationOverride(v *CapacitySpecification) *RestoreTableInput { + s.CapacitySpecificationOverride = v + return s +} + +// SetEncryptionSpecificationOverride sets the EncryptionSpecificationOverride field's value. +func (s *RestoreTableInput) SetEncryptionSpecificationOverride(v *EncryptionSpecification) *RestoreTableInput { + s.EncryptionSpecificationOverride = v + return s +} + +// SetPointInTimeRecoveryOverride sets the PointInTimeRecoveryOverride field's value. +func (s *RestoreTableInput) SetPointInTimeRecoveryOverride(v *PointInTimeRecovery) *RestoreTableInput { + s.PointInTimeRecoveryOverride = v + return s +} + +// SetRestoreTimestamp sets the RestoreTimestamp field's value. +func (s *RestoreTableInput) SetRestoreTimestamp(v time.Time) *RestoreTableInput { + s.RestoreTimestamp = &v + return s +} + +// SetSourceKeyspaceName sets the SourceKeyspaceName field's value. +func (s *RestoreTableInput) SetSourceKeyspaceName(v string) *RestoreTableInput { + s.SourceKeyspaceName = &v + return s +} + +// SetSourceTableName sets the SourceTableName field's value. +func (s *RestoreTableInput) SetSourceTableName(v string) *RestoreTableInput { + s.SourceTableName = &v + return s +} + +// SetTagsOverride sets the TagsOverride field's value. +func (s *RestoreTableInput) SetTagsOverride(v []*Tag) *RestoreTableInput { + s.TagsOverride = v + return s +} + +// SetTargetKeyspaceName sets the TargetKeyspaceName field's value. +func (s *RestoreTableInput) SetTargetKeyspaceName(v string) *RestoreTableInput { + s.TargetKeyspaceName = &v + return s +} + +// SetTargetTableName sets the TargetTableName field's value. +func (s *RestoreTableInput) SetTargetTableName(v string) *RestoreTableInput { + s.TargetTableName = &v + return s +} + +type RestoreTableOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the restored table. + // + // RestoredTableARN is a required field + RestoredTableARN *string `locationName:"restoredTableARN" min:"20" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RestoreTableOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RestoreTableOutput) GoString() string { + return s.String() +} + +// SetRestoredTableARN sets the RestoredTableARN field's value. +func (s *RestoreTableOutput) SetRestoredTableARN(v string) *RestoreTableOutput { + s.RestoredTableARN = &v + return s +} + +// Describes the schema of the table. +type SchemaDefinition struct { + _ struct{} `type:"structure"` + + // The regular columns of the table. + // + // AllColumns is a required field + AllColumns []*ColumnDefinition `locationName:"allColumns" min:"1" type:"list" required:"true"` + + // The columns that are part of the clustering key of the table. + ClusteringKeys []*ClusteringKey `locationName:"clusteringKeys" type:"list"` + + // The columns that are part of the partition key of the table . + // + // PartitionKeys is a required field + PartitionKeys []*PartitionKey `locationName:"partitionKeys" min:"1" type:"list" required:"true"` + + // The columns that have been defined as STATIC. Static columns store values + // that are shared by all rows in the same partition. + StaticColumns []*StaticColumn `locationName:"staticColumns" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SchemaDefinition) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SchemaDefinition) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SchemaDefinition) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SchemaDefinition"} + if s.AllColumns == nil { + invalidParams.Add(request.NewErrParamRequired("AllColumns")) + } + if s.AllColumns != nil && len(s.AllColumns) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AllColumns", 1)) + } + if s.PartitionKeys == nil { + invalidParams.Add(request.NewErrParamRequired("PartitionKeys")) + } + if s.PartitionKeys != nil && len(s.PartitionKeys) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PartitionKeys", 1)) + } + if s.AllColumns != nil { + for i, v := range s.AllColumns { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AllColumns", i), err.(request.ErrInvalidParams)) + } + } + } + if s.ClusteringKeys != nil { + for i, v := range s.ClusteringKeys { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ClusteringKeys", i), err.(request.ErrInvalidParams)) + } + } + } + if s.PartitionKeys != nil { + for i, v := range s.PartitionKeys { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "PartitionKeys", i), err.(request.ErrInvalidParams)) + } + } + } + if s.StaticColumns != nil { + for i, v := range s.StaticColumns { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "StaticColumns", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAllColumns sets the AllColumns field's value. +func (s *SchemaDefinition) SetAllColumns(v []*ColumnDefinition) *SchemaDefinition { + s.AllColumns = v + return s +} + +// SetClusteringKeys sets the ClusteringKeys field's value. +func (s *SchemaDefinition) SetClusteringKeys(v []*ClusteringKey) *SchemaDefinition { + s.ClusteringKeys = v + return s +} + +// SetPartitionKeys sets the PartitionKeys field's value. +func (s *SchemaDefinition) SetPartitionKeys(v []*PartitionKey) *SchemaDefinition { + s.PartitionKeys = v + return s +} + +// SetStaticColumns sets the StaticColumns field's value. +func (s *SchemaDefinition) SetStaticColumns(v []*StaticColumn) *SchemaDefinition { + s.StaticColumns = v + return s +} + +// The operation exceeded the service quota for this resource. For more information +// on service quotas, see Quotas (https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html) +// in the Amazon Keyspaces Developer Guide. +type ServiceQuotaExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) GoString() string { + return s.String() +} + +func newErrorServiceQuotaExceededException(v protocol.ResponseMetadata) error { + return &ServiceQuotaExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ServiceQuotaExceededException) Code() string { + return "ServiceQuotaExceededException" +} + +// Message returns the exception's message. +func (s *ServiceQuotaExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ServiceQuotaExceededException) OrigErr() error { + return nil +} + +func (s *ServiceQuotaExceededException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ServiceQuotaExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ServiceQuotaExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The static columns of the table. Static columns store values that are shared +// by all rows in the same partition. +type StaticColumn struct { + _ struct{} `type:"structure"` + + // The name of the static column. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StaticColumn) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StaticColumn) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StaticColumn) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StaticColumn"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *StaticColumn) SetName(v string) *StaticColumn { + s.Name = &v + return s +} + +// Returns the name of the specified table, the keyspace it is stored in, and +// the unique identifier in the format of an Amazon Resource Name (ARN). +type TableSummary struct { + _ struct{} `type:"structure"` + + // The name of the keyspace that the table is stored in. + // + // KeyspaceName is a required field + KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"` + + // The unique identifier of the table in the format of an Amazon Resource Name + // (ARN). + // + // ResourceArn is a required field + ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"` + + // The name of the table. + // + // TableName is a required field + TableName *string `locationName:"tableName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TableSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TableSummary) GoString() string { + return s.String() +} + +// SetKeyspaceName sets the KeyspaceName field's value. +func (s *TableSummary) SetKeyspaceName(v string) *TableSummary { + s.KeyspaceName = &v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TableSummary) SetResourceArn(v string) *TableSummary { + s.ResourceArn = &v + return s +} + +// SetTableName sets the TableName field's value. +func (s *TableSummary) SetTableName(v string) *TableSummary { + s.TableName = &v + return s +} + +// Describes a tag. A tag is a key-value pair. You can add up to 50 tags to +// a single Amazon Keyspaces resource. +// +// Amazon Web Services-assigned tag names and values are automatically assigned +// the aws: prefix, which the user cannot assign. Amazon Web Services-assigned +// tag names do not count towards the tag limit of 50. User-assigned tag names +// have the prefix user: in the Cost Allocation Report. You cannot backdate +// the application of a tag. +// +// For more information, see Adding tags and labels to Amazon Keyspaces resources +// (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) +// in the Amazon Keyspaces Developer Guide. +type Tag struct { + _ struct{} `type:"structure"` + + // The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource + // can only have up to one tag with the same key. If you try to add an existing + // tag (same key), the existing tag value will be updated to the new value. + // + // Key is a required field + Key *string `locationName:"key" min:"1" type:"string" required:"true"` + + // The value of the tag. Tag values are case-sensitive and can be null. + // + // Value is a required field + Value *string `locationName:"value" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Tag) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Tag) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Tag) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Tag"} + if s.Key == nil { + invalidParams.Add(request.NewErrParamRequired("Key")) + } + if s.Key != nil && len(*s.Key) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Key", 1)) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + if s.Value != nil && len(*s.Value) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Value", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKey sets the Key field's value. +func (s *Tag) SetKey(v string) *Tag { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *Tag) SetValue(v string) *Tag { + s.Value = &v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which + // to add tags. + // + // ResourceArn is a required field + ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"` + + // The tags to be assigned to the Amazon Keyspaces resource. + // + // Tags is a required field + Tags []*Tag `locationName:"tags" min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 20)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) GoString() string { + return s.String() +} + +// Enable custom Time to Live (TTL) settings for rows and columns without setting +// a TTL default for the specified table. +// +// For more information, see Enabling TTL on tables (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_enabling) +// in the Amazon Keyspaces Developer Guide. +type TimeToLive struct { + _ struct{} `type:"structure"` + + // Shows how to enable custom Time to Live (TTL) settings for the specified + // table. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"TimeToLiveStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TimeToLive) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TimeToLive) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TimeToLive) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TimeToLive"} + if s.Status == nil { + invalidParams.Add(request.NewErrParamRequired("Status")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetStatus sets the Status field's value. +func (s *TimeToLive) SetStatus(v string) *TimeToLive { + s.Status = &v + return s +} + +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Keyspaces resource that the tags will be removed from. This value + // is an Amazon Resource Name (ARN). + // + // ResourceArn is a required field + ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"` + + // A list of existing tags to be removed from the Amazon Keyspaces resource. + // + // Tags is a required field + Tags []*Tag `locationName:"tags" min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 20)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *UntagResourceInput) SetTags(v []*Tag) *UntagResourceInput { + s.Tags = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +type UpdateTableInput struct { + _ struct{} `type:"structure"` + + // For each column to be added to the specified table: + // + // * name - The name of the column. + // + // * type - An Amazon Keyspaces data type. For more information, see Data + // types (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) + // in the Amazon Keyspaces Developer Guide. + AddColumns []*ColumnDefinition `locationName:"addColumns" min:"1" type:"list"` + + // Modifies the read/write throughput capacity mode for the table. The options + // are: + // + // * throughputMode:PAY_PER_REQUEST and + // + // * throughputMode:PROVISIONED. The provisioned capacity mode requires readCapacityUnits + // and writeCapacityUnits as inputs. + // + // The default is throughput_mode:PAY_PER_REQUEST. + // + // For more information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) + // in the Amazon Keyspaces Developer Guide. + CapacitySpecification *CapacitySpecification `locationName:"capacitySpecification" type:"structure"` + + // The default Time to Live setting in seconds for the table. + // + // For more information, see Setting the default TTL value for a table (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl) + // in the Amazon Keyspaces Developer Guide. + DefaultTimeToLive *int64 `locationName:"defaultTimeToLive" min:"1" type:"integer"` + + // Modifies the encryption settings of the table. You can choose one of the + // following KMS key (KMS key): + // + // type:AWS_OWNED_KMS_KEY
- This key is owned
+ // by Amazon Keyspaces.
type:CUSTOMER_MANAGED_KMS_KEY
+ // - This key is stored in your account and is created, owned, and managed
+ // by you. This option requires the kms_key_identifier
of the
+ // KMS key in Amazon Resource Name (ARN) format as input.
The default is AWS_OWNED_KMS_KEY
.
For more information, + // see Encryption + // at rest in the Amazon Keyspaces Developer Guide.
+ EncryptionSpecification *EncryptionSpecification `locationName:"encryptionSpecification" type:"structure"` + + // The name of the keyspace the specified table is stored in. + // + // KeyspaceName is a required field + KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"` + + // Modifies the pointInTimeRecovery settings of the table. The options are: + // + // * ENABLED + // + // * DISABLED + // + // If it's not specified, the default is DISABLED. + // + // For more information, see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) + // in the Amazon Keyspaces Developer Guide. + PointInTimeRecovery *PointInTimeRecovery `locationName:"pointInTimeRecovery" type:"structure"` + + // The name of the table. + // + // TableName is a required field + TableName *string `locationName:"tableName" min:"1" type:"string" required:"true"` + + // Modifies Time to Live custom settings for the table. The options are: + // + // * status:enabled + // + // * status:disabled + // + // The default is status:disabled. After ttl is enabled, you can't disable it + // for the table. + // + // For more information, see Expiring data by using Amazon Keyspaces Time to + // Live (TTL) (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html) + // in the Amazon Keyspaces Developer Guide. + Ttl *TimeToLive `locationName:"ttl" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateTableInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateTableInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateTableInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateTableInput"} + if s.AddColumns != nil && len(s.AddColumns) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AddColumns", 1)) + } + if s.DefaultTimeToLive != nil && *s.DefaultTimeToLive < 1 { + invalidParams.Add(request.NewErrParamMinValue("DefaultTimeToLive", 1)) + } + if s.KeyspaceName == nil { + invalidParams.Add(request.NewErrParamRequired("KeyspaceName")) + } + if s.KeyspaceName != nil && len(*s.KeyspaceName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KeyspaceName", 1)) + } + if s.TableName == nil { + invalidParams.Add(request.NewErrParamRequired("TableName")) + } + if s.TableName != nil && len(*s.TableName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TableName", 1)) + } + if s.AddColumns != nil { + for i, v := range s.AddColumns { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AddColumns", i), err.(request.ErrInvalidParams)) + } + } + } + if s.CapacitySpecification != nil { + if err := s.CapacitySpecification.Validate(); err != nil { + invalidParams.AddNested("CapacitySpecification", err.(request.ErrInvalidParams)) + } + } + if s.EncryptionSpecification != nil { + if err := s.EncryptionSpecification.Validate(); err != nil { + invalidParams.AddNested("EncryptionSpecification", err.(request.ErrInvalidParams)) + } + } + if s.PointInTimeRecovery != nil { + if err := s.PointInTimeRecovery.Validate(); err != nil { + invalidParams.AddNested("PointInTimeRecovery", err.(request.ErrInvalidParams)) + } + } + if s.Ttl != nil { + if err := s.Ttl.Validate(); err != nil { + invalidParams.AddNested("Ttl", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAddColumns sets the AddColumns field's value. +func (s *UpdateTableInput) SetAddColumns(v []*ColumnDefinition) *UpdateTableInput { + s.AddColumns = v + return s +} + +// SetCapacitySpecification sets the CapacitySpecification field's value. +func (s *UpdateTableInput) SetCapacitySpecification(v *CapacitySpecification) *UpdateTableInput { + s.CapacitySpecification = v + return s +} + +// SetDefaultTimeToLive sets the DefaultTimeToLive field's value. +func (s *UpdateTableInput) SetDefaultTimeToLive(v int64) *UpdateTableInput { + s.DefaultTimeToLive = &v + return s +} + +// SetEncryptionSpecification sets the EncryptionSpecification field's value. +func (s *UpdateTableInput) SetEncryptionSpecification(v *EncryptionSpecification) *UpdateTableInput { + s.EncryptionSpecification = v + return s +} + +// SetKeyspaceName sets the KeyspaceName field's value. +func (s *UpdateTableInput) SetKeyspaceName(v string) *UpdateTableInput { + s.KeyspaceName = &v + return s +} + +// SetPointInTimeRecovery sets the PointInTimeRecovery field's value. +func (s *UpdateTableInput) SetPointInTimeRecovery(v *PointInTimeRecovery) *UpdateTableInput { + s.PointInTimeRecovery = v + return s +} + +// SetTableName sets the TableName field's value. +func (s *UpdateTableInput) SetTableName(v string) *UpdateTableInput { + s.TableName = &v + return s +} + +// SetTtl sets the Ttl field's value. +func (s *UpdateTableInput) SetTtl(v *TimeToLive) *UpdateTableInput { + s.Ttl = v + return s +} + +type UpdateTableOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the modified table. + // + // ResourceArn is a required field + ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateTableOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateTableOutput) GoString() string { + return s.String() +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UpdateTableOutput) SetResourceArn(v string) *UpdateTableOutput { + s.ResourceArn = &v + return s +} + +// The operation failed due to an invalid or malformed request. +type ValidationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) GoString() string { + return s.String() +} + +func newErrorValidationException(v protocol.ResponseMetadata) error { + return &ValidationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ValidationException) Code() string { + return "ValidationException" +} + +// Message returns the exception's message. +func (s *ValidationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ValidationException) OrigErr() error { + return nil +} + +func (s *ValidationException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ValidationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ValidationException) RequestID() string { + return s.RespMetadata.RequestID +} + +const ( + // EncryptionTypeCustomerManagedKmsKey is a EncryptionType enum value + EncryptionTypeCustomerManagedKmsKey = "CUSTOMER_MANAGED_KMS_KEY" + + // EncryptionTypeAwsOwnedKmsKey is a EncryptionType enum value + EncryptionTypeAwsOwnedKmsKey = "AWS_OWNED_KMS_KEY" +) + +// EncryptionType_Values returns all elements of the EncryptionType enum +func EncryptionType_Values() []string { + return []string{ + EncryptionTypeCustomerManagedKmsKey, + EncryptionTypeAwsOwnedKmsKey, + } +} + +const ( + // PointInTimeRecoveryStatusEnabled is a PointInTimeRecoveryStatus enum value + PointInTimeRecoveryStatusEnabled = "ENABLED" + + // PointInTimeRecoveryStatusDisabled is a PointInTimeRecoveryStatus enum value + PointInTimeRecoveryStatusDisabled = "DISABLED" +) + +// PointInTimeRecoveryStatus_Values returns all elements of the PointInTimeRecoveryStatus enum +func PointInTimeRecoveryStatus_Values() []string { + return []string{ + PointInTimeRecoveryStatusEnabled, + PointInTimeRecoveryStatusDisabled, + } +} + +const ( + // SortOrderAsc is a SortOrder enum value + SortOrderAsc = "ASC" + + // SortOrderDesc is a SortOrder enum value + SortOrderDesc = "DESC" +) + +// SortOrder_Values returns all elements of the SortOrder enum +func SortOrder_Values() []string { + return []string{ + SortOrderAsc, + SortOrderDesc, + } +} + +const ( + // TableStatusActive is a TableStatus enum value + TableStatusActive = "ACTIVE" + + // TableStatusCreating is a TableStatus enum value + TableStatusCreating = "CREATING" + + // TableStatusUpdating is a TableStatus enum value + TableStatusUpdating = "UPDATING" + + // TableStatusDeleting is a TableStatus enum value + TableStatusDeleting = "DELETING" + + // TableStatusDeleted is a TableStatus enum value + TableStatusDeleted = "DELETED" + + // TableStatusRestoring is a TableStatus enum value + TableStatusRestoring = "RESTORING" + + // TableStatusInaccessibleEncryptionCredentials is a TableStatus enum value + TableStatusInaccessibleEncryptionCredentials = "INACCESSIBLE_ENCRYPTION_CREDENTIALS" +) + +// TableStatus_Values returns all elements of the TableStatus enum +func TableStatus_Values() []string { + return []string{ + TableStatusActive, + TableStatusCreating, + TableStatusUpdating, + TableStatusDeleting, + TableStatusDeleted, + TableStatusRestoring, + TableStatusInaccessibleEncryptionCredentials, + } +} + +const ( + // ThroughputModePayPerRequest is a ThroughputMode enum value + ThroughputModePayPerRequest = "PAY_PER_REQUEST" + + // ThroughputModeProvisioned is a ThroughputMode enum value + ThroughputModeProvisioned = "PROVISIONED" +) + +// ThroughputMode_Values returns all elements of the ThroughputMode enum +func ThroughputMode_Values() []string { + return []string{ + ThroughputModePayPerRequest, + ThroughputModeProvisioned, + } +} + +const ( + // TimeToLiveStatusEnabled is a TimeToLiveStatus enum value + TimeToLiveStatusEnabled = "ENABLED" +) + +// TimeToLiveStatus_Values returns all elements of the TimeToLiveStatus enum +func TimeToLiveStatus_Values() []string { + return []string{ + TimeToLiveStatusEnabled, + } +} diff --git a/service/keyspaces/doc.go b/service/keyspaces/doc.go new file mode 100644 index 00000000000..817b2003cf1 --- /dev/null +++ b/service/keyspaces/doc.go @@ -0,0 +1,45 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package keyspaces provides the client and types for making API +// requests to Amazon Keyspaces. +// +// Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, +// and managed Apache Cassandra-compatible database service. Amazon Keyspaces +// makes it easy to migrate, run, and scale Cassandra workloads in the Amazon +// Web Services Cloud. With just a few clicks on the Amazon Web Services Management +// Console or a few lines of code, you can create keyspaces and tables in Amazon +// Keyspaces, without deploying any infrastructure or installing software. +// +//In addition to supporting Cassandra Query Language (CQL) requests via +// open-source Cassandra drivers, Amazon Keyspaces supports data definition +// language (DDL) operations to manage keyspaces and tables using the Amazon +// Web Services SDK and CLI. This API reference describes the supported DDL +// operations in detail.
For the list of all supported CQL +// APIs, see Supported +// Cassandra APIs, operations, and data types in Amazon Keyspaces in +// the Amazon Keyspaces Developer Guide.
For more information +// about Amazon Web Services APIs, for example how to implement retry logic +// or how to sign Amazon Web Services API requests, see Amazon +// Web Services APIs in the General Reference.