// // Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"). // You may not use this file except in compliance with the License. // A copy of the License is located at // // http://aws.amazon.com/apache2.0 // // or in the "license" file accompanying this file. This file is distributed // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either // express or implied. See the License for the specific language governing // permissions and limitations under the License. // #import #import #import NS_ASSUME_NONNULL_BEGIN FOUNDATION_EXPORT NSString *const AWSDynamoDBErrorDomain; typedef NS_ENUM(NSInteger, AWSDynamoDBErrorType) { AWSDynamoDBErrorUnknown, AWSDynamoDBErrorBackupInUse, AWSDynamoDBErrorBackupNotFound, AWSDynamoDBErrorConditionalCheckFailed, AWSDynamoDBErrorContinuousBackupsUnavailable, AWSDynamoDBErrorDuplicateItem, AWSDynamoDBErrorExportConflict, AWSDynamoDBErrorExportNotFound, AWSDynamoDBErrorGlobalTableAlreadyExists, AWSDynamoDBErrorGlobalTableNotFound, AWSDynamoDBErrorIdempotentParameterMismatch, AWSDynamoDBErrorImportConflict, AWSDynamoDBErrorImportNotFound, AWSDynamoDBErrorIndexNotFound, AWSDynamoDBErrorInternalServer, AWSDynamoDBErrorInvalidExportTime, AWSDynamoDBErrorInvalidRestoreTime, AWSDynamoDBErrorItemCollectionSizeLimitExceeded, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorPointInTimeRecoveryUnavailable, AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorReplicaAlreadyExists, AWSDynamoDBErrorReplicaNotFound, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorResourceInUse, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorTableAlreadyExists, AWSDynamoDBErrorTableInUse, AWSDynamoDBErrorTableNotFound, AWSDynamoDBErrorTransactionCanceled, AWSDynamoDBErrorTransactionConflict, AWSDynamoDBErrorTransactionInProgress, }; typedef NS_ENUM(NSInteger, AWSDynamoDBAttributeAction) { AWSDynamoDBAttributeActionUnknown, AWSDynamoDBAttributeActionAdd, AWSDynamoDBAttributeActionPut, AWSDynamoDBAttributeActionDelete, }; typedef NS_ENUM(NSInteger, AWSDynamoDBBackupStatus) { AWSDynamoDBBackupStatusUnknown, AWSDynamoDBBackupStatusCreating, AWSDynamoDBBackupStatusDeleted, AWSDynamoDBBackupStatusAvailable, }; typedef NS_ENUM(NSInteger, AWSDynamoDBBackupType) { AWSDynamoDBBackupTypeUnknown, AWSDynamoDBBackupTypeUser, AWSDynamoDBBackupTypeSystem, AWSDynamoDBBackupTypeAwsBackup, }; typedef NS_ENUM(NSInteger, AWSDynamoDBBackupTypeFilter) { AWSDynamoDBBackupTypeFilterUnknown, AWSDynamoDBBackupTypeFilterUser, AWSDynamoDBBackupTypeFilterSystem, AWSDynamoDBBackupTypeFilterAwsBackup, AWSDynamoDBBackupTypeFilterAll, }; typedef NS_ENUM(NSInteger, AWSDynamoDBBatchStatementErrorCodeEnum) { AWSDynamoDBBatchStatementErrorCodeEnumUnknown, AWSDynamoDBBatchStatementErrorCodeEnumConditionalCheckFailed, AWSDynamoDBBatchStatementErrorCodeEnumItemCollectionSizeLimitExceeded, AWSDynamoDBBatchStatementErrorCodeEnumRequestLimitExceeded, AWSDynamoDBBatchStatementErrorCodeEnumValidationError, AWSDynamoDBBatchStatementErrorCodeEnumProvisionedThroughputExceeded, AWSDynamoDBBatchStatementErrorCodeEnumTransactionConflict, AWSDynamoDBBatchStatementErrorCodeEnumThrottlingError, AWSDynamoDBBatchStatementErrorCodeEnumInternalServerError, AWSDynamoDBBatchStatementErrorCodeEnumResourceNotFound, AWSDynamoDBBatchStatementErrorCodeEnumAccessDenied, AWSDynamoDBBatchStatementErrorCodeEnumDuplicateItem, }; typedef NS_ENUM(NSInteger, AWSDynamoDBBillingMode) { AWSDynamoDBBillingModeUnknown, AWSDynamoDBBillingModeProvisioned, AWSDynamoDBBillingModePayPerRequest, }; typedef NS_ENUM(NSInteger, AWSDynamoDBComparisonOperator) { AWSDynamoDBComparisonOperatorUnknown, AWSDynamoDBComparisonOperatorEQ, AWSDynamoDBComparisonOperatorNE, AWSDynamoDBComparisonOperatorIN, AWSDynamoDBComparisonOperatorLE, AWSDynamoDBComparisonOperatorLT, AWSDynamoDBComparisonOperatorGE, AWSDynamoDBComparisonOperatorGT, AWSDynamoDBComparisonOperatorBetween, AWSDynamoDBComparisonOperatorNotNull, AWSDynamoDBComparisonOperatorNull, AWSDynamoDBComparisonOperatorContains, AWSDynamoDBComparisonOperatorNotContains, AWSDynamoDBComparisonOperatorBeginsWith, }; typedef NS_ENUM(NSInteger, AWSDynamoDBConditionalOperator) { AWSDynamoDBConditionalOperatorUnknown, AWSDynamoDBConditionalOperatorAnd, AWSDynamoDBConditionalOperatorOr, }; typedef NS_ENUM(NSInteger, AWSDynamoDBContinuousBackupsStatus) { AWSDynamoDBContinuousBackupsStatusUnknown, AWSDynamoDBContinuousBackupsStatusEnabled, AWSDynamoDBContinuousBackupsStatusDisabled, }; typedef NS_ENUM(NSInteger, AWSDynamoDBContributorInsightsAction) { AWSDynamoDBContributorInsightsActionUnknown, AWSDynamoDBContributorInsightsActionEnable, AWSDynamoDBContributorInsightsActionDisable, }; typedef NS_ENUM(NSInteger, AWSDynamoDBContributorInsightsStatus) { AWSDynamoDBContributorInsightsStatusUnknown, AWSDynamoDBContributorInsightsStatusEnabling, AWSDynamoDBContributorInsightsStatusEnabled, AWSDynamoDBContributorInsightsStatusDisabling, AWSDynamoDBContributorInsightsStatusDisabled, AWSDynamoDBContributorInsightsStatusFailed, }; typedef NS_ENUM(NSInteger, AWSDynamoDBDestinationStatus) { AWSDynamoDBDestinationStatusUnknown, AWSDynamoDBDestinationStatusEnabling, AWSDynamoDBDestinationStatusActive, AWSDynamoDBDestinationStatusDisabling, AWSDynamoDBDestinationStatusDisabled, AWSDynamoDBDestinationStatusEnableFailed, }; typedef NS_ENUM(NSInteger, AWSDynamoDBExportFormat) { AWSDynamoDBExportFormatUnknown, AWSDynamoDBExportFormatDynamodbJson, AWSDynamoDBExportFormatIon, }; typedef NS_ENUM(NSInteger, AWSDynamoDBExportStatus) { AWSDynamoDBExportStatusUnknown, AWSDynamoDBExportStatusInProgress, AWSDynamoDBExportStatusCompleted, AWSDynamoDBExportStatusFailed, }; typedef NS_ENUM(NSInteger, AWSDynamoDBGlobalTableStatus) { AWSDynamoDBGlobalTableStatusUnknown, AWSDynamoDBGlobalTableStatusCreating, AWSDynamoDBGlobalTableStatusActive, AWSDynamoDBGlobalTableStatusDeleting, AWSDynamoDBGlobalTableStatusUpdating, }; typedef NS_ENUM(NSInteger, AWSDynamoDBImportStatus) { AWSDynamoDBImportStatusUnknown, AWSDynamoDBImportStatusInProgress, AWSDynamoDBImportStatusCompleted, AWSDynamoDBImportStatusCancelling, AWSDynamoDBImportStatusCancelled, AWSDynamoDBImportStatusFailed, }; typedef NS_ENUM(NSInteger, AWSDynamoDBIndexStatus) { AWSDynamoDBIndexStatusUnknown, AWSDynamoDBIndexStatusCreating, AWSDynamoDBIndexStatusUpdating, AWSDynamoDBIndexStatusDeleting, AWSDynamoDBIndexStatusActive, }; typedef NS_ENUM(NSInteger, AWSDynamoDBInputCompressionType) { AWSDynamoDBInputCompressionTypeUnknown, AWSDynamoDBInputCompressionTypeGzip, AWSDynamoDBInputCompressionTypeZstd, AWSDynamoDBInputCompressionTypeNone, }; typedef NS_ENUM(NSInteger, AWSDynamoDBInputFormat) { AWSDynamoDBInputFormatUnknown, AWSDynamoDBInputFormatDynamodbJson, AWSDynamoDBInputFormatIon, AWSDynamoDBInputFormatCsv, }; typedef NS_ENUM(NSInteger, AWSDynamoDBKeyType) { AWSDynamoDBKeyTypeUnknown, AWSDynamoDBKeyTypeHash, AWSDynamoDBKeyTypeRange, }; typedef NS_ENUM(NSInteger, AWSDynamoDBPointInTimeRecoveryStatus) { AWSDynamoDBPointInTimeRecoveryStatusUnknown, AWSDynamoDBPointInTimeRecoveryStatusEnabled, AWSDynamoDBPointInTimeRecoveryStatusDisabled, }; typedef NS_ENUM(NSInteger, AWSDynamoDBProjectionType) { AWSDynamoDBProjectionTypeUnknown, AWSDynamoDBProjectionTypeAll, AWSDynamoDBProjectionTypeKeysOnly, AWSDynamoDBProjectionTypeInclude, }; typedef NS_ENUM(NSInteger, AWSDynamoDBReplicaStatus) { AWSDynamoDBReplicaStatusUnknown, AWSDynamoDBReplicaStatusCreating, AWSDynamoDBReplicaStatusCreationFailed, AWSDynamoDBReplicaStatusUpdating, AWSDynamoDBReplicaStatusDeleting, AWSDynamoDBReplicaStatusActive, AWSDynamoDBReplicaStatusRegionDisabled, AWSDynamoDBReplicaStatusInaccessibleEncryptionCredentials, }; typedef NS_ENUM(NSInteger, AWSDynamoDBReturnConsumedCapacity) { AWSDynamoDBReturnConsumedCapacityUnknown, AWSDynamoDBReturnConsumedCapacityIndexes, AWSDynamoDBReturnConsumedCapacityTotal, AWSDynamoDBReturnConsumedCapacityNone, }; typedef NS_ENUM(NSInteger, AWSDynamoDBReturnItemCollectionMetrics) { AWSDynamoDBReturnItemCollectionMetricsUnknown, AWSDynamoDBReturnItemCollectionMetricsSize, AWSDynamoDBReturnItemCollectionMetricsNone, }; typedef NS_ENUM(NSInteger, AWSDynamoDBReturnValue) { AWSDynamoDBReturnValueUnknown, AWSDynamoDBReturnValueNone, AWSDynamoDBReturnValueAllOld, AWSDynamoDBReturnValueUpdatedOld, AWSDynamoDBReturnValueAllNew, AWSDynamoDBReturnValueUpdatedNew, }; typedef NS_ENUM(NSInteger, AWSDynamoDBReturnValuesOnConditionCheckFailure) { AWSDynamoDBReturnValuesOnConditionCheckFailureUnknown, AWSDynamoDBReturnValuesOnConditionCheckFailureAllOld, AWSDynamoDBReturnValuesOnConditionCheckFailureNone, }; typedef NS_ENUM(NSInteger, AWSDynamoDBS3SseAlgorithm) { AWSDynamoDBS3SseAlgorithmUnknown, AWSDynamoDBS3SseAlgorithmAES256, AWSDynamoDBS3SseAlgorithmKms, }; typedef NS_ENUM(NSInteger, AWSDynamoDBSSEStatus) { AWSDynamoDBSSEStatusUnknown, AWSDynamoDBSSEStatusEnabling, AWSDynamoDBSSEStatusEnabled, AWSDynamoDBSSEStatusDisabling, AWSDynamoDBSSEStatusDisabled, AWSDynamoDBSSEStatusUpdating, }; typedef NS_ENUM(NSInteger, AWSDynamoDBSSEType) { AWSDynamoDBSSETypeUnknown, AWSDynamoDBSSETypeAES256, AWSDynamoDBSSETypeKms, }; typedef NS_ENUM(NSInteger, AWSDynamoDBScalarAttributeType) { AWSDynamoDBScalarAttributeTypeUnknown, AWSDynamoDBScalarAttributeTypeS, AWSDynamoDBScalarAttributeTypeN, AWSDynamoDBScalarAttributeTypeB, }; typedef NS_ENUM(NSInteger, AWSDynamoDBSelect) { AWSDynamoDBSelectUnknown, AWSDynamoDBSelectAllAttributes, AWSDynamoDBSelectAllProjectedAttributes, AWSDynamoDBSelectSpecificAttributes, AWSDynamoDBSelectCount, }; typedef NS_ENUM(NSInteger, AWSDynamoDBStreamViewType) { AWSDynamoDBStreamViewTypeUnknown, AWSDynamoDBStreamViewTypeNewImage, AWSDynamoDBStreamViewTypeOldImage, AWSDynamoDBStreamViewTypeNewAndOldImages, AWSDynamoDBStreamViewTypeKeysOnly, }; typedef NS_ENUM(NSInteger, AWSDynamoDBTableClass) { AWSDynamoDBTableClassUnknown, AWSDynamoDBTableClassStandard, AWSDynamoDBTableClassStandardInfrequentAccess, }; typedef NS_ENUM(NSInteger, AWSDynamoDBTableStatus) { AWSDynamoDBTableStatusUnknown, AWSDynamoDBTableStatusCreating, AWSDynamoDBTableStatusUpdating, AWSDynamoDBTableStatusDeleting, AWSDynamoDBTableStatusActive, AWSDynamoDBTableStatusInaccessibleEncryptionCredentials, AWSDynamoDBTableStatusArchiving, AWSDynamoDBTableStatusArchived, }; typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { AWSDynamoDBTimeToLiveStatusUnknown, AWSDynamoDBTimeToLiveStatusEnabling, AWSDynamoDBTimeToLiveStatusDisabling, AWSDynamoDBTimeToLiveStatusEnabled, AWSDynamoDBTimeToLiveStatusDisabled, }; @class AWSDynamoDBArchivalSummary; @class AWSDynamoDBAttributeDefinition; @class AWSDynamoDBAttributeValue; @class AWSDynamoDBAttributeValueUpdate; @class AWSDynamoDBAutoScalingPolicyDescription; @class AWSDynamoDBAutoScalingPolicyUpdate; @class AWSDynamoDBAutoScalingSettingsDescription; @class AWSDynamoDBAutoScalingSettingsUpdate; @class AWSDynamoDBAutoScalingTargetTrackingScalingPolicyConfigurationDescription; @class AWSDynamoDBAutoScalingTargetTrackingScalingPolicyConfigurationUpdate; @class AWSDynamoDBBackupDescription; @class AWSDynamoDBBackupDetails; @class AWSDynamoDBBackupSummary; @class AWSDynamoDBBatchExecuteStatementInput; @class AWSDynamoDBBatchExecuteStatementOutput; @class AWSDynamoDBBatchGetItemInput; @class AWSDynamoDBBatchGetItemOutput; @class AWSDynamoDBBatchStatementError; @class AWSDynamoDBBatchStatementRequest; @class AWSDynamoDBBatchStatementResponse; @class AWSDynamoDBBatchWriteItemInput; @class AWSDynamoDBBatchWriteItemOutput; @class AWSDynamoDBBillingModeSummary; @class AWSDynamoDBCancellationReason; @class AWSDynamoDBCapacity; @class AWSDynamoDBCondition; @class AWSDynamoDBConditionCheck; @class AWSDynamoDBConsumedCapacity; @class AWSDynamoDBContinuousBackupsDescription; @class AWSDynamoDBContributorInsightsSummary; @class AWSDynamoDBCreateBackupInput; @class AWSDynamoDBCreateBackupOutput; @class AWSDynamoDBCreateGlobalSecondaryIndexAction; @class AWSDynamoDBCreateGlobalTableInput; @class AWSDynamoDBCreateGlobalTableOutput; @class AWSDynamoDBCreateReplicaAction; @class AWSDynamoDBCreateReplicationGroupMemberAction; @class AWSDynamoDBCreateTableInput; @class AWSDynamoDBCreateTableOutput; @class AWSDynamoDBCsvOptions; @class AWSDynamoDBRemove; @class AWSDynamoDBDeleteBackupInput; @class AWSDynamoDBDeleteBackupOutput; @class AWSDynamoDBDeleteGlobalSecondaryIndexAction; @class AWSDynamoDBDeleteItemInput; @class AWSDynamoDBDeleteItemOutput; @class AWSDynamoDBDeleteReplicaAction; @class AWSDynamoDBDeleteReplicationGroupMemberAction; @class AWSDynamoDBDeleteRequest; @class AWSDynamoDBDeleteTableInput; @class AWSDynamoDBDeleteTableOutput; @class AWSDynamoDBDescribeBackupInput; @class AWSDynamoDBDescribeBackupOutput; @class AWSDynamoDBDescribeContinuousBackupsInput; @class AWSDynamoDBDescribeContinuousBackupsOutput; @class AWSDynamoDBDescribeContributorInsightsInput; @class AWSDynamoDBDescribeContributorInsightsOutput; @class AWSDynamoDBDescribeEndpointsRequest; @class AWSDynamoDBDescribeEndpointsResponse; @class AWSDynamoDBDescribeExportInput; @class AWSDynamoDBDescribeExportOutput; @class AWSDynamoDBDescribeGlobalTableInput; @class AWSDynamoDBDescribeGlobalTableOutput; @class AWSDynamoDBDescribeGlobalTableSettingsInput; @class AWSDynamoDBDescribeGlobalTableSettingsOutput; @class AWSDynamoDBDescribeImportInput; @class AWSDynamoDBDescribeImportOutput; @class AWSDynamoDBDescribeKinesisStreamingDestinationInput; @class AWSDynamoDBDescribeKinesisStreamingDestinationOutput; @class AWSDynamoDBDescribeLimitsInput; @class AWSDynamoDBDescribeLimitsOutput; @class AWSDynamoDBDescribeTableInput; @class AWSDynamoDBDescribeTableOutput; @class AWSDynamoDBDescribeTableReplicaAutoScalingInput; @class AWSDynamoDBDescribeTableReplicaAutoScalingOutput; @class AWSDynamoDBDescribeTimeToLiveInput; @class AWSDynamoDBDescribeTimeToLiveOutput; @class AWSDynamoDBEndpoint; @class AWSDynamoDBExecuteStatementInput; @class AWSDynamoDBExecuteStatementOutput; @class AWSDynamoDBExecuteTransactionInput; @class AWSDynamoDBExecuteTransactionOutput; @class AWSDynamoDBExpectedAttributeValue; @class AWSDynamoDBExportDescription; @class AWSDynamoDBExportSummary; @class AWSDynamoDBExportTableToPointInTimeInput; @class AWSDynamoDBExportTableToPointInTimeOutput; @class AWSDynamoDBFailureException; @class AWSDynamoDBGet; @class AWSDynamoDBGetItemInput; @class AWSDynamoDBGetItemOutput; @class AWSDynamoDBGlobalSecondaryIndex; @class AWSDynamoDBGlobalSecondaryIndexAutoScalingUpdate; @class AWSDynamoDBGlobalSecondaryIndexDescription; @class AWSDynamoDBGlobalSecondaryIndexInfo; @class AWSDynamoDBGlobalSecondaryIndexUpdate; @class AWSDynamoDBGlobalTable; @class AWSDynamoDBGlobalTableDescription; @class AWSDynamoDBGlobalTableGlobalSecondaryIndexSettingsUpdate; @class AWSDynamoDBImportSummary; @class AWSDynamoDBImportTableDescription; @class AWSDynamoDBImportTableInput; @class AWSDynamoDBImportTableOutput; @class AWSDynamoDBInputFormatOptions; @class AWSDynamoDBItemCollectionMetrics; @class AWSDynamoDBItemResponse; @class AWSDynamoDBKeySchemaElement; @class AWSDynamoDBKeysAndAttributes; @class AWSDynamoDBKinesisDataStreamDestination; @class AWSDynamoDBKinesisStreamingDestinationInput; @class AWSDynamoDBKinesisStreamingDestinationOutput; @class AWSDynamoDBListBackupsInput; @class AWSDynamoDBListBackupsOutput; @class AWSDynamoDBListContributorInsightsInput; @class AWSDynamoDBListContributorInsightsOutput; @class AWSDynamoDBListExportsInput; @class AWSDynamoDBListExportsOutput; @class AWSDynamoDBListGlobalTablesInput; @class AWSDynamoDBListGlobalTablesOutput; @class AWSDynamoDBListImportsInput; @class AWSDynamoDBListImportsOutput; @class AWSDynamoDBListTablesInput; @class AWSDynamoDBListTablesOutput; @class AWSDynamoDBListTagsOfResourceInput; @class AWSDynamoDBListTagsOfResourceOutput; @class AWSDynamoDBLocalSecondaryIndex; @class AWSDynamoDBLocalSecondaryIndexDescription; @class AWSDynamoDBLocalSecondaryIndexInfo; @class AWSDynamoDBParameterizedStatement; @class AWSDynamoDBPointInTimeRecoveryDescription; @class AWSDynamoDBPointInTimeRecoverySpecification; @class AWSDynamoDBProjection; @class AWSDynamoDBProvisionedThroughput; @class AWSDynamoDBProvisionedThroughputDescription; @class AWSDynamoDBProvisionedThroughputOverride; @class AWSDynamoDBPut; @class AWSDynamoDBPutItemInput; @class AWSDynamoDBPutItemOutput; @class AWSDynamoDBPutRequest; @class AWSDynamoDBQueryInput; @class AWSDynamoDBQueryOutput; @class AWSDynamoDBReplica; @class AWSDynamoDBReplicaAutoScalingDescription; @class AWSDynamoDBReplicaAutoScalingUpdate; @class AWSDynamoDBReplicaDescription; @class AWSDynamoDBReplicaGlobalSecondaryIndex; @class AWSDynamoDBReplicaGlobalSecondaryIndexAutoScalingDescription; @class AWSDynamoDBReplicaGlobalSecondaryIndexAutoScalingUpdate; @class AWSDynamoDBReplicaGlobalSecondaryIndexDescription; @class AWSDynamoDBReplicaGlobalSecondaryIndexSettingsDescription; @class AWSDynamoDBReplicaGlobalSecondaryIndexSettingsUpdate; @class AWSDynamoDBReplicaSettingsDescription; @class AWSDynamoDBReplicaSettingsUpdate; @class AWSDynamoDBReplicaUpdate; @class AWSDynamoDBReplicationGroupUpdate; @class AWSDynamoDBRestoreSummary; @class AWSDynamoDBRestoreTableFromBackupInput; @class AWSDynamoDBRestoreTableFromBackupOutput; @class AWSDynamoDBRestoreTableToPointInTimeInput; @class AWSDynamoDBRestoreTableToPointInTimeOutput; @class AWSDynamoDBS3BucketSource; @class AWSDynamoDBSSEDescription; @class AWSDynamoDBSSESpecification; @class AWSDynamoDBScanInput; @class AWSDynamoDBScanOutput; @class AWSDynamoDBSourceTableDetails; @class AWSDynamoDBSourceTableFeatureDetails; @class AWSDynamoDBStreamSpecification; @class AWSDynamoDBTableAutoScalingDescription; @class AWSDynamoDBTableClassSummary; @class AWSDynamoDBTableCreationParameters; @class AWSDynamoDBTableDescription; @class AWSDynamoDBTag; @class AWSDynamoDBTagResourceInput; @class AWSDynamoDBTimeToLiveDescription; @class AWSDynamoDBTimeToLiveSpecification; @class AWSDynamoDBTransactGetItem; @class AWSDynamoDBTransactGetItemsInput; @class AWSDynamoDBTransactGetItemsOutput; @class AWSDynamoDBTransactWriteItem; @class AWSDynamoDBTransactWriteItemsInput; @class AWSDynamoDBTransactWriteItemsOutput; @class AWSDynamoDBUntagResourceInput; @class AWSDynamoDBUpdate; @class AWSDynamoDBUpdateContinuousBackupsInput; @class AWSDynamoDBUpdateContinuousBackupsOutput; @class AWSDynamoDBUpdateContributorInsightsInput; @class AWSDynamoDBUpdateContributorInsightsOutput; @class AWSDynamoDBUpdateGlobalSecondaryIndexAction; @class AWSDynamoDBUpdateGlobalTableInput; @class AWSDynamoDBUpdateGlobalTableOutput; @class AWSDynamoDBUpdateGlobalTableSettingsInput; @class AWSDynamoDBUpdateGlobalTableSettingsOutput; @class AWSDynamoDBUpdateItemInput; @class AWSDynamoDBUpdateItemOutput; @class AWSDynamoDBUpdateReplicationGroupMemberAction; @class AWSDynamoDBUpdateTableInput; @class AWSDynamoDBUpdateTableOutput; @class AWSDynamoDBUpdateTableReplicaAutoScalingInput; @class AWSDynamoDBUpdateTableReplicaAutoScalingOutput; @class AWSDynamoDBUpdateTimeToLiveInput; @class AWSDynamoDBUpdateTimeToLiveOutput; @class AWSDynamoDBWriteRequest; /**

Contains details of a table archival operation.

*/ @interface AWSDynamoDBArchivalSummary : AWSModel /**

The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.

*/ @property (nonatomic, strong) NSString * _Nullable archivalBackupArn; /**

The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.

*/ @property (nonatomic, strong) NSDate * _Nullable archivalDateTime; /**

The reason DynamoDB archived the table. Currently, the only possible value is:

  • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.

*/ @property (nonatomic, strong) NSString * _Nullable archivalReason; @end /**

Represents an attribute for describing the key schema for the table and indexes.

Required parameters: [AttributeName, AttributeType] */ @interface AWSDynamoDBAttributeDefinition : AWSModel /**

A name for the attribute.

*/ @property (nonatomic, strong) NSString * _Nullable attributeName; /**

The data type for the attribute, where:

  • S - the attribute is of type String

  • N - the attribute is of type Number

  • B - the attribute is of type Binary

*/ @property (nonatomic, assign) AWSDynamoDBScalarAttributeType attributeType; @end /**

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

*/ @interface AWSDynamoDBAttributeValue : AWSModel /**

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

*/ @property (nonatomic, strong) NSData * _Nullable B; /**

An attribute of type Boolean. For example:

"BOOL": true

*/ @property (nonatomic, strong) NSNumber * _Nullable BOOLEAN; /**

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

*/ @property (nonatomic, strong) NSArray * _Nullable BS; /**

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

*/ @property (nonatomic, strong) NSArray * _Nullable L; /**

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

*/ @property (nonatomic, strong) NSDictionary * _Nullable M; /**

An attribute of type Number. For example:

"N": "123.45"

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

*/ @property (nonatomic, strong) NSString * _Nullable N; /**

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

*/ @property (nonatomic, strong) NSArray * _Nullable NS; /**

An attribute of type Null. For example:

"NULL": true

*/ @property (nonatomic, strong) NSNumber * _Nullable NIL; /**

An attribute of type String. For example:

"S": "Hello"

*/ @property (nonatomic, strong) NSString * _Nullable S; /**

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

*/ @property (nonatomic, strong) NSArray * _Nullable SS; @end /**

For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.

You cannot use UpdateItem to update any primary key attributes. Instead, you will need to delete the item, and then use PutItem to create a new item with new attributes.

Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.

*/ @interface AWSDynamoDBAttributeValueUpdate : AWSModel /**

Specifies how to perform the update. Valid values are PUT (default), DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

If an item with the specified Key is found in the table:

  • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

  • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

  • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

    • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.

    This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.

If no item with the specified Key is found:

  • PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.

  • DELETE - Nothing happens; there is no attribute to delete.

  • ADD - DynamoDB creates a new item with the supplied primary key and number (or set) for the attribute value. The only data types allowed are number, number set, string set or binary set.

*/ @property (nonatomic, assign) AWSDynamoDBAttributeAction action; /**

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBAttributeValue * _Nullable value; @end /**

Represents the properties of the scaling policy.

*/ @interface AWSDynamoDBAutoScalingPolicyDescription : AWSModel /**

The name of the scaling policy.

*/ @property (nonatomic, strong) NSString * _Nullable policyName; /**

Represents a target tracking scaling policy configuration.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingTargetTrackingScalingPolicyConfigurationDescription * _Nullable targetTrackingScalingPolicyConfiguration; @end /**

Represents the auto scaling policy to be modified.

Required parameters: [TargetTrackingScalingPolicyConfiguration] */ @interface AWSDynamoDBAutoScalingPolicyUpdate : AWSModel /**

The name of the scaling policy.

*/ @property (nonatomic, strong) NSString * _Nullable policyName; /**

Represents a target tracking scaling policy configuration.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingTargetTrackingScalingPolicyConfigurationUpdate * _Nullable targetTrackingScalingPolicyConfiguration; @end /**

Represents the auto scaling settings for a global table or global secondary index.

*/ @interface AWSDynamoDBAutoScalingSettingsDescription : AWSModel /**

Disabled auto scaling for this global table or global secondary index.

*/ @property (nonatomic, strong) NSNumber * _Nullable autoScalingDisabled; /**

Role ARN used for configuring the auto scaling policy.

*/ @property (nonatomic, strong) NSString * _Nullable autoScalingRoleArn; /**

The maximum capacity units that a global table or global secondary index should be scaled up to.

*/ @property (nonatomic, strong) NSNumber * _Nullable maximumUnits; /**

The minimum capacity units that a global table or global secondary index should be scaled down to.

*/ @property (nonatomic, strong) NSNumber * _Nullable minimumUnits; /**

Information about the scaling policies.

*/ @property (nonatomic, strong) NSArray * _Nullable scalingPolicies; @end /**

Represents the auto scaling settings to be modified for a global table or global secondary index.

*/ @interface AWSDynamoDBAutoScalingSettingsUpdate : AWSModel /**

Disabled auto scaling for this global table or global secondary index.

*/ @property (nonatomic, strong) NSNumber * _Nullable autoScalingDisabled; /**

Role ARN used for configuring auto scaling policy.

*/ @property (nonatomic, strong) NSString * _Nullable autoScalingRoleArn; /**

The maximum capacity units that a global table or global secondary index should be scaled up to.

*/ @property (nonatomic, strong) NSNumber * _Nullable maximumUnits; /**

The minimum capacity units that a global table or global secondary index should be scaled down to.

*/ @property (nonatomic, strong) NSNumber * _Nullable minimumUnits; /**

The scaling policy to apply for scaling target global table or global secondary index capacity units.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingPolicyUpdate * _Nullable scalingPolicyUpdate; @end /**

Represents the properties of a target tracking scaling policy.

Required parameters: [TargetValue] */ @interface AWSDynamoDBAutoScalingTargetTrackingScalingPolicyConfigurationDescription : AWSModel /**

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

*/ @property (nonatomic, strong) NSNumber * _Nullable disableScaleIn; /**

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.

*/ @property (nonatomic, strong) NSNumber * _Nullable scaleInCooldown; /**

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

*/ @property (nonatomic, strong) NSNumber * _Nullable scaleOutCooldown; /**

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

*/ @property (nonatomic, strong) NSNumber * _Nullable targetValue; @end /**

Represents the settings of a target tracking scaling policy that will be modified.

Required parameters: [TargetValue] */ @interface AWSDynamoDBAutoScalingTargetTrackingScalingPolicyConfigurationUpdate : AWSModel /**

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

*/ @property (nonatomic, strong) NSNumber * _Nullable disableScaleIn; /**

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.

*/ @property (nonatomic, strong) NSNumber * _Nullable scaleInCooldown; /**

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

*/ @property (nonatomic, strong) NSNumber * _Nullable scaleOutCooldown; /**

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

*/ @property (nonatomic, strong) NSNumber * _Nullable targetValue; @end /**

Contains the description of the backup created for the table.

*/ @interface AWSDynamoDBBackupDescription : AWSModel /**

Contains the details of the backup created for the table.

*/ @property (nonatomic, strong) AWSDynamoDBBackupDetails * _Nullable backupDetails; /**

Contains the details of the table when the backup was created.

*/ @property (nonatomic, strong) AWSDynamoDBSourceTableDetails * _Nullable sourceTableDetails; /**

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

*/ @property (nonatomic, strong) AWSDynamoDBSourceTableFeatureDetails * _Nullable sourceTableFeatureDetails; @end /**

Contains the details of the backup created for the table.

Required parameters: [BackupArn, BackupName, BackupStatus, BackupType, BackupCreationDateTime] */ @interface AWSDynamoDBBackupDetails : AWSModel /**

ARN associated with the backup.

*/ @property (nonatomic, strong) NSString * _Nullable backupArn; /**

Time at which the backup was created. This is the request time of the backup.

*/ @property (nonatomic, strong) NSDate * _Nullable backupCreationDateTime; /**

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

*/ @property (nonatomic, strong) NSDate * _Nullable backupExpiryDateTime; /**

Name of the requested backup.

*/ @property (nonatomic, strong) NSString * _Nullable backupName; /**

Size of the backup in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

*/ @property (nonatomic, strong) NSNumber * _Nullable backupSizeBytes; /**

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

*/ @property (nonatomic, assign) AWSDynamoDBBackupStatus backupStatus; /**

BackupType:

  • USER - You create and manage these using the on-demand backup feature.

  • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

  • AWS_BACKUP - On-demand backup created by you from Backup service.

*/ @property (nonatomic, assign) AWSDynamoDBBackupType backupType; @end /**

Contains details for the backup.

*/ @interface AWSDynamoDBBackupSummary : AWSModel /**

ARN associated with the backup.

*/ @property (nonatomic, strong) NSString * _Nullable backupArn; /**

Time at which the backup was created.

*/ @property (nonatomic, strong) NSDate * _Nullable backupCreationDateTime; /**

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

*/ @property (nonatomic, strong) NSDate * _Nullable backupExpiryDateTime; /**

Name of the specified backup.

*/ @property (nonatomic, strong) NSString * _Nullable backupName; /**

Size of the backup in bytes.

*/ @property (nonatomic, strong) NSNumber * _Nullable backupSizeBytes; /**

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

*/ @property (nonatomic, assign) AWSDynamoDBBackupStatus backupStatus; /**

BackupType:

  • USER - You create and manage these using the on-demand backup feature.

  • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

  • AWS_BACKUP - On-demand backup created by you from Backup service.

*/ @property (nonatomic, assign) AWSDynamoDBBackupType backupType; /**

ARN associated with the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableArn; /**

Unique identifier for the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableId; /**

Name of the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBBatchExecuteStatementInput : AWSRequest /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

The list of PartiQL statements representing the batch to run.

*/ @property (nonatomic, strong) NSArray * _Nullable statements; @end /** */ @interface AWSDynamoDBBatchExecuteStatementOutput : AWSModel /**

The capacity units consumed by the entire operation. The values of the list are ordered according to the ordering of the statements.

*/ @property (nonatomic, strong) NSArray * _Nullable consumedCapacity; /**

The response to each PartiQL statement in the batch.

*/ @property (nonatomic, strong) NSArray * _Nullable responses; @end /**

Represents the input of a BatchGetItem operation.

Required parameters: [RequestItems] */ @interface AWSDynamoDBBatchGetItemInput : AWSRequest /**

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.

Each element in the map of items to retrieve consists of the following:

  • ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.

  • ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames:

    • To access an attribute whose name conflicts with a DynamoDB reserved word.

    • To create a placeholder for repeating occurrences of an attribute name in an expression.

    • To prevent special characters in an attribute name from being misinterpreted in an expression.

    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

    • Percentile

    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

    • {"#P":"Percentile"}

    You could then use this substitution in an expression, as in this example:

    • #P = :val

    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

    For more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

  • Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.

  • ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

    If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.

    For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

  • AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable requestItems; /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; @end /**

Represents the output of a BatchGetItem operation.

*/ @interface AWSDynamoDBBatchGetItemOutput : AWSModel /**

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

  • TableName - The table that consumed the provisioned throughput.

  • CapacityUnits - The total number of capacity units consumed.

*/ @property (nonatomic, strong) NSArray * _Nullable consumedCapacity; /**

A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

*/ @property (nonatomic, strong) NSDictionary *> *> * _Nullable responses; /**

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

  • Keys - An array of primary key attribute values that define specific items in the table.

  • ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

  • ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

*/ @property (nonatomic, strong) NSDictionary * _Nullable unprocessedKeys; @end /**

An error associated with a statement in a PartiQL batch that was run.

*/ @interface AWSDynamoDBBatchStatementError : AWSModel /**

The error code associated with the failed PartiQL batch statement.

*/ @property (nonatomic, assign) AWSDynamoDBBatchStatementErrorCodeEnum code; /**

The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure is specified as ALL_OLD.

*/ @property (nonatomic, strong) NSDictionary * _Nullable item; /**

The error message associated with the PartiQL batch response.

*/ @property (nonatomic, strong) NSString * _Nullable message; @end /**

A PartiQL batch statement request.

Required parameters: [Statement] */ @interface AWSDynamoDBBatchStatementRequest : AWSModel /**

The read consistency of the PartiQL batch request.

*/ @property (nonatomic, strong) NSNumber * _Nullable consistentRead; /**

The parameters associated with a PartiQL statement in the batch request.

*/ @property (nonatomic, strong) NSArray * _Nullable parameters; /**

An optional parameter that returns the item attributes for a PartiQL batch request operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

*/ @property (nonatomic, assign) AWSDynamoDBReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure; /**

A valid PartiQL statement.

*/ @property (nonatomic, strong) NSString * _Nullable statement; @end /**

A PartiQL batch statement response..

*/ @interface AWSDynamoDBBatchStatementResponse : AWSModel /**

The error associated with a failed PartiQL batch statement.

*/ @property (nonatomic, strong) AWSDynamoDBBatchStatementError * _Nullable error; /**

A DynamoDB item associated with a BatchStatementResponse

*/ @property (nonatomic, strong) NSDictionary * _Nullable item; /**

The table name associated with a failed PartiQL batch statement.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the input of a BatchWriteItem operation.

Required parameters: [RequestItems] */ @interface AWSDynamoDBBatchWriteItemInput : AWSRequest /**

A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

  • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

    • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

  • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

    • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with a ValidationException exception.

      If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

*/ @property (nonatomic, strong) NSDictionary *> * _Nullable requestItems; /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

*/ @property (nonatomic, assign) AWSDynamoDBReturnItemCollectionMetrics returnItemCollectionMetrics; @end /**

Represents the output of a BatchWriteItem operation.

*/ @interface AWSDynamoDBBatchWriteItemOutput : AWSModel /**

The capacity units consumed by the entire BatchWriteItem operation.

Each element consists of:

  • TableName - The table that consumed the provisioned throughput.

  • CapacityUnits - The total number of capacity units consumed.

*/ @property (nonatomic, strong) NSArray * _Nullable consumedCapacity; /**

A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

Each entry consists of the following subelements:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item.

  • SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

*/ @property (nonatomic, strong) NSDictionary *> * _Nullable itemCollectionMetrics; /**

A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchWriteItem operation. For more information, see RequestItems in the Request Parameters section.

Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).

  • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

    • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

  • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

    • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

      If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

*/ @property (nonatomic, strong) NSDictionary *> * _Nullable unprocessedItems; @end /**

Contains the details for the read/write capacity mode. This page talks about PROVISIONED and PAY_PER_REQUEST billing modes. For more information about these modes, see Read/write capacity mode.

You may need to switch to on-demand mode at least once in order to return a BillingModeSummary response.

 */ @interface AWSDynamoDBBillingModeSummary : AWSModel /**

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

  • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

*/ @property (nonatomic, assign) AWSDynamoDBBillingMode billingMode; /**

Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

*/ @property (nonatomic, strong) NSDate * _Nullable lastUpdateToPayPerRequestDateTime; @end /**

An ordered list of errors for each item in the request which caused the transaction to get cancelled. The values of the list are ordered according to the ordering of the TransactWriteItems request parameter. If no error occurred for the associated item an error with a Null code and Null message will be present.

*/ @interface AWSDynamoDBCancellationReason : AWSModel /**

Status code for the result of the cancelled transaction.

*/ @property (nonatomic, strong) NSString * _Nullable code; /**

Item in the request which caused the transaction to get cancelled.

*/ @property (nonatomic, strong) NSDictionary * _Nullable item; /**

Cancellation reason message description.

*/ @property (nonatomic, strong) NSString * _Nullable message; @end /**

Represents the amount of provisioned throughput capacity consumed on a table or an index.

*/ @interface AWSDynamoDBCapacity : AWSModel /**

The total number of capacity units consumed on a table or an index.

*/ @property (nonatomic, strong) NSNumber * _Nullable capacityUnits; /**

The total number of read capacity units consumed on a table or an index.

*/ @property (nonatomic, strong) NSNumber * _Nullable readCapacityUnits; /**

The total number of write capacity units consumed on a table or an index.

*/ @property (nonatomic, strong) NSNumber * _Nullable writeCapacityUnits; @end /**

Represents the selection criteria for a Query or Scan operation:

  • For a Query operation, Condition is used for specifying the KeyConditions to use when querying a table or an index. For KeyConditions, only the following comparison operators are supported:

    EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN

    Condition is also used in a QueryFilter, which evaluates the query results and returns only the desired values.

  • For a Scan operation, Condition is used in a ScanFilter, which evaluates the scan results and returns only the desired values.

Required parameters: [ComparisonOperator] */ @interface AWSDynamoDBCondition : AWSModel /**

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

*/ @property (nonatomic, strong) NSArray * _Nullable attributeValueList; /**

A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

  • EQ : Equal. EQ is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

  • NE : Not equal. NE is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

  • LE : Less than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • LT : Less than.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • GE : Greater than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • GT : Greater than.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

    This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.

  • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

    This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.

  • CONTAINS : Checks for a subsequence, or value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

    CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

  • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

    NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

  • BEGINS_WITH : Checks for a prefix.

    AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

  • IN : Checks for matching elements in a list.

    AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

  • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

    AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, assign) AWSDynamoDBComparisonOperator comparisonOperator; @end /**

Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.

Required parameters: [Key, TableName, ConditionExpression] */ @interface AWSDynamoDBConditionCheck : AWSModel /**

A condition that must be satisfied in order for a conditional update to succeed. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable conditionExpression; /**

One or more substitution tokens for attribute names in an expression. For more information, see Expression attribute names in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

One or more values that can be substituted in an expression. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeValues; /**

The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.

*/ @property (nonatomic, strong) NSDictionary * _Nullable key; /**

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

*/ @property (nonatomic, assign) AWSDynamoDBReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure; /**

Name of the table for the check item request.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

*/ @interface AWSDynamoDBConsumedCapacity : AWSModel /**

The total number of capacity units consumed by the operation.

*/ @property (nonatomic, strong) NSNumber * _Nullable capacityUnits; /**

The amount of throughput consumed on each global index affected by the operation.

*/ @property (nonatomic, strong) NSDictionary * _Nullable globalSecondaryIndexes; /**

The amount of throughput consumed on each local index affected by the operation.

*/ @property (nonatomic, strong) NSDictionary * _Nullable localSecondaryIndexes; /**

The total number of read capacity units consumed by the operation.

*/ @property (nonatomic, strong) NSNumber * _Nullable readCapacityUnits; /**

The amount of throughput consumed on the table affected by the operation.

*/ @property (nonatomic, strong) AWSDynamoDBCapacity * _Nullable table; /**

The name of the table that was affected by the operation.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; /**

The total number of write capacity units consumed by the operation.

*/ @property (nonatomic, strong) NSNumber * _Nullable writeCapacityUnits; @end /**

Represents the continuous backups and point in time recovery settings on the table.

Required parameters: [ContinuousBackupsStatus] */ @interface AWSDynamoDBContinuousBackupsDescription : AWSModel /**

ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED

*/ @property (nonatomic, assign) AWSDynamoDBContinuousBackupsStatus continuousBackupsStatus; /**

The description of the point in time recovery settings applied to the table.

*/ @property (nonatomic, strong) AWSDynamoDBPointInTimeRecoveryDescription * _Nullable pointInTimeRecoveryDescription; @end /**

Represents a Contributor Insights summary entry.

*/ @interface AWSDynamoDBContributorInsightsSummary : AWSModel /**

Describes the current status for contributor insights for the given table and index, if applicable.

*/ @property (nonatomic, assign) AWSDynamoDBContributorInsightsStatus contributorInsightsStatus; /**

Name of the index associated with the summary, if any.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

Name of the table associated with the summary.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBCreateBackupInput : AWSRequest /**

Specified name for the backup.

*/ @property (nonatomic, strong) NSString * _Nullable backupName; /**

The name of the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBCreateBackupOutput : AWSModel /**

Contains the details of the backup created for the table.

*/ @property (nonatomic, strong) AWSDynamoDBBackupDetails * _Nullable backupDetails; @end /**

Represents a new global secondary index to be added to an existing table.

Required parameters: [IndexName, KeySchema, Projection] */ @interface AWSDynamoDBCreateGlobalSecondaryIndexAction : AWSModel /**

The name of the global secondary index to be created.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The key schema for the global secondary index.

*/ @property (nonatomic, strong) NSArray * _Nullable keySchema; /**

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

*/ @property (nonatomic, strong) AWSDynamoDBProjection * _Nullable projection; /**

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput * _Nullable provisionedThroughput; @end /** */ @interface AWSDynamoDBCreateGlobalTableInput : AWSRequest /**

The global table name.

*/ @property (nonatomic, strong) NSString * _Nullable globalTableName; /**

The Regions where the global table needs to be created.

*/ @property (nonatomic, strong) NSArray * _Nullable replicationGroup; @end /** */ @interface AWSDynamoDBCreateGlobalTableOutput : AWSModel /**

Contains the details of the global table.

*/ @property (nonatomic, strong) AWSDynamoDBGlobalTableDescription * _Nullable globalTableDescription; @end /**

Represents a replica to be added.

Required parameters: [RegionName] */ @interface AWSDynamoDBCreateReplicaAction : AWSModel /**

The Region of the replica to be added.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; @end /**

Represents a replica to be created.

Required parameters: [RegionName] */ @interface AWSDynamoDBCreateReplicationGroupMemberAction : AWSModel /**

Replica-specific global secondary index settings.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexes; /**

The KMS key that should be used for KMS encryption in the new replica. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS key alias/aws/dynamodb.

*/ @property (nonatomic, strong) NSString * _Nullable KMSMasterKeyId; /**

Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughputOverride * _Nullable provisionedThroughputOverride; /**

The Region where the new replica will be created.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; /**

Replica-specific table class. If not specified, uses the source table's table class.

*/ @property (nonatomic, assign) AWSDynamoDBTableClass tableClassOverride; @end /**

Represents the input of a CreateTable operation.

Required parameters: [AttributeDefinitions, TableName, KeySchema] */ @interface AWSDynamoDBCreateTableInput : AWSRequest /**

An array of attributes that describe the key schema for the table and indexes.

*/ @property (nonatomic, strong) NSArray * _Nullable attributeDefinitions; /**

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

*/ @property (nonatomic, assign) AWSDynamoDBBillingMode billingMode; /**

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

*/ @property (nonatomic, strong) NSNumber * _Nullable deletionProtectionEnabled; /**

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

  • IndexName - The name of the global secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the global secondary index.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexes; /**

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.

  • KeyType - The role that the key attribute will assume:

    • HASH - partition key

    • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable keySchema; /**

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

  • IndexName - The name of the local secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

*/ @property (nonatomic, strong) NSArray * _Nullable localSecondaryIndexes; /**

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput * _Nullable provisionedThroughput; /**

Represents the settings used to enable server-side encryption.

*/ @property (nonatomic, strong) AWSDynamoDBSSESpecification * _Nullable SSESpecification; /**

The settings for DynamoDB Streams on the table. These settings consist of:

  • StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).

  • StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

    • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

    • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

    • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

    • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

*/ @property (nonatomic, strong) AWSDynamoDBStreamSpecification * _Nullable streamSpecification; /**

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

*/ @property (nonatomic, assign) AWSDynamoDBTableClass tableClass; /**

The name of the table to create.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; /**

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /**

Represents the output of a CreateTable operation.

*/ @interface AWSDynamoDBCreateTableOutput : AWSModel /**

Represents the properties of the table.

*/ @property (nonatomic, strong) AWSDynamoDBTableDescription * _Nullable tableDescription; @end /**

Processing options for the CSV file being imported.

*/ @interface AWSDynamoDBCsvOptions : AWSModel /**

The delimiter used for separating items in the CSV file being imported.

*/ @property (nonatomic, strong) NSString * _Nullable delimiter; /**

List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.

*/ @property (nonatomic, strong) NSArray * _Nullable headerList; @end /**

Represents a request to perform a DeleteItem operation.

Required parameters: [Key, TableName] */ @interface AWSDynamoDBRemove : AWSModel /**

A condition that must be satisfied in order for a conditional delete to succeed.

*/ @property (nonatomic, strong) NSString * _Nullable conditionExpression; /**

One or more substitution tokens for attribute names in an expression.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

One or more values that can be substituted in an expression.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeValues; /**

The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute.

*/ @property (nonatomic, strong) NSDictionary * _Nullable key; /**

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

*/ @property (nonatomic, assign) AWSDynamoDBReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure; /**

Name of the table in which the item to be deleted resides.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBDeleteBackupInput : AWSRequest /**

The ARN associated with the backup.

*/ @property (nonatomic, strong) NSString * _Nullable backupArn; @end /** */ @interface AWSDynamoDBDeleteBackupOutput : AWSModel /**

Contains the description of the backup created for the table.

*/ @property (nonatomic, strong) AWSDynamoDBBackupDescription * _Nullable backupDescription; @end /**

Represents a global secondary index to be deleted from an existing table.

Required parameters: [IndexName] */ @interface AWSDynamoDBDeleteGlobalSecondaryIndexAction : AWSModel /**

The name of the global secondary index to be deleted.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; @end /**

Represents the input of a DeleteItem operation.

Required parameters: [TableName, Key] */ @interface AWSDynamoDBDeleteItemInput : AWSRequest /**

A condition that must be satisfied in order for a conditional DeleteItem to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable conditionExpression; /**

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, assign) AWSDynamoDBConditionalOperator conditionalOperator; /**

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expected; /**

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeValues; /**

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

*/ @property (nonatomic, strong) NSDictionary * _Nullable key; /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

*/ @property (nonatomic, assign) AWSDynamoDBReturnItemCollectionMetrics returnItemCollectionMetrics; /**

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - The content of the old item is returned.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

 */ @property (nonatomic, assign) AWSDynamoDBReturnValue returnValues; /**

An optional parameter that returns the item attributes for a DeleteItem operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

*/ @property (nonatomic, assign) AWSDynamoDBReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure; /**

The name of the table from which to delete the item.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the output of a DeleteItem operation.

*/ @interface AWSDynamoDBDeleteItemOutput : AWSModel /**

A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

*/ @property (nonatomic, strong) NSDictionary * _Nullable attributes; /**

The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBConsumedCapacity * _Nullable consumedCapacity; /**

Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

  • SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

*/ @property (nonatomic, strong) AWSDynamoDBItemCollectionMetrics * _Nullable itemCollectionMetrics; @end /**

Represents a replica to be removed.

Required parameters: [RegionName] */ @interface AWSDynamoDBDeleteReplicaAction : AWSModel /**

The Region of the replica to be removed.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; @end /**

Represents a replica to be deleted.

Required parameters: [RegionName] */ @interface AWSDynamoDBDeleteReplicationGroupMemberAction : AWSModel /**

The Region where the replica exists.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; @end /**

Represents a request to perform a DeleteItem operation on an item.

Required parameters: [Key] */ @interface AWSDynamoDBDeleteRequest : AWSModel /**

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

*/ @property (nonatomic, strong) NSDictionary * _Nullable key; @end /**

Represents the input of a DeleteTable operation.

Required parameters: [TableName] */ @interface AWSDynamoDBDeleteTableInput : AWSRequest /**

The name of the table to delete.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the output of a DeleteTable operation.

*/ @interface AWSDynamoDBDeleteTableOutput : AWSModel /**

Represents the properties of a table.

*/ @property (nonatomic, strong) AWSDynamoDBTableDescription * _Nullable tableDescription; @end /** */ @interface AWSDynamoDBDescribeBackupInput : AWSRequest /**

The Amazon Resource Name (ARN) associated with the backup.

*/ @property (nonatomic, strong) NSString * _Nullable backupArn; @end /** */ @interface AWSDynamoDBDescribeBackupOutput : AWSModel /**

Contains the description of the backup created for the table.

*/ @property (nonatomic, strong) AWSDynamoDBBackupDescription * _Nullable backupDescription; @end /** */ @interface AWSDynamoDBDescribeContinuousBackupsInput : AWSRequest /**

Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBDescribeContinuousBackupsOutput : AWSModel /**

Represents the continuous backups and point in time recovery settings on the table.

*/ @property (nonatomic, strong) AWSDynamoDBContinuousBackupsDescription * _Nullable continuousBackupsDescription; @end /** */ @interface AWSDynamoDBDescribeContributorInsightsInput : AWSRequest /**

The name of the global secondary index to describe, if applicable.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The name of the table to describe.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBDescribeContributorInsightsOutput : AWSModel /**

List of names of the associated contributor insights rules.

*/ @property (nonatomic, strong) NSArray * _Nullable contributorInsightsRuleList; /**

Current status of contributor insights.

*/ @property (nonatomic, assign) AWSDynamoDBContributorInsightsStatus contributorInsightsStatus; /**

Returns information about the last failure that was encountered.

The most common exceptions for a FAILED status are:

  • LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.

  • AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions.

  • AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions.

  • InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.

*/ @property (nonatomic, strong) AWSDynamoDBFailureException * _Nullable failureException; /**

The name of the global secondary index being described.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

Timestamp of the last time the status was changed.

*/ @property (nonatomic, strong) NSDate * _Nullable lastUpdateDateTime; /**

The name of the table being described.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBDescribeEndpointsRequest : AWSRequest @end /** */ @interface AWSDynamoDBDescribeEndpointsResponse : AWSModel /**

List of endpoints.

*/ @property (nonatomic, strong) NSArray * _Nullable endpoints; @end /** */ @interface AWSDynamoDBDescribeExportInput : AWSRequest /**

The Amazon Resource Name (ARN) associated with the export.

*/ @property (nonatomic, strong) NSString * _Nullable exportArn; @end /** */ @interface AWSDynamoDBDescribeExportOutput : AWSModel /**

Represents the properties of the export.

*/ @property (nonatomic, strong) AWSDynamoDBExportDescription * _Nullable exportDescription; @end /** */ @interface AWSDynamoDBDescribeGlobalTableInput : AWSRequest /**

The name of the global table.

*/ @property (nonatomic, strong) NSString * _Nullable globalTableName; @end /** */ @interface AWSDynamoDBDescribeGlobalTableOutput : AWSModel /**

Contains the details of the global table.

*/ @property (nonatomic, strong) AWSDynamoDBGlobalTableDescription * _Nullable globalTableDescription; @end /** */ @interface AWSDynamoDBDescribeGlobalTableSettingsInput : AWSRequest /**

The name of the global table to describe.

*/ @property (nonatomic, strong) NSString * _Nullable globalTableName; @end /** */ @interface AWSDynamoDBDescribeGlobalTableSettingsOutput : AWSModel /**

The name of the global table.

*/ @property (nonatomic, strong) NSString * _Nullable globalTableName; /**

The Region-specific settings for the global table.

*/ @property (nonatomic, strong) NSArray * _Nullable replicaSettings; @end /** */ @interface AWSDynamoDBDescribeImportInput : AWSRequest /**

The Amazon Resource Name (ARN) associated with the table you're importing to.

*/ @property (nonatomic, strong) NSString * _Nullable importArn; @end /** */ @interface AWSDynamoDBDescribeImportOutput : AWSModel /**

Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered.

*/ @property (nonatomic, strong) AWSDynamoDBImportTableDescription * _Nullable importTableDescription; @end /** */ @interface AWSDynamoDBDescribeKinesisStreamingDestinationInput : AWSRequest /**

The name of the table being described.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBDescribeKinesisStreamingDestinationOutput : AWSModel /**

The list of replica structures for the table being described.

*/ @property (nonatomic, strong) NSArray * _Nullable kinesisDataStreamDestinations; /**

The name of the table being described.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the input of a DescribeLimits operation. Has no content.

*/ @interface AWSDynamoDBDescribeLimitsInput : AWSRequest @end /**

Represents the output of a DescribeLimits operation.

*/ @interface AWSDynamoDBDescribeLimitsOutput : AWSModel /**

The maximum total read capacity units that your account allows you to provision across all of your tables in this Region.

*/ @property (nonatomic, strong) NSNumber * _Nullable accountMaxReadCapacityUnits; /**

The maximum total write capacity units that your account allows you to provision across all of your tables in this Region.

*/ @property (nonatomic, strong) NSNumber * _Nullable accountMaxWriteCapacityUnits; /**

The maximum read capacity units that your account allows you to provision for a new table that you are creating in this Region, including the read capacity units provisioned for its global secondary indexes (GSIs).

*/ @property (nonatomic, strong) NSNumber * _Nullable tableMaxReadCapacityUnits; /**

The maximum write capacity units that your account allows you to provision for a new table that you are creating in this Region, including the write capacity units provisioned for its global secondary indexes (GSIs).

*/ @property (nonatomic, strong) NSNumber * _Nullable tableMaxWriteCapacityUnits; @end /**

Represents the input of a DescribeTable operation.

Required parameters: [TableName] */ @interface AWSDynamoDBDescribeTableInput : AWSRequest /**

The name of the table to describe.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the output of a DescribeTable operation.

*/ @interface AWSDynamoDBDescribeTableOutput : AWSModel /**

The properties of the table.

*/ @property (nonatomic, strong) AWSDynamoDBTableDescription * _Nullable table; @end /** */ @interface AWSDynamoDBDescribeTableReplicaAutoScalingInput : AWSRequest /**

The name of the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBDescribeTableReplicaAutoScalingOutput : AWSModel /**

Represents the auto scaling properties of the table.

*/ @property (nonatomic, strong) AWSDynamoDBTableAutoScalingDescription * _Nullable tableAutoScalingDescription; @end /** */ @interface AWSDynamoDBDescribeTimeToLiveInput : AWSRequest /**

The name of the table to be described.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBDescribeTimeToLiveOutput : AWSModel /**

*/ @property (nonatomic, strong) AWSDynamoDBTimeToLiveDescription * _Nullable timeToLiveDescription; @end /**

An endpoint information details.

Required parameters: [Address, CachePeriodInMinutes] */ @interface AWSDynamoDBEndpoint : AWSModel /**

IP address of the endpoint.

*/ @property (nonatomic, strong) NSString * _Nullable address; /**

Endpoint cache time to live (TTL) value.

*/ @property (nonatomic, strong) NSNumber * _Nullable cachePeriodInMinutes; @end /** */ @interface AWSDynamoDBExecuteStatementInput : AWSRequest /**

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

*/ @property (nonatomic, strong) NSNumber * _Nullable consistentRead; /**

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, along with a key in LastEvaluatedKey to apply in a subsequent operation so you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

Set this value to get remaining results, if NextToken was returned in the statement response.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The parameters for the PartiQL statement, if any.

*/ @property (nonatomic, strong) NSArray * _Nullable parameters; /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

An optional parameter that returns the item attributes for an ExecuteStatement operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

*/ @property (nonatomic, assign) AWSDynamoDBReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure; /**

The PartiQL statement representing the operation to run.

*/ @property (nonatomic, strong) NSString * _Nullable statement; @end /** */ @interface AWSDynamoDBExecuteStatementOutput : AWSModel /**

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBConsumedCapacity * _Nullable consumedCapacity; /**

If a read operation was used, this property will contain the result of the read operation; a map of attribute names and their values. For the write operations this value will be empty.

*/ @property (nonatomic, strong) NSArray *> * _Nullable items; /**

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

*/ @property (nonatomic, strong) NSDictionary * _Nullable lastEvaluatedKey; /**

If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSDynamoDBExecuteTransactionInput : AWSRequest /**

Set this value to get remaining results, if NextToken was returned in the statement response.

*/ @property (nonatomic, strong) NSString * _Nullable clientRequestToken; /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response. For more information, see TransactGetItems and TransactWriteItems.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

The list of PartiQL statements representing the transaction to run.

*/ @property (nonatomic, strong) NSArray * _Nullable transactStatements; @end /** */ @interface AWSDynamoDBExecuteTransactionOutput : AWSModel /**

The capacity units consumed by the entire operation. The values of the list are ordered according to the ordering of the statements.

*/ @property (nonatomic, strong) NSArray * _Nullable consumedCapacity; /**

The response to a PartiQL transaction.

*/ @property (nonatomic, strong) NSArray * _Nullable responses; @end /**

Represents a condition to be compared with an attribute value. This condition can be used with DeleteItem, PutItem, or UpdateItem operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of two different ways:

  • Use AttributeValueList to specify one or more values to compare against an attribute. Use ComparisonOperator to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds.

  • Use Value to specify a value that DynamoDB will compare against an attribute. If the values match, then ExpectedAttributeValue evaluates to true and the conditional operation succeeds. Optionally, you can also set Exists to false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.

Value and Exists are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

*/ @interface AWSDynamoDBExpectedAttributeValue : AWSModel /**

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable attributeValueList; /**

A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

  • EQ : Equal. EQ is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

  • NE : Not equal. NE is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

  • LE : Less than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • LT : Less than.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • GE : Greater than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • GT : Greater than.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

    This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.

  • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

    This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.

  • CONTAINS : Checks for a subsequence, or value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

    CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

  • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

    NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

  • BEGINS_WITH : Checks for a prefix.

    AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

  • IN : Checks for matching elements in a list.

    AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

  • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

    AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

*/ @property (nonatomic, assign) AWSDynamoDBComparisonOperator comparisonOperator; /**

Causes DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionCheckFailedException.

  • If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionCheckFailedException.

The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

*/ @property (nonatomic, strong) NSNumber * _Nullable exists; /**

Represents the data for the expected attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBAttributeValue * _Nullable value; @end /**

Represents the properties of the exported table.

*/ @interface AWSDynamoDBExportDescription : AWSModel /**

The billable size of the table export.

*/ @property (nonatomic, strong) NSNumber * _Nullable billedSizeBytes; /**

The client token that was provided for the export task. A client token makes calls to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

*/ @property (nonatomic, strong) NSString * _Nullable clientToken; /**

The time at which the export task completed.

*/ @property (nonatomic, strong) NSDate * _Nullable endTime; /**

The Amazon Resource Name (ARN) of the table export.

*/ @property (nonatomic, strong) NSString * _Nullable exportArn; /**

The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

*/ @property (nonatomic, assign) AWSDynamoDBExportFormat exportFormat; /**

The name of the manifest file for the export task.

*/ @property (nonatomic, strong) NSString * _Nullable exportManifest; /**

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

*/ @property (nonatomic, assign) AWSDynamoDBExportStatus exportStatus; /**

Point in time from which table data was exported.

*/ @property (nonatomic, strong) NSDate * _Nullable exportTime; /**

Status code for the result of the failed export.

*/ @property (nonatomic, strong) NSString * _Nullable failureCode; /**

Export failure reason description.

*/ @property (nonatomic, strong) NSString * _Nullable failureMessage; /**

The number of items exported.

*/ @property (nonatomic, strong) NSNumber * _Nullable itemCount; /**

The name of the Amazon S3 bucket containing the export.

*/ @property (nonatomic, strong) NSString * _Nullable s3Bucket; /**

The ID of the Amazon Web Services account that owns the bucket containing the export.

*/ @property (nonatomic, strong) NSString * _Nullable s3BucketOwner; /**

The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.

*/ @property (nonatomic, strong) NSString * _Nullable s3Prefix; /**

Type of encryption used on the bucket where export data is stored. Valid values for S3SseAlgorithm are:

  • AES256 - server-side encryption with Amazon S3 managed keys

  • KMS - server-side encryption with KMS managed keys

*/ @property (nonatomic, assign) AWSDynamoDBS3SseAlgorithm s3SseAlgorithm; /**

The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).

*/ @property (nonatomic, strong) NSString * _Nullable s3SseKmsKeyId; /**

The time at which the export task began.

*/ @property (nonatomic, strong) NSDate * _Nullable startTime; /**

The Amazon Resource Name (ARN) of the table that was exported.

*/ @property (nonatomic, strong) NSString * _Nullable tableArn; /**

Unique ID of the table that was exported.

*/ @property (nonatomic, strong) NSString * _Nullable tableId; @end /**

Summary information about an export task.

*/ @interface AWSDynamoDBExportSummary : AWSModel /**

The Amazon Resource Name (ARN) of the export.

*/ @property (nonatomic, strong) NSString * _Nullable exportArn; /**

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

*/ @property (nonatomic, assign) AWSDynamoDBExportStatus exportStatus; @end /** */ @interface AWSDynamoDBExportTableToPointInTimeInput : AWSRequest /**

Providing a ClientToken makes the call to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an ImportConflictException.

*/ @property (nonatomic, strong) NSString * _Nullable clientToken; /**

The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

*/ @property (nonatomic, assign) AWSDynamoDBExportFormat exportFormat; /**

Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.

*/ @property (nonatomic, strong) NSDate * _Nullable exportTime; /**

The name of the Amazon S3 bucket to export the snapshot to.

*/ @property (nonatomic, strong) NSString * _Nullable s3Bucket; /**

The ID of the Amazon Web Services account that owns the bucket the export will be stored in.

*/ @property (nonatomic, strong) NSString * _Nullable s3BucketOwner; /**

The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

*/ @property (nonatomic, strong) NSString * _Nullable s3Prefix; /**

Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:

  • AES256 - server-side encryption with Amazon S3 managed keys

  • KMS - server-side encryption with KMS managed keys

*/ @property (nonatomic, assign) AWSDynamoDBS3SseAlgorithm s3SseAlgorithm; /**

The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

*/ @property (nonatomic, strong) NSString * _Nullable s3SseKmsKeyId; /**

The Amazon Resource Name (ARN) associated with the table to export.

*/ @property (nonatomic, strong) NSString * _Nullable tableArn; @end /** */ @interface AWSDynamoDBExportTableToPointInTimeOutput : AWSModel /**

Contains a description of the table export.

*/ @property (nonatomic, strong) AWSDynamoDBExportDescription * _Nullable exportDescription; @end /**

Represents a failure a contributor insights operation.

*/ @interface AWSDynamoDBFailureException : AWSModel /**

Description of the failure.

*/ @property (nonatomic, strong) NSString * _Nullable exceptionDescription; /**

Exception name.

*/ @property (nonatomic, strong) NSString * _Nullable exceptionName; @end /**

Specifies an item and related attribute values to retrieve in a TransactGetItem object.

Required parameters: [Key, TableName] */ @interface AWSDynamoDBGet : AWSModel /**

One or more substitution tokens for attribute names in the ProjectionExpression parameter.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.

*/ @property (nonatomic, strong) NSDictionary * _Nullable key; /**

A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.

*/ @property (nonatomic, strong) NSString * _Nullable projectionExpression; /**

The name of the table from which to retrieve the specified item.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the input of a GetItem operation.

Required parameters: [TableName, Key] */ @interface AWSDynamoDBGetItemInput : AWSRequest /**

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable attributesToGet; /**

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

*/ @property (nonatomic, strong) NSNumber * _Nullable consistentRead; /**

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

*/ @property (nonatomic, strong) NSDictionary * _Nullable key; /**

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable projectionExpression; /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

The name of the table containing the requested item.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the output of a GetItem operation.

*/ @interface AWSDynamoDBGetItemOutput : AWSModel /**

The capacity units consumed by the GetItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBConsumedCapacity * _Nullable consumedCapacity; /**

A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.

*/ @property (nonatomic, strong) NSDictionary * _Nullable item; @end /**

Represents the properties of a global secondary index.

Required parameters: [IndexName, KeySchema, Projection] */ @interface AWSDynamoDBGlobalSecondaryIndex : AWSModel /**

The name of the global secondary index. The name must be unique among all other indexes on this table.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

 */ @property (nonatomic, strong) NSArray * _Nullable keySchema; /**

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

*/ @property (nonatomic, strong) AWSDynamoDBProjection * _Nullable projection; /**

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput * _Nullable provisionedThroughput; @end /**

Represents the auto scaling settings of a global secondary index for a global table that will be modified.

*/ @interface AWSDynamoDBGlobalSecondaryIndexAutoScalingUpdate : AWSModel /**

The name of the global secondary index.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

Represents the auto scaling settings to be modified for a global table or global secondary index.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsUpdate * _Nullable provisionedWriteCapacityAutoScalingUpdate; @end /**

Represents the properties of a global secondary index.

*/ @interface AWSDynamoDBGlobalSecondaryIndexDescription : AWSModel /**

Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false.

For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

 */ @property (nonatomic, strong) NSNumber * _Nullable backfilling; /**

The Amazon Resource Name (ARN) that uniquely identifies the index.

*/ @property (nonatomic, strong) NSString * _Nullable indexArn; /**

The name of the global secondary index.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

*/ @property (nonatomic, strong) NSNumber * _Nullable indexSizeBytes; /**

The current state of the global secondary index:

  • CREATING - The index is being created.

  • UPDATING - The index is being updated.

  • DELETING - The index is being deleted.

  • ACTIVE - The index is ready for use.

*/ @property (nonatomic, assign) AWSDynamoDBIndexStatus indexStatus; /**

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

*/ @property (nonatomic, strong) NSNumber * _Nullable itemCount; /**

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

 */ @property (nonatomic, strong) NSArray * _Nullable keySchema; /**

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

*/ @property (nonatomic, strong) AWSDynamoDBProjection * _Nullable projection; /**

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughputDescription * _Nullable provisionedThroughput; @end /**

Represents the properties of a global secondary index for the table when the backup was created.

*/ @interface AWSDynamoDBGlobalSecondaryIndexInfo : AWSModel /**

The name of the global secondary index.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

 */ @property (nonatomic, strong) NSArray * _Nullable keySchema; /**

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

*/ @property (nonatomic, strong) AWSDynamoDBProjection * _Nullable projection; /**

Represents the provisioned throughput settings for the specified global secondary index.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput * _Nullable provisionedThroughput; @end /**

Represents one of the following:

  • A new global secondary index to be added to an existing table.

  • New provisioned throughput parameters for an existing global secondary index.

  • An existing global secondary index to be removed from an existing table.

*/ @interface AWSDynamoDBGlobalSecondaryIndexUpdate : AWSModel /**

The parameters required for creating a global secondary index on an existing table:

  • IndexName

  • KeySchema

  • AttributeDefinitions

  • Projection

  • ProvisionedThroughput

*/ @property (nonatomic, strong) AWSDynamoDBCreateGlobalSecondaryIndexAction * _Nullable create; /**

The name of an existing global secondary index to be removed.

*/ @property (nonatomic, strong) AWSDynamoDBDeleteGlobalSecondaryIndexAction * _Nullable remove; /**

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

*/ @property (nonatomic, strong) AWSDynamoDBUpdateGlobalSecondaryIndexAction * _Nullable update; @end /**

Represents the properties of a global table.

*/ @interface AWSDynamoDBGlobalTable : AWSModel /**

The global table name.

*/ @property (nonatomic, strong) NSString * _Nullable globalTableName; /**

The Regions where the global table has replicas.

*/ @property (nonatomic, strong) NSArray * _Nullable replicationGroup; @end /**

Contains details about the global table.

*/ @interface AWSDynamoDBGlobalTableDescription : AWSModel /**

The creation time of the global table.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDateTime; /**

The unique identifier of the global table.

*/ @property (nonatomic, strong) NSString * _Nullable globalTableArn; /**

The global table name.

*/ @property (nonatomic, strong) NSString * _Nullable globalTableName; /**

The current state of the global table:

  • CREATING - The global table is being created.

  • UPDATING - The global table is being updated.

  • DELETING - The global table is being deleted.

  • ACTIVE - The global table is ready for use.

*/ @property (nonatomic, assign) AWSDynamoDBGlobalTableStatus globalTableStatus; /**

The Regions where the global table has replicas.

*/ @property (nonatomic, strong) NSArray * _Nullable replicationGroup; @end /**

Represents the settings of a global secondary index for a global table that will be modified.

Required parameters: [IndexName] */ @interface AWSDynamoDBGlobalTableGlobalSecondaryIndexSettingsUpdate : AWSModel /**

The name of the global secondary index. The name must be unique among all other indexes on this table.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

Auto scaling settings for managing a global secondary index's write capacity units.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsUpdate * _Nullable provisionedWriteCapacityAutoScalingSettingsUpdate; /**

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

*/ @property (nonatomic, strong) NSNumber * _Nullable provisionedWriteCapacityUnits; @end /**

Summary information about the source file for the import.

*/ @interface AWSDynamoDBImportSummary : AWSModel /**

The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with this import task.

*/ @property (nonatomic, strong) NSString * _Nullable cloudWatchLogGroupArn; /**

The time at which this import task ended. (Does this include the successful complete creation of the table it was imported to?)

*/ @property (nonatomic, strong) NSDate * _Nullable endTime; /**

The Amazon Resource Number (ARN) corresponding to the import request.

*/ @property (nonatomic, strong) NSString * _Nullable importArn; /**

The status of the import operation.

*/ @property (nonatomic, assign) AWSDynamoDBImportStatus importStatus; /**

The format of the source data. Valid values are CSV, DYNAMODB_JSON or ION.

*/ @property (nonatomic, assign) AWSDynamoDBInputFormat inputFormat; /**

The path and S3 bucket of the source file that is being imported. This includes the S3Bucket (required), S3KeyPrefix (optional) and S3BucketOwner (optional if the bucket is owned by the requester).

*/ @property (nonatomic, strong) AWSDynamoDBS3BucketSource * _Nullable s3BucketSource; /**

The time at which this import task began.

*/ @property (nonatomic, strong) NSDate * _Nullable startTime; /**

The Amazon Resource Number (ARN) of the table being imported into.

*/ @property (nonatomic, strong) NSString * _Nullable tableArn; @end /**

Represents the properties of the table being imported into.

*/ @interface AWSDynamoDBImportTableDescription : AWSModel /**

The client token that was provided for the import task. Reusing the client token on retry makes a call to ImportTable idempotent.

*/ @property (nonatomic, strong) NSString * _Nullable clientToken; /**

The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.

*/ @property (nonatomic, strong) NSString * _Nullable cloudWatchLogGroupArn; /**

The time at which the creation of the table associated with this import task completed.

*/ @property (nonatomic, strong) NSDate * _Nullable endTime; /**

The number of errors occurred on importing the source file into the target table.

*/ @property (nonatomic, strong) NSNumber * _Nullable errorCount; /**

The error code corresponding to the failure that the import job ran into during execution.

*/ @property (nonatomic, strong) NSString * _Nullable failureCode; /**

The error message corresponding to the failure that the import job ran into during execution.

*/ @property (nonatomic, strong) NSString * _Nullable failureMessage; /**

The Amazon Resource Number (ARN) corresponding to the import request.

*/ @property (nonatomic, strong) NSString * _Nullable importArn; /**

The status of the import.

*/ @property (nonatomic, assign) AWSDynamoDBImportStatus importStatus; /**

The number of items successfully imported into the new table.

*/ @property (nonatomic, strong) NSNumber * _Nullable importedItemCount; /**

The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.

*/ @property (nonatomic, assign) AWSDynamoDBInputCompressionType inputCompressionType; /**

The format of the source data going into the target table.

*/ @property (nonatomic, assign) AWSDynamoDBInputFormat inputFormat; /**

The format options for the data that was imported into the target table. There is one value, CsvOption.

*/ @property (nonatomic, strong) AWSDynamoDBInputFormatOptions * _Nullable inputFormatOptions; /**

The total number of items processed from the source file.

*/ @property (nonatomic, strong) NSNumber * _Nullable processedItemCount; /**

The total size of data processed from the source file, in Bytes.

*/ @property (nonatomic, strong) NSNumber * _Nullable processedSizeBytes; /**

Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).

*/ @property (nonatomic, strong) AWSDynamoDBS3BucketSource * _Nullable s3BucketSource; /**

The time when this import task started.

*/ @property (nonatomic, strong) NSDate * _Nullable startTime; /**

The Amazon Resource Number (ARN) of the table being imported into.

*/ @property (nonatomic, strong) NSString * _Nullable tableArn; /**

The parameters for the new table that is being imported into.

*/ @property (nonatomic, strong) AWSDynamoDBTableCreationParameters * _Nullable tableCreationParameters; /**

The table id corresponding to the table created by import table process.

*/ @property (nonatomic, strong) NSString * _Nullable tableId; @end /** */ @interface AWSDynamoDBImportTableInput : AWSRequest /**

Providing a ClientToken makes the call to ImportTableInput idempotent, meaning that multiple identical calls have the same effect as one single call.

A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

*/ @property (nonatomic, strong) NSString * _Nullable clientToken; /**

Type of compression to be used on the input coming from the imported table.

*/ @property (nonatomic, assign) AWSDynamoDBInputCompressionType inputCompressionType; /**

The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.

*/ @property (nonatomic, assign) AWSDynamoDBInputFormat inputFormat; /**

Additional properties that specify how the input is formatted,

*/ @property (nonatomic, strong) AWSDynamoDBInputFormatOptions * _Nullable inputFormatOptions; /**

The S3 bucket that provides the source for the import.

*/ @property (nonatomic, strong) AWSDynamoDBS3BucketSource * _Nullable s3BucketSource; /**

Parameters for the table to import the data into.

*/ @property (nonatomic, strong) AWSDynamoDBTableCreationParameters * _Nullable tableCreationParameters; @end /** */ @interface AWSDynamoDBImportTableOutput : AWSModel /**

Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered.

*/ @property (nonatomic, strong) AWSDynamoDBImportTableDescription * _Nullable importTableDescription; @end /**

The format options for the data that was imported into the target table. There is one value, CsvOption.

*/ @interface AWSDynamoDBInputFormatOptions : AWSModel /**

The options for imported source files in CSV format. The values are Delimiter and HeaderList.

*/ @property (nonatomic, strong) AWSDynamoDBCsvOptions * _Nullable csv; @end /**

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

*/ @interface AWSDynamoDBItemCollectionMetrics : AWSModel /**

The partition key value of the item collection. This value is the same as the partition key value of the item.

*/ @property (nonatomic, strong) NSDictionary * _Nullable itemCollectionKey; /**

An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

*/ @property (nonatomic, strong) NSArray * _Nullable sizeEstimateRangeGB; @end /**

Details for the requested item.

*/ @interface AWSDynamoDBItemResponse : AWSModel /**

Map of attribute data consisting of the data type and attribute value.

*/ @property (nonatomic, strong) NSDictionary * _Nullable item; @end /**

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

Required parameters: [AttributeName, KeyType] */ @interface AWSDynamoDBKeySchemaElement : AWSModel /**

The name of a key attribute.

*/ @property (nonatomic, strong) NSString * _Nullable attributeName; /**

The role that this key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

 */ @property (nonatomic, assign) AWSDynamoDBKeyType keyType; @end /**

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.

Required parameters: [Keys] */ @interface AWSDynamoDBKeysAndAttributes : AWSModel /**

This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable attributesToGet; /**

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

*/ @property (nonatomic, strong) NSNumber * _Nullable consistentRead; /**

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

The primary key attribute values that define the items and the attributes associated with the items.

*/ @property (nonatomic, strong) NSArray *> * _Nullable keys; /**

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable projectionExpression; @end /**

Describes a Kinesis data stream destination.

*/ @interface AWSDynamoDBKinesisDataStreamDestination : AWSModel /**

The current status of replication.

*/ @property (nonatomic, assign) AWSDynamoDBDestinationStatus destinationStatus; /**

The human-readable string that corresponds to the replica status.

*/ @property (nonatomic, strong) NSString * _Nullable destinationStatusDescription; /**

The ARN for a specific Kinesis data stream.

*/ @property (nonatomic, strong) NSString * _Nullable streamArn; @end /** */ @interface AWSDynamoDBKinesisStreamingDestinationInput : AWSRequest /**

The ARN for a Kinesis data stream.

*/ @property (nonatomic, strong) NSString * _Nullable streamArn; /**

The name of the DynamoDB table.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBKinesisStreamingDestinationOutput : AWSModel /**

The current status of the replication.

*/ @property (nonatomic, assign) AWSDynamoDBDestinationStatus destinationStatus; /**

The ARN for the specific Kinesis data stream.

*/ @property (nonatomic, strong) NSString * _Nullable streamArn; /**

The name of the table being modified.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBListBackupsInput : AWSRequest /**

The backups from the table specified by BackupType are listed.

Where BackupType can be:

  • USER - On-demand backup created by you. (The default setting if no other backup types are specified.)

  • SYSTEM - On-demand backup automatically created by DynamoDB.

  • ALL - All types of on-demand backups (USER and SYSTEM).

*/ @property (nonatomic, assign) AWSDynamoDBBackupTypeFilter backupType; /**

LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

*/ @property (nonatomic, strong) NSString * _Nullable exclusiveStartBackupArn; /**

Maximum number of backups to return at once.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

The backups from the table specified by TableName are listed.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; /**

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

*/ @property (nonatomic, strong) NSDate * _Nullable timeRangeLowerBound; /**

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

*/ @property (nonatomic, strong) NSDate * _Nullable timeRangeUpperBound; @end /** */ @interface AWSDynamoDBListBackupsOutput : AWSModel /**

List of BackupSummary objects.

*/ @property (nonatomic, strong) NSArray * _Nullable backupSummaries; /**

The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no more results to be retrieved.

If LastEvaluatedBackupArn is not empty, this may or may not indicate that there is more data to be returned. All results are guaranteed to have been returned if and only if no value for LastEvaluatedBackupArn is returned.

*/ @property (nonatomic, strong) NSString * _Nullable lastEvaluatedBackupArn; @end /** */ @interface AWSDynamoDBListContributorInsightsInput : AWSRequest /**

Maximum number of results to return per page.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

A token to for the desired page, if there is one.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The name of the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBListContributorInsightsOutput : AWSModel /**

A list of ContributorInsightsSummary.

*/ @property (nonatomic, strong) NSArray * _Nullable contributorInsightsSummaries; /**

A token to go to the next page if there is one.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSDynamoDBListExportsInput : AWSRequest /**

Maximum number of results to return per page.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

An optional string that, if supplied, must be copied from the output of a previous call to ListExports. When provided in this manner, the API fetches the next page of results.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The Amazon Resource Name (ARN) associated with the exported table.

*/ @property (nonatomic, strong) NSString * _Nullable tableArn; @end /** */ @interface AWSDynamoDBListExportsOutput : AWSModel /**

A list of ExportSummary objects.

*/ @property (nonatomic, strong) NSArray * _Nullable exportSummaries; /**

If this value is returned, there are additional results to be displayed. To retrieve them, call ListExports again, with NextToken set to this value.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSDynamoDBListGlobalTablesInput : AWSRequest /**

The first global table name that this operation will evaluate.

*/ @property (nonatomic, strong) NSString * _Nullable exclusiveStartGlobalTableName; /**

The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.

If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point, with a table name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to the ExclusiveStartGlobalTableName parameter.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

Lists the global tables in a specific Region.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; @end /** */ @interface AWSDynamoDBListGlobalTablesOutput : AWSModel /**

List of global table names.

*/ @property (nonatomic, strong) NSArray * _Nullable globalTables; /**

Last evaluated global table name.

*/ @property (nonatomic, strong) NSString * _Nullable lastEvaluatedGlobalTableName; @end /** */ @interface AWSDynamoDBListImportsInput : AWSRequest /**

An optional string that, if supplied, must be copied from the output of a previous call to ListImports. When provided in this manner, the API fetches the next page of results.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The number of ImportSummary objects returned in a single page.

*/ @property (nonatomic, strong) NSNumber * _Nullable pageSize; /**

The Amazon Resource Name (ARN) associated with the table that was imported to.

*/ @property (nonatomic, strong) NSString * _Nullable tableArn; @end /** */ @interface AWSDynamoDBListImportsOutput : AWSModel /**

A list of ImportSummary objects.

*/ @property (nonatomic, strong) NSArray * _Nullable importSummaryList; /**

If this value is returned, there are additional results to be displayed. To retrieve them, call ListImports again, with NextToken set to this value.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**

Represents the input of a ListTables operation.

*/ @interface AWSDynamoDBListTablesInput : AWSRequest /**

The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

*/ @property (nonatomic, strong) NSString * _Nullable exclusiveStartTableName; /**

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; @end /**

Represents the output of a ListTables operation.

*/ @interface AWSDynamoDBListTablesOutput : AWSModel /**

The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.

If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.

*/ @property (nonatomic, strong) NSString * _Nullable lastEvaluatedTableName; /**

The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.

*/ @property (nonatomic, strong) NSArray * _Nullable tableNames; @end /** */ @interface AWSDynamoDBListTagsOfResourceInput : AWSRequest /**

An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; @end /** */ @interface AWSDynamoDBListTagsOfResourceOutput : AWSModel /**

If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The tags currently associated with the Amazon DynamoDB resource.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /**

Represents the properties of a local secondary index.

Required parameters: [IndexName, KeySchema, Projection] */ @interface AWSDynamoDBLocalSecondaryIndex : AWSModel /**

The name of the local secondary index. The name must be unique among all other indexes on this table.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

 */ @property (nonatomic, strong) NSArray * _Nullable keySchema; /**

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

*/ @property (nonatomic, strong) AWSDynamoDBProjection * _Nullable projection; @end /**

Represents the properties of a local secondary index.

*/ @interface AWSDynamoDBLocalSecondaryIndexDescription : AWSModel /**

The Amazon Resource Name (ARN) that uniquely identifies the index.

*/ @property (nonatomic, strong) NSString * _Nullable indexArn; /**

Represents the name of the local secondary index.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

*/ @property (nonatomic, strong) NSNumber * _Nullable indexSizeBytes; /**

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

*/ @property (nonatomic, strong) NSNumber * _Nullable itemCount; /**

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

 */ @property (nonatomic, strong) NSArray * _Nullable keySchema; /**

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

*/ @property (nonatomic, strong) AWSDynamoDBProjection * _Nullable projection; @end /**

Represents the properties of a local secondary index for the table when the backup was created.

*/ @interface AWSDynamoDBLocalSecondaryIndexInfo : AWSModel /**

Represents the name of the local secondary index.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

 */ @property (nonatomic, strong) NSArray * _Nullable keySchema; /**

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

*/ @property (nonatomic, strong) AWSDynamoDBProjection * _Nullable projection; @end /**

Represents a PartiQL statment that uses parameters.

Required parameters: [Statement] */ @interface AWSDynamoDBParameterizedStatement : AWSModel /**

The parameter values.

*/ @property (nonatomic, strong) NSArray * _Nullable parameters; /**

An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

*/ @property (nonatomic, assign) AWSDynamoDBReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure; /**

A PartiQL statment that uses parameters.

*/ @property (nonatomic, strong) NSString * _Nullable statement; @end /**

The description of the point in time settings applied to the table.

*/ @interface AWSDynamoDBPointInTimeRecoveryDescription : AWSModel /**

Specifies the earliest point in time you can restore your table to. You can restore your table to any point in time during the last 35 days.

*/ @property (nonatomic, strong) NSDate * _Nullable earliestRestorableDateTime; /**

LatestRestorableDateTime is typically 5 minutes before the current time.

*/ @property (nonatomic, strong) NSDate * _Nullable latestRestorableDateTime; /**

The current state of point in time recovery:

  • ENABLED - Point in time recovery is enabled.

  • DISABLED - Point in time recovery is disabled.

*/ @property (nonatomic, assign) AWSDynamoDBPointInTimeRecoveryStatus pointInTimeRecoveryStatus; @end /**

Represents the settings used to enable point in time recovery.

Required parameters: [PointInTimeRecoveryEnabled] */ @interface AWSDynamoDBPointInTimeRecoverySpecification : AWSModel /**

Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

*/ @property (nonatomic, strong) NSNumber * _Nullable pointInTimeRecoveryEnabled; @end /**

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

*/ @interface AWSDynamoDBProjection : AWSModel /**

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

*/ @property (nonatomic, strong) NSArray * _Nullable nonKeyAttributes; /**

The set of attributes that are projected into the index:

  • KEYS_ONLY - Only the index and primary keys are projected into the index.

  • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

  • ALL - All of the table attributes are projected into the index.

*/ @property (nonatomic, assign) AWSDynamoDBProjectionType projectionType; @end /**

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

Required parameters: [ReadCapacityUnits, WriteCapacityUnits] */ @interface AWSDynamoDBProvisionedThroughput : AWSModel /**

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

*/ @property (nonatomic, strong) NSNumber * _Nullable readCapacityUnits; /**

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

*/ @property (nonatomic, strong) NSNumber * _Nullable writeCapacityUnits; @end /**

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

*/ @interface AWSDynamoDBProvisionedThroughputDescription : AWSModel /**

The date and time of the last provisioned throughput decrease for this table.

*/ @property (nonatomic, strong) NSDate * _Nullable lastDecreaseDateTime; /**

The date and time of the last provisioned throughput increase for this table.

*/ @property (nonatomic, strong) NSDate * _Nullable lastIncreaseDateTime; /**

The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSNumber * _Nullable numberOfDecreasesToday; /**

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

*/ @property (nonatomic, strong) NSNumber * _Nullable readCapacityUnits; /**

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

*/ @property (nonatomic, strong) NSNumber * _Nullable writeCapacityUnits; @end /**

Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.

*/ @interface AWSDynamoDBProvisionedThroughputOverride : AWSModel /**

Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.

*/ @property (nonatomic, strong) NSNumber * _Nullable readCapacityUnits; @end /**

Represents a request to perform a PutItem operation.

Required parameters: [Item, TableName] */ @interface AWSDynamoDBPut : AWSModel /**

A condition that must be satisfied in order for a conditional update to succeed.

*/ @property (nonatomic, strong) NSString * _Nullable conditionExpression; /**

One or more substitution tokens for attribute names in an expression.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

One or more values that can be substituted in an expression.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeValues; /**

A map of attribute name to attribute values, representing the primary key of the item to be written by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

*/ @property (nonatomic, strong) NSDictionary * _Nullable item; /**

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

*/ @property (nonatomic, assign) AWSDynamoDBReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure; /**

Name of the table in which to write the item.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the input of a PutItem operation.

Required parameters: [TableName, Item] */ @interface AWSDynamoDBPutItemInput : AWSRequest /**

A condition that must be satisfied in order for a conditional PutItem operation to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable conditionExpression; /**

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, assign) AWSDynamoDBConditionalOperator conditionalOperator; /**

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expected; /**

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeValues; /**

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

*/ @property (nonatomic, strong) NSDictionary * _Nullable item; /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

*/ @property (nonatomic, assign) AWSDynamoDBReturnItemCollectionMetrics returnItemCollectionMetrics; /**

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

The values returned are strongly consistent.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.

 */ @property (nonatomic, assign) AWSDynamoDBReturnValue returnValues; /**

An optional parameter that returns the item attributes for a PutItem operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

*/ @property (nonatomic, assign) AWSDynamoDBReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure; /**

The name of the table to contain the item.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the output of a PutItem operation.

*/ @interface AWSDynamoDBPutItemOutput : AWSModel /**

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

*/ @property (nonatomic, strong) NSDictionary * _Nullable attributes; /**

The capacity units consumed by the PutItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBConsumedCapacity * _Nullable consumedCapacity; /**

Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

  • SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

*/ @property (nonatomic, strong) AWSDynamoDBItemCollectionMetrics * _Nullable itemCollectionMetrics; @end /**

Represents a request to perform a PutItem operation on an item.

Required parameters: [Item] */ @interface AWSDynamoDBPutRequest : AWSModel /**

A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

*/ @property (nonatomic, strong) NSDictionary * _Nullable item; @end /**

Represents the input of a Query operation.

Required parameters: [TableName] */ @interface AWSDynamoDBQueryInput : AWSRequest /**

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable attributesToGet; /**

This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, assign) AWSDynamoDBConditionalOperator conditionalOperator; /**

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

*/ @property (nonatomic, strong) NSNumber * _Nullable consistentRead; /**

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number, or Binary. No set data types are allowed.

*/ @property (nonatomic, strong) NSDictionary * _Nullable exclusiveStartKey; /**

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeValues; /**

A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable filterExpression; /**

The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The condition that specifies the key values for items to be retrieved by the Query action.

The condition must perform an equality test on a single partition key value.

The condition can optionally perform one of several comparison tests on a single sort key value. This allows Query to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.

The partition key equality test is required, and must be specified in the following format:

partitionKeyName=:partitionkeyval

If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:

partitionKeyName=:partitionkeyvalANDsortKeyName=:sortkeyval

Valid comparisons for the sort key condition are as follows:

  • sortKeyName=:sortkeyval - true if the sort key value is equal to :sortkeyval.

  • sortKeyName<:sortkeyval - true if the sort key value is less than :sortkeyval.

  • sortKeyName<=:sortkeyval - true if the sort key value is less than or equal to :sortkeyval.

  • sortKeyName>:sortkeyval - true if the sort key value is greater than :sortkeyval.

  • sortKeyName>= :sortkeyval - true if the sort key value is greater than or equal to :sortkeyval.

  • sortKeyNameBETWEEN:sortkeyval1AND:sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and less than or equal to :sortkeyval2.

  • begins_with (sortKeyName, :sortkeyval) - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name begins_with is case-sensitive.

Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval and :sortval with actual values at runtime.

You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:

  • Size = :myval

To work around this, define a placeholder (such a #S) to represent the attribute name Size. KeyConditionExpression then is as follows:

  • #S = :myval

For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.

For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable keyConditionExpression; /**

This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable keyConditions; /**

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable projectionExpression; /**

This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable queryFilter; /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.

If ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.

*/ @property (nonatomic, strong) NSNumber * _Nullable scanIndexForward; /**

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression. This return value is equivalent to specifying ProjectionExpression without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor ProjectionExpression are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and ProjectionExpression together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying ProjectionExpression without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

 */ @property (nonatomic, assign) AWSDynamoDBSelect select; /**

The name of the table containing the requested items.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the output of a Query operation.

*/ @interface AWSDynamoDBQueryOutput : AWSModel /**

The capacity units consumed by the Query operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBConsumedCapacity * _Nullable consumedCapacity; /**

The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

*/ @property (nonatomic, strong) NSNumber * _Nullable count; /**

An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

*/ @property (nonatomic, strong) NSArray *> * _Nullable items; /**

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

*/ @property (nonatomic, strong) NSDictionary * _Nullable lastEvaluatedKey; /**

The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

*/ @property (nonatomic, strong) NSNumber * _Nullable scannedCount; @end /**

Represents the properties of a replica.

*/ @interface AWSDynamoDBReplica : AWSModel /**

The Region where the replica needs to be created.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; @end /**

Represents the auto scaling settings of the replica.

*/ @interface AWSDynamoDBReplicaAutoScalingDescription : AWSModel /**

Replica-specific global secondary index auto scaling settings.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexes; /**

The Region where the replica exists.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; /**

Represents the auto scaling settings for a global table or global secondary index.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsDescription * _Nullable replicaProvisionedReadCapacityAutoScalingSettings; /**

Represents the auto scaling settings for a global table or global secondary index.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsDescription * _Nullable replicaProvisionedWriteCapacityAutoScalingSettings; /**

The current state of the replica:

  • CREATING - The replica is being created.

  • UPDATING - The replica is being updated.

  • DELETING - The replica is being deleted.

  • ACTIVE - The replica is ready for use.

*/ @property (nonatomic, assign) AWSDynamoDBReplicaStatus replicaStatus; @end /**

Represents the auto scaling settings of a replica that will be modified.

Required parameters: [RegionName] */ @interface AWSDynamoDBReplicaAutoScalingUpdate : AWSModel /**

The Region where the replica exists.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; /**

Represents the auto scaling settings of global secondary indexes that will be modified.

*/ @property (nonatomic, strong) NSArray * _Nullable replicaGlobalSecondaryIndexUpdates; /**

Represents the auto scaling settings to be modified for a global table or global secondary index.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsUpdate * _Nullable replicaProvisionedReadCapacityAutoScalingUpdate; @end /**

Contains the details of the replica.

*/ @interface AWSDynamoDBReplicaDescription : AWSModel /**

Replica-specific global secondary index settings.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexes; /**

The KMS key of the replica that will be used for KMS encryption.

*/ @property (nonatomic, strong) NSString * _Nullable KMSMasterKeyId; /**

Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughputOverride * _Nullable provisionedThroughputOverride; /**

The name of the Region.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; /**

The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

*/ @property (nonatomic, strong) NSDate * _Nullable replicaInaccessibleDateTime; /**

The current state of the replica:

  • CREATING - The replica is being created.

  • UPDATING - The replica is being updated.

  • DELETING - The replica is being deleted.

  • ACTIVE - The replica is ready for use.

  • REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.

    If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

  • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.

    If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

*/ @property (nonatomic, assign) AWSDynamoDBReplicaStatus replicaStatus; /**

Detailed information about the replica status.

*/ @property (nonatomic, strong) NSString * _Nullable replicaStatusDescription; /**

Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.

*/ @property (nonatomic, strong) NSString * _Nullable replicaStatusPercentProgress; /**

Contains details of the table class.

*/ @property (nonatomic, strong) AWSDynamoDBTableClassSummary * _Nullable replicaTableClassSummary; @end /**

Represents the properties of a replica global secondary index.

Required parameters: [IndexName] */ @interface AWSDynamoDBReplicaGlobalSecondaryIndex : AWSModel /**

The name of the global secondary index.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughputOverride * _Nullable provisionedThroughputOverride; @end /**

Represents the auto scaling configuration for a replica global secondary index.

*/ @interface AWSDynamoDBReplicaGlobalSecondaryIndexAutoScalingDescription : AWSModel /**

The name of the global secondary index.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The current state of the replica global secondary index:

  • CREATING - The index is being created.

  • UPDATING - The table/index configuration is being updated. The table/index remains available for data operations when UPDATING

  • DELETING - The index is being deleted.

  • ACTIVE - The index is ready for use.

*/ @property (nonatomic, assign) AWSDynamoDBIndexStatus indexStatus; /**

Represents the auto scaling settings for a global table or global secondary index.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsDescription * _Nullable provisionedReadCapacityAutoScalingSettings; /**

Represents the auto scaling settings for a global table or global secondary index.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsDescription * _Nullable provisionedWriteCapacityAutoScalingSettings; @end /**

Represents the auto scaling settings of a global secondary index for a replica that will be modified.

*/ @interface AWSDynamoDBReplicaGlobalSecondaryIndexAutoScalingUpdate : AWSModel /**

The name of the global secondary index.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

Represents the auto scaling settings to be modified for a global table or global secondary index.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsUpdate * _Nullable provisionedReadCapacityAutoScalingUpdate; @end /**

Represents the properties of a replica global secondary index.

*/ @interface AWSDynamoDBReplicaGlobalSecondaryIndexDescription : AWSModel /**

The name of the global secondary index.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

If not described, uses the source table GSI's read capacity settings.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughputOverride * _Nullable provisionedThroughputOverride; @end /**

Represents the properties of a global secondary index.

Required parameters: [IndexName] */ @interface AWSDynamoDBReplicaGlobalSecondaryIndexSettingsDescription : AWSModel /**

The name of the global secondary index. The name must be unique among all other indexes on this table.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The current status of the global secondary index:

  • CREATING - The global secondary index is being created.

  • UPDATING - The global secondary index is being updated.

  • DELETING - The global secondary index is being deleted.

  • ACTIVE - The global secondary index is ready for use.

*/ @property (nonatomic, assign) AWSDynamoDBIndexStatus indexStatus; /**

Auto scaling settings for a global secondary index replica's read capacity units.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsDescription * _Nullable provisionedReadCapacityAutoScalingSettings; /**

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

*/ @property (nonatomic, strong) NSNumber * _Nullable provisionedReadCapacityUnits; /**

Auto scaling settings for a global secondary index replica's write capacity units.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsDescription * _Nullable provisionedWriteCapacityAutoScalingSettings; /**

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

*/ @property (nonatomic, strong) NSNumber * _Nullable provisionedWriteCapacityUnits; @end /**

Represents the settings of a global secondary index for a global table that will be modified.

Required parameters: [IndexName] */ @interface AWSDynamoDBReplicaGlobalSecondaryIndexSettingsUpdate : AWSModel /**

The name of the global secondary index. The name must be unique among all other indexes on this table.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

Auto scaling settings for managing a global secondary index replica's read capacity units.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsUpdate * _Nullable provisionedReadCapacityAutoScalingSettingsUpdate; /**

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

*/ @property (nonatomic, strong) NSNumber * _Nullable provisionedReadCapacityUnits; @end /**

Represents the properties of a replica.

Required parameters: [RegionName] */ @interface AWSDynamoDBReplicaSettingsDescription : AWSModel /**

The Region name of the replica.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; /**

The read/write capacity mode of the replica.

*/ @property (nonatomic, strong) AWSDynamoDBBillingModeSummary * _Nullable replicaBillingModeSummary; /**

Replica global secondary index settings for the global table.

*/ @property (nonatomic, strong) NSArray * _Nullable replicaGlobalSecondaryIndexSettings; /**

Auto scaling settings for a global table replica's read capacity units.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsDescription * _Nullable replicaProvisionedReadCapacityAutoScalingSettings; /**

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSNumber * _Nullable replicaProvisionedReadCapacityUnits; /**

Auto scaling settings for a global table replica's write capacity units.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsDescription * _Nullable replicaProvisionedWriteCapacityAutoScalingSettings; /**

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSNumber * _Nullable replicaProvisionedWriteCapacityUnits; /**

The current state of the Region:

  • CREATING - The Region is being created.

  • UPDATING - The Region is being updated.

  • DELETING - The Region is being deleted.

  • ACTIVE - The Region is ready for use.

*/ @property (nonatomic, assign) AWSDynamoDBReplicaStatus replicaStatus; /**

Contains details of the table class.

*/ @property (nonatomic, strong) AWSDynamoDBTableClassSummary * _Nullable replicaTableClassSummary; @end /**

Represents the settings for a global table in a Region that will be modified.

Required parameters: [RegionName] */ @interface AWSDynamoDBReplicaSettingsUpdate : AWSModel /**

The Region of the replica to be added.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; /**

Represents the settings of a global secondary index for a global table that will be modified.

*/ @property (nonatomic, strong) NSArray * _Nullable replicaGlobalSecondaryIndexSettingsUpdate; /**

Auto scaling settings for managing a global table replica's read capacity units.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsUpdate * _Nullable replicaProvisionedReadCapacityAutoScalingSettingsUpdate; /**

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSNumber * _Nullable replicaProvisionedReadCapacityUnits; /**

Replica-specific table class. If not specified, uses the source table's table class.

*/ @property (nonatomic, assign) AWSDynamoDBTableClass replicaTableClass; @end /**

Represents one of the following:

  • A new replica to be added to an existing global table.

  • New parameters for an existing replica.

  • An existing replica to be removed from an existing global table.

*/ @interface AWSDynamoDBReplicaUpdate : AWSModel /**

The parameters required for creating a replica on an existing global table.

*/ @property (nonatomic, strong) AWSDynamoDBCreateReplicaAction * _Nullable create; /**

The name of the existing replica to be removed.

*/ @property (nonatomic, strong) AWSDynamoDBDeleteReplicaAction * _Nullable remove; @end /**

Represents one of the following:

  • A new replica to be added to an existing regional table or global table. This request invokes the CreateTableReplica action in the destination Region.

  • New parameters for an existing replica. This request invokes the UpdateTable action in the destination Region.

  • An existing replica to be deleted. The request invokes the DeleteTableReplica action in the destination Region, deleting the replica and all if its items in the destination Region.

When you manually remove a table or global table replica, you do not automatically remove any associated scalable targets, scaling policies, or CloudWatch alarms.

 */ @interface AWSDynamoDBReplicationGroupUpdate : AWSModel /**

The parameters required for creating a replica for the table.

*/ @property (nonatomic, strong) AWSDynamoDBCreateReplicationGroupMemberAction * _Nullable create; /**

The parameters required for deleting a replica for the table.

*/ @property (nonatomic, strong) AWSDynamoDBDeleteReplicationGroupMemberAction * _Nullable remove; /**

The parameters required for updating a replica for the table.

*/ @property (nonatomic, strong) AWSDynamoDBUpdateReplicationGroupMemberAction * _Nullable update; @end /**

Contains details for the restore.

Required parameters: [RestoreDateTime, RestoreInProgress] */ @interface AWSDynamoDBRestoreSummary : AWSModel /**

Point in time or source backup time.

*/ @property (nonatomic, strong) NSDate * _Nullable restoreDateTime; /**

Indicates if a restore is in progress or not.

*/ @property (nonatomic, strong) NSNumber * _Nullable restoreInProgress; /**

The Amazon Resource Name (ARN) of the backup from which the table was restored.

*/ @property (nonatomic, strong) NSString * _Nullable sourceBackupArn; /**

The ARN of the source table of the backup that is being restored.

*/ @property (nonatomic, strong) NSString * _Nullable sourceTableArn; @end /** */ @interface AWSDynamoDBRestoreTableFromBackupInput : AWSRequest /**

The Amazon Resource Name (ARN) associated with the backup.

*/ @property (nonatomic, strong) NSString * _Nullable backupArn; /**

The billing mode of the restored table.

*/ @property (nonatomic, assign) AWSDynamoDBBillingMode billingModeOverride; /**

List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexOverride; /**

List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

*/ @property (nonatomic, strong) NSArray * _Nullable localSecondaryIndexOverride; /**

Provisioned throughput settings for the restored table.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput * _Nullable provisionedThroughputOverride; /**

The new server-side encryption settings for the restored table.

*/ @property (nonatomic, strong) AWSDynamoDBSSESpecification * _Nullable SSESpecificationOverride; /**

The name of the new table to which the backup must be restored.

*/ @property (nonatomic, strong) NSString * _Nullable targetTableName; @end /** */ @interface AWSDynamoDBRestoreTableFromBackupOutput : AWSModel /**

The description of the table created from an existing backup.

*/ @property (nonatomic, strong) AWSDynamoDBTableDescription * _Nullable tableDescription; @end /** */ @interface AWSDynamoDBRestoreTableToPointInTimeInput : AWSRequest /**

The billing mode of the restored table.

*/ @property (nonatomic, assign) AWSDynamoDBBillingMode billingModeOverride; /**

List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexOverride; /**

List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

*/ @property (nonatomic, strong) NSArray * _Nullable localSecondaryIndexOverride; /**

Provisioned throughput settings for the restored table.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput * _Nullable provisionedThroughputOverride; /**

Time in the past to restore the table to.

*/ @property (nonatomic, strong) NSDate * _Nullable restoreDateTime; /**

The new server-side encryption settings for the restored table.

*/ @property (nonatomic, strong) AWSDynamoDBSSESpecification * _Nullable SSESpecificationOverride; /**

The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).

*/ @property (nonatomic, strong) NSString * _Nullable sourceTableArn; /**

Name of the source table that is being restored.

*/ @property (nonatomic, strong) NSString * _Nullable sourceTableName; /**

The name of the new table to which it must be restored to.

*/ @property (nonatomic, strong) NSString * _Nullable targetTableName; /**

Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.

*/ @property (nonatomic, strong) NSNumber * _Nullable useLatestRestorableTime; @end /** */ @interface AWSDynamoDBRestoreTableToPointInTimeOutput : AWSModel /**

Represents the properties of a table.

*/ @property (nonatomic, strong) AWSDynamoDBTableDescription * _Nullable tableDescription; @end /**

The S3 bucket that is being imported from.

Required parameters: [S3Bucket] */ @interface AWSDynamoDBS3BucketSource : AWSModel /**

The S3 bucket that is being imported from.

*/ @property (nonatomic, strong) NSString * _Nullable s3Bucket; /**

The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.

*/ @property (nonatomic, strong) NSString * _Nullable s3BucketOwner; /**

The key prefix shared by all S3 Objects that are being imported.

*/ @property (nonatomic, strong) NSString * _Nullable s3KeyPrefix; @end /**

The description of the server-side encryption status on the specified table.

*/ @interface AWSDynamoDBSSEDescription : AWSModel /**

Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.

*/ @property (nonatomic, strong) NSDate * _Nullable inaccessibleEncryptionDateTime; /**

The KMS key ARN used for the KMS encryption.

*/ @property (nonatomic, strong) NSString * _Nullable KMSMasterKeyArn; /**

Server-side encryption type. The only supported value is:

  • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).

*/ @property (nonatomic, assign) AWSDynamoDBSSEType SSEType; /**

Represents the current state of server-side encryption. The only supported values are:

  • ENABLED - Server-side encryption is enabled.

  • UPDATING - Server-side encryption is being updated.

*/ @property (nonatomic, assign) AWSDynamoDBSSEStatus status; @end /**

Represents the settings used to enable server-side encryption.

*/ @interface AWSDynamoDBSSESpecification : AWSModel /**

Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.

*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**

The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.

*/ @property (nonatomic, strong) NSString * _Nullable KMSMasterKeyId; /**

Server-side encryption type. The only supported value is:

  • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).

*/ @property (nonatomic, assign) AWSDynamoDBSSEType SSEType; @end /**

Represents the input of a Scan operation.

Required parameters: [TableName] */ @interface AWSDynamoDBScanInput : AWSRequest /**

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable attributesToGet; /**

This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, assign) AWSDynamoDBConditionalOperator conditionalOperator; /**

A Boolean value that determines the read consistency model during the scan:

  • If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem, or DeleteItem).

  • If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.

The default setting for ConsistentRead is false.

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

*/ @property (nonatomic, strong) NSNumber * _Nullable consistentRead; /**

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

*/ @property (nonatomic, strong) NSDictionary * _Nullable exclusiveStartKey; /**

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeValues; /**

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable filterExpression; /**

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable projectionExpression; /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable scanFilter; /**

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.

The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

If you provide Segment, you must also provide TotalSegments.

*/ @property (nonatomic, strong) NSNumber * _Nullable segment; /**

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression. This return value is equivalent to specifying ProjectionExpression without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor ProjectionExpression are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and ProjectionExpression together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying ProjectionExpression without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

 */ @property (nonatomic, assign) AWSDynamoDBSelect select; /**

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; /**

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.

The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.

If you specify TotalSegments, you must also specify Segment.

*/ @property (nonatomic, strong) NSNumber * _Nullable totalSegments; @end /**

Represents the output of a Scan operation.

*/ @interface AWSDynamoDBScanOutput : AWSModel /**

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBConsumedCapacity * _Nullable consumedCapacity; /**

The number of items in the response.

If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count is the same as ScannedCount.

*/ @property (nonatomic, strong) NSNumber * _Nullable count; /**

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

*/ @property (nonatomic, strong) NSArray *> * _Nullable items; /**

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

*/ @property (nonatomic, strong) NSDictionary * _Nullable lastEvaluatedKey; /**

The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

*/ @property (nonatomic, strong) NSNumber * _Nullable scannedCount; @end /**

Contains the details of the table when the backup was created.

Required parameters: [TableName, TableId, KeySchema, TableCreationDateTime, ProvisionedThroughput] */ @interface AWSDynamoDBSourceTableDetails : AWSModel /**

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

  • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

*/ @property (nonatomic, assign) AWSDynamoDBBillingMode billingMode; /**

Number of items in the table. Note that this is an approximate value.

*/ @property (nonatomic, strong) NSNumber * _Nullable itemCount; /**

Schema of the table.

*/ @property (nonatomic, strong) NSArray * _Nullable keySchema; /**

Read IOPs and Write IOPS on the table when the backup was created.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput * _Nullable provisionedThroughput; /**

ARN of the table for which backup was created.

*/ @property (nonatomic, strong) NSString * _Nullable tableArn; /**

Time when the source table was created.

*/ @property (nonatomic, strong) NSDate * _Nullable tableCreationDateTime; /**

Unique identifier for the table for which the backup was created.

*/ @property (nonatomic, strong) NSString * _Nullable tableId; /**

The name of the table for which the backup was created.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; /**

Size of the table in bytes. Note that this is an approximate value.

*/ @property (nonatomic, strong) NSNumber * _Nullable tableSizeBytes; @end /**

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

*/ @interface AWSDynamoDBSourceTableFeatureDetails : AWSModel /**

Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the table at the time of backup.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexes; /**

Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.

*/ @property (nonatomic, strong) NSArray * _Nullable localSecondaryIndexes; /**

The description of the server-side encryption status on the table when the backup was created.

*/ @property (nonatomic, strong) AWSDynamoDBSSEDescription * _Nullable SSEDescription; /**

Stream settings on the table when the backup was created.

*/ @property (nonatomic, strong) AWSDynamoDBStreamSpecification * _Nullable streamDescription; /**

Time to Live settings on the table when the backup was created.

*/ @property (nonatomic, strong) AWSDynamoDBTimeToLiveDescription * _Nullable timeToLiveDescription; @end /**

Represents the DynamoDB Streams configuration for a table in DynamoDB.

Required parameters: [StreamEnabled] */ @interface AWSDynamoDBStreamSpecification : AWSModel /**

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

*/ @property (nonatomic, strong) NSNumber * _Nullable streamEnabled; /**

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

  • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

  • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

  • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

  • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

*/ @property (nonatomic, assign) AWSDynamoDBStreamViewType streamViewType; @end /**

Represents the auto scaling configuration for a global table.

*/ @interface AWSDynamoDBTableAutoScalingDescription : AWSModel /**

Represents replicas of the global table.

*/ @property (nonatomic, strong) NSArray * _Nullable replicas; /**

The name of the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; /**

The current state of the table:

  • CREATING - The table is being created.

  • UPDATING - The table is being updated.

  • DELETING - The table is being deleted.

  • ACTIVE - The table is ready for use.

*/ @property (nonatomic, assign) AWSDynamoDBTableStatus tableStatus; @end /**

Contains details of the table class.

*/ @interface AWSDynamoDBTableClassSummary : AWSModel /**

The date and time at which the table class was last updated.

*/ @property (nonatomic, strong) NSDate * _Nullable lastUpdateDateTime; /**

The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

*/ @property (nonatomic, assign) AWSDynamoDBTableClass tableClass; @end /**

The parameters for the table created as part of the import operation.

Required parameters: [TableName, AttributeDefinitions, KeySchema] */ @interface AWSDynamoDBTableCreationParameters : AWSModel /**

The attributes of the table created as part of the import operation.

*/ @property (nonatomic, strong) NSArray * _Nullable attributeDefinitions; /**

The billing mode for provisioning the table created as part of the import operation.

*/ @property (nonatomic, assign) AWSDynamoDBBillingMode billingMode; /**

The Global Secondary Indexes (GSI) of the table to be created as part of the import operation.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexes; /**

The primary key and option sort key of the table created as part of the import operation.

*/ @property (nonatomic, strong) NSArray * _Nullable keySchema; /**

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput * _Nullable provisionedThroughput; /**

Represents the settings used to enable server-side encryption.

*/ @property (nonatomic, strong) AWSDynamoDBSSESpecification * _Nullable SSESpecification; /**

The name of the table created as part of the import operation.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the properties of a table.

*/ @interface AWSDynamoDBTableDescription : AWSModel /**

Contains information about the table archive.

*/ @property (nonatomic, strong) AWSDynamoDBArchivalSummary * _Nullable archivalSummary; /**

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

Each AttributeDefinition object in this array is composed of:

  • AttributeName - The name of the attribute.

  • AttributeType - The data type for the attribute.

*/ @property (nonatomic, strong) NSArray * _Nullable attributeDefinitions; /**

Contains the details for the read/write capacity mode.

*/ @property (nonatomic, strong) AWSDynamoDBBillingModeSummary * _Nullable billingModeSummary; /**

The date and time when the table was created, in UNIX epoch time format.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDateTime; /**

Indicates whether deletion protection is enabled (true) or disabled (false) on the table.

*/ @property (nonatomic, strong) NSNumber * _Nullable deletionProtectionEnabled; /**

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

  • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

    You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (This attribute does not appear for indexes that were created during a CreateTable operation.)

  • IndexName - The name of the global secondary index.

  • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

  • IndexStatus - The current status of the global secondary index:

    • CREATING - The index is being created.

    • UPDATING - The index is being updated.

    • DELETING - The index is being deleted.

    • ACTIVE - The index is ready for use.

  • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

  • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

If the table is in the DELETING state, no information about indexes will be returned.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexes; /**

Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.

*/ @property (nonatomic, strong) NSString * _Nullable globalTableVersion; /**

The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

*/ @property (nonatomic, strong) NSNumber * _Nullable itemCount; /**

The primary key structure for the table. Each KeySchemaElement consists of:

  • AttributeName - The name of the attribute.

  • KeyType - The role of the attribute:

    • HASH - partition key

    • RANGE - sort key

    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

    The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable keySchema; /**

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

*/ @property (nonatomic, strong) NSString * _Nullable latestStreamArn; /**

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • Amazon Web Services customer ID

  • Table name

  • StreamLabel

*/ @property (nonatomic, strong) NSString * _Nullable latestStreamLabel; /**

Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

  • IndexName - The name of the local secondary index.

  • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

  • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

If the table is in the DELETING state, no information about indexes will be returned.

*/ @property (nonatomic, strong) NSArray * _Nullable localSecondaryIndexes; /**

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughputDescription * _Nullable provisionedThroughput; /**

Represents replicas of the table.

*/ @property (nonatomic, strong) NSArray * _Nullable replicas; /**

Contains details for the restore.

*/ @property (nonatomic, strong) AWSDynamoDBRestoreSummary * _Nullable restoreSummary; /**

The description of the server-side encryption status on the specified table.

*/ @property (nonatomic, strong) AWSDynamoDBSSEDescription * _Nullable SSEDescription; /**

The current DynamoDB Streams configuration for the table.

*/ @property (nonatomic, strong) AWSDynamoDBStreamSpecification * _Nullable streamSpecification; /**

The Amazon Resource Name (ARN) that uniquely identifies the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableArn; /**

Contains details of the table class.

*/ @property (nonatomic, strong) AWSDynamoDBTableClassSummary * _Nullable tableClassSummary; /**

Unique identifier for the table for which the backup was created.

*/ @property (nonatomic, strong) NSString * _Nullable tableId; /**

The name of the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; /**

The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

*/ @property (nonatomic, strong) NSNumber * _Nullable tableSizeBytes; /**

The current state of the table:

  • CREATING - The table is being created.

  • UPDATING - The table/index configuration is being updated. The table/index remains available for data operations when UPDATING.

  • DELETING - The table is being deleted.

  • ACTIVE - The table is ready for use.

  • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days.

  • ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.

  • ARCHIVED - The table has been archived. See the ArchivalReason for more information.

*/ @property (nonatomic, assign) AWSDynamoDBTableStatus tableStatus; @end /**

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.

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 an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

Required parameters: [Key, Value] */ @interface AWSDynamoDBTag : AWSModel /**

The key of the tag. Tag keys are case sensitive. Each DynamoDB table 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.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

The value of the tag. Tag values are case-sensitive and can be null.

*/ @property (nonatomic, strong) NSString * _Nullable value; @end /** */ @interface AWSDynamoDBTagResourceInput : AWSRequest /**

Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

The tags to be assigned to the Amazon DynamoDB resource.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /**

The description of the Time to Live (TTL) status on the specified table.

*/ @interface AWSDynamoDBTimeToLiveDescription : AWSModel /**

The name of the TTL attribute for items in the table.

*/ @property (nonatomic, strong) NSString * _Nullable attributeName; /**

The TTL status for the table.

*/ @property (nonatomic, assign) AWSDynamoDBTimeToLiveStatus timeToLiveStatus; @end /**

Represents the settings used to enable or disable Time to Live (TTL) for the specified table.

Required parameters: [Enabled, AttributeName] */ @interface AWSDynamoDBTimeToLiveSpecification : AWSModel /**

The name of the TTL attribute used to store the expiration time for items in the table.

*/ @property (nonatomic, strong) NSString * _Nullable attributeName; /**

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; @end /**

Specifies an item to be retrieved as part of the transaction.

Required parameters: [Get] */ @interface AWSDynamoDBTransactGetItem : AWSModel /**

Contains the primary key that identifies the item to get, together with the name of the table that contains the item, and optionally the specific attributes of the item to retrieve.

*/ @property (nonatomic, strong) AWSDynamoDBGet * _Nullable get; @end /** */ @interface AWSDynamoDBTransactGetItemsInput : AWSRequest /**

A value of TOTAL causes consumed capacity information to be returned, and a value of NONE prevents that information from being returned. No other value is valid.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

An ordered array of up to 100 TransactGetItem objects, each of which contains a Get structure.

*/ @property (nonatomic, strong) NSArray * _Nullable transactItems; @end /** */ @interface AWSDynamoDBTransactGetItemsOutput : AWSModel /**

If the ReturnConsumedCapacity value was TOTAL, this is an array of ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units consumed by the TransactGetItems call in that table.

*/ @property (nonatomic, strong) NSArray * _Nullable consumedCapacity; /**

An ordered array of up to 100 ItemResponse objects, each of which corresponds to the TransactGetItem object in the same position in the TransactItems array. Each ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the requested item.

If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.

*/ @property (nonatomic, strong) NSArray * _Nullable responses; @end /**

A list of requests that can perform update, put, delete, or check operations on multiple items in one or more tables atomically.

*/ @interface AWSDynamoDBTransactWriteItem : AWSModel /**

A request to perform a check item operation.

*/ @property (nonatomic, strong) AWSDynamoDBConditionCheck * _Nullable conditionCheck; /**

A request to perform a DeleteItem operation.

*/ @property (nonatomic, strong) AWSDynamoDBRemove * _Nullable remove; /**

A request to perform a PutItem operation.

*/ @property (nonatomic, strong) AWSDynamoDBPut * _Nullable put; /**

A request to perform an UpdateItem operation.

*/ @property (nonatomic, strong) AWSDynamoDBUpdate * _Nullable update; @end /** */ @interface AWSDynamoDBTransactWriteItemsInput : AWSRequest /**

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

*/ @property (nonatomic, strong) NSString * _Nullable clientRequestToken; /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections (if any), that were modified during the operation and are returned in the response. If set to NONE (the default), no statistics are returned.

*/ @property (nonatomic, assign) AWSDynamoDBReturnItemCollectionMetrics returnItemCollectionMetrics; /**

An ordered array of up to 100 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same Amazon Web Services account and Region, and no two of them can operate on the same item.

*/ @property (nonatomic, strong) NSArray * _Nullable transactItems; @end /** */ @interface AWSDynamoDBTransactWriteItemsOutput : AWSModel /**

The capacity units consumed by the entire TransactWriteItems operation. The values of the list are ordered according to the ordering of the TransactItems request parameter.

*/ @property (nonatomic, strong) NSArray * _Nullable consumedCapacity; /**

A list of tables that were processed by TransactWriteItems and, for each table, information about any item collections that were affected by individual UpdateItem, PutItem, or DeleteItem operations.

*/ @property (nonatomic, strong) NSDictionary *> * _Nullable itemCollectionMetrics; @end /** */ @interface AWSDynamoDBUntagResourceInput : AWSRequest /**

The DynamoDB resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the DynamoDB resource.

*/ @property (nonatomic, strong) NSArray * _Nullable tagKeys; @end /**

Represents a request to perform an UpdateItem operation.

Required parameters: [Key, UpdateExpression, TableName] */ @interface AWSDynamoDBUpdate : AWSModel /**

A condition that must be satisfied in order for a conditional update to succeed.

*/ @property (nonatomic, strong) NSString * _Nullable conditionExpression; /**

One or more substitution tokens for attribute names in an expression.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

One or more values that can be substituted in an expression.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeValues; /**

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

*/ @property (nonatomic, strong) NSDictionary * _Nullable key; /**

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

*/ @property (nonatomic, assign) AWSDynamoDBReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure; /**

Name of the table for the UpdateItem request.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; /**

An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

*/ @property (nonatomic, strong) NSString * _Nullable updateExpression; @end /** */ @interface AWSDynamoDBUpdateContinuousBackupsInput : AWSRequest /**

Represents the settings used to enable point in time recovery.

*/ @property (nonatomic, strong) AWSDynamoDBPointInTimeRecoverySpecification * _Nullable pointInTimeRecoverySpecification; /**

The name of the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBUpdateContinuousBackupsOutput : AWSModel /**

Represents the continuous backups and point in time recovery settings on the table.

*/ @property (nonatomic, strong) AWSDynamoDBContinuousBackupsDescription * _Nullable continuousBackupsDescription; @end /** */ @interface AWSDynamoDBUpdateContributorInsightsInput : AWSRequest /**

Represents the contributor insights action.

*/ @property (nonatomic, assign) AWSDynamoDBContributorInsightsAction contributorInsightsAction; /**

The global secondary index name, if applicable.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The name of the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBUpdateContributorInsightsOutput : AWSModel /**

The status of contributor insights

*/ @property (nonatomic, assign) AWSDynamoDBContributorInsightsStatus contributorInsightsStatus; /**

The name of the global secondary index, if applicable.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

The name of the table.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the new provisioned throughput settings to be applied to a global secondary index.

Required parameters: [IndexName, ProvisionedThroughput] */ @interface AWSDynamoDBUpdateGlobalSecondaryIndexAction : AWSModel /**

The name of the global secondary index to be updated.

*/ @property (nonatomic, strong) NSString * _Nullable indexName; /**

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput * _Nullable provisionedThroughput; @end /** */ @interface AWSDynamoDBUpdateGlobalTableInput : AWSRequest /**

The global table name.

*/ @property (nonatomic, strong) NSString * _Nullable globalTableName; /**

A list of Regions that should be added or removed from the global table.

*/ @property (nonatomic, strong) NSArray * _Nullable replicaUpdates; @end /** */ @interface AWSDynamoDBUpdateGlobalTableOutput : AWSModel /**

Contains the details of the global table.

*/ @property (nonatomic, strong) AWSDynamoDBGlobalTableDescription * _Nullable globalTableDescription; @end /** */ @interface AWSDynamoDBUpdateGlobalTableSettingsInput : AWSRequest /**

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

*/ @property (nonatomic, assign) AWSDynamoDBBillingMode globalTableBillingMode; /**

Represents the settings of a global secondary index for a global table that will be modified.

*/ @property (nonatomic, strong) NSArray * _Nullable globalTableGlobalSecondaryIndexSettingsUpdate; /**

The name of the global table

*/ @property (nonatomic, strong) NSString * _Nullable globalTableName; /**

Auto scaling settings for managing provisioned write capacity for the global table.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsUpdate * _Nullable globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate; /**

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

*/ @property (nonatomic, strong) NSNumber * _Nullable globalTableProvisionedWriteCapacityUnits; /**

Represents the settings for a global table in a Region that will be modified.

*/ @property (nonatomic, strong) NSArray * _Nullable replicaSettingsUpdate; @end /** */ @interface AWSDynamoDBUpdateGlobalTableSettingsOutput : AWSModel /**

The name of the global table.

*/ @property (nonatomic, strong) NSString * _Nullable globalTableName; /**

The Region-specific settings for the global table.

*/ @property (nonatomic, strong) NSArray * _Nullable replicaSettings; @end /**

Represents the input of an UpdateItem operation.

Required parameters: [TableName, Key] */ @interface AWSDynamoDBUpdateItemInput : AWSRequest /**

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable attributeUpdates; /**

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable conditionExpression; /**

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, assign) AWSDynamoDBConditionalOperator conditionalOperator; /**

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expected; /**

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeNames; /**

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSDictionary * _Nullable expressionAttributeValues; /**

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

*/ @property (nonatomic, strong) NSDictionary * _Nullable key; /**

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

*/ @property (nonatomic, assign) AWSDynamoDBReturnConsumedCapacity returnConsumedCapacity; /**

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

*/ @property (nonatomic, assign) AWSDynamoDBReturnItemCollectionMetrics returnItemCollectionMetrics; /**

Use ReturnValues if you want to get the item attributes as they appear before or after they are successfully updated. For UpdateItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.

  • UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.

  • ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.

  • UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The values returned are strongly consistent.

*/ @property (nonatomic, assign) AWSDynamoDBReturnValue returnValues; /**

An optional parameter that returns the item attributes for an UpdateItem operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

*/ @property (nonatomic, assign) AWSDynamoDBReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure; /**

The name of the table containing the item to update.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; /**

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.

  • SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

    SET supports the following functions:

    • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

    • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

    These function names are case-sensitive.

  • REMOVE - Removes one or more attributes from an item.

  • ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

    • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

  • DELETE - Deletes an element from a set.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

    The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable updateExpression; @end /**

Represents the output of an UpdateItem operation.

*/ @interface AWSDynamoDBUpdateItemOutput : AWSModel /**

A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter.

The Attributes map is only present if the update was successful and ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

*/ @property (nonatomic, strong) NSDictionary * _Nullable attributes; /**

The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) AWSDynamoDBConsumedCapacity * _Nullable consumedCapacity; /**

Information about item collections, if any, that were affected by the UpdateItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

  • SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

*/ @property (nonatomic, strong) AWSDynamoDBItemCollectionMetrics * _Nullable itemCollectionMetrics; @end /**

Represents a replica to be modified.

Required parameters: [RegionName] */ @interface AWSDynamoDBUpdateReplicationGroupMemberAction : AWSModel /**

Replica-specific global secondary index settings.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexes; /**

The KMS key of the replica that should be used for KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS key alias/aws/dynamodb.

*/ @property (nonatomic, strong) NSString * _Nullable KMSMasterKeyId; /**

Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughputOverride * _Nullable provisionedThroughputOverride; /**

The Region where the replica exists.

*/ @property (nonatomic, strong) NSString * _Nullable regionName; /**

Replica-specific table class. If not specified, uses the source table's table class.

*/ @property (nonatomic, assign) AWSDynamoDBTableClass tableClassOverride; @end /**

Represents the input of an UpdateTable operation.

Required parameters: [TableName] */ @interface AWSDynamoDBUpdateTableInput : AWSRequest /**

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

*/ @property (nonatomic, strong) NSArray * _Nullable attributeDefinitions; /**

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

*/ @property (nonatomic, assign) AWSDynamoDBBillingMode billingMode; /**

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

*/ @property (nonatomic, strong) NSNumber * _Nullable deletionProtectionEnabled; /**

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexUpdates; /**

The new provisioned throughput settings for the specified table or index.

*/ @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput * _Nullable provisionedThroughput; /**

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 (Current) of global tables.

*/ @property (nonatomic, strong) NSArray * _Nullable replicaUpdates; /**

The new server-side encryption settings for the specified table.

*/ @property (nonatomic, strong) AWSDynamoDBSSESpecification * _Nullable SSESpecification; /**

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

 */ @property (nonatomic, strong) AWSDynamoDBStreamSpecification * _Nullable streamSpecification; /**

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

*/ @property (nonatomic, assign) AWSDynamoDBTableClass tableClass; /**

The name of the table to be updated.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /**

Represents the output of an UpdateTable operation.

*/ @interface AWSDynamoDBUpdateTableOutput : AWSModel /**

Represents the properties of the table.

*/ @property (nonatomic, strong) AWSDynamoDBTableDescription * _Nullable tableDescription; @end /** */ @interface AWSDynamoDBUpdateTableReplicaAutoScalingInput : AWSRequest /**

Represents the auto scaling settings of the global secondary indexes of the replica to be updated.

*/ @property (nonatomic, strong) NSArray * _Nullable globalSecondaryIndexUpdates; /**

Represents the auto scaling settings to be modified for a global table or global secondary index.

*/ @property (nonatomic, strong) AWSDynamoDBAutoScalingSettingsUpdate * _Nullable provisionedWriteCapacityAutoScalingUpdate; /**

Represents the auto scaling settings of replicas of the table that will be modified.

*/ @property (nonatomic, strong) NSArray * _Nullable replicaUpdates; /**

The name of the global table to be updated.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; @end /** */ @interface AWSDynamoDBUpdateTableReplicaAutoScalingOutput : AWSModel /**

Returns information about the auto scaling settings of a table with replicas.

*/ @property (nonatomic, strong) AWSDynamoDBTableAutoScalingDescription * _Nullable tableAutoScalingDescription; @end /**

Represents the input of an UpdateTimeToLive operation.

Required parameters: [TableName, TimeToLiveSpecification] */ @interface AWSDynamoDBUpdateTimeToLiveInput : AWSRequest /**

The name of the table to be configured.

*/ @property (nonatomic, strong) NSString * _Nullable tableName; /**

Represents the settings used to enable or disable Time to Live for the specified table.

*/ @property (nonatomic, strong) AWSDynamoDBTimeToLiveSpecification * _Nullable timeToLiveSpecification; @end /** */ @interface AWSDynamoDBUpdateTimeToLiveOutput : AWSModel /**

Represents the output of an UpdateTimeToLive operation.

*/ @property (nonatomic, strong) AWSDynamoDBTimeToLiveSpecification * _Nullable timeToLiveSpecification; @end /**

Represents an operation to perform - either DeleteItem or PutItem. You can only request one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you need to provide two separate WriteRequest objects.

*/ @interface AWSDynamoDBWriteRequest : AWSModel /**

A request to perform a DeleteItem operation.

*/ @property (nonatomic, strong) AWSDynamoDBDeleteRequest * _Nullable deleteRequest; /**

A request to perform a PutItem operation.

*/ @property (nonatomic, strong) AWSDynamoDBPutRequest * _Nullable putRequest; @end NS_ASSUME_NONNULL_END