Information about an agent hierarchy group.
+ */ +@interface AWSConnectAgentHierarchyGroup : AWSModel + + +/** +The Amazon Resource Name (ARN) of the group.
+ */ +@property (nonatomic, strong) NSString * _Nullable arn; + +@end + /**A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
*/ @@ -1857,11 +1963,26 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { */ @property (nonatomic, strong) NSNumber * _Nullable agentPauseDurationInSeconds; +/** +The configuration for the allowed capabilities for participants present over the call.
+ */ +@property (nonatomic, strong) AWSConnectParticipantCapabilities * _Nullable capabilities; + /**The timestamp when the contact was connected to the agent.
*/ @property (nonatomic, strong) NSDate * _Nullable connectedToAgentTimestamp; +/** +Information regarding Agent’s device.
+ */ +@property (nonatomic, strong) AWSConnectDeviceInfo * _Nullable deviceInfo; + +/** +The agent hierarchy groups for the agent.
+ */ +@property (nonatomic, strong) AWSConnectHierarchyGroups * _Nullable hierarchyGroups; + /**The identifier of the agent who accepted the contact.
*/ @@ -1869,6 +1990,19 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +Information about the quality of the Agent's media connection
+ */ +@interface AWSConnectAgentQualityMetrics : AWSModel + + +/** +Information about the audio quality of the Agent
+ */ +@property (nonatomic, strong) AWSConnectAudioQualityMetricsInfo * _Nullable audio; + +@end + /**Contains information about an agent status.
*/ @@ -2463,6 +2597,88 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +Information about the attached file.
+ Required parameters: [CreationTime, FileArn, FileId, FileName, FileSizeInBytes, FileStatus] + */ +@interface AWSConnectAttachedFile : AWSModel + + +/** +The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
Represents the identity that created the file.
+ */ +@property (nonatomic, strong) AWSConnectCreatedByInfo * _Nullable createdBy; + +/** +The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
The unique identifier of the attached file resource (ARN).
+ */ +@property (nonatomic, strong) NSString * _Nullable fileArn; + +/** +The unique identifier of the attached file resource.
+ */ +@property (nonatomic, strong) NSString * _Nullable fileId; + +/** +A case-sensitive name of the attached file being uploaded.
+ */ +@property (nonatomic, strong) NSString * _Nullable fileName; + +/** +The size of the attached file in bytes.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable fileSizeInBytes; + +/** +The current status of the attached file.
+ */ +@property (nonatomic, assign) AWSConnectFileStatusType fileStatus; + +/** +The use case for the file.
+ */ +@property (nonatomic, assign) AWSConnectFileUseCaseType fileUseCaseType; + +/** +The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
+ */ +@interface AWSConnectAttachedFileError : AWSModel + + +/** +Status code describing the failure.
+ */ +@property (nonatomic, strong) NSString * _Nullable errorCode; + +/** +Why the attached file couldn't be retrieved.
+ */ +@property (nonatomic, strong) NSString * _Nullable errorMessage; + +/** +The unique identifier of the attached file resource.
+ */ +@property (nonatomic, strong) NSString * _Nullable fileId; + +@end + /**Information about a reference when the referenceType is ATTACHMENT. Otherwise, null.
An object to specify the predefined attribute condition.
+ */ +@interface AWSConnectAttributeCondition : AWSModel + + +/** +The operator of the condition.
+ */ +@property (nonatomic, strong) NSString * _Nullable comparisonOperator; + +/** +The name of predefined attribute.
+ */ +@property (nonatomic, strong) NSString * _Nullable name; + +/** +The proficiency level of the condition.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable proficiencyLevel; + +/** +The value of predefined attribute.
+ */ +@property (nonatomic, strong) NSString * _Nullable value; + +@end + /**Has audio-specific configurations as the operating parameter for Echo Reduction.
*/ @@ -2553,6 +2797,24 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +Contains information for score and potential quality issues for Audio
+ */ +@interface AWSConnectAudioQualityMetricsInfo : AWSModel + + +/** +List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.
Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer
Number measuring the estimated quality of the media connection.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable qualityScore; + +@end + /**Information about available phone numbers.
*/ @@ -2658,6 +2920,47 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** + + */ +@interface AWSConnectBatchGetAttachedFileMetadataRequest : AWSRequest + + +/** +The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The unique identifiers of the attached file resource.
+ */ +@property (nonatomic, strong) NSArrayThe unique identifier of the Connect instance.
+ */ +@property (nonatomic, strong) NSString * _Nullable instanceId; + +@end + +/** + + */ +@interface AWSConnectBatchGetAttachedFileMetadataResponse : AWSModel + + +/** +List of errors of attached files that could not be retrieved.
+ */ +@property (nonatomic, strong) NSArrayList of attached files that were successfully retrieved.
+ */ +@property (nonatomic, strong) NSArrayThe resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The unique identifier of the attached file resource.
+ */ +@property (nonatomic, strong) NSString * _Nullable fileId; + +/** +The unique identifier of the Connect instance.
+ */ +@property (nonatomic, strong) NSString * _Nullable instanceId; + +@end + +/** + Response from CompleteAttachedFileUpload API + */ +@interface AWSConnectCompleteAttachedFileUploadResponse : AWSModel + + @end /** @@ -2967,21 +3302,51 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { */ @property (nonatomic, strong) AWSConnectAgentInfo * _Nullable agentInfo; +/** +Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
+ */ +@property (nonatomic, assign) AWSConnectAnsweringMachineDetectionStatus answeringMachineDetectionStatus; + /**The Amazon Resource Name (ARN) for the contact.
*/ @property (nonatomic, strong) NSString * _Nullable arn; +/** +Information associated with a campaign.
+ */ +@property (nonatomic, strong) AWSConnectCampaign * _Nullable campaign; + /**How the contact reached your contact center.
*/ @property (nonatomic, assign) AWSConnectChannel channel; +/** +The timestamp when customer endpoint connected to Amazon Connect.
+ */ +@property (nonatomic, strong) NSDate * _Nullable connectedToSystemTimestamp; + +/** +Information about the Customer on the contact.
+ */ +@property (nonatomic, strong) AWSConnectCustomer * _Nullable customer; + +/** +Information about customer’s voice activity.
+ */ +@property (nonatomic, strong) AWSConnectCustomerVoiceActivity * _Nullable customerVoiceActivity; + /**The description of the contact.
*/ @property (nonatomic, strong) NSString * _Nullable detail; +/** +Information about the call disconnect experience.
+ */ +@property (nonatomic, strong) AWSConnectDisconnectDetails * _Nullable disconnectDetails; + /**The timestamp when the customer endpoint disconnected from Amazon Connect.
*/ @@ -3032,6 +3397,11 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { */ @property (nonatomic, strong) NSString * _Nullable previousContactId; +/** +Information about the quality of the participant's media connection.
+ */ +@property (nonatomic, strong) AWSConnectQualityMetrics * _Nullable qualityMetrics; + /**If this contact was queued, this contains information about the queue.
*/ @@ -3052,11 +3422,21 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { */ @property (nonatomic, strong) NSString * _Nullable relatedContactId; +/** +Latest routing criteria on the contact.
+ */ +@property (nonatomic, strong) AWSConnectRoutingCriteria * _Nullable routingCriteria; + /**The timestamp, in Unix epoch time format, at which to start running the inbound flow.
*/ @property (nonatomic, strong) NSDate * _Nullable scheduledTimestamp; +/** +A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.
Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
*/ @@ -3179,6 +3559,11 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { */ @property (nonatomic, assign) AWSConnectContactFlowState state; +/** +The status of the contact flow.
+ */ +@property (nonatomic, assign) AWSConnectContactFlowStatus status; + /**The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
*/ @@ -3239,6 +3624,42 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +The search criteria to be used to return flow modules.
+ */ +@interface AWSConnectContactFlowModuleSearchCriteria : AWSModel + + +/** +A list of conditions which would be applied together with an AND condition.
A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name and description.
The search criteria to be used to return flow modules.
+ */ +@interface AWSConnectContactFlowModuleSearchFilter : AWSModel + + +/** +An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
Contains summary information about a flow.
*/ @@ -3267,6 +3688,57 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +The search criteria to be used to return contact flows.
+ */ +@interface AWSConnectContactFlowSearchCriteria : AWSModel + + +/** +A list of conditions which would be applied together with an AND condition.
A list of conditions which would be applied together with an OR condition.
The state of the flow.
+ */ +@property (nonatomic, assign) AWSConnectContactFlowState stateCondition; + +/** +The status of the flow.
+ */ +@property (nonatomic, assign) AWSConnectContactFlowStatus statusCondition; + +/** +A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name and description.
The type of flow.
+ */ +@property (nonatomic, assign) AWSConnectContactFlowType typeCondition; + +@end + +/** +Filters to be applied to search results.
+ */ +@interface AWSConnectContactFlowSearchFilter : AWSModel + + +/** +An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language.
*/ @@ -3283,6 +3755,11 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { */ @property (nonatomic, assign) AWSConnectContactFlowState contactFlowState; +/** +The status of the contact flow.
+ */ +@property (nonatomic, assign) AWSConnectContactFlowStatus contactFlowStatus; + /**The type of flow.
*/ @@ -3607,6 +4084,11 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { */ @property (nonatomic, strong) NSString * _Nullable name; +/** +Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
*/ @@ -4298,7 +4780,7 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @property (nonatomic, strong) NSDictionaryThis API is in preview release for Amazon Connect and is subject to change.
A list of third-party applications that the security profile will give access to.
+A list of third-party applications that the security profile will give access to.
*/ @property (nonatomic, strong) NSArrayInformation on the identity that created the file.
+ */ +@interface AWSConnectCreatedByInfo : AWSModel + + +/** +STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
An agent ARN representing a connect user.
+ */ +@property (nonatomic, strong) NSString * _Nullable connectUserArn; + +@end + /**Contains credentials to use for federation.
*/ @@ -4919,6 +5419,55 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +Information about the Customer on the contact.
+ */ +@interface AWSConnectCustomer : AWSModel + + +/** +The configuration for the allowed capabilities for participants present over the call.
+ */ +@property (nonatomic, strong) AWSConnectParticipantCapabilities * _Nullable capabilities; + +/** +Information regarding Customer’s device.
+ */ +@property (nonatomic, strong) AWSConnectDeviceInfo * _Nullable deviceInfo; + +@end + +/** +Information about the quality of the Customer's media connection
+ */ +@interface AWSConnectCustomerQualityMetrics : AWSModel + + +/** +Information about the audio quality of the Customer
+ */ +@property (nonatomic, strong) AWSConnectAudioQualityMetricsInfo * _Nullable audio; + +@end + +/** +Information about customer’s voice activity.
+ */ +@interface AWSConnectCustomerVoiceActivity : AWSModel + + +/** +Timestamp that measures the end of the customer greeting from an outbound voice call.
+ */ +@property (nonatomic, strong) NSDate * _Nullable greetingEndTimestamp; + +/** +Timestamp that measures the beginning of the customer greeting from an outbound voice call.
+ */ +@property (nonatomic, strong) NSDate * _Nullable greetingStartTimestamp; + +@end + /**Information about a reference when the referenceType is DATE. Otherwise, null.
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The unique identifier of the attached file resource.
+ */ +@property (nonatomic, strong) NSString * _Nullable fileId; + +/** +The unique identifier of the Connect instance.
+ */ +@property (nonatomic, strong) NSString * _Nullable instanceId; + +@end + +/** + Response from DeleteAttachedFile API + */ +@interface AWSConnectDeleteAttachedFileResponse : AWSModel + + @end /** @@ -6223,6 +6804,29 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +Information regarding the device.
+ */ +@interface AWSConnectDeviceInfo : AWSModel + + +/** +Operating system that the participant used for the call.
+ */ +@property (nonatomic, strong) NSString * _Nullable operatingSystem; + +/** +Name of the platform that the participant used for the call.
+ */ +@property (nonatomic, strong) NSString * _Nullable platformName; + +/** +Version of the platform that the participant used for the call.
+ */ +@property (nonatomic, strong) NSString * _Nullable platformVersion; + +@end + /**Contains information about the dimensions for a set of metrics.
*/ @@ -6546,6 +7150,19 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +Information about the call disconnect experience.
+ */ +@interface AWSConnectDisconnectDetails : AWSModel + + +/** +Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.
+ */ +@property (nonatomic, strong) NSString * _Nullable potentialDisconnectIssue; + +@end + /**Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.
*/ @@ -6609,6 +7226,24 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +Metadata used to download the attached file.
+ */ +@interface AWSConnectDownloadUrlMetadata : AWSModel + + +/** +A pre-signed URL that should be used to download the attached file.
+ */ +@property (nonatomic, strong) NSString * _Nullable url; + +/** +The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
+ */ +@property (nonatomic, strong) NSString * _Nullable urlExpiry; + +@end + /**Information about a reference when the referenceType is EMAIL. Otherwise, null.
An object to specify the expiration of a routing step.
+ */ +@interface AWSConnectExpiry : AWSModel + + +/** +The number of seconds to wait before expiring the routing step.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable durationInSeconds; + +/** +The timestamp indicating when the routing step expires.
+ */ +@property (nonatomic, strong) NSDate * _Nullable expiryTimestamp; + +@end + +/** +A tagged union to specify expression for a routing step.
+ */ +@interface AWSConnectExpression : AWSModel + + +/** +List of routing expressions which will be AND-ed together.
+ */ +@property (nonatomic, strong) NSArrayAn object to specify the predefined attribute condition.
+ */ +@property (nonatomic, strong) AWSConnectAttributeCondition * _Nullable attributeCondition; + +/** +List of routing expressions which will be OR-ed together.
+ */ +@property (nonatomic, strong) NSArrayRequest for which contact failed to be generated.
*/ @@ -7613,6 +8289,99 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** + Request to GetAttachedFile API. + Required parameters: [InstanceId, FileId, AssociatedResourceArn] + */ +@interface AWSConnectGetAttachedFileRequest : AWSRequest + + +/** +The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The unique identifier of the attached file resource.
+ */ +@property (nonatomic, strong) NSString * _Nullable fileId; + +/** +The unique identifier of the Connect instance.
+ */ +@property (nonatomic, strong) NSString * _Nullable instanceId; + +/** +Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable urlExpiryInSeconds; + +@end + +/** + Response from GetAttachedFile API. + Required parameters: [FileSizeInBytes] + */ +@interface AWSConnectGetAttachedFileResponse : AWSModel + + +/** +The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
+ */ +@property (nonatomic, strong) NSString * _Nullable associatedResourceArn; + +/** +Represents the identity that created the file.
+ */ +@property (nonatomic, strong) AWSConnectCreatedByInfo * _Nullable createdBy; + +/** +The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
URL and expiry to be used when downloading the attached file.
+ */ +@property (nonatomic, strong) AWSConnectDownloadUrlMetadata * _Nullable downloadUrlMetadata; + +/** +The unique identifier of the attached file resource (ARN).
+ */ +@property (nonatomic, strong) NSString * _Nullable fileArn; + +/** +The unique identifier of the attached file resource.
+ */ +@property (nonatomic, strong) NSString * _Nullable fileId; + +/** +A case-sensitive name of the attached file being uploaded.
+ */ +@property (nonatomic, strong) NSString * _Nullable fileName; + +/** +The size of the attached file in bytes.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable fileSizeInBytes; + +/** +The current status of the attached file.
+ */ +@property (nonatomic, assign) AWSConnectFileStatusType fileStatus; + +/** +The use case for the file.
+ */ +@property (nonatomic, assign) AWSConnectFileUseCaseType fileUseCaseType; + +/** +The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
The filters to apply to returned metrics. You can filter on the following resources:
Queues
Routing profiles
Agents
Channels
User hierarchy groups
Feature
Routing step expression
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | FEATURE | CASE_TEMPLATE_ARN | CASE_STATUS | contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.
ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
The filters to apply to returned metrics. You can filter on the following resources:
Agents
Channels
Feature
Queues
Routing profiles
Routing step expression
User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | FEATURE | FLOW_TYPE | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | INITIATION_METHOD | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | QUEUE | Q_CONNECT_ENABLED |
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.
ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
Q_CONNECT_ENABLED. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED filter key.
TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
This filter is available only for contact record-driven metrics.
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | CASE_TEMPLATE_ARN | CASE_STATUS | contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | INITIATION_METHOD | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average conversation duration
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average greeting time agent
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average interruptions agent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average interruption time agent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average talk time agent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average talk time customer
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Contact abandoned
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued by Enqueue
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Maximum queued time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Talk time agent percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Talk time customer percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
UI name: Contacts answered in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
UI name: Contacts abandoned in X seconds
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
UI name: Callback attempts
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Metric filter:
Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
UI name: Contacts answered in X seconds
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The timestamp when this resource was last modified.
+The timestamp when this resource was last modified.
+ */ +@property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; + +/** +The name of the hierarchy group.
+ */ +@property (nonatomic, strong) NSString * _Nullable name; + +@end + +/** +Information about the hierarchy group.
+ */ +@interface AWSConnectHierarchyGroupSummaryReference : AWSModel + + +/** +The Amazon Resource Name (ARN) for the hierarchy group.
+ */ +@property (nonatomic, strong) NSString * _Nullable arn; + +/** +The unique identifier for the hierarchy group.
+ */ +@property (nonatomic, strong) NSString * _Nullable identifier; + +@end + +/** +Information about the agent hierarchy. Hierarchies can be configured with up to five levels.
*/ -@property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; +@interface AWSConnectHierarchyGroups : AWSModel + /** -The name of the hierarchy group.
+The group at level one of the agent hierarchy.
*/ -@property (nonatomic, strong) NSString * _Nullable name; - -@end +@property (nonatomic, strong) AWSConnectAgentHierarchyGroup * _Nullable level1; /** -Information about the hierarchy group.
+The group at level two of the agent hierarchy.
*/ -@interface AWSConnectHierarchyGroupSummaryReference : AWSModel +@property (nonatomic, strong) AWSConnectAgentHierarchyGroup * _Nullable level2; +/** +The group at level three of the agent hierarchy.
+ */ +@property (nonatomic, strong) AWSConnectAgentHierarchyGroup * _Nullable level3; /** -The Amazon Resource Name (ARN) for the hierarchy group.
+The group at level four of the agent hierarchy.
*/ -@property (nonatomic, strong) NSString * _Nullable arn; +@property (nonatomic, strong) AWSConnectAgentHierarchyGroup * _Nullable level4; /** -The unique identifier for the hierarchy group.
+The group at level five of the agent hierarchy.
*/ -@property (nonatomic, strong) NSString * _Nullable identifier; +@property (nonatomic, strong) AWSConnectAgentHierarchyGroup * _Nullable level5; @end @@ -8993,6 +9795,19 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +Reason why the request was invalid.
+ */ +@interface AWSConnectInvalidRequestExceptionReason : AWSModel + + +/** +Reason why the StartAttachedFiledUpload request was invalid.
+ */ +@property (nonatomic, assign) AWSConnectAttachedFileInvalidRequestExceptionReason attachedFileInvalidRequestExceptionReason; + +@end + /**A field that is invisible to an agent.
*/ @@ -10627,7 +11442,7 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { /** -This API is in preview release for Amazon Connect and is subject to change.
A list of the third-party application's metadata.
+A list of the third-party application's metadata.
*/ @property (nonatomic, strong) NSArrayThe key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON. These are the same values as the InitiationMethod and DisconnectReason in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator's Guide.
The key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON. These are the same values as the InitiationMethod and DisconnectReason in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator Guide.
Information about the quality of the participant's media connection.
+ */ +@interface AWSConnectQualityMetrics : AWSModel + + +/** +Information about the quality of Agent media connection.
+ */ +@property (nonatomic, strong) AWSConnectAgentQualityMetrics * _Nullable agent; + +/** +Information about the quality of Customer media connection.
+ */ +@property (nonatomic, strong) AWSConnectCustomerQualityMetrics * _Nullable customer; + @end /** @@ -12946,6 +13779,29 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @interface AWSConnectResumeContactResponse : AWSModel +@end + +/** +Latest routing criteria on the contact.
+ */ +@interface AWSConnectRoutingCriteria : AWSModel + + +/** +The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.
+ */ +@property (nonatomic, strong) NSDate * _Nullable activationTimestamp; + +/** +Information about the index of the routing criteria.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable index; + +/** +List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
+ */ +@property (nonatomic, strong) NSArrayThe IDs of the associated queue.
+ */ +@property (nonatomic, strong) NSArrayThe identifier of the default outbound queue for this routing profile.
*/ @@ -13143,7 +14004,7 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @property (nonatomic, strong) NSArrayA leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name, description, and resourceID.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are associatedQueueIds, name, description, and resourceID.
Information about the submit automated evaluation action.
+ */ +@property (nonatomic, strong) AWSConnectSubmitAutoEvaluationActionDefinition * _Nullable submitAutoEvaluationAction; + /**Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ +@property (nonatomic, strong) NSString * _Nullable instanceId; + +/** +The maximum number of results to return per page.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable maxResults; + +/** +The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
+ */ +@property (nonatomic, strong) NSString * _Nullable nextToken; + +/** +The search criteria to be used to return contact flow modules.
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
Filters to be applied to search results.
+ */ +@property (nonatomic, strong) AWSConnectContactFlowModuleSearchFilter * _Nullable searchFilter; + +@end + +/** + + */ +@interface AWSConnectSearchContactFlowModulesResponse : AWSModel + + +/** +The total number of contact flows which matched your search query.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable approximateTotalCount; + +/** +The search criteria to be used to return contact flow modules.
+ */ +@property (nonatomic, strong) NSArrayIf there are additional results, this is the token for the next set of results.
+ */ +@property (nonatomic, strong) NSString * _Nullable nextToken; + +@end + +/** + + */ +@interface AWSConnectSearchContactFlowsRequest : AWSRequest + + +/** +The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ +@property (nonatomic, strong) NSString * _Nullable instanceId; + +/** +The maximum number of results to return per page.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable maxResults; + +/** +The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
+ */ +@property (nonatomic, strong) NSString * _Nullable nextToken; + +/** +The search criteria to be used to return flows.
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
Filters to be applied to search results.
+ */ +@property (nonatomic, strong) AWSConnectContactFlowSearchFilter * _Nullable searchFilter; + +@end + +/** + + */ +@interface AWSConnectSearchContactFlowsResponse : AWSModel + + +/** +The total number of contact flows which matched your search query.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable approximateTotalCount; + +/** +Information about the contact flows.
+ */ +@property (nonatomic, strong) NSArrayIf there are additional results, this is the token for the next set of results.
+ */ +@property (nonatomic, strong) NSString * _Nullable nextToken; + +@end + /** */ @@ -14549,6 +15527,97 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** + + */ +@interface AWSConnectStartAttachedFileUploadRequest : AWSRequest + + +/** +The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
+ */ +@property (nonatomic, strong) NSString * _Nullable clientToken; + +/** +Represents the identity that created the file.
+ */ +@property (nonatomic, strong) AWSConnectCreatedByInfo * _Nullable createdBy; + +/** +A case-sensitive name of the attached file being uploaded.
+ */ +@property (nonatomic, strong) NSString * _Nullable fileName; + +/** +The size of the attached file in bytes.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable fileSizeInBytes; + +/** +The use case for the file.
+ */ +@property (nonatomic, assign) AWSConnectFileUseCaseType fileUseCaseType; + +/** +The unique identifier of the Connect instance.
+ */ +@property (nonatomic, strong) NSString * _Nullable instanceId; + +/** +The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable urlExpiryInSeconds; + +@end + +/** + Response from StartAttachedFileUpload API. + */ +@interface AWSConnectStartAttachedFileUploadResponse : AWSModel + + +/** +Represents the identity that created the file.
+ */ +@property (nonatomic, strong) AWSConnectCreatedByInfo * _Nullable createdBy; + +/** +The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
The unique identifier of the attached file resource (ARN).
+ */ +@property (nonatomic, strong) NSString * _Nullable fileArn; + +/** +The unique identifier of the attached file resource.
+ */ +@property (nonatomic, strong) NSString * _Nullable fileId; + +/** +The current status of the attached file.
+ */ +@property (nonatomic, assign) AWSConnectFileStatusType fileStatus; + +/** +Information to be used while uploading the attached file.
+ */ +@property (nonatomic, strong) AWSConnectUploadUrlMetadata * _Nullable uploadUrlMetadata; + +@end + /** */ @@ -15016,6 +16085,29 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +Step signifies the criteria to be used for routing to an agent
+ */ +@interface AWSConnectStep : AWSModel + + +/** +An object to specify the expiration of a routing step.
+ */ +@property (nonatomic, strong) AWSConnectExpiry * _Nullable expiry; + +/** +A tagged union to specify expression for a routing step.
+ */ +@property (nonatomic, strong) AWSConnectExpression * _Nullable expression; + +/** +Represents status of the Routing step.
+ */ +@property (nonatomic, assign) AWSConnectRoutingCriteriaStepStatus status; + +@end + /** */ @@ -15150,6 +16242,20 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end +/** +Information about the submit automated evaluation action.
+ Required parameters: [EvaluationFormId] + */ +@interface AWSConnectSubmitAutoEvaluationActionDefinition : AWSModel + + +/** +The identifier of the auto-evaluation enabled form.
+ */ +@property (nonatomic, strong) NSString * _Nullable evaluationFormId; + +@end + /** */ @@ -15887,7 +16993,7 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { /** -The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
+The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:
Remove unnecessary attributes by setting their values to empty.
If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the Amazon Connect Administrator Guide.
This API is in preview release for Amazon Connect and is subject to change.
A list of the third-party application's metadata.
+A list of the third-party application's metadata.
*/ @property (nonatomic, strong) NSArrayFields required when uploading an attached file.
+ */ +@interface AWSConnectUploadUrlMetadata : AWSModel + + +/** +A map of headers that should be provided when uploading the attached file.
+ */ +@property (nonatomic, strong) NSDictionaryA pre-signed S3 URL that should be used for uploading the attached file.
+ */ +@property (nonatomic, strong) NSString * _Nullable url; + +/** +The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
\"\ },\ + \"BatchGetAttachedFileMetadata\":{\ + \"name\":\"BatchGetAttachedFileMetadata\",\ + \"http\":{\ + \"method\":\"POST\",\ + \"requestUri\":\"/attached-files/{InstanceId}\"\ + },\ + \"input\":{\"shape\":\"BatchGetAttachedFileMetadataRequest\"},\ + \"output\":{\"shape\":\"BatchGetAttachedFileMetadataResponse\"},\ + \"errors\":[\ + {\"shape\":\"AccessDeniedException\"},\ + {\"shape\":\"InvalidRequestException\"},\ + {\"shape\":\"InternalServiceException\"},\ + {\"shape\":\"ResourceNotFoundException\"},\ + {\"shape\":\"ThrottlingException\"}\ + ],\ + \"documentation\":\"Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
\"\ + },\ \"BatchGetFlowAssociation\":{\ \"name\":\"BatchGetFlowAssociation\",\ \"http\":{\ @@ -420,7 +438,24 @@ - (NSString *)definitionString { {\"shape\":\"IdempotencyException\"},\ {\"shape\":\"AccessDeniedException\"}\ ],\ - \"documentation\":\"Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
\"\ + \"documentation\":\"Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
\"\ + },\ + \"CompleteAttachedFileUpload\":{\ + \"name\":\"CompleteAttachedFileUpload\",\ + \"http\":{\ + \"method\":\"POST\",\ + \"requestUri\":\"/attached-files/{InstanceId}/{FileId}\"\ + },\ + \"input\":{\"shape\":\"CompleteAttachedFileUploadRequest\"},\ + \"output\":{\"shape\":\"CompleteAttachedFileUploadResponse\"},\ + \"errors\":[\ + {\"shape\":\"AccessDeniedException\"},\ + {\"shape\":\"InvalidRequestException\"},\ + {\"shape\":\"InternalServiceException\"},\ + {\"shape\":\"ResourceNotFoundException\"},\ + {\"shape\":\"ThrottlingException\"}\ + ],\ + \"documentation\":\"Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
\"\ },\ \"CreateAgentStatus\":{\ \"name\":\"CreateAgentStatus\",\ @@ -624,7 +659,7 @@ - (NSString *)definitionString { {\"shape\":\"ThrottlingException\"},\ {\"shape\":\"InternalServiceException\"}\ ],\ - \"documentation\":\"Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator's Guide.
\"\ + \"documentation\":\"Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
\"\ },\ \"CreateQueue\":{\ \"name\":\"CreateQueue\",\ @@ -893,6 +928,23 @@ - (NSString *)definitionString { ],\ \"documentation\":\"Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
\"\ },\ + \"DeleteAttachedFile\":{\ + \"name\":\"DeleteAttachedFile\",\ + \"http\":{\ + \"method\":\"DELETE\",\ + \"requestUri\":\"/attached-files/{InstanceId}/{FileId}\"\ + },\ + \"input\":{\"shape\":\"DeleteAttachedFileRequest\"},\ + \"output\":{\"shape\":\"DeleteAttachedFileResponse\"},\ + \"errors\":[\ + {\"shape\":\"AccessDeniedException\"},\ + {\"shape\":\"InvalidRequestException\"},\ + {\"shape\":\"InternalServiceException\"},\ + {\"shape\":\"ResourceNotFoundException\"},\ + {\"shape\":\"ThrottlingException\"}\ + ],\ + \"documentation\":\"Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
\"\ + \"documentation\":\"Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED
Describes the specified flow module.
\"\ + \"documentation\":\"Describes the specified flow module.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Dismisses contacts from an agentâs CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.
Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator's Guide.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
\"\ + \"documentation\":\"Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
\"\ },\ \"ReplicateInstance\":{\ \"name\":\"ReplicateInstance\",\ @@ -2976,6 +3045,40 @@ - (NSString *)definitionString { ],\ \"documentation\":\"Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.
Searches the flow modules in an Amazon Connect instance, with optional filtering.
\"\ + },\ + \"SearchContactFlows\":{\ + \"name\":\"SearchContactFlows\",\ + \"http\":{\ + \"method\":\"POST\",\ + \"requestUri\":\"/search-contact-flows\"\ + },\ + \"input\":{\"shape\":\"SearchContactFlowsRequest\"},\ + \"output\":{\"shape\":\"SearchContactFlowsResponse\"},\ + \"errors\":[\ + {\"shape\":\"InvalidRequestException\"},\ + {\"shape\":\"InvalidParameterException\"},\ + {\"shape\":\"ResourceNotFoundException\"},\ + {\"shape\":\"ThrottlingException\"},\ + {\"shape\":\"InternalServiceException\"}\ + ],\ + \"documentation\":\"Searches the contact flows in an Amazon Connect instance, with optional filtering.
\"\ + },\ \"SearchContacts\":{\ \"name\":\"SearchContacts\",\ \"http\":{\ @@ -3180,6 +3283,24 @@ - (NSString *)definitionString { ],\ \"documentation\":\"Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
\"\ },\ + \"StartAttachedFileUpload\":{\ + \"name\":\"StartAttachedFileUpload\",\ + \"http\":{\ + \"method\":\"PUT\",\ + \"requestUri\":\"/attached-files/{InstanceId}\"\ + },\ + \"input\":{\"shape\":\"StartAttachedFileUploadRequest\"},\ + \"output\":{\"shape\":\"StartAttachedFileUploadResponse\"},\ + \"errors\":[\ + {\"shape\":\"AccessDeniedException\"},\ + {\"shape\":\"InvalidRequestException\"},\ + {\"shape\":\"InternalServiceException\"},\ + {\"shape\":\"ThrottlingException\"},\ + {\"shape\":\"ResourceConflictException\"},\ + {\"shape\":\"ServiceQuotaExceededException\"}\ + ],\ + \"documentation\":\"Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to a Connect Case.
Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
Chat and task contacts can be terminated in any state, regardless of initiation method.
\"\ + \"documentation\":\"Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
\"\ },\ \"StopContactRecording\":{\ \"name\":\"StopContactRecording\",\ @@ -3554,7 +3675,7 @@ - (NSString *)definitionString { {\"shape\":\"ThrottlingException\"},\ {\"shape\":\"InternalServiceException\"}\ ],\ - \"documentation\":\"Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
\"\ + \"documentation\":\"Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Updates specified flow module for the specified Amazon Connect instance.
\"\ + \"documentation\":\"Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
This API is in preview release for Amazon Connect and is subject to change.
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
\"\ + \"documentation\":\"Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
The Amazon Resource Name (ARN) of the group.
\"\ + }\ + },\ + \"documentation\":\"Information about an agent hierarchy group.
\"\ + },\ \"AgentHierarchyGroups\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -4445,7 +4577,16 @@ - (NSString *)definitionString { \"AgentPauseDurationInSeconds\":{\ \"shape\":\"AgentPauseDurationInSeconds\",\ \"documentation\":\"Agent pause duration for a contact in seconds.
\"\ - }\ + },\ + \"HierarchyGroups\":{\ + \"shape\":\"HierarchyGroups\",\ + \"documentation\":\"The agent hierarchy groups for the agent.
\"\ + },\ + \"DeviceInfo\":{\ + \"shape\":\"DeviceInfo\",\ + \"documentation\":\"Information regarding Agentâs device.
\"\ + },\ + \"Capabilities\":{\"shape\":\"ParticipantCapabilities\"}\ },\ \"documentation\":\"Information about the agent who accepted the contact.
\"\ },\ @@ -4459,6 +4600,16 @@ - (NSString *)definitionString { \"type\":\"integer\",\ \"min\":0\ },\ + \"AgentQualityMetrics\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"Audio\":{\ + \"shape\":\"AudioQualityMetricsInfo\",\ + \"documentation\":\"Information about the audio quality of the Agent
\"\ + }\ + },\ + \"documentation\":\"Information about the quality of the Agent's media connection
\"\ + },\ \"AgentResourceId\":{\ \"type\":\"string\",\ \"max\":256,\ @@ -4685,6 +4836,25 @@ - (NSString *)definitionString { },\ \"documentation\":\"Configuration of the answering machine detection.
\"\ },\ + \"AnsweringMachineDetectionStatus\":{\ + \"type\":\"string\",\ + \"enum\":[\ + \"ANSWERED\",\ + \"UNDETECTED\",\ + \"ERROR\",\ + \"HUMAN_ANSWERED\",\ + \"SIT_TONE_DETECTED\",\ + \"SIT_TONE_BUSY\",\ + \"SIT_TONE_INVALID_NUMBER\",\ + \"FAX_MACHINE_DETECTED\",\ + \"VOICEMAIL_BEEP\",\ + \"VOICEMAIL_NO_BEEP\",\ + \"AMD_UNRESOLVED\",\ + \"AMD_UNANSWERED\",\ + \"AMD_ERROR\",\ + \"AMD_NOT_APPLICABLE\"\ + ]\ + },\ \"Application\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -5104,11 +5274,104 @@ - (NSString *)definitionString { }\ }\ },\ + \"AssociatedQueueIdList\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"QueueId\"}\ + },\ \"AssociationId\":{\ \"type\":\"string\",\ \"max\":100,\ \"min\":1\ },\ + \"AttachedFile\":{\ + \"type\":\"structure\",\ + \"required\":[\ + \"CreationTime\",\ + \"FileArn\",\ + \"FileId\",\ + \"FileName\",\ + \"FileSizeInBytes\",\ + \"FileStatus\"\ + ],\ + \"members\":{\ + \"CreationTime\":{\ + \"shape\":\"ISO8601Datetime\",\ + \"documentation\":\"The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
The unique identifier of the attached file resource (ARN).
\"\ + },\ + \"FileId\":{\ + \"shape\":\"FileId\",\ + \"documentation\":\"The unique identifier of the attached file resource.
\"\ + },\ + \"FileName\":{\ + \"shape\":\"FileName\",\ + \"documentation\":\"A case-sensitive name of the attached file being uploaded.
\"\ + },\ + \"FileSizeInBytes\":{\ + \"shape\":\"FileSizeInBytes\",\ + \"documentation\":\"The size of the attached file in bytes.
\",\ + \"box\":true\ + },\ + \"FileStatus\":{\ + \"shape\":\"FileStatusType\",\ + \"documentation\":\"The current status of the attached file.
\"\ + },\ + \"CreatedBy\":{\ + \"shape\":\"CreatedByInfo\",\ + \"documentation\":\"Represents the identity that created the file.
\"\ + },\ + \"FileUseCaseType\":{\ + \"shape\":\"FileUseCaseType\",\ + \"documentation\":\"The use case for the file.
\"\ + },\ + \"AssociatedResourceArn\":{\ + \"shape\":\"ARN\",\ + \"documentation\":\"The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The tags used to organize, track, or control access for this resource. For example, { \\\"Tags\\\": {\\\"key1\\\":\\\"value1\\\", \\\"key2\\\":\\\"value2\\\"} }.
Information about the attached file.
\"\ + },\ + \"AttachedFileError\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"ErrorCode\":{\ + \"shape\":\"ErrorCode\",\ + \"documentation\":\"Status code describing the failure.
\"\ + },\ + \"ErrorMessage\":{\ + \"shape\":\"ErrorMessage\",\ + \"documentation\":\"Why the attached file couldn't be retrieved.
\"\ + },\ + \"FileId\":{\ + \"shape\":\"FileId\",\ + \"documentation\":\"The unique identifier of the attached file resource.
\"\ + }\ + },\ + \"documentation\":\"Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
\"\ + },\ + \"AttachedFileErrorsList\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"AttachedFileError\"}\ + },\ + \"AttachedFileInvalidRequestExceptionReason\":{\ + \"type\":\"string\",\ + \"enum\":[\ + \"INVALID_FILE_SIZE\",\ + \"INVALID_FILE_TYPE\",\ + \"INVALID_FILE_NAME\"\ + ]\ + },\ + \"AttachedFilesList\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"AttachedFile\"}\ + },\ \"AttachmentName\":{\ \"type\":\"string\",\ \"max\":256,\ @@ -5172,6 +5435,28 @@ - (NSString *)definitionString { },\ \"documentation\":\"A list of conditions which would be applied together with an AND condition.
The name of predefined attribute.
\"\ + },\ + \"Value\":{\ + \"shape\":\"ProficiencyValue\",\ + \"documentation\":\"The value of predefined attribute.
\"\ + },\ + \"ProficiencyLevel\":{\ + \"shape\":\"ProficiencyLevel\",\ + \"documentation\":\"The proficiency level of the condition.
\"\ + },\ + \"ComparisonOperator\":{\ + \"shape\":\"ComparisonOperator\",\ + \"documentation\":\"The operator of the condition.
\"\ + }\ + },\ + \"documentation\":\"An object to specify the predefined attribute condition.
\"\ + },\ \"AttributeName\":{\ \"type\":\"string\",\ \"max\":32767,\ @@ -5205,6 +5490,21 @@ - (NSString *)definitionString { },\ \"documentation\":\"Has audio-specific configurations as the operating parameter for Echo Reduction.
\"\ },\ + \"AudioQualityMetricsInfo\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"QualityScore\":{\ + \"shape\":\"AudioQualityScore\",\ + \"documentation\":\"Number measuring the estimated quality of the media connection.
\"\ + },\ + \"PotentialQualityIssues\":{\ + \"shape\":\"PotentialAudioQualityIssues\",\ + \"documentation\":\"List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.
Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer
Contains information for score and potential quality issues for Audio
\"\ + },\ + \"AudioQualityScore\":{\"type\":\"float\"},\ \"AutoAccept\":{\"type\":\"boolean\"},\ \"AvailableNumberSummary\":{\ \"type\":\"structure\",\ @@ -5306,6 +5606,45 @@ - (NSString *)definitionString { }\ }\ },\ + \"BatchGetAttachedFileMetadataRequest\":{\ + \"type\":\"structure\",\ + \"required\":[\ + \"FileIds\",\ + \"InstanceId\",\ + \"AssociatedResourceArn\"\ + ],\ + \"members\":{\ + \"FileIds\":{\ + \"shape\":\"FileIdList\",\ + \"documentation\":\"The unique identifiers of the attached file resource.
\"\ + },\ + \"InstanceId\":{\ + \"shape\":\"InstanceId\",\ + \"documentation\":\"The unique identifier of the Connect instance.
\",\ + \"location\":\"uri\",\ + \"locationName\":\"InstanceId\"\ + },\ + \"AssociatedResourceArn\":{\ + \"shape\":\"ARN\",\ + \"documentation\":\"The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
List of attached files that were successfully retrieved.
\"\ + },\ + \"Errors\":{\ + \"shape\":\"AttachedFileErrorsList\",\ + \"documentation\":\"List of errors of attached files that could not be retrieved.
\"\ + }\ + }\ + },\ \"BatchGetFlowAssociationRequest\":{\ \"type\":\"structure\",\ \"required\":[\ @@ -5624,6 +5963,46 @@ - (NSString *)definitionString { \"type\":\"string\",\ \"enum\":[\"LT\"]\ },\ + \"ComparisonOperator\":{\ + \"type\":\"string\",\ + \"max\":127,\ + \"min\":1\ + },\ + \"CompleteAttachedFileUploadRequest\":{\ + \"type\":\"structure\",\ + \"required\":[\ + \"InstanceId\",\ + \"FileId\",\ + \"AssociatedResourceArn\"\ + ],\ + \"members\":{\ + \"InstanceId\":{\ + \"shape\":\"InstanceId\",\ + \"documentation\":\"The unique identifier of the Connect instance.
\",\ + \"location\":\"uri\",\ + \"locationName\":\"InstanceId\"\ + },\ + \"FileId\":{\ + \"shape\":\"FileId\",\ + \"documentation\":\"The unique identifier of the attached file resource.
\",\ + \"location\":\"uri\",\ + \"locationName\":\"FileId\"\ + },\ + \"AssociatedResourceArn\":{\ + \"shape\":\"ARN\",\ + \"documentation\":\"The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
\"\ + },\ + \"ConnectedToSystemTimestamp\":{\ + \"shape\":\"timestamp\",\ + \"documentation\":\"The timestamp when customer endpoint connected to Amazon Connect.
\"\ + },\ + \"RoutingCriteria\":{\ + \"shape\":\"RoutingCriteria\",\ + \"documentation\":\"Latest routing criteria on the contact.
\"\ + },\ + \"Customer\":{\ + \"shape\":\"Customer\",\ + \"documentation\":\"Information about the Customer on the contact.
\"\ + },\ + \"Campaign\":{\"shape\":\"Campaign\"},\ + \"AnsweringMachineDetectionStatus\":{\ + \"shape\":\"AnsweringMachineDetectionStatus\",\ + \"documentation\":\"Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
\"\ + },\ + \"CustomerVoiceActivity\":{\ + \"shape\":\"CustomerVoiceActivity\",\ + \"documentation\":\"Information about customerâs voice activity.
\"\ + },\ + \"QualityMetrics\":{\ + \"shape\":\"QualityMetrics\",\ + \"documentation\":\"Information about the quality of the participant's media connection.
\"\ + },\ + \"DisconnectDetails\":{\ + \"shape\":\"DisconnectDetails\",\ + \"documentation\":\"Information about the call disconnect experience.
\"\ + },\ + \"SegmentAttributes\":{\ + \"shape\":\"SegmentAttributes\",\ + \"documentation\":\"A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.
Contains information about a contact.
\"\ @@ -5829,6 +6241,10 @@ - (NSString *)definitionString { \"shape\":\"ContactFlowState\",\ \"documentation\":\"The type of flow.
\"\ },\ + \"Status\":{\ + \"shape\":\"ContactFlowStatus\",\ + \"documentation\":\"The status of the contact flow.
\"\ + },\ \"Description\":{\ \"shape\":\"ContactFlowDescription\",\ \"documentation\":\"The description of the flow.
\"\ @@ -5910,6 +6326,36 @@ - (NSString *)definitionString { \"min\":1,\ \"pattern\":\".*\\\\S.*\"\ },\ + \"ContactFlowModuleSearchConditionList\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"ContactFlowModuleSearchCriteria\"}\ + },\ + \"ContactFlowModuleSearchCriteria\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"OrConditions\":{\ + \"shape\":\"ContactFlowModuleSearchConditionList\",\ + \"documentation\":\"A list of conditions which would be applied together with an OR condition.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return flow modules.
\"\ + },\ + \"ContactFlowModuleSearchFilter\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"TagFilter\":{\"shape\":\"ControlPlaneTagFilter\"}\ + },\ + \"documentation\":\"The search criteria to be used to return flow modules.
\"\ + },\ + \"ContactFlowModuleSearchSummaryList\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"ContactFlowModule\"}\ + },\ \"ContactFlowModuleState\":{\ \"type\":\"string\",\ \"enum\":[\ @@ -5963,6 +6409,48 @@ - (NSString *)definitionString { \"error\":{\"httpStatusCode\":404},\ \"exception\":true\ },\ + \"ContactFlowSearchConditionList\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"ContactFlowSearchCriteria\"}\ + },\ + \"ContactFlowSearchCriteria\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"OrConditions\":{\ + \"shape\":\"ContactFlowSearchConditionList\",\ + \"documentation\":\"A list of conditions which would be applied together with an OR condition.
A list of conditions which would be applied together with an AND condition.
The type of flow.
\"\ + },\ + \"StateCondition\":{\ + \"shape\":\"ContactFlowState\",\ + \"documentation\":\"The state of the flow.
\"\ + },\ + \"StatusCondition\":{\ + \"shape\":\"ContactFlowStatus\",\ + \"documentation\":\"The status of the flow.
\"\ + }\ + },\ + \"documentation\":\"The search criteria to be used to return contact flows.
\"\ + },\ + \"ContactFlowSearchFilter\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"TagFilter\":{\"shape\":\"ControlPlaneTagFilter\"}\ + },\ + \"documentation\":\"Filters to be applied to search results.
\"\ + },\ + \"ContactFlowSearchSummaryList\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"ContactFlow\"}\ + },\ \"ContactFlowState\":{\ \"type\":\"string\",\ \"enum\":[\ @@ -5970,6 +6458,13 @@ - (NSString *)definitionString { \"ARCHIVED\"\ ]\ },\ + \"ContactFlowStatus\":{\ + \"type\":\"string\",\ + \"enum\":[\ + \"PUBLISHED\",\ + \"SAVED\"\ + ]\ + },\ \"ContactFlowSummary\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -5992,6 +6487,10 @@ - (NSString *)definitionString { \"ContactFlowState\":{\ \"shape\":\"ContactFlowState\",\ \"documentation\":\"The type of flow.
\"\ + },\ + \"ContactFlowStatus\":{\ + \"shape\":\"ContactFlowStatus\",\ + \"documentation\":\"The status of the contact flow.
\"\ }\ },\ \"documentation\":\"Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language.
\"\ @@ -6372,6 +6871,10 @@ - (NSString *)definitionString { \"shape\":\"ContactFlowContent\",\ \"documentation\":\"The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
\"\ },\ + \"Status\":{\ + \"shape\":\"ContactFlowStatus\",\ + \"documentation\":\"Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.
The tags used to organize, track, or control access for this resource. For example, { \\\"Tags\\\": {\\\"key1\\\":\\\"value1\\\", \\\"key2\\\":\\\"value2\\\"} }.
\"\ @@ -7020,7 +7523,7 @@ - (NSString *)definitionString { },\ \"Applications\":{\ \"shape\":\"Applications\",\ - \"documentation\":\"This API is in preview release for Amazon Connect and is subject to change.
A list of third-party applications that the security profile will give access to.
\"\ + \"documentation\":\"A list of third-party applications that the security profile will give access to.
\"\ },\ \"HierarchyRestrictedResources\":{\ \"shape\":\"HierarchyRestrictedResourceList\",\ @@ -7452,6 +7955,21 @@ - (NSString *)definitionString { }\ }\ },\ + \"CreatedByInfo\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"ConnectUserArn\":{\ + \"shape\":\"ARN\",\ + \"documentation\":\"An agent ARN representing a connect user.
\"\ + },\ + \"AWSIdentityArn\":{\ + \"shape\":\"ARN\",\ + \"documentation\":\"STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
Information on the identity that created the file.
\",\ + \"union\":true\ + },\ \"Credentials\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -7577,6 +8095,41 @@ - (NSString *)definitionString { \"type\":\"list\",\ \"member\":{\"shape\":\"CurrentMetric\"}\ },\ + \"Customer\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"DeviceInfo\":{\ + \"shape\":\"DeviceInfo\",\ + \"documentation\":\"Information regarding Customerâs device.
\"\ + },\ + \"Capabilities\":{\"shape\":\"ParticipantCapabilities\"}\ + },\ + \"documentation\":\"Information about the Customer on the contact.
\"\ + },\ + \"CustomerQualityMetrics\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"Audio\":{\ + \"shape\":\"AudioQualityMetricsInfo\",\ + \"documentation\":\"Information about the audio quality of the Customer
\"\ + }\ + },\ + \"documentation\":\"Information about the quality of the Customer's media connection
\"\ + },\ + \"CustomerVoiceActivity\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"GreetingStartTimestamp\":{\ + \"shape\":\"timestamp\",\ + \"documentation\":\"Timestamp that measures the beginning of the customer greeting from an outbound voice call.
\"\ + },\ + \"GreetingEndTimestamp\":{\ + \"shape\":\"timestamp\",\ + \"documentation\":\"Timestamp that measures the end of the customer greeting from an outbound voice call.
\"\ + }\ + },\ + \"documentation\":\"Information about customerâs voice activity.
\"\ + },\ \"DataSetId\":{\ \"type\":\"string\",\ \"max\":255,\ @@ -7685,6 +8238,41 @@ - (NSString *)definitionString { \"max\":9999,\ \"min\":0\ },\ + \"DeleteAttachedFileRequest\":{\ + \"type\":\"structure\",\ + \"required\":[\ + \"InstanceId\",\ + \"FileId\",\ + \"AssociatedResourceArn\"\ + ],\ + \"members\":{\ + \"InstanceId\":{\ + \"shape\":\"InstanceId\",\ + \"documentation\":\"The unique identifier of the Connect instance.
\",\ + \"location\":\"uri\",\ + \"locationName\":\"InstanceId\"\ + },\ + \"FileId\":{\ + \"shape\":\"FileId\",\ + \"documentation\":\"The unique identifier of the attached file resource.
\",\ + \"location\":\"uri\",\ + \"locationName\":\"FileId\"\ + },\ + \"AssociatedResourceArn\":{\ + \"shape\":\"ARN\",\ + \"documentation\":\"The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
Name of the platform that the participant used for the call.
\"\ + },\ + \"PlatformVersion\":{\ + \"shape\":\"PlatformVersion\",\ + \"documentation\":\"Version of the platform that the participant used for the call.
\"\ + },\ + \"OperatingSystem\":{\ + \"shape\":\"OperatingSystem\",\ + \"documentation\":\"Operating system that the participant used for the call.
\"\ + }\ + },\ + \"documentation\":\"Information regarding the device.
\"\ + },\ \"Dimensions\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -9312,6 +9918,16 @@ - (NSString *)definitionString { }\ }\ },\ + \"DisconnectDetails\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"PotentialDisconnectIssue\":{\ + \"shape\":\"PotentialDisconnectIssue\",\ + \"documentation\":\"Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.
\"\ + }\ + },\ + \"documentation\":\"Information about the call disconnect experience.
\"\ + },\ \"DisconnectReason\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -9382,6 +9998,20 @@ - (NSString *)definitionString { \"member\":{\"shape\":\"Distribution\"}\ },\ \"Double\":{\"type\":\"double\"},\ + \"DownloadUrlMetadata\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"Url\":{\ + \"shape\":\"MetadataUrl\",\ + \"documentation\":\"A pre-signed URL that should be used to download the attached file.
\"\ + },\ + \"UrlExpiry\":{\ + \"shape\":\"ISO8601Datetime\",\ + \"documentation\":\"The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
\"\ + }\ + },\ + \"documentation\":\"Metadata used to download the attached file.
\"\ + },\ \"DuplicateResourceException\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -9391,6 +10021,7 @@ - (NSString *)definitionString { \"error\":{\"httpStatusCode\":409},\ \"exception\":true\ },\ + \"DurationInSeconds\":{\"type\":\"integer\"},\ \"Email\":{\ \"type\":\"string\",\ \"sensitive\":true\ @@ -9470,6 +10101,8 @@ - (NSString *)definitionString { \"CONTACT_FLOW\"\ ]\ },\ + \"ErrorCode\":{\"type\":\"string\"},\ + \"ErrorMessage\":{\"type\":\"string\"},\ \"ErrorResult\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -9726,6 +10359,11 @@ - (NSString *)definitionString { \"max\":1024,\ \"min\":0\ },\ + \"EvaluationFormId\":{\ + \"type\":\"string\",\ + \"max\":256,\ + \"min\":1\ + },\ \"EvaluationFormItem\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -10367,6 +11005,42 @@ - (NSString *)definitionString { \"OnCaseUpdate\"\ ]\ },\ + \"Expiry\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"DurationInSeconds\":{\ + \"shape\":\"DurationInSeconds\",\ + \"documentation\":\"The number of seconds to wait before expiring the routing step.
\"\ + },\ + \"ExpiryTimestamp\":{\ + \"shape\":\"timestamp\",\ + \"documentation\":\"The timestamp indicating when the routing step expires.
\"\ + }\ + },\ + \"documentation\":\"An object to specify the expiration of a routing step.
\"\ + },\ + \"Expression\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"AttributeCondition\":{\ + \"shape\":\"AttributeCondition\",\ + \"documentation\":\"An object to specify the predefined attribute condition.
\"\ + },\ + \"AndExpression\":{\ + \"shape\":\"Expressions\",\ + \"documentation\":\"List of routing expressions which will be AND-ed together.
\"\ + },\ + \"OrExpression\":{\ + \"shape\":\"Expressions\",\ + \"documentation\":\"List of routing expressions which will be OR-ed together.
\"\ + }\ + },\ + \"documentation\":\"A tagged union to specify expression for a routing step.
\"\ + },\ + \"Expressions\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"Expression\"}\ + },\ \"FailedRequest\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -10458,6 +11132,40 @@ - (NSString *)definitionString { \"type\":\"list\",\ \"member\":{\"shape\":\"FieldValue\"}\ },\ + \"FileId\":{\ + \"type\":\"string\",\ + \"max\":256,\ + \"min\":1\ + },\ + \"FileIdList\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"FileId\"},\ + \"min\":1\ + },\ + \"FileName\":{\ + \"type\":\"string\",\ + \"max\":256,\ + \"min\":1,\ + \"pattern\":\"^\\\\P{C}*$\"\ + },\ + \"FileSizeInBytes\":{\ + \"type\":\"long\",\ + \"box\":true,\ + \"min\":1\ + },\ + \"FileStatusType\":{\ + \"type\":\"string\",\ + \"enum\":[\ + \"APPROVED\",\ + \"REJECTED\",\ + \"PROCESSING\",\ + \"FAILED\"\ + ]\ + },\ + \"FileUseCaseType\":{\ + \"type\":\"string\",\ + \"enum\":[\"ATTACHMENT\"]\ + },\ \"FilterV2\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -10517,29 +11225,116 @@ - (NSString *)definitionString { \"shape\":\"ARN\",\ \"documentation\":\"The identifier of the resource.
\"\ },\ - \"FlowId\":{\ + \"FlowId\":{\ + \"shape\":\"ARN\",\ + \"documentation\":\"The identifier of the flow.
\"\ + },\ + \"ResourceType\":{\ + \"shape\":\"ListFlowAssociationResourceType\",\ + \"documentation\":\"The type of resource association.
\"\ + }\ + },\ + \"documentation\":\"Information about flow associations.
\"\ + },\ + \"FlowAssociationSummaryList\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"FlowAssociationSummary\"}\ + },\ + \"FunctionArn\":{\ + \"type\":\"string\",\ + \"max\":140,\ + \"min\":1\ + },\ + \"FunctionArnsList\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"FunctionArn\"}\ + },\ + \"GetAttachedFileRequest\":{\ + \"type\":\"structure\",\ + \"required\":[\ + \"InstanceId\",\ + \"FileId\",\ + \"AssociatedResourceArn\"\ + ],\ + \"members\":{\ + \"InstanceId\":{\ + \"shape\":\"InstanceId\",\ + \"documentation\":\"The unique identifier of the Connect instance.
\",\ + \"location\":\"uri\",\ + \"locationName\":\"InstanceId\"\ + },\ + \"FileId\":{\ + \"shape\":\"FileId\",\ + \"documentation\":\"The unique identifier of the attached file resource.
\",\ + \"location\":\"uri\",\ + \"locationName\":\"FileId\"\ + },\ + \"UrlExpiryInSeconds\":{\ + \"shape\":\"URLExpiryInSeconds\",\ + \"documentation\":\"Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
\",\ + \"location\":\"querystring\",\ + \"locationName\":\"urlExpiryInSeconds\"\ + },\ + \"AssociatedResourceArn\":{\ + \"shape\":\"ARN\",\ + \"documentation\":\"The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The unique identifier of the attached file resource (ARN).
\"\ + },\ + \"FileId\":{\ + \"shape\":\"FileId\",\ + \"documentation\":\"The unique identifier of the attached file resource.
\"\ + },\ + \"CreationTime\":{\ + \"shape\":\"ISO8601Datetime\",\ + \"documentation\":\"The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
The current status of the attached file.
\"\ + },\ + \"FileName\":{\ + \"shape\":\"FileName\",\ + \"documentation\":\"A case-sensitive name of the attached file being uploaded.
\"\ + },\ + \"FileSizeInBytes\":{\ + \"shape\":\"FileSizeInBytes\",\ + \"documentation\":\"The size of the attached file in bytes.
\",\ + \"box\":true\ + },\ + \"AssociatedResourceArn\":{\ \"shape\":\"ARN\",\ - \"documentation\":\"The identifier of the flow.
\"\ + \"documentation\":\"The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
\"\ },\ - \"ResourceType\":{\ - \"shape\":\"ListFlowAssociationResourceType\",\ - \"documentation\":\"The type of resource association.
\"\ + \"FileUseCaseType\":{\ + \"shape\":\"FileUseCaseType\",\ + \"documentation\":\"The use case for the file.
\"\ + },\ + \"CreatedBy\":{\ + \"shape\":\"CreatedByInfo\",\ + \"documentation\":\"Represents the identity that created the file.
\"\ + },\ + \"DownloadUrlMetadata\":{\ + \"shape\":\"DownloadUrlMetadata\",\ + \"documentation\":\"URL and expiry to be used when downloading the attached file.
\"\ + },\ + \"Tags\":{\ + \"shape\":\"TagMap\",\ + \"documentation\":\"The tags used to organize, track, or control access for this resource. For example, { \\\"Tags\\\": {\\\"key1\\\":\\\"value1\\\", \\\"key2\\\":\\\"value2\\\"} }.
Information about flow associations.
\"\ - },\ - \"FlowAssociationSummaryList\":{\ - \"type\":\"list\",\ - \"member\":{\"shape\":\"FlowAssociationSummary\"}\ - },\ - \"FunctionArn\":{\ - \"type\":\"string\",\ - \"max\":140,\ - \"min\":1\ - },\ - \"FunctionArnsList\":{\ - \"type\":\"list\",\ - \"member\":{\"shape\":\"FunctionArn\"}\ + \"documentation\":\"Response from GetAttachedFile API.\"\ },\ \"GetContactAttributesRequest\":{\ \"type\":\"structure\",\ @@ -10844,15 +11639,15 @@ - (NSString *)definitionString { },\ \"Filters\":{\ \"shape\":\"FiltersV2List\",\ - \"documentation\":\"The filters to apply to returned metrics. You can filter on the following resources:
Queues
Routing profiles
Agents
Channels
User hierarchy groups
Feature
Routing step expression
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | FEATURE | CASE_TEMPLATE_ARN | CASE_STATUS | contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.
ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
The filters to apply to returned metrics. You can filter on the following resources:
Agents
Channels
Feature
Queues
Routing profiles
Routing step expression
User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | FEATURE | FLOW_TYPE | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | INITIATION_METHOD | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | QUEUE | Q_CONNECT_ENABLED |
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.
ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
Q_CONNECT_ENABLED. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED filter key.
TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
This filter is available only for contact record-driven metrics.
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | CASE_TEMPLATE_ARN | CASE_STATUS | contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | INITIATION_METHOD | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average conversation duration
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average greeting time agent
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average interruptions agent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average interruption time agent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average talk time agent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average talk time customer
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Contact abandoned
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued by Enqueue
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \\\"Less than\\\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Maximum queued time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Talk time agent percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Talk time customer percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \\\"Less than\\\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \\\"Less than\\\").
UI name: Contacts answered in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \\\"Less than\\\").
UI name: Contacts abandoned in X seconds
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
UI name: Callback attempts
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Metric filter:
Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \\\"Less than\\\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \\\"Less than\\\").
UI name: Contacts answered in X seconds
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \\\"Less than\\\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \\\"Less than\\\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
Information about the hierarchy group.
\"\ },\ + \"HierarchyGroups\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"Level1\":{\ + \"shape\":\"AgentHierarchyGroup\",\ + \"documentation\":\"The group at level one of the agent hierarchy.
\"\ + },\ + \"Level2\":{\ + \"shape\":\"AgentHierarchyGroup\",\ + \"documentation\":\"The group at level two of the agent hierarchy.
\"\ + },\ + \"Level3\":{\ + \"shape\":\"AgentHierarchyGroup\",\ + \"documentation\":\"The group at level three of the agent hierarchy.
\"\ + },\ + \"Level4\":{\ + \"shape\":\"AgentHierarchyGroup\",\ + \"documentation\":\"The group at level four of the agent hierarchy.
\"\ + },\ + \"Level5\":{\ + \"shape\":\"AgentHierarchyGroup\",\ + \"documentation\":\"The group at level five of the agent hierarchy.
\"\ + }\ + },\ + \"documentation\":\"Information about the agent hierarchy. Hierarchies can be configured with up to five levels.
\"\ + },\ \"HierarchyLevel\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -11657,6 +12478,7 @@ - (NSString *)definitionString { }\ },\ \"InboundCallsEnabled\":{\"type\":\"boolean\"},\ + \"Index\":{\"type\":\"integer\"},\ \"InitiationMethodList\":{\ \"type\":\"list\",\ \"member\":{\"shape\":\"ContactInitiationMethod\"}\ @@ -12013,12 +12835,24 @@ - (NSString *)definitionString { \"Message\":{\ \"shape\":\"Message\",\ \"documentation\":\"The message about the request.
\"\ - }\ + },\ + \"Reason\":{\"shape\":\"InvalidRequestExceptionReason\"}\ },\ \"documentation\":\"The request is not valid.
\",\ \"error\":{\"httpStatusCode\":400},\ \"exception\":true\ },\ + \"InvalidRequestExceptionReason\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"AttachedFileInvalidRequestExceptionReason\":{\ + \"shape\":\"AttachedFileInvalidRequestExceptionReason\",\ + \"documentation\":\"Reason why the StartAttachedFiledUpload request was invalid.
\"\ + }\ + },\ + \"documentation\":\"Reason why the request was invalid.
\",\ + \"union\":true\ + },\ \"InvisibleFieldInfo\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -13606,7 +14440,7 @@ - (NSString *)definitionString { \"members\":{\ \"Applications\":{\ \"shape\":\"Applications\",\ - \"documentation\":\"This API is in preview release for Amazon Connect and is subject to change.
A list of the third-party application's metadata.
\"\ + \"documentation\":\"A list of the third-party application's metadata.
\"\ },\ \"NextToken\":{\ \"shape\":\"NextToken\",\ @@ -14280,6 +15114,11 @@ - (NSString *)definitionString { },\ \"MeetingId\":{\"type\":\"string\"},\ \"Message\":{\"type\":\"string\"},\ + \"MetadataUrl\":{\ + \"type\":\"string\",\ + \"max\":2000,\ + \"min\":1\ + },\ \"MetricDataCollectionsV2\":{\ \"type\":\"list\",\ \"member\":{\"shape\":\"MetricDataV2\"}\ @@ -14304,7 +15143,7 @@ - (NSString *)definitionString { \"members\":{\ \"MetricFilterKey\":{\ \"shape\":\"String\",\ - \"documentation\":\"The key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON. These are the same values as the InitiationMethod and DisconnectReason in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator's Guide.
The key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON. These are the same values as the InitiationMethod and DisconnectReason in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator Guide.
Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question.
Sentiment scores have a minimum value of -5 and maximum value of 5.
Duration labels, such as NON_TALK_TIME, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value of 0 and maximum value of 28800.
Percentages have a minimum value of 0 and maximum value of 100.
NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of 1000.
Information about the quality of Agent media connection.
\"\ + },\ + \"Customer\":{\ + \"shape\":\"CustomerQualityMetrics\",\ + \"documentation\":\"Information about the quality of Customer media connection.
\"\ + }\ + },\ + \"documentation\":\"Information about the quality of the participant's media connection.
\"\ + },\ \"Queue\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -16591,6 +17480,33 @@ - (NSString *)definitionString { \"members\":{\ }\ },\ + \"RoutingCriteria\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"Steps\":{\ + \"shape\":\"Steps\",\ + \"documentation\":\"List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
\"\ + },\ + \"ActivationTimestamp\":{\ + \"shape\":\"timestamp\",\ + \"documentation\":\"The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.
\"\ + },\ + \"Index\":{\ + \"shape\":\"Index\",\ + \"documentation\":\"Information about the index of the routing criteria.
\"\ + }\ + },\ + \"documentation\":\"Latest routing criteria on the contact.
\"\ + },\ + \"RoutingCriteriaStepStatus\":{\ + \"type\":\"string\",\ + \"enum\":[\ + \"ACTIVE\",\ + \"INACTIVE\",\ + \"JOINED\",\ + \"EXPIRED\"\ + ]\ + },\ \"RoutingExpression\":{\ \"type\":\"string\",\ \"max\":3000,\ @@ -16659,6 +17575,10 @@ - (NSString *)definitionString { \"IsDefault\":{\ \"shape\":\"Boolean\",\ \"documentation\":\"Whether this a default routing profile.
\"\ + },\ + \"AssociatedQueueIds\":{\ + \"shape\":\"AssociatedQueueIdList\",\ + \"documentation\":\"The IDs of the associated queue.
\"\ }\ },\ \"documentation\":\"Contains information about a routing profile.
\"\ @@ -16804,7 +17724,7 @@ - (NSString *)definitionString { },\ \"StringCondition\":{\ \"shape\":\"StringCondition\",\ - \"documentation\":\"A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name, description, and resourceID.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are associatedQueueIds, name, description, and resourceID.
The search criteria to be used to return routing profiles.
The name and description fields support \\\"contains\\\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate.
Information about the submit automated evaluation action.
\"\ }\ },\ \"documentation\":\"Information about the action to be performed when a rule is triggered.
\"\ @@ -17122,6 +18046,94 @@ - (NSString *)definitionString { }\ }\ },\ + \"SearchContactFlowModulesRequest\":{\ + \"type\":\"structure\",\ + \"required\":[\"InstanceId\"],\ + \"members\":{\ + \"InstanceId\":{\ + \"shape\":\"InstanceId\",\ + \"documentation\":\"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
\"\ + },\ + \"NextToken\":{\ + \"shape\":\"NextToken2500\",\ + \"documentation\":\"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
\"\ + },\ + \"MaxResults\":{\ + \"shape\":\"MaxResult100\",\ + \"documentation\":\"The maximum number of results to return per page.
\",\ + \"box\":true\ + },\ + \"SearchFilter\":{\ + \"shape\":\"ContactFlowModuleSearchFilter\",\ + \"documentation\":\"Filters to be applied to search results.
\"\ + },\ + \"SearchCriteria\":{\ + \"shape\":\"ContactFlowModuleSearchCriteria\",\ + \"documentation\":\"The search criteria to be used to return contact flow modules.
The name and description fields support \\\"contains\\\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
The search criteria to be used to return contact flow modules.
\"\ + },\ + \"NextToken\":{\ + \"shape\":\"NextToken2500\",\ + \"documentation\":\"If there are additional results, this is the token for the next set of results.
\"\ + },\ + \"ApproximateTotalCount\":{\ + \"shape\":\"ApproximateTotalCount\",\ + \"documentation\":\"The total number of contact flows which matched your search query.
\"\ + }\ + }\ + },\ + \"SearchContactFlowsRequest\":{\ + \"type\":\"structure\",\ + \"required\":[\"InstanceId\"],\ + \"members\":{\ + \"InstanceId\":{\ + \"shape\":\"InstanceId\",\ + \"documentation\":\"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
\"\ + },\ + \"NextToken\":{\ + \"shape\":\"NextToken2500\",\ + \"documentation\":\"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
\"\ + },\ + \"MaxResults\":{\ + \"shape\":\"MaxResult100\",\ + \"documentation\":\"The maximum number of results to return per page.
\",\ + \"box\":true\ + },\ + \"SearchFilter\":{\ + \"shape\":\"ContactFlowSearchFilter\",\ + \"documentation\":\"Filters to be applied to search results.
\"\ + },\ + \"SearchCriteria\":{\ + \"shape\":\"ContactFlowSearchCriteria\",\ + \"documentation\":\"The search criteria to be used to return flows.
The name and description fields support \\\"contains\\\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
Information about the contact flows.
\"\ + },\ + \"NextToken\":{\ + \"shape\":\"NextToken2500\",\ + \"documentation\":\"If there are additional results, this is the token for the next set of results.
\"\ + },\ + \"ApproximateTotalCount\":{\ + \"shape\":\"ApproximateTotalCount\",\ + \"documentation\":\"The total number of contact flows which matched your search query.
\"\ + }\ + }\ + },\ \"SearchContactsMatchType\":{\ \"type\":\"string\",\ \"enum\":[\ @@ -18182,6 +19194,90 @@ - (NSString *)definitionString { \"CASES\"\ ]\ },\ + \"StartAttachedFileUploadRequest\":{\ + \"type\":\"structure\",\ + \"required\":[\ + \"InstanceId\",\ + \"FileName\",\ + \"FileSizeInBytes\",\ + \"FileUseCaseType\",\ + \"AssociatedResourceArn\"\ + ],\ + \"members\":{\ + \"ClientToken\":{\ + \"shape\":\"ClientToken\",\ + \"documentation\":\"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
\",\ + \"idempotencyToken\":true\ + },\ + \"InstanceId\":{\ + \"shape\":\"InstanceId\",\ + \"documentation\":\"The unique identifier of the Connect instance.
\",\ + \"location\":\"uri\",\ + \"locationName\":\"InstanceId\"\ + },\ + \"FileName\":{\ + \"shape\":\"FileName\",\ + \"documentation\":\"A case-sensitive name of the attached file being uploaded.
\"\ + },\ + \"FileSizeInBytes\":{\ + \"shape\":\"FileSizeInBytes\",\ + \"documentation\":\"The size of the attached file in bytes.
\",\ + \"box\":true\ + },\ + \"UrlExpiryInSeconds\":{\ + \"shape\":\"URLExpiryInSeconds\",\ + \"documentation\":\"Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
\"\ + },\ + \"FileUseCaseType\":{\ + \"shape\":\"FileUseCaseType\",\ + \"documentation\":\"The use case for the file.
\"\ + },\ + \"AssociatedResourceArn\":{\ + \"shape\":\"ARN\",\ + \"documentation\":\"The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
Represents the identity that created the file.
\"\ + },\ + \"Tags\":{\ + \"shape\":\"TagMap\",\ + \"documentation\":\"The tags used to organize, track, or control access for this resource. For example, { \\\"Tags\\\": {\\\"key1\\\":\\\"value1\\\", \\\"key2\\\":\\\"value2\\\"} }.
The unique identifier of the attached file resource (ARN).
\"\ + },\ + \"FileId\":{\ + \"shape\":\"FileId\",\ + \"documentation\":\"The unique identifier of the attached file resource.
\"\ + },\ + \"CreationTime\":{\ + \"shape\":\"ISO8601Datetime\",\ + \"documentation\":\"The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
The current status of the attached file.
\"\ + },\ + \"CreatedBy\":{\ + \"shape\":\"CreatedByInfo\",\ + \"documentation\":\"Represents the identity that created the file.
\"\ + },\ + \"UploadUrlMetadata\":{\ + \"shape\":\"UploadUrlMetadata\",\ + \"documentation\":\"Information to be used while uploading the attached file.
\"\ + }\ + },\ + \"documentation\":\"Response from StartAttachedFileUpload API.\"\ + },\ \"StartChatContactRequest\":{\ \"type\":\"structure\",\ \"required\":[\ @@ -18590,6 +19686,28 @@ - (NSString *)definitionString { \"AVG\"\ ]\ },\ + \"Step\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"Expiry\":{\ + \"shape\":\"Expiry\",\ + \"documentation\":\"An object to specify the expiration of a routing step.
\"\ + },\ + \"Expression\":{\ + \"shape\":\"Expression\",\ + \"documentation\":\"A tagged union to specify expression for a routing step.
\"\ + },\ + \"Status\":{\ + \"shape\":\"RoutingCriteriaStepStatus\",\ + \"documentation\":\"Represents status of the Routing step.
\"\ + }\ + },\ + \"documentation\":\"Step signifies the criteria to be used for routing to an agent
\"\ + },\ + \"Steps\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"Step\"}\ + },\ \"StopContactRecordingRequest\":{\ \"type\":\"structure\",\ \"required\":[\ @@ -18730,6 +19848,17 @@ - (NSString *)definitionString { \"max\":200,\ \"min\":1\ },\ + \"SubmitAutoEvaluationActionDefinition\":{\ + \"type\":\"structure\",\ + \"required\":[\"EvaluationFormId\"],\ + \"members\":{\ + \"EvaluationFormId\":{\ + \"shape\":\"EvaluationFormId\",\ + \"documentation\":\"The identifier of the auto-evaluation enabled form.
\"\ + }\ + },\ + \"documentation\":\"Information about the submit automated evaluation action.
\"\ + },\ \"SubmitContactEvaluationRequest\":{\ \"type\":\"structure\",\ \"required\":[\ @@ -19511,6 +20640,11 @@ - (NSString *)definitionString { \"max\":2000,\ \"min\":1\ },\ + \"URLExpiryInSeconds\":{\ + \"type\":\"integer\",\ + \"max\":300,\ + \"min\":5\ + },\ \"Unit\":{\ \"type\":\"string\",\ \"enum\":[\ @@ -19649,7 +20783,7 @@ - (NSString *)definitionString { },\ \"Attributes\":{\ \"shape\":\"Attributes\",\ - \"documentation\":\"The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
\"\ + \"documentation\":\"The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:
Remove unnecessary attributes by setting their values to empty.
If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the Amazon Connect Administrator Guide.
This API is in preview release for Amazon Connect and is subject to change.
A list of the third-party application's metadata.
\"\ + \"documentation\":\"A list of the third-party application's metadata.
\"\ },\ \"HierarchyRestrictedResources\":{\ \"shape\":\"HierarchyRestrictedResourceList\",\ @@ -21142,7 +22276,40 @@ - (NSString *)definitionString { \"members\":{\ }\ },\ + \"UploadUrlMetadata\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"Url\":{\ + \"shape\":\"MetadataUrl\",\ + \"documentation\":\"A pre-signed S3 URL that should be used for uploading the attached file.
\"\ + },\ + \"UrlExpiry\":{\ + \"shape\":\"ISO8601Datetime\",\ + \"documentation\":\"The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
A map of headers that should be provided when uploading the attached file.
\"\ + }\ + },\ + \"documentation\":\"Fields required when uploading an attached file.
\"\ + },\ \"Url\":{\"type\":\"string\"},\ + \"UrlMetadataSignedHeaders\":{\ + \"type\":\"map\",\ + \"key\":{\"shape\":\"UrlMetadataSignedHeadersKey\"},\ + \"value\":{\"shape\":\"UrlMetadataSignedHeadersValue\"}\ + },\ + \"UrlMetadataSignedHeadersKey\":{\ + \"type\":\"string\",\ + \"max\":128,\ + \"min\":1\ + },\ + \"UrlMetadataSignedHeadersValue\":{\ + \"type\":\"string\",\ + \"max\":256,\ + \"min\":1\ + },\ \"UrlReference\":{\ \"type\":\"structure\",\ \"members\":{\ diff --git a/AWSConnect/AWSConnectService.h b/AWSConnect/AWSConnectService.h index 0d1d4e5f897..bf3f7f7ba97 100644 --- a/AWSConnect/AWSConnectService.h +++ b/AWSConnect/AWSConnectService.h @@ -575,6 +575,31 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; */ - (void)batchDisassociateAnalyticsDataSet:(AWSConnectBatchDisassociateAnalyticsDataSetRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectBatchDisassociateAnalyticsDataSetResponse * _Nullable response, NSError * _Nullable error))completionHandler; +/** +Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
+ + @param request A container for the necessary parameters to execute the BatchGetAttachedFileMetadata service method. + + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSConnectBatchGetAttachedFileMetadataResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSConnectErrorDomain` domain and the following error code: `AWSConnectErrorAccessDenied`, `AWSConnectErrorInvalidRequest`, `AWSConnectErrorInternalService`, `AWSConnectErrorResourceNotFound`, `AWSConnectErrorThrottling`. + + @see AWSConnectBatchGetAttachedFileMetadataRequest + @see AWSConnectBatchGetAttachedFileMetadataResponse + */ +- (AWSTaskAllows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
+ + @param request A container for the necessary parameters to execute the BatchGetAttachedFileMetadata service method. + @param completionHandler The completion handler to call when the load request is complete. + `response` - A response object, or `nil` if the request failed. + `error` - An error object that indicates why the request failed, or `nil` if the request was successful. On failed execution, `error` may contain an `NSError` with `AWSConnectErrorDomain` domain and the following error code: `AWSConnectErrorAccessDenied`, `AWSConnectErrorInvalidRequest`, `AWSConnectErrorInternalService`, `AWSConnectErrorResourceNotFound`, `AWSConnectErrorThrottling`. + + @see AWSConnectBatchGetAttachedFileMetadataRequest + @see AWSConnectBatchGetAttachedFileMetadataResponse + */ +- (void)batchGetAttachedFileMetadata:(AWSConnectBatchGetAttachedFileMetadataRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectBatchGetAttachedFileMetadataResponse * _Nullable response, NSError * _Nullable error))completionHandler; + /**Retrieve the flow associations for the given resources.
@@ -626,7 +651,7 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; - (void)batchPutContact:(AWSConnectBatchPutContactRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectBatchPutContactResponse * _Nullable response, NSError * _Nullable error))completionHandler; /** -Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
+Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
@param request A container for the necessary parameters to execute the ClaimPhoneNumber service method. @@ -638,7 +663,7 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; - (AWSTaskClaims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
+Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
@param request A container for the necessary parameters to execute the ClaimPhoneNumber service method. @param completionHandler The completion handler to call when the load request is complete. @@ -650,6 +675,31 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; */ - (void)claimPhoneNumber:(AWSConnectClaimPhoneNumberRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectClaimPhoneNumberResponse * _Nullable response, NSError * _Nullable error))completionHandler; +/** +Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
+ + @param request A container for the necessary parameters to execute the CompleteAttachedFileUpload service method. + + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSConnectCompleteAttachedFileUploadResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSConnectErrorDomain` domain and the following error code: `AWSConnectErrorAccessDenied`, `AWSConnectErrorInvalidRequest`, `AWSConnectErrorInternalService`, `AWSConnectErrorResourceNotFound`, `AWSConnectErrorThrottling`. + + @see AWSConnectCompleteAttachedFileUploadRequest + @see AWSConnectCompleteAttachedFileUploadResponse + */ +- (AWSTaskAllows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
+ + @param request A container for the necessary parameters to execute the CompleteAttachedFileUpload service method. + @param completionHandler The completion handler to call when the load request is complete. + `response` - A response object, or `nil` if the request failed. + `error` - An error object that indicates why the request failed, or `nil` if the request was successful. On failed execution, `error` may contain an `NSError` with `AWSConnectErrorDomain` domain and the following error code: `AWSConnectErrorAccessDenied`, `AWSConnectErrorInvalidRequest`, `AWSConnectErrorInternalService`, `AWSConnectErrorResourceNotFound`, `AWSConnectErrorThrottling`. + + @see AWSConnectCompleteAttachedFileUploadRequest + @see AWSConnectCompleteAttachedFileUploadResponse + */ +- (void)completeAttachedFileUpload:(AWSConnectCompleteAttachedFileUploadRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectCompleteAttachedFileUploadResponse * _Nullable response, NSError * _Nullable error))completionHandler; + /**This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
@@ -898,7 +948,7 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; - (void)createPredefinedAttribute:(AWSConnectCreatePredefinedAttributeRequest *)request completionHandler:(void (^ _Nullable)(NSError * _Nullable error))completionHandler; /** -Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator's Guide.
+Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
@param request A container for the necessary parameters to execute the CreatePrompt service method. @@ -910,7 +960,7 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; - (AWSTaskCreates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator's Guide.
+Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
@param request A container for the necessary parameters to execute the CreatePrompt service method. @param completionHandler The completion handler to call when the load request is complete. @@ -1272,6 +1322,31 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; */ - (void)deactivateEvaluationForm:(AWSConnectDeactivateEvaluationFormRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectDeactivateEvaluationFormResponse * _Nullable response, NSError * _Nullable error))completionHandler; +/** +Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
Deletes a contact evaluation in the specified Amazon Connect instance.
@@ -1853,7 +1928,7 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; - (void)describeContactEvaluation:(AWSConnectDescribeContactEvaluationRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectDescribeContactEvaluationResponse * _Nullable response, NSError * _Nullable error))completionHandler; /** -Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
+Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
+Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED
Describes the specified flow module.
+Describes the specified flow module.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Describes the specified flow module.
+Describes the specified flow module.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
Retrieves the contact attributes for the specified contact.
@@ -2845,7 +2945,7 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; - (void)getMetricData:(AWSConnectGetMetricDataRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectGetMetricDataResponse * _Nullable response, NSError * _Nullable error))completionHandler; /** -Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator's Guide.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator's Guide.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
+Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
@param request A container for the necessary parameters to execute the ReleasePhoneNumber service method. @@ -4156,7 +4256,7 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; - (AWSTask *)releasePhoneNumber:(AWSConnectReleasePhoneNumberRequest *)request; /** -Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
+Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
@param request A container for the necessary parameters to execute the ReleasePhoneNumber service method. @param completionHandler The completion handler to call when the load request is complete. @@ -4266,6 +4366,56 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; */ - (void)searchAvailablePhoneNumbers:(AWSConnectSearchAvailablePhoneNumbersRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectSearchAvailablePhoneNumbersResponse * _Nullable response, NSError * _Nullable error))completionHandler; +/** +Searches the flow modules in an Amazon Connect instance, with optional filtering.
+ + @param request A container for the necessary parameters to execute the SearchContactFlowModules service method. + + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSConnectSearchContactFlowModulesResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSConnectErrorDomain` domain and the following error code: `AWSConnectErrorInvalidRequest`, `AWSConnectErrorInvalidParameter`, `AWSConnectErrorResourceNotFound`, `AWSConnectErrorThrottling`, `AWSConnectErrorInternalService`. + + @see AWSConnectSearchContactFlowModulesRequest + @see AWSConnectSearchContactFlowModulesResponse + */ +- (AWSTaskSearches the flow modules in an Amazon Connect instance, with optional filtering.
+ + @param request A container for the necessary parameters to execute the SearchContactFlowModules service method. + @param completionHandler The completion handler to call when the load request is complete. + `response` - A response object, or `nil` if the request failed. + `error` - An error object that indicates why the request failed, or `nil` if the request was successful. On failed execution, `error` may contain an `NSError` with `AWSConnectErrorDomain` domain and the following error code: `AWSConnectErrorInvalidRequest`, `AWSConnectErrorInvalidParameter`, `AWSConnectErrorResourceNotFound`, `AWSConnectErrorThrottling`, `AWSConnectErrorInternalService`. + + @see AWSConnectSearchContactFlowModulesRequest + @see AWSConnectSearchContactFlowModulesResponse + */ +- (void)searchContactFlowModules:(AWSConnectSearchContactFlowModulesRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectSearchContactFlowModulesResponse * _Nullable response, NSError * _Nullable error))completionHandler; + +/** +Searches the contact flows in an Amazon Connect instance, with optional filtering.
+ + @param request A container for the necessary parameters to execute the SearchContactFlows service method. + + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSConnectSearchContactFlowsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSConnectErrorDomain` domain and the following error code: `AWSConnectErrorInvalidRequest`, `AWSConnectErrorInvalidParameter`, `AWSConnectErrorResourceNotFound`, `AWSConnectErrorThrottling`, `AWSConnectErrorInternalService`. + + @see AWSConnectSearchContactFlowsRequest + @see AWSConnectSearchContactFlowsResponse + */ +- (AWSTaskSearches the contact flows in an Amazon Connect instance, with optional filtering.
+ + @param request A container for the necessary parameters to execute the SearchContactFlows service method. + @param completionHandler The completion handler to call when the load request is complete. + `response` - A response object, or `nil` if the request failed. + `error` - An error object that indicates why the request failed, or `nil` if the request was successful. On failed execution, `error` may contain an `NSError` with `AWSConnectErrorDomain` domain and the following error code: `AWSConnectErrorInvalidRequest`, `AWSConnectErrorInvalidParameter`, `AWSConnectErrorResourceNotFound`, `AWSConnectErrorThrottling`, `AWSConnectErrorInternalService`. + + @see AWSConnectSearchContactFlowsRequest + @see AWSConnectSearchContactFlowsResponse + */ +- (void)searchContactFlows:(AWSConnectSearchContactFlowsRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectSearchContactFlowsResponse * _Nullable response, NSError * _Nullable error))completionHandler; + /**Searches contacts in an Amazon Connect instance.
@@ -4566,6 +4716,31 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; */ - (void)sendChatIntegrationEvent:(AWSConnectSendChatIntegrationEventRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectSendChatIntegrationEventResponse * _Nullable response, NSError * _Nullable error))completionHandler; +/** +Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to a Connect Case.
Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to a Connect Case.
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see Chat in the Amazon Connect Administrator Guide.
@@ -4742,7 +4917,7 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; - (void)startWebRTCContact:(AWSConnectStartWebRTCContactRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectStartWebRTCContactResponse * _Nullable response, NSError * _Nullable error))completionHandler; /** -Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
Chat and task contacts can be terminated in any state, regardless of initiation method.
+Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
@param request A container for the necessary parameters to execute the StopContact service method. @@ -4754,7 +4929,7 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; - (AWSTaskEnds the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
Chat and task contacts can be terminated in any state, regardless of initiation method.
+Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
@param request A container for the necessary parameters to execute the StopContact service method. @param completionHandler The completion handler to call when the load request is complete. @@ -5083,7 +5258,7 @@ FOUNDATION_EXPORT NSString *const AWSConnectSDKVersion; - (void)updateContactEvaluation:(AWSConnectUpdateContactEvaluationRequest *)request completionHandler:(void (^ _Nullable)(AWSConnectUpdateContactEvaluationResponse * _Nullable response, NSError * _Nullable error))completionHandler; /** -Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
+Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
+Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Updates specified flow module for the specified Amazon Connect instance.
+Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Updates specified flow module for the specified Amazon Connect instance.
+Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
This API is in preview release for Amazon Connect and is subject to change.
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
+Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
This API is in preview release for Amazon Connect and is subject to change.
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
+Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
Use this parameter to specify a custom period of time between each rotation date. If no value is specified, the default value is 365 days.
The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter.
You can use the kms:RotationPeriodInDays condition key to further constrain the values that principals can specify in the RotationPeriodInDays parameter.
Identifies the specified symmetric encryption KMS key.
+ */ +@property (nonatomic, strong) NSString * _Nullable keyId; + /**A Boolean value that specifies whether key rotation is enabled.
*/ @property (nonatomic, strong) NSNumber * _Nullable keyRotationEnabled; +/** +The next date that KMS will automatically rotate the key material.
+ */ +@property (nonatomic, strong) NSDate * _Nullable nextRotationDate; + +/** +Identifies the date and time that an in progress on-demand rotation was initiated.
The KMS API follows an eventual consistency model due to the distributed nature of the system. As a result, there might be a slight delay between initiating on-demand key rotation and the rotation's completion. Once the on-demand rotation is complete, use ListKeyRotations to view the details of the on-demand rotation.
+ */ +@property (nonatomic, strong) NSDate * _Nullable onDemandRotationStartDate; + +/** +The number of days between each automatic rotation. The default value is 365 days.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable rotationPeriodInDays; + @end /** @@ -1520,12 +1559,12 @@ typedef NS_ENUM(NSInteger, AWSKMSXksProxyConnectivityType) { @property (nonatomic, strong) NSString * _Nullable keyId; /** -The algorithm you will use with the RSA public key (PublicKey) in the response to protect your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.
For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material directly with the RSA public key from KMS.
The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an RSA private key, you must use an RSA_AES wrapping algorithm.
RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).
You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping algorithm.
The algorithm you will use with the asymmetric public key (PublicKey) in the response to protect your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.
For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material directly with the RSA public key from KMS. For SM2PKE wrapping algorithms, you encrypt your key material directly with the SM2 public key from KMS.
The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an RSA private key, you must use an RSA_AES wrapping algorithm, except in China Regions, where you must use the SM2PKE wrapping algorithm to import an RSA private key.
The SM2PKE wrapping algorithm is available only in China Regions. The RSA_AES_KEY_WRAP_SHA_256 and RSA_AES_KEY_WRAP_SHA_1 wrapping algorithms are not supported in China Regions.
RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).
You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping algorithm.
SM2PKE (China Regions only) — supported for wrapping RSA, ECC, and SM2 key material.
The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping algorithm to protect your key material during import.
Use the longest RSA wrapping key that is practical.
You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key.
+The type of public key to return in the response. You will use this wrapping key with the specified wrapping algorithm to protect your key material during import.
Use the longest wrapping key that is practical.
You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key.
The SM2 wrapping key spec is available only in China Regions.
*/ @property (nonatomic, assign) AWSKMSWrappingKeySpec wrappingKeySpec; @@ -1919,7 +1958,7 @@ typedef NS_ENUM(NSInteger, AWSKMSXksProxyConnectivityType) { @property (nonatomic, strong) NSString * _Nullable nextMarker; /** -A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
Gets the key rotations for the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
+ */ +@property (nonatomic, strong) NSString * _Nullable keyId; + +/** +Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable limit; + +/** +Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
A list of completed key material rotations.
+ */ +@property (nonatomic, strong) NSArrayA flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
Identifies a symmetric encryption KMS key. You cannot perform on-demand rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To perform on-demand rotation of a set of related multi-Region keys, invoke the on-demand rotation on the primary key.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
+ */ +@property (nonatomic, strong) NSString * _Nullable keyId; + +@end + +/** + + */ +@interface AWSKMSRotateKeyOnDemandResponse : AWSModel + + +/** +Identifies the symmetric encryption KMS key that you initiated on-demand rotation on.
+ */ +@property (nonatomic, strong) NSString * _Nullable keyId; + +@end + +/** +Contains information about completed key material rotations.
+ */ +@interface AWSKMSRotationsListEntry : AWSModel + + +/** +Unique identifier of the key.
+ */ +@property (nonatomic, strong) NSString * _Nullable keyId; + +/** +Date and time that the key material rotation completed. Formatted as Unix time.
+ */ +@property (nonatomic, strong) NSDate * _Nullable rotationDate; + +/** +Identifies whether the key material rotation was a scheduled automatic rotation or an on-demand rotation.
+ */ +@property (nonatomic, assign) AWSKMSRotationType rotationType; + +@end + /** */ diff --git a/AWSKMS/AWSKMSModel.m b/AWSKMS/AWSKMSModel.m index 2789858412f..dfa31f0ce52 100644 --- a/AWSKMS/AWSKMSModel.m +++ b/AWSKMS/AWSKMSModel.m @@ -983,6 +983,7 @@ + (BOOL)supportsSecureCoding { + (NSDictionary *)JSONKeyPathsByPropertyKey { return @{ @"keyId" : @"KeyId", + @"rotationPeriodInDays" : @"RotationPeriodInDays", }; } @@ -1666,10 +1667,30 @@ + (BOOL)supportsSecureCoding { + (NSDictionary *)JSONKeyPathsByPropertyKey { return @{ + @"keyId" : @"KeyId", @"keyRotationEnabled" : @"KeyRotationEnabled", + @"nextRotationDate" : @"NextRotationDate", + @"onDemandRotationStartDate" : @"OnDemandRotationStartDate", + @"rotationPeriodInDays" : @"RotationPeriodInDays", }; } ++ (NSValueTransformer *)nextRotationDateJSONTransformer { + return [AWSMTLValueTransformer reversibleTransformerWithForwardBlock:^id(NSNumber *number) { + return [NSDate dateWithTimeIntervalSince1970:[number doubleValue]]; + } reverseBlock:^id(NSDate *date) { + return [NSString stringWithFormat:@"%f", [date timeIntervalSince1970]]; + }]; +} + ++ (NSValueTransformer *)onDemandRotationStartDateJSONTransformer { + return [AWSMTLValueTransformer reversibleTransformerWithForwardBlock:^id(NSNumber *number) { + return [NSDate dateWithTimeIntervalSince1970:[number doubleValue]]; + } reverseBlock:^id(NSDate *date) { + return [NSString stringWithFormat:@"%f", [date timeIntervalSince1970]]; + }]; +} + @end @implementation AWSKMSGetParametersForImportRequest @@ -1703,6 +1724,9 @@ + (NSValueTransformer *)wrappingAlgorithmJSONTransformer { if ([value caseInsensitiveCompare:@"RSA_AES_KEY_WRAP_SHA_256"] == NSOrderedSame) { return @(AWSKMSAlgorithmSpecRsaAesKeyWrapSha256); } + if ([value caseInsensitiveCompare:@"SM2PKE"] == NSOrderedSame) { + return @(AWSKMSAlgorithmSpecSm2pke); + } return @(AWSKMSAlgorithmSpecUnknown); } reverseBlock:^NSString *(NSNumber *value) { switch ([value integerValue]) { @@ -1716,6 +1740,8 @@ + (NSValueTransformer *)wrappingAlgorithmJSONTransformer { return @"RSA_AES_KEY_WRAP_SHA_1"; case AWSKMSAlgorithmSpecRsaAesKeyWrapSha256: return @"RSA_AES_KEY_WRAP_SHA_256"; + case AWSKMSAlgorithmSpecSm2pke: + return @"SM2PKE"; default: return nil; } @@ -1733,6 +1759,9 @@ + (NSValueTransformer *)wrappingKeySpecJSONTransformer { if ([value caseInsensitiveCompare:@"RSA_4096"] == NSOrderedSame) { return @(AWSKMSWrappingKeySpecRsa4096); } + if ([value caseInsensitiveCompare:@"SM2"] == NSOrderedSame) { + return @(AWSKMSWrappingKeySpecSm2); + } return @(AWSKMSWrappingKeySpecUnknown); } reverseBlock:^NSString *(NSNumber *value) { switch ([value integerValue]) { @@ -1742,6 +1771,8 @@ + (NSValueTransformer *)wrappingKeySpecJSONTransformer { return @"RSA_3072"; case AWSKMSWrappingKeySpecRsa4096: return @"RSA_4096"; + case AWSKMSWrappingKeySpecSm2: + return @"SM2"; default: return nil; } @@ -2584,6 +2615,42 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey { @end +@implementation AWSKMSListKeyRotationsRequest + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"keyId" : @"KeyId", + @"limit" : @"Limit", + @"marker" : @"Marker", + }; +} + +@end + +@implementation AWSKMSListKeyRotationsResponse + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"nextMarker" : @"NextMarker", + @"rotations" : @"Rotations", + @"truncated" : @"Truncated", + }; +} + ++ (NSValueTransformer *)rotationsJSONTransformer { + return [NSValueTransformer awsmtl_JSONArrayTransformerWithModelClass:[AWSKMSRotationsListEntry class]]; +} + +@end + @implementation AWSKMSListKeysRequest + (BOOL)supportsSecureCoding { @@ -3023,6 +3090,79 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey { @end +@implementation AWSKMSRotateKeyOnDemandRequest + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"keyId" : @"KeyId", + }; +} + +@end + +@implementation AWSKMSRotateKeyOnDemandResponse + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"keyId" : @"KeyId", + }; +} + +@end + +@implementation AWSKMSRotationsListEntry + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"keyId" : @"KeyId", + @"rotationDate" : @"RotationDate", + @"rotationType" : @"RotationType", + }; +} + ++ (NSValueTransformer *)rotationDateJSONTransformer { + return [AWSMTLValueTransformer reversibleTransformerWithForwardBlock:^id(NSNumber *number) { + return [NSDate dateWithTimeIntervalSince1970:[number doubleValue]]; + } reverseBlock:^id(NSDate *date) { + return [NSString stringWithFormat:@"%f", [date timeIntervalSince1970]]; + }]; +} + ++ (NSValueTransformer *)rotationTypeJSONTransformer { + return [AWSMTLValueTransformer reversibleTransformerWithForwardBlock:^NSNumber *(NSString *value) { + if ([value caseInsensitiveCompare:@"AUTOMATIC"] == NSOrderedSame) { + return @(AWSKMSRotationTypeAutomatic); + } + if ([value caseInsensitiveCompare:@"ON_DEMAND"] == NSOrderedSame) { + return @(AWSKMSRotationTypeOnDemand); + } + return @(AWSKMSRotationTypeUnknown); + } reverseBlock:^NSString *(NSNumber *value) { + switch ([value integerValue]) { + case AWSKMSRotationTypeAutomatic: + return @"AUTOMATIC"; + case AWSKMSRotationTypeOnDemand: + return @"ON_DEMAND"; + default: + return nil; + } + }]; +} + +@end + @implementation AWSKMSScheduleKeyDeletionRequest + (BOOL)supportsSecureCoding { diff --git a/AWSKMS/AWSKMSResources.m b/AWSKMS/AWSKMSResources.m index 694ce47249f..1a79a897f84 100644 --- a/AWSKMS/AWSKMSResources.m +++ b/AWSKMS/AWSKMSResources.m @@ -63,6 +63,7 @@ - (NSString *)definitionString { \"endpointPrefix\":\"kms\",\ \"jsonVersion\":\"1.1\",\ \"protocol\":\"json\",\ + \"protocols\":[\"json\"],\ \"serviceAbbreviation\":\"KMS\",\ \"serviceFullName\":\"AWS Key Management Service\",\ \"serviceId\":\"KMS\",\ @@ -332,7 +333,7 @@ - (NSString *)definitionString { {\"shape\":\"KMSInvalidStateException\"},\ {\"shape\":\"UnsupportedOperationException\"}\ ],\ - \"documentation\":\"Disables automatic rotation of the key material of the specified symmetric encryption KMS key.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You can enable (EnableKeyRotation) and disable automatic rotation of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS keys varies.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:DisableKeyRotation (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ + \"documentation\":\"Disables automatic rotation of the key material of the specified symmetric encryption KMS key.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You can enable (EnableKeyRotation) and disable automatic rotation of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS keys varies.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:DisableKeyRotation (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ },\ \"DisconnectCustomKeyStore\":{\ \"name\":\"DisconnectCustomKeyStore\",\ @@ -382,7 +383,7 @@ - (NSString *)definitionString { {\"shape\":\"KMSInvalidStateException\"},\ {\"shape\":\"UnsupportedOperationException\"}\ ],\ - \"documentation\":\"Enables automatic rotation of the key material of the specified symmetric encryption KMS key.
When you enable automatic rotation of a customer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys varies.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days).
New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter.
Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:EnableKeyRotation (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ + \"documentation\":\"Enables automatic rotation of the key material of the specified symmetric encryption KMS key.
By default, when you enable automatic rotation of a customer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can use the optional RotationPeriodInDays parameter to specify a custom rotation period when you enable key rotation, or you can use RotationPeriodInDays to modify the rotation period of a key that you previously enabled automatic key rotation on.
You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation. You can use the GetKeyRotationStatus operation to identify any in progress rotations. You can use the ListKeyRotations operation to view the details of completed rotations.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You cannot enable or disable automatic rotation of Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys is managed by the Amazon Web Services service that owns the key.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days).
New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter.
Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:EnableKeyRotation (key policy)
Related operations:
You can perform on-demand (RotateKeyOnDemand) rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled.
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ },\ \"Encrypt\":{\ \"name\":\"Encrypt\",\ @@ -561,7 +562,7 @@ - (NSString *)definitionString { {\"shape\":\"KMSInvalidStateException\"},\ {\"shape\":\"UnsupportedOperationException\"}\ ],\ - \"documentation\":\"Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key.
When you enable automatic rotation for customer managed KMS keys, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key..
You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always true.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.
Pending deletion: While a KMS key is pending deletion, its key rotation status is false and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to true.
Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.
Required permissions: kms:GetKeyRotationStatus (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ + \"documentation\":\"Provides detailed information about the rotation status for a KMS key, including whether automatic rotation of the key material is enabled for the specified KMS key, the rotation period, and the next scheduled rotation date.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key..
You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always true.
You can perform on-demand (RotateKeyOnDemand) rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. You can use GetKeyRotationStatus to identify the date and time that an in progress on-demand rotation was initiated. You can use ListKeyRotations to view the details of completed rotations.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.
Pending deletion: While a KMS key is pending deletion, its key rotation status is false and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to true.
Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.
Required permissions: kms:GetKeyRotationStatus (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ },\ \"GetParametersForImport\":{\ \"name\":\"GetParametersForImport\",\ @@ -579,7 +580,7 @@ - (NSString *)definitionString { {\"shape\":\"KMSInternalException\"},\ {\"shape\":\"KMSInvalidStateException\"}\ ],\ - \"documentation\":\"Returns the public key and an import token you need to import or reimport key material for a KMS key.
By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.
Before calling GetParametersForImport, use the CreateKey operation with an Origin value of EXTERNAL to create a KMS key with no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a multi-Region key of any supported type. However, you can't import key material into a KMS key in a custom key store. You can also use GetParametersForImport to get a public key and import token to reimport the original key material into a KMS key whose key material expired or was deleted.
GetParametersForImport returns the items that you need to import your key material.
The public key (or \\\"wrapping key\\\") of an RSA key pair that KMS generates.
You will use this public key to encrypt (\\\"wrap\\\") your key material while it's in transit to KMS.
A import token that ensures that KMS can decrypt your key material and associate it with the correct KMS key.
The public key and its import token are permanently linked and must be used together. Each public key and import token set is valid for 24 hours. The expiration date and time appear in the ParametersValidTo field in the GetParametersForImport response. You cannot use an expired public key or import token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.
GetParametersForImport requires the following information:
The key ID of the KMS key for which you are importing the key material.
The key spec of the public key (\\\"wrapping key\\\") that you will use to encrypt your key material during import.
The wrapping algorithm that you will use with the public key to encrypt your key material.
You can use the same or a different public key spec and wrapping algorithm each time you import or reimport the same key material.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetParametersForImport (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ + \"documentation\":\"Returns the public key and an import token you need to import or reimport key material for a KMS key.
By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.
Before calling GetParametersForImport, use the CreateKey operation with an Origin value of EXTERNAL to create a KMS key with no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a multi-Region key of any supported type. However, you can't import key material into a KMS key in a custom key store. You can also use GetParametersForImport to get a public key and import token to reimport the original key material into a KMS key whose key material expired or was deleted.
GetParametersForImport returns the items that you need to import your key material.
The public key (or \\\"wrapping key\\\") of an asymmetric key pair that KMS generates.
You will use this public key to encrypt (\\\"wrap\\\") your key material while it's in transit to KMS.
A import token that ensures that KMS can decrypt your key material and associate it with the correct KMS key.
The public key and its import token are permanently linked and must be used together. Each public key and import token set is valid for 24 hours. The expiration date and time appear in the ParametersValidTo field in the GetParametersForImport response. You cannot use an expired public key or import token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.
GetParametersForImport requires the following information:
The key ID of the KMS key for which you are importing the key material.
The key spec of the public key (\\\"wrapping key\\\") that you will use to encrypt your key material during import.
The wrapping algorithm that you will use with the public key to encrypt your key material.
You can use the same or a different public key spec and wrapping algorithm each time you import or reimport the same key material.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetParametersForImport (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ },\ \"GetPublicKey\":{\ \"name\":\"GetPublicKey\",\ @@ -678,6 +679,24 @@ - (NSString *)definitionString { ],\ \"documentation\":\"Gets the names of the key policies that are attached to a KMS key. This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ListKeyPolicies (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ },\ + \"ListKeyRotations\":{\ + \"name\":\"ListKeyRotations\",\ + \"http\":{\ + \"method\":\"POST\",\ + \"requestUri\":\"/\"\ + },\ + \"input\":{\"shape\":\"ListKeyRotationsRequest\"},\ + \"output\":{\"shape\":\"ListKeyRotationsResponse\"},\ + \"errors\":[\ + {\"shape\":\"NotFoundException\"},\ + {\"shape\":\"InvalidArnException\"},\ + {\"shape\":\"InvalidMarkerException\"},\ + {\"shape\":\"KMSInternalException\"},\ + {\"shape\":\"KMSInvalidStateException\"},\ + {\"shape\":\"UnsupportedOperationException\"}\ + ],\ + \"documentation\":\"Returns information about all completed key material rotations for the specified KMS key.
You must specify the KMS key in all requests. You can refine the key rotations list by limiting the number of rotations returned.
For detailed information about automatic and on-demand key rotations, see Rotating KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ListKeyRotations (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ + },\ \"ListKeys\":{\ \"name\":\"ListKeys\",\ \"http\":{\ @@ -827,6 +846,27 @@ - (NSString *)definitionString { ],\ \"documentation\":\"Deletes the specified grant. You revoke a grant to terminate the permissions that the grant allows. For more information, see Retiring and revoking grants in the Key Management Service Developer Guide .
When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. For details, see Eventual consistency in the Key Management Service Developer Guide .
For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of working with grants in several programming languages, see Programming grants.
Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.
Required permissions: kms:RevokeGrant (key policy).
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ },\ + \"RotateKeyOnDemand\":{\ + \"name\":\"RotateKeyOnDemand\",\ + \"http\":{\ + \"method\":\"POST\",\ + \"requestUri\":\"/\"\ + },\ + \"input\":{\"shape\":\"RotateKeyOnDemandRequest\"},\ + \"output\":{\"shape\":\"RotateKeyOnDemandResponse\"},\ + \"errors\":[\ + {\"shape\":\"NotFoundException\"},\ + {\"shape\":\"DisabledException\"},\ + {\"shape\":\"InvalidArnException\"},\ + {\"shape\":\"DependencyTimeoutException\"},\ + {\"shape\":\"KMSInternalException\"},\ + {\"shape\":\"KMSInvalidStateException\"},\ + {\"shape\":\"UnsupportedOperationException\"},\ + {\"shape\":\"LimitExceededException\"},\ + {\"shape\":\"ConflictException\"}\ + ],\ + \"documentation\":\"Immediately initiates rotation of the key material of the specified symmetric encryption KMS key.
You can perform on-demand rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. On-demand rotations do not change existing automatic rotation schedules. For example, consider a KMS key that has automatic key rotation enabled with a rotation period of 730 days. If the key is scheduled to automatically rotate on April 14, 2024, and you perform an on-demand rotation on April 10, 2024, the key will automatically rotate, as scheduled, on April 14, 2024 and every 730 days thereafter.
You can perform on-demand key rotation a maximum of 10 times per KMS key. You can use the KMS console to view the number of remaining on-demand rotations available for a KMS key.
You can use GetKeyRotationStatus to identify any in progress on-demand rotations. You can use ListKeyRotations to identify the date that completed on-demand rotations were performed. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch.
On-demand key rotation is supported only on symmetric encryption KMS keys. You cannot perform on-demand rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To perform on-demand rotation of a set of related multi-Region keys, invoke the on-demand rotation on the primary key.
You cannot initiate on-demand rotation of Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys is managed by the Amazon Web Services service that owns the key.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:RotateKeyOnDemand (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
\"\ + },\ \"ScheduleKeyDeletion\":{\ \"name\":\"ScheduleKeyDeletion\",\ \"http\":{\ @@ -1029,7 +1069,8 @@ - (NSString *)definitionString { \"RSAES_OAEP_SHA_1\",\ \"RSAES_OAEP_SHA_256\",\ \"RSA_AES_KEY_WRAP_SHA_1\",\ - \"RSA_AES_KEY_WRAP_SHA_256\"\ + \"RSA_AES_KEY_WRAP_SHA_256\",\ + \"SM2PKE\"\ ]\ },\ \"AliasList\":{\ @@ -1157,6 +1198,14 @@ - (NSString *)definitionString { \"documentation\":\"The request was rejected because the specified CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster for an CloudHSM key store.
Specify an CloudHSM cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.
CloudHSM clusters that share a backup history have the same cluster certificate. To view the cluster certificate of an CloudHSM cluster, use the DescribeClusters operation.
\",\ \"exception\":true\ },\ + \"ConflictException\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"message\":{\"shape\":\"ErrorMessageType\"}\ + },\ + \"documentation\":\"The request was rejected because an automatic rotation of this key is currently in progress or scheduled to begin within the next 20 minutes.
\",\ + \"exception\":true\ + },\ \"ConnectCustomKeyStoreRequest\":{\ \"type\":\"structure\",\ \"required\":[\"CustomKeyStoreId\"],\ @@ -1661,7 +1710,7 @@ - (NSString *)definitionString { },\ \"Truncated\":{\ \"shape\":\"BooleanType\",\ - \"documentation\":\"A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
\"\ + },\ + \"RotationPeriodInDays\":{\ + \"shape\":\"RotationPeriodInDaysType\",\ + \"documentation\":\"Use this parameter to specify a custom period of time between each rotation date. If no value is specified, the default value is 365 days.
The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter.
You can use the kms:RotationPeriodInDays condition key to further constrain the values that principals can specify in the RotationPeriodInDays parameter.
\"\ }\ }\ },\ @@ -2180,6 +2233,22 @@ - (NSString *)definitionString { \"KeyRotationEnabled\":{\ \"shape\":\"BooleanType\",\ \"documentation\":\"
A Boolean value that specifies whether key rotation is enabled.
\"\ + },\ + \"KeyId\":{\ + \"shape\":\"KeyIdType\",\ + \"documentation\":\"Identifies the specified symmetric encryption KMS key.
\"\ + },\ + \"RotationPeriodInDays\":{\ + \"shape\":\"RotationPeriodInDaysType\",\ + \"documentation\":\"The number of days between each automatic rotation. The default value is 365 days.
\"\ + },\ + \"NextRotationDate\":{\ + \"shape\":\"DateType\",\ + \"documentation\":\"The next date that KMS will automatically rotate the key material.
\"\ + },\ + \"OnDemandRotationStartDate\":{\ + \"shape\":\"DateType\",\ + \"documentation\":\"Identifies the date and time that an in progress on-demand rotation was initiated.
The KMS API follows an eventual consistency model due to the distributed nature of the system. As a result, there might be a slight delay between initiating on-demand key rotation and the rotation's completion. Once the on-demand rotation is complete, use ListKeyRotations to view the details of the on-demand rotation.
\"\ }\ }\ },\ @@ -2197,11 +2266,11 @@ - (NSString *)definitionString { },\ \"WrappingAlgorithm\":{\ \"shape\":\"AlgorithmSpec\",\ - \"documentation\":\"The algorithm you will use with the RSA public key (PublicKey) in the response to protect your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.
For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material directly with the RSA public key from KMS.
The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an RSA private key, you must use an RSA_AES wrapping algorithm.
RSA_AES_KEY_WRAP_SHA_256 â Supported for wrapping RSA and ECC key material.
RSA_AES_KEY_WRAP_SHA_1 â Supported for wrapping RSA and ECC key material.
RSAES_OAEP_SHA_256 â Supported for all types of key material, except RSA key material (private key).
You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_OAEP_SHA_1 â Supported for all types of key material, except RSA key material (private key).
You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_PKCS1_V1_5 (Deprecated) â As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping algorithm.
The algorithm you will use with the asymmetric public key (PublicKey) in the response to protect your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.
For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material directly with the RSA public key from KMS. For SM2PKE wrapping algorithms, you encrypt your key material directly with the SM2 public key from KMS.
The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an RSA private key, you must use an RSA_AES wrapping algorithm, except in China Regions, where you must use the SM2PKE wrapping algorithm to import an RSA private key.
The SM2PKE wrapping algorithm is available only in China Regions. The RSA_AES_KEY_WRAP_SHA_256 and RSA_AES_KEY_WRAP_SHA_1 wrapping algorithms are not supported in China Regions.
RSA_AES_KEY_WRAP_SHA_256 â Supported for wrapping RSA and ECC key material.
RSA_AES_KEY_WRAP_SHA_1 â Supported for wrapping RSA and ECC key material.
RSAES_OAEP_SHA_256 â Supported for all types of key material, except RSA key material (private key).
You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_OAEP_SHA_1 â Supported for all types of key material, except RSA key material (private key).
You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_PKCS1_V1_5 (Deprecated) â As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping algorithm.
SM2PKE (China Regions only) â supported for wrapping RSA, ECC, and SM2 key material.
The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping algorithm to protect your key material during import.
Use the longest RSA wrapping key that is practical.
You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key.
\"\ + \"documentation\":\"The type of public key to return in the response. You will use this wrapping key with the specified wrapping algorithm to protect your key material during import.
Use the longest wrapping key that is practical.
You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key.
The SM2 wrapping key spec is available only in China Regions.
\"\ }\ }\ },\ @@ -2774,7 +2843,7 @@ - (NSString *)definitionString { },\ \"Truncated\":{\ \"shape\":\"BooleanType\",\ - \"documentation\":\"A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
Gets the key rotations for the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
\"\ + },\ + \"Limit\":{\ + \"shape\":\"LimitType\",\ + \"documentation\":\"Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
\"\ + },\ + \"Marker\":{\ + \"shape\":\"MarkerType\",\ + \"documentation\":\"Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
A list of completed key material rotations.
\"\ + },\ + \"NextMarker\":{\ + \"shape\":\"MarkerType\",\ + \"documentation\":\"When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
Identifies a symmetric encryption KMS key. You cannot perform on-demand rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To perform on-demand rotation of a set of related multi-Region keys, invoke the on-demand rotation on the primary key.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
\"\ + }\ + }\ + },\ + \"RotateKeyOnDemandResponse\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"KeyId\":{\ + \"shape\":\"KeyIdType\",\ + \"documentation\":\"Identifies the symmetric encryption KMS key that you initiated on-demand rotation on.
\"\ + }\ + }\ + },\ + \"RotationPeriodInDaysType\":{\ + \"type\":\"integer\",\ + \"max\":2560,\ + \"min\":90\ + },\ + \"RotationType\":{\ + \"type\":\"string\",\ + \"enum\":[\ + \"AUTOMATIC\",\ + \"ON_DEMAND\"\ + ]\ + },\ + \"RotationsList\":{\ + \"type\":\"list\",\ + \"member\":{\"shape\":\"RotationsListEntry\"}\ + },\ + \"RotationsListEntry\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"KeyId\":{\ + \"shape\":\"KeyIdType\",\ + \"documentation\":\"Unique identifier of the key.
\"\ + },\ + \"RotationDate\":{\ + \"shape\":\"DateType\",\ + \"documentation\":\"Date and time that the key material rotation completed. Formatted as Unix time.
\"\ + },\ + \"RotationType\":{\ + \"shape\":\"RotationType\",\ + \"documentation\":\"Identifies whether the key material rotation was a scheduled automatic rotation or an on-demand rotation.
\"\ + }\ + },\ + \"documentation\":\"Contains information about completed key material rotations.
\"\ + },\ \"ScheduleKeyDeletionRequest\":{\ \"type\":\"structure\",\ \"required\":[\"KeyId\"],\ @@ -3691,7 +3848,8 @@ - (NSString *)definitionString { \"enum\":[\ \"RSA_2048\",\ \"RSA_3072\",\ - \"RSA_4096\"\ + \"RSA_4096\",\ + \"SM2\"\ ]\ },\ \"XksKeyAlreadyInUseException\":{\ diff --git a/AWSKMS/AWSKMSService.h b/AWSKMS/AWSKMSService.h index d5f73bb1271..5cea6a0d38b 100644 --- a/AWSKMS/AWSKMSService.h +++ b/AWSKMS/AWSKMSService.h @@ -488,7 +488,7 @@ FOUNDATION_EXPORT NSString *const AWSKMSSDKVersion; - (void)disableKey:(AWSKMSDisableKeyRequest *)request completionHandler:(void (^ _Nullable)(NSError * _Nullable error))completionHandler; /** -Disables automatic rotation of the key material of the specified symmetric encryption KMS key.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You can enable (EnableKeyRotation) and disable automatic rotation of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS keys varies.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:DisableKeyRotation (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+Disables automatic rotation of the key material of the specified symmetric encryption KMS key.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You can enable (EnableKeyRotation) and disable automatic rotation of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS keys varies.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:DisableKeyRotation (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
@param request A container for the necessary parameters to execute the DisableKeyRotation service method. @@ -499,7 +499,7 @@ FOUNDATION_EXPORT NSString *const AWSKMSSDKVersion; - (AWSTask *)disableKeyRotation:(AWSKMSDisableKeyRotationRequest *)request; /** -Disables automatic rotation of the key material of the specified symmetric encryption KMS key.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You can enable (EnableKeyRotation) and disable automatic rotation of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS keys varies.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:DisableKeyRotation (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+Disables automatic rotation of the key material of the specified symmetric encryption KMS key.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You can enable (EnableKeyRotation) and disable automatic rotation of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS keys varies.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:DisableKeyRotation (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
@param request A container for the necessary parameters to execute the DisableKeyRotation service method. @param completionHandler The completion handler to call when the load request is complete. @@ -557,7 +557,7 @@ FOUNDATION_EXPORT NSString *const AWSKMSSDKVersion; - (void)enableKey:(AWSKMSEnableKeyRequest *)request completionHandler:(void (^ _Nullable)(NSError * _Nullable error))completionHandler; /** -Enables automatic rotation of the key material of the specified symmetric encryption KMS key.
When you enable automatic rotation of a customer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys varies.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days).
New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter.
Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:EnableKeyRotation (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+Enables automatic rotation of the key material of the specified symmetric encryption KMS key.
By default, when you enable automatic rotation of a customer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can use the optional RotationPeriodInDays parameter to specify a custom rotation period when you enable key rotation, or you can use RotationPeriodInDays to modify the rotation period of a key that you previously enabled automatic key rotation on.
You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation. You can use the GetKeyRotationStatus operation to identify any in progress rotations. You can use the ListKeyRotations operation to view the details of completed rotations.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You cannot enable or disable automatic rotation of Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys is managed by the Amazon Web Services service that owns the key.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days).
New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter.
Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:EnableKeyRotation (key policy)
Related operations:
You can perform on-demand (RotateKeyOnDemand) rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled.
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
@param request A container for the necessary parameters to execute the EnableKeyRotation service method. @@ -568,7 +568,7 @@ FOUNDATION_EXPORT NSString *const AWSKMSSDKVersion; - (AWSTask *)enableKeyRotation:(AWSKMSEnableKeyRotationRequest *)request; /** -Enables automatic rotation of the key material of the specified symmetric encryption KMS key.
When you enable automatic rotation of a customer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys varies.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days).
New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter.
Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:EnableKeyRotation (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+Enables automatic rotation of the key material of the specified symmetric encryption KMS key.
By default, when you enable automatic rotation of a customer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can use the optional RotationPeriodInDays parameter to specify a custom rotation period when you enable key rotation, or you can use RotationPeriodInDays to modify the rotation period of a key that you previously enabled automatic key rotation on.
You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation. You can use the GetKeyRotationStatus operation to identify any in progress rotations. You can use the ListKeyRotations operation to view the details of completed rotations.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You cannot enable or disable automatic rotation of Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys is managed by the Amazon Web Services service that owns the key.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days).
New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter.
Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:EnableKeyRotation (key policy)
Related operations:
You can perform on-demand (RotateKeyOnDemand) rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled.
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
@param request A container for the necessary parameters to execute the EnableKeyRotation service method. @param completionHandler The completion handler to call when the load request is complete. @@ -779,7 +779,7 @@ FOUNDATION_EXPORT NSString *const AWSKMSSDKVersion; - (void)getKeyPolicy:(AWSKMSGetKeyPolicyRequest *)request completionHandler:(void (^ _Nullable)(AWSKMSGetKeyPolicyResponse * _Nullable response, NSError * _Nullable error))completionHandler; /** -Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key.
When you enable automatic rotation for customer managed KMS keys, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key..
You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always true.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.
Pending deletion: While a KMS key is pending deletion, its key rotation status is false and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to true.
Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.
Required permissions: kms:GetKeyRotationStatus (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+Provides detailed information about the rotation status for a KMS key, including whether automatic rotation of the key material is enabled for the specified KMS key, the rotation period, and the next scheduled rotation date.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key..
You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always true.
You can perform on-demand (RotateKeyOnDemand) rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. You can use GetKeyRotationStatus to identify the date and time that an in progress on-demand rotation was initiated. You can use ListKeyRotations to view the details of completed rotations.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.
Pending deletion: While a KMS key is pending deletion, its key rotation status is false and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to true.
Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.
Required permissions: kms:GetKeyRotationStatus (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
@param request A container for the necessary parameters to execute the GetKeyRotationStatus service method. @@ -791,7 +791,7 @@ FOUNDATION_EXPORT NSString *const AWSKMSSDKVersion; - (AWSTaskGets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key.
When you enable automatic rotation for customer managed KMS keys, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key..
You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always true.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.
Pending deletion: While a KMS key is pending deletion, its key rotation status is false and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to true.
Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.
Required permissions: kms:GetKeyRotationStatus (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+Provides detailed information about the rotation status for a KMS key, including whether automatic rotation of the key material is enabled for the specified KMS key, the rotation period, and the next scheduled rotation date.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key..
You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always true.
You can perform on-demand (RotateKeyOnDemand) rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. You can use GetKeyRotationStatus to identify the date and time that an in progress on-demand rotation was initiated. You can use ListKeyRotations to view the details of completed rotations.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.
Pending deletion: While a KMS key is pending deletion, its key rotation status is false and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to true.
Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.
Required permissions: kms:GetKeyRotationStatus (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
@param request A container for the necessary parameters to execute the GetKeyRotationStatus service method. @param completionHandler The completion handler to call when the load request is complete. @@ -804,7 +804,7 @@ FOUNDATION_EXPORT NSString *const AWSKMSSDKVersion; - (void)getKeyRotationStatus:(AWSKMSGetKeyRotationStatusRequest *)request completionHandler:(void (^ _Nullable)(AWSKMSGetKeyRotationStatusResponse * _Nullable response, NSError * _Nullable error))completionHandler; /** -Returns the public key and an import token you need to import or reimport key material for a KMS key.
By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.
Before calling GetParametersForImport, use the CreateKey operation with an Origin value of EXTERNAL to create a KMS key with no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a multi-Region key of any supported type. However, you can't import key material into a KMS key in a custom key store. You can also use GetParametersForImport to get a public key and import token to reimport the original key material into a KMS key whose key material expired or was deleted.
GetParametersForImport returns the items that you need to import your key material.
The public key (or "wrapping key") of an RSA key pair that KMS generates.
You will use this public key to encrypt ("wrap") your key material while it's in transit to KMS.
A import token that ensures that KMS can decrypt your key material and associate it with the correct KMS key.
The public key and its import token are permanently linked and must be used together. Each public key and import token set is valid for 24 hours. The expiration date and time appear in the ParametersValidTo field in the GetParametersForImport response. You cannot use an expired public key or import token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.
GetParametersForImport requires the following information:
The key ID of the KMS key for which you are importing the key material.
The key spec of the public key ("wrapping key") that you will use to encrypt your key material during import.
The wrapping algorithm that you will use with the public key to encrypt your key material.
You can use the same or a different public key spec and wrapping algorithm each time you import or reimport the same key material.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetParametersForImport (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+Returns the public key and an import token you need to import or reimport key material for a KMS key.
By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.
Before calling GetParametersForImport, use the CreateKey operation with an Origin value of EXTERNAL to create a KMS key with no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a multi-Region key of any supported type. However, you can't import key material into a KMS key in a custom key store. You can also use GetParametersForImport to get a public key and import token to reimport the original key material into a KMS key whose key material expired or was deleted.
GetParametersForImport returns the items that you need to import your key material.
The public key (or "wrapping key") of an asymmetric key pair that KMS generates.
You will use this public key to encrypt ("wrap") your key material while it's in transit to KMS.
A import token that ensures that KMS can decrypt your key material and associate it with the correct KMS key.
The public key and its import token are permanently linked and must be used together. Each public key and import token set is valid for 24 hours. The expiration date and time appear in the ParametersValidTo field in the GetParametersForImport response. You cannot use an expired public key or import token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.
GetParametersForImport requires the following information:
The key ID of the KMS key for which you are importing the key material.
The key spec of the public key ("wrapping key") that you will use to encrypt your key material during import.
The wrapping algorithm that you will use with the public key to encrypt your key material.
You can use the same or a different public key spec and wrapping algorithm each time you import or reimport the same key material.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetParametersForImport (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
@param request A container for the necessary parameters to execute the GetParametersForImport service method. @@ -816,7 +816,7 @@ FOUNDATION_EXPORT NSString *const AWSKMSSDKVersion; - (AWSTaskReturns the public key and an import token you need to import or reimport key material for a KMS key.
By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.
Before calling GetParametersForImport, use the CreateKey operation with an Origin value of EXTERNAL to create a KMS key with no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a multi-Region key of any supported type. However, you can't import key material into a KMS key in a custom key store. You can also use GetParametersForImport to get a public key and import token to reimport the original key material into a KMS key whose key material expired or was deleted.
GetParametersForImport returns the items that you need to import your key material.
The public key (or "wrapping key") of an RSA key pair that KMS generates.
You will use this public key to encrypt ("wrap") your key material while it's in transit to KMS.
A import token that ensures that KMS can decrypt your key material and associate it with the correct KMS key.
The public key and its import token are permanently linked and must be used together. Each public key and import token set is valid for 24 hours. The expiration date and time appear in the ParametersValidTo field in the GetParametersForImport response. You cannot use an expired public key or import token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.
GetParametersForImport requires the following information:
The key ID of the KMS key for which you are importing the key material.
The key spec of the public key ("wrapping key") that you will use to encrypt your key material during import.
The wrapping algorithm that you will use with the public key to encrypt your key material.
You can use the same or a different public key spec and wrapping algorithm each time you import or reimport the same key material.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetParametersForImport (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+Returns the public key and an import token you need to import or reimport key material for a KMS key.
By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.
Before calling GetParametersForImport, use the CreateKey operation with an Origin value of EXTERNAL to create a KMS key with no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a multi-Region key of any supported type. However, you can't import key material into a KMS key in a custom key store. You can also use GetParametersForImport to get a public key and import token to reimport the original key material into a KMS key whose key material expired or was deleted.
GetParametersForImport returns the items that you need to import your key material.
The public key (or "wrapping key") of an asymmetric key pair that KMS generates.
You will use this public key to encrypt ("wrap") your key material while it's in transit to KMS.
A import token that ensures that KMS can decrypt your key material and associate it with the correct KMS key.
The public key and its import token are permanently linked and must be used together. Each public key and import token set is valid for 24 hours. The expiration date and time appear in the ParametersValidTo field in the GetParametersForImport response. You cannot use an expired public key or import token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.
GetParametersForImport requires the following information:
The key ID of the KMS key for which you are importing the key material.
The key spec of the public key ("wrapping key") that you will use to encrypt your key material during import.
The wrapping algorithm that you will use with the public key to encrypt your key material.
You can use the same or a different public key spec and wrapping algorithm each time you import or reimport the same key material.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetParametersForImport (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
@param request A container for the necessary parameters to execute the GetParametersForImport service method. @param completionHandler The completion handler to call when the load request is complete. @@ -953,6 +953,31 @@ FOUNDATION_EXPORT NSString *const AWSKMSSDKVersion; */ - (void)listKeyPolicies:(AWSKMSListKeyPoliciesRequest *)request completionHandler:(void (^ _Nullable)(AWSKMSListKeyPoliciesResponse * _Nullable response, NSError * _Nullable error))completionHandler; +/** +Returns information about all completed key material rotations for the specified KMS key.
You must specify the KMS key in all requests. You can refine the key rotations list by limiting the number of rotations returned.
For detailed information about automatic and on-demand key rotations, see Rotating KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ListKeyRotations (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+ + @param request A container for the necessary parameters to execute the ListKeyRotations service method. + + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSKMSListKeyRotationsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSKMSErrorDomain` domain and the following error code: `AWSKMSErrorNotFound`, `AWSKMSErrorInvalidArn`, `AWSKMSErrorInvalidMarker`, `AWSKMSErrorKMSInternal`, `AWSKMSErrorKMSInvalidState`, `AWSKMSErrorUnsupportedOperation`. + + @see AWSKMSListKeyRotationsRequest + @see AWSKMSListKeyRotationsResponse + */ +- (AWSTaskReturns information about all completed key material rotations for the specified KMS key.
You must specify the KMS key in all requests. You can refine the key rotations list by limiting the number of rotations returned.
For detailed information about automatic and on-demand key rotations, see Rotating KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ListKeyRotations (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+ + @param request A container for the necessary parameters to execute the ListKeyRotations service method. + @param completionHandler The completion handler to call when the load request is complete. + `response` - A response object, or `nil` if the request failed. + `error` - An error object that indicates why the request failed, or `nil` if the request was successful. On failed execution, `error` may contain an `NSError` with `AWSKMSErrorDomain` domain and the following error code: `AWSKMSErrorNotFound`, `AWSKMSErrorInvalidArn`, `AWSKMSErrorInvalidMarker`, `AWSKMSErrorKMSInternal`, `AWSKMSErrorKMSInvalidState`, `AWSKMSErrorUnsupportedOperation`. + + @see AWSKMSListKeyRotationsRequest + @see AWSKMSListKeyRotationsResponse + */ +- (void)listKeyRotations:(AWSKMSListKeyRotationsRequest *)request completionHandler:(void (^ _Nullable)(AWSKMSListKeyRotationsResponse * _Nullable response, NSError * _Nullable error))completionHandler; + /**Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ListKeys (IAM policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
@@ -1144,6 +1169,31 @@ FOUNDATION_EXPORT NSString *const AWSKMSSDKVersion; */ - (void)revokeGrant:(AWSKMSRevokeGrantRequest *)request completionHandler:(void (^ _Nullable)(NSError * _Nullable error))completionHandler; +/** +Immediately initiates rotation of the key material of the specified symmetric encryption KMS key.
You can perform on-demand rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. On-demand rotations do not change existing automatic rotation schedules. For example, consider a KMS key that has automatic key rotation enabled with a rotation period of 730 days. If the key is scheduled to automatically rotate on April 14, 2024, and you perform an on-demand rotation on April 10, 2024, the key will automatically rotate, as scheduled, on April 14, 2024 and every 730 days thereafter.
You can perform on-demand key rotation a maximum of 10 times per KMS key. You can use the KMS console to view the number of remaining on-demand rotations available for a KMS key.
You can use GetKeyRotationStatus to identify any in progress on-demand rotations. You can use ListKeyRotations to identify the date that completed on-demand rotations were performed. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch.
On-demand key rotation is supported only on symmetric encryption KMS keys. You cannot perform on-demand rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To perform on-demand rotation of a set of related multi-Region keys, invoke the on-demand rotation on the primary key.
You cannot initiate on-demand rotation of Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys is managed by the Amazon Web Services service that owns the key.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:RotateKeyOnDemand (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+ + @param request A container for the necessary parameters to execute the RotateKeyOnDemand service method. + + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSKMSRotateKeyOnDemandResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSKMSErrorDomain` domain and the following error code: `AWSKMSErrorNotFound`, `AWSKMSErrorDisabled`, `AWSKMSErrorInvalidArn`, `AWSKMSErrorDependencyTimeout`, `AWSKMSErrorKMSInternal`, `AWSKMSErrorKMSInvalidState`, `AWSKMSErrorUnsupportedOperation`, `AWSKMSErrorLimitExceeded`, `AWSKMSErrorConflict`. + + @see AWSKMSRotateKeyOnDemandRequest + @see AWSKMSRotateKeyOnDemandResponse + */ +- (AWSTaskImmediately initiates rotation of the key material of the specified symmetric encryption KMS key.
You can perform on-demand rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. On-demand rotations do not change existing automatic rotation schedules. For example, consider a KMS key that has automatic key rotation enabled with a rotation period of 730 days. If the key is scheduled to automatically rotate on April 14, 2024, and you perform an on-demand rotation on April 10, 2024, the key will automatically rotate, as scheduled, on April 14, 2024 and every 730 days thereafter.
You can perform on-demand key rotation a maximum of 10 times per KMS key. You can use the KMS console to view the number of remaining on-demand rotations available for a KMS key.
You can use GetKeyRotationStatus to identify any in progress on-demand rotations. You can use ListKeyRotations to identify the date that completed on-demand rotations were performed. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch.
On-demand key rotation is supported only on symmetric encryption KMS keys. You cannot perform on-demand rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To perform on-demand rotation of a set of related multi-Region keys, invoke the on-demand rotation on the primary key.
You cannot initiate on-demand rotation of Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys is managed by the Amazon Web Services service that owns the key.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:RotateKeyOnDemand (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
+ + @param request A container for the necessary parameters to execute the RotateKeyOnDemand service method. + @param completionHandler The completion handler to call when the load request is complete. + `response` - A response object, or `nil` if the request failed. + `error` - An error object that indicates why the request failed, or `nil` if the request was successful. On failed execution, `error` may contain an `NSError` with `AWSKMSErrorDomain` domain and the following error code: `AWSKMSErrorNotFound`, `AWSKMSErrorDisabled`, `AWSKMSErrorInvalidArn`, `AWSKMSErrorDependencyTimeout`, `AWSKMSErrorKMSInternal`, `AWSKMSErrorKMSInvalidState`, `AWSKMSErrorUnsupportedOperation`, `AWSKMSErrorLimitExceeded`, `AWSKMSErrorConflict`. + + @see AWSKMSRotateKeyOnDemandRequest + @see AWSKMSRotateKeyOnDemandResponse + */ +- (void)rotateKeyOnDemand:(AWSKMSRotateKeyOnDemandRequest *)request completionHandler:(void (^ _Nullable)(AWSKMSRotateKeyOnDemandResponse * _Nullable response, NSError * _Nullable error))completionHandler; + /**Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is successful, the key state of the KMS key changes to PendingDeletion and the key can't be used in any cryptographic operations. It remains in this state for the duration of the waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all KMS data associated with it, including all aliases that refer to it.
Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is a multi-Region replica key, or an asymmetric or HMAC KMS key with imported key material.) To prevent the use of a KMS key without deleting it, use DisableKey.
You can schedule the deletion of a multi-Region primary key and its replica keys at any time. However, KMS will not delete a multi-Region primary key with existing replica keys. If you schedule the deletion of a primary key with replicas, its key state changes to PendingReplicaDeletion and it cannot be replicated or used in cryptographic operations. This status can continue indefinitely. When the last of its replicas keys is deleted (not just scheduled), the key state of the primary key changes to PendingDeletion and its waiting period (PendingWindowInDays) begins. For details, see Deleting multi-Region keys in the Key Management Service Developer Guide.
When KMS deletes a KMS key from an CloudHSM key store, it makes a best effort to delete the associated key material from the associated CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. Deleting a KMS key from an external key store has no effect on the associated external key. However, for both types of custom key stores, deleting a KMS key is destructive and irreversible. You cannot decrypt ciphertext encrypted under the KMS key by using only its associated external key or CloudHSM key. Also, you cannot recreate a KMS key in an external key store by creating a new KMS key with the same key material.
For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ScheduleKeyDeletion (key policy)
Related operations
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
diff --git a/AWSKMS/AWSKMSService.m b/AWSKMS/AWSKMSService.m index 6749709203b..d7b3ac9ba01 100644 --- a/AWSKMS/AWSKMSService.m +++ b/AWSKMS/AWSKMSService.m @@ -45,6 +45,7 @@ + (void)initialize { @"CloudHsmClusterNotActiveException" : @(AWSKMSErrorCloudHsmClusterNotActive), @"CloudHsmClusterNotFoundException" : @(AWSKMSErrorCloudHsmClusterNotFound), @"CloudHsmClusterNotRelatedException" : @(AWSKMSErrorCloudHsmClusterNotRelated), + @"ConflictException" : @(AWSKMSErrorConflict), @"CustomKeyStoreHasCMKsException" : @(AWSKMSErrorCustomKeyStoreHasCMKs), @"CustomKeyStoreInvalidStateException" : @(AWSKMSErrorCustomKeyStoreInvalidState), @"CustomKeyStoreNameInUseException" : @(AWSKMSErrorCustomKeyStoreNameInUse), @@ -1049,6 +1050,29 @@ - (void)listKeyPolicies:(AWSKMSListKeyPoliciesRequest *)request }]; } +- (AWSTaskThe 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.
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 capacity mode in the Amazon DynamoDB Developer Guide.
The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
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.
*/ @@ -1506,6 +1513,11 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { */ @property (nonatomic, strong) NSString * _Nullable KMSMasterKeyId; +/** +The maximum on-demand throughput settings for the specified replica table being created. You can only modify MaxReadRequestUnits, because you can't modify MaxWriteRequestUnits for individual replica tables.
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
*/ @@ -1536,7 +1548,7 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { @property (nonatomic, strong) NSArrayControls 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.
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 capacity mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
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; /** -An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.
When you attach a resource-based policy while creating a table, the policy creation is strongly consistent.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. You can’t request an increase for this limit. For a full list of all considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.
+An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.
When you attach a resource-based policy while creating a table, the policy application is strongly consistent.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.
You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.
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.
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 capacity mode in the Amazon DynamoDB Developer Guide.
A unique string that represents the revision ID of the policy. If you are comparing revision IDs, make sure to always use string comparison logic.
This value will be empty if you make a request against a resource without a policy.
+A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
This value will be empty if you make a request against a resource without a policy.
*/ @property (nonatomic, strong) NSString * _Nullable revisionId; @@ -2360,7 +2377,7 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { /** -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.
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 capacity mode in the Amazon DynamoDB Developer Guide.
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.
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 Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.
A unique string that represents the revision ID of the policy. If you are comparing revision IDs, make sure to always use string comparison logic.
+A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
*/ @property (nonatomic, strong) NSString * _Nullable revisionId; @@ -2819,6 +2836,11 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { */ @property (nonatomic, strong) NSArrayThe maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
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.
*/ @@ -2890,6 +2912,11 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { */ @property (nonatomic, strong) NSArrayThe maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
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.
*/ @@ -2918,6 +2945,11 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { */ @property (nonatomic, strong) NSArraySets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
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.
*/ @@ -3806,6 +3838,37 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { @end +/** +Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
Overrides the on-demand throughput settings for this replica table. If you don't specify a value for this parameter, it uses the source table's on-demand throughput settings.
+ */ +@interface AWSDynamoDBOnDemandThroughputOverride : AWSModel + + +/** +Maximum number of read request units for the specified replica table.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable maxReadRequestUnits; + +@end + /**Represents a PartiQL statement that uses parameters.
Required parameters: [Statement] @@ -4065,7 +4128,7 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { @property (nonatomic, strong) NSDictionaryThe 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.
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 Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.
A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy. When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.
To conditionally put a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.
A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.
When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.
To conditionally attach a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.
An Amazon Web Services resource-based policy document in JSON format.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.
+An Amazon Web Services resource-based policy document in JSON format.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.
Within a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.
For a full list of all considerations that apply while attaching a resource-based policy, see Resource-based policy considerations.
*/ @property (nonatomic, strong) NSString * _Nullable policy; @@ -4125,7 +4188,7 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { /** -A unique string that represents the revision ID of the policy. If you are comparing revision IDs, make sure to always use string comparison logic.
+A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
*/ @property (nonatomic, strong) NSString * _Nullable revisionId; @@ -4232,7 +4295,7 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { /** -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.
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 Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.
Overrides the maximum on-demand throughput settings for the specified replica table.
+ */ +@property (nonatomic, strong) AWSDynamoDBOnDemandThroughputOverride * _Nullable onDemandThroughputOverride; + /**Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
*/ @@ -4393,6 +4461,11 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { */ @property (nonatomic, strong) NSString * _Nullable indexName; +/** +Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
+ */ +@property (nonatomic, strong) AWSDynamoDBOnDemandThroughputOverride * _Nullable onDemandThroughputOverride; + /**Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.
*/ @@ -4457,6 +4530,11 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { */ @property (nonatomic, strong) NSString * _Nullable indexName; +/** +Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
+ */ +@property (nonatomic, strong) AWSDynamoDBOnDemandThroughputOverride * _Nullable onDemandThroughputOverride; + /**If not described, uses the source table GSI's read capacity settings.
*/ @@ -4711,6 +4789,11 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { */ @property (nonatomic, strong) NSArraySets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Provisioned throughput settings for the restored table.
*/ @@ -4762,6 +4845,11 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { */ @property (nonatomic, strong) NSArraySets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Provisioned throughput settings for the restored table.
*/ @@ -4983,7 +5071,7 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { /** -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.
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 Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.
Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Read IOPs and Write IOPS on the table when the backup was created.
*/ @@ -5183,6 +5276,11 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { */ @property (nonatomic, strong) NSArraySets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
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.
*/ @@ -5266,6 +5364,11 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { */ @property (nonatomic, strong) NSArrayThe maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
*/ @@ -5662,7 +5765,7 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { /**Represents the new provisioned throughput settings to be applied to a global secondary index.
- Required parameters: [IndexName, ProvisionedThroughput] + Required parameters: [IndexName] */ @interface AWSDynamoDBUpdateGlobalSecondaryIndexAction : AWSModel @@ -5672,6 +5775,11 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { */ @property (nonatomic, strong) NSString * _Nullable indexName; +/** +Updates the maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
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.
*/ @@ -5717,7 +5825,7 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { /** -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.
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 capacity mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
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.
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 Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.
Overrides the maximum on-demand throughput for the replica table.
+ */ +@property (nonatomic, strong) AWSDynamoDBOnDemandThroughputOverride * _Nullable onDemandThroughputOverride; + /**Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
*/ @@ -5974,7 +6087,7 @@ typedef NS_ENUM(NSInteger, AWSDynamoDBTimeToLiveStatus) { @property (nonatomic, strong) NSArrayControls 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.
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 capacity mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
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.
A list of replica update actions (create, delete, or update) for the table.
For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.
BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
One or more tables specified in the BatchWriteItem request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.
The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.
BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
One or more tables specified in the BatchWriteItem request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.
Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
If local secondary indexes are specified, then the following conditions must also be met:
The local secondary indexes must have the same name.
The local secondary indexes must have the same hash key and sort key (if present).
Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
If local secondary indexes are specified, then the following conditions must also be met:
The local secondary indexes must have the same name.
The local secondary indexes must have the same hash key and sort key (if present).
Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
This operation only applies to Version 2019.11.21 (Current) of global tables.
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
Returns information about the specified global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Returns information about the specified global table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Describes Region-specific settings for a global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Describes Region-specific settings for a global table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
This operation only applies to Version 2019.11.21 (Current) of global tables.
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
Describes auto scaling settings across replicas of the global table at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
Describes auto scaling settings across replicas of the global table at once.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, you can assume the policy will start getting applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.
Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.
Lists all global tables that have a replica in the specified Region.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Lists all global tables that have a replica in the specified Region.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent .
PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId which doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.
PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.
Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent .
PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.
PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
This operation only applies to Version 2017.11.29 of global tables. If you are using global tables Version 2019.11.21 you can use UpdateTable instead.
Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
The global secondary indexes must have the same provisioned and maximum write capacity units.
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables Version 2019.11.21 you can use UpdateTable instead.
Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
The global secondary indexes must have the same provisioned and maximum write capacity units.
Updates settings for a global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Updates settings for a global table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
This operation only applies to Version 2019.11.21 (Current) of global tables.
You can only perform one of the following operations at once:
Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.
UpdateTable is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
You can only perform one of the following operations at once:
Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.
UpdateTable is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.
Updates auto scaling settings on your global tables at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
Updates auto scaling settings on your global tables at once.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
The amount of throughput consumed on each global index affected by the operation.
\"\ }\ },\ - \"documentation\":\"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.
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 capacity mode in the Amazon DynamoDB Developer Guide.
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.
\"\ + },\ + \"OnDemandThroughput\":{\ + \"shape\":\"OnDemandThroughput\",\ + \"documentation\":\"The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents a new global secondary index to be added to an existing table.
\"\ @@ -2086,6 +2091,10 @@ - (NSString *)definitionString { \"shape\":\"ProvisionedThroughputOverride\",\ \"documentation\":\"Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
\"\ },\ + \"OnDemandThroughputOverride\":{\ + \"shape\":\"OnDemandThroughputOverride\",\ + \"documentation\":\"The maximum on-demand throughput settings for the specified replica table being created. You can only modify MaxReadRequestUnits, because you can't modify MaxWriteRequestUnits for individual replica tables.
Replica-specific global secondary index settings.
\"\ @@ -2127,7 +2136,7 @@ - (NSString *)definitionString { },\ \"BillingMode\":{\ \"shape\":\"BillingMode\",\ - \"documentation\":\"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.
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 capacity mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.
When you attach a resource-based policy while creating a table, the policy creation is strongly consistent.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. You canât request an increase for this limit. For a full list of all considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.
\"\ + \"documentation\":\"An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.
When you attach a resource-based policy while creating a table, the policy application is strongly consistent.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.
You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.
Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents the input of a CreateTable operation.
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.
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 capacity mode in the Amazon DynamoDB Developer Guide.
A unique string that represents the revision ID of the policy. If you are comparing revision IDs, make sure to always use string comparison logic.
This value will be empty if you make a request against a resource without a policy.
\"\ + \"documentation\":\"A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
This value will be empty if you make a request against a resource without a policy.
\"\ }\ }\ },\ @@ -3203,7 +3216,7 @@ - (NSString *)definitionString { },\ \"ConsumedCapacity\":{\ \"shape\":\"ConsumedCapacity\",\ - \"documentation\":\"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.
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 Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.
Represents the output of a GetItem operation.
A unique string that represents the revision ID of the policy. If you are comparing revision IDs, make sure to always use string comparison logic.
\"\ + \"documentation\":\"A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
\"\ }\ }\ },\ @@ -3254,6 +3267,10 @@ - (NSString *)definitionString { \"ProvisionedThroughput\":{\ \"shape\":\"ProvisionedThroughput\",\ \"documentation\":\"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.
\"\ + },\ + \"OnDemandThroughput\":{\ + \"shape\":\"OnDemandThroughput\",\ + \"documentation\":\"The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents the properties of a global secondary index.
\"\ @@ -3312,6 +3329,10 @@ - (NSString *)definitionString { \"IndexArn\":{\ \"shape\":\"String\",\ \"documentation\":\"The Amazon Resource Name (ARN) that uniquely identifies the index.
\"\ + },\ + \"OnDemandThroughput\":{\ + \"shape\":\"OnDemandThroughput\",\ + \"documentation\":\"The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents the properties of a global secondary index.
\"\ @@ -3338,7 +3359,8 @@ - (NSString *)definitionString { \"ProvisionedThroughput\":{\ \"shape\":\"ProvisionedThroughput\",\ \"documentation\":\"Represents the provisioned throughput settings for the specified global secondary index.
\"\ - }\ + },\ + \"OnDemandThroughput\":{\"shape\":\"OnDemandThroughput\"}\ },\ \"documentation\":\"Represents the properties of a global secondary index for the table when the backup was created.
\"\ },\ @@ -4366,6 +4388,30 @@ - (NSString *)definitionString { \"type\":\"list\",\ \"member\":{\"shape\":\"NumberAttributeValue\"}\ },\ + \"OnDemandThroughput\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"MaxReadRequestUnits\":{\ + \"shape\":\"LongObject\",\ + \"documentation\":\"Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Maximum number of read request units for the specified replica table.
\"\ + }\ + },\ + \"documentation\":\"Overrides the on-demand throughput settings for this replica table. If you don't specify a value for this parameter, it uses the source table's on-demand throughput settings.
\"\ + },\ \"ParameterizedStatement\":{\ \"type\":\"structure\",\ \"required\":[\"Statement\"],\ @@ -4672,7 +4718,7 @@ - (NSString *)definitionString { },\ \"ConsumedCapacity\":{\ \"shape\":\"ConsumedCapacity\",\ - \"documentation\":\"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.
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 Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.
An Amazon Web Services resource-based policy document in JSON format.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.
\"\ + \"documentation\":\"An Amazon Web Services resource-based policy document in JSON format.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.
Within a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.
For a full list of all considerations that apply while attaching a resource-based policy, see Resource-based policy considerations.
\"\ },\ \"ExpectedRevisionId\":{\ \"shape\":\"PolicyRevisionId\",\ - \"documentation\":\"A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy. When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.
To conditionally put a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.
A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.
When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.
To conditionally attach a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.
A unique string that represents the revision ID of the policy. If you are comparing revision IDs, make sure to always use string comparison logic.
\"\ + \"documentation\":\"A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
\"\ }\ }\ },\ @@ -4819,7 +4865,7 @@ - (NSString *)definitionString { },\ \"ConsumedCapacity\":{\ \"shape\":\"ConsumedCapacity\",\ - \"documentation\":\"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.
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 Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.
Represents the output of a Query operation.
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
\"\ },\ + \"OnDemandThroughputOverride\":{\ + \"shape\":\"OnDemandThroughputOverride\",\ + \"documentation\":\"Overrides the maximum on-demand throughput settings for the specified replica table.
\"\ + },\ \"GlobalSecondaryIndexes\":{\ \"shape\":\"ReplicaGlobalSecondaryIndexDescriptionList\",\ \"documentation\":\"Replica-specific global secondary index settings.
\"\ @@ -4942,6 +4992,10 @@ - (NSString *)definitionString { \"ProvisionedThroughputOverride\":{\ \"shape\":\"ProvisionedThroughputOverride\",\ \"documentation\":\"Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.
\"\ + },\ + \"OnDemandThroughputOverride\":{\ + \"shape\":\"OnDemandThroughputOverride\",\ + \"documentation\":\"Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
\"\ }\ },\ \"documentation\":\"Represents the properties of a replica global secondary index.
\"\ @@ -4991,6 +5045,10 @@ - (NSString *)definitionString { \"ProvisionedThroughputOverride\":{\ \"shape\":\"ProvisionedThroughputOverride\",\ \"documentation\":\"If not described, uses the source table GSI's read capacity settings.
\"\ + },\ + \"OnDemandThroughputOverride\":{\ + \"shape\":\"OnDemandThroughputOverride\",\ + \"documentation\":\"Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
\"\ }\ },\ \"documentation\":\"Represents the properties of a replica global secondary index.
\"\ @@ -5302,6 +5360,7 @@ - (NSString *)definitionString { \"shape\":\"ProvisionedThroughput\",\ \"documentation\":\"Provisioned throughput settings for the restored table.
\"\ },\ + \"OnDemandThroughputOverride\":{\"shape\":\"OnDemandThroughput\"},\ \"SSESpecificationOverride\":{\ \"shape\":\"SSESpecification\",\ \"documentation\":\"The new server-side encryption settings for the restored table.
\"\ @@ -5357,6 +5416,7 @@ - (NSString *)definitionString { \"shape\":\"ProvisionedThroughput\",\ \"documentation\":\"Provisioned throughput settings for the restored table.
\"\ },\ + \"OnDemandThroughputOverride\":{\"shape\":\"OnDemandThroughput\"},\ \"SSESpecificationOverride\":{\ \"shape\":\"SSESpecification\",\ \"documentation\":\"The new server-side encryption settings for the restored table.
\"\ @@ -5604,7 +5664,7 @@ - (NSString *)definitionString { },\ \"ConsumedCapacity\":{\ \"shape\":\"ConsumedCapacity\",\ - \"documentation\":\"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.
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 Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.
Represents the output of a Scan operation.
Read IOPs and Write IOPS on the table when the backup was created.
\"\ },\ + \"OnDemandThroughput\":{\"shape\":\"OnDemandThroughput\"},\ \"ItemCount\":{\ \"shape\":\"ItemCount\",\ \"documentation\":\"Number of items in the table. Note that this is an approximate value.
\"\ @@ -5822,6 +5883,7 @@ - (NSString *)definitionString { \"documentation\":\"The billing mode for provisioning the table created as part of the import operation.
\"\ },\ \"ProvisionedThroughput\":{\"shape\":\"ProvisionedThroughput\"},\ + \"OnDemandThroughput\":{\"shape\":\"OnDemandThroughput\"},\ \"SSESpecification\":{\"shape\":\"SSESpecification\"},\ \"GlobalSecondaryIndexes\":{\ \"shape\":\"GlobalSecondaryIndexList\",\ @@ -5924,6 +5986,10 @@ - (NSString *)definitionString { \"DeletionProtectionEnabled\":{\ \"shape\":\"DeletionProtectionEnabled\",\ \"documentation\":\"Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
\"\ + },\ + \"OnDemandThroughput\":{\ + \"shape\":\"OnDemandThroughput\",\ + \"documentation\":\"The maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents the properties of a table.
\"\ @@ -6328,10 +6394,7 @@ - (NSString *)definitionString { \"UpdateExpression\":{\"type\":\"string\"},\ \"UpdateGlobalSecondaryIndexAction\":{\ \"type\":\"structure\",\ - \"required\":[\ - \"IndexName\",\ - \"ProvisionedThroughput\"\ - ],\ + \"required\":[\"IndexName\"],\ \"members\":{\ \"IndexName\":{\ \"shape\":\"IndexName\",\ @@ -6340,6 +6403,10 @@ - (NSString *)definitionString { \"ProvisionedThroughput\":{\ \"shape\":\"ProvisionedThroughput\",\ \"documentation\":\"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.
\"\ + },\ + \"OnDemandThroughput\":{\ + \"shape\":\"OnDemandThroughput\",\ + \"documentation\":\"Updates the maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents the new provisioned throughput settings to be applied to a global secondary index.
\"\ @@ -6380,7 +6447,7 @@ - (NSString *)definitionString { },\ \"GlobalTableBillingMode\":{\ \"shape\":\"BillingMode\",\ - \"documentation\":\"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.
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 capacity mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
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.
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 Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
\"\ },\ + \"OnDemandThroughputOverride\":{\ + \"shape\":\"OnDemandThroughputOverride\",\ + \"documentation\":\"Overrides the maximum on-demand throughput for the replica table.
\"\ + },\ \"GlobalSecondaryIndexes\":{\ \"shape\":\"ReplicaGlobalSecondaryIndexList\",\ \"documentation\":\"Replica-specific global secondary index settings.
\"\ @@ -6583,7 +6654,7 @@ - (NSString *)definitionString { },\ \"BillingMode\":{\ \"shape\":\"BillingMode\",\ - \"documentation\":\"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.
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 capacity mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
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.
A list of replica update actions (create, delete, or update) for the table.
For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
\"\ + },\ + \"OnDemandThroughput\":{\ + \"shape\":\"OnDemandThroughput\",\ + \"documentation\":\"Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents the input of an UpdateTable operation.
The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.
BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
One or more tables specified in the BatchWriteItem request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.
The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.
BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
One or more tables specified in the BatchWriteItem request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.
Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.
The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.
BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
One or more tables specified in the BatchWriteItem request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.
The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.
BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
One or more tables specified in the BatchWriteItem request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.
Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
If local secondary indexes are specified, then the following conditions must also be met:
The local secondary indexes must have the same name.
The local secondary indexes must have the same hash key and sort key (if present).
Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
If local secondary indexes are specified, then the following conditions must also be met:
The local secondary indexes must have the same name.
The local secondary indexes must have the same hash key and sort key (if present).
Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
If local secondary indexes are specified, then the following conditions must also be met:
The local secondary indexes must have the same name.
The local secondary indexes must have the same hash key and sort key (if present).
Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
If local secondary indexes are specified, then the following conditions must also be met:
The local secondary indexes must have the same name.
The local secondary indexes must have the same hash key and sort key (if present).
Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
This operation only applies to Version 2019.11.21 (Current) of global tables.
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
This operation only applies to Version 2019.11.21 (Current) of global tables.
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
Returns information about the specified global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Returns information about the specified global table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Returns information about the specified global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Returns information about the specified global table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Describes Region-specific settings for a global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Describes Region-specific settings for a global table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Describes Region-specific settings for a global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Describes Region-specific settings for a global table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
This operation only applies to Version 2019.11.21 (Current) of global tables.
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
This operation only applies to Version 2019.11.21 (Current) of global tables.
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
Describes auto scaling settings across replicas of the global table at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
Describes auto scaling settings across replicas of the global table at once.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
Describes auto scaling settings across replicas of the global table at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
Describes auto scaling settings across replicas of the global table at once.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, you can assume the policy will start getting applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.
Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.
Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, you can assume the policy will start getting applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.
Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.
Lists all global tables that have a replica in the specified Region.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Lists all global tables that have a replica in the specified Region.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Lists all global tables that have a replica in the specified Region.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Lists all global tables that have a replica in the specified Region.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent.
PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId which doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.
PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.
Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent.
PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.
PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.
Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent.
PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId which doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.
PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.
Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent.
PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.
PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
This operation only applies to Version 2017.11.29 of global tables. If you are using global tables Version 2019.11.21 you can use UpdateTable instead.
Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
The global secondary indexes must have the same provisioned and maximum write capacity units.
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables Version 2019.11.21 you can use UpdateTable instead.
Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
The global secondary indexes must have the same provisioned and maximum write capacity units.
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
This operation only applies to Version 2017.11.29 of global tables. If you are using global tables Version 2019.11.21 you can use UpdateTable instead.
Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
The global secondary indexes must have the same provisioned and maximum write capacity units.
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables Version 2019.11.21 you can use UpdateTable instead.
Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
The global secondary indexes must have the same provisioned and maximum write capacity units.
Updates settings for a global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Updates settings for a global table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Updates settings for a global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Updates settings for a global table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
This operation only applies to Version 2019.11.21 (Current) of global tables.
You can only perform one of the following operations at once:
Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.
UpdateTable is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
You can only perform one of the following operations at once:
Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.
UpdateTable is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
This operation only applies to Version 2019.11.21 (Current) of global tables.
You can only perform one of the following operations at once:
Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.
UpdateTable is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
You can only perform one of the following operations at once:
Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.
UpdateTable is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.
Updates auto scaling settings on your global tables at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
Updates auto scaling settings on your global tables at once.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
Updates auto scaling settings on your global tables at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
Updates auto scaling settings on your global tables at once.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle is stored. The object key is formated as follows: role_arn/certificate_arn.
The key of the Amazon S3 object where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: role_arn/certificate_arn.
The ID of the KMS customer master key (CMK) used to encrypt the private key.
+The ID of the KMS key used to encrypt the private key.
*/ @property (nonatomic, strong) NSString * _Nullable encryptionKmsKeyId; @@ -8811,7 +8837,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) NSNumber * _Nullable dryRun; /** -The IDs of the Spot Fleet requests.
+The IDs of the Spot Fleet requests.
Constraint: You can specify up to 100 IDs in a single request.
*/ @property (nonatomic, strong) NSArrayFor devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
+For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.
Default: 65000
Valid values: 1 to 2,147,483,647
For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.
Valid values: 2,147,483,648 to 4,294,967,295
The Amazon Resource Name (ARN) for the customer gateway certificate.
*/ @@ -11175,7 +11206,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) NSNumber * _Nullable dryRun; /** -IPv4 address for the customer gateway device's outside interface. The address must be static.
+IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
+The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
*/ @property (nonatomic, strong) NSString * _Nullable errorCode; /** -The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
+The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
*/ @property (nonatomic, strong) NSString * _Nullable errorMessage; @@ -12221,7 +12252,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) NSString * _Nullable launchTemplateName; /** -The tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template.
To specify the tags for the resources that are created when an instance is launched, you must use the TagSpecifications parameter in the launch template data structure.
The tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template.
To specify the tags for the resources that are created when an instance is launched, you must use the TagSpecifications parameter in the launch template data structure.
The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateId; /** -The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateName; @@ -12287,7 +12318,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) NSNumber * _Nullable resolveAlias; /** -The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.
The version of the launch template on which to base the new version. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.
If you specify this parameter, the new version inherits the launch parameters from the source version. If you specify additional launch parameters for the new version, they overwrite any corresponding launch parameters inherited from the source version.
If you omit this parameter, the new version contains only the launch parameters that you specify for the new version.
*/ @property (nonatomic, strong) NSString * _Nullable sourceVersion; @@ -15602,10 +15633,15 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { /** -The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Valid values: 1 to 2,147,483,647
The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Valid values: 2,147,483,648 to 4,294,967,295
The Amazon Resource Name (ARN) for the customer gateway certificate.
*/ @@ -15622,7 +15658,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) NSString * _Nullable deviceName; /** -The IP address of the customer gateway device's outside interface.
+ IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
The IDs of the EC2 Fleets.
+The IDs of the EC2 Fleets.
Constraints: In a single request, you can specify up to 25 instant fleet IDs and up to 100 maintain or request fleet IDs.
The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateId; /** -The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateName; @@ -16432,12 +16468,12 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) NSNumber * _Nullable dryRun; /** -The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateId; /** -The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateName; @@ -20975,12 +21011,12 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) NSNumber * _Nullable dryRun; /** -One or more filters. Filter names and values are case-sensitive.
location - This depends on the location type. For example, if the location type is region (default), the location is the Region code (for example, us-east-2.)
instance-type - The instance type. For example, c5.2xlarge.
One or more filters. Filter names and values are case-sensitive.
instance-type - The instance type. For a list of possible values, see Instance.
location - The location. For a list of possible identifiers, see Regions and Zones.
The location type.
+The location type.
availability-zone - The Availability Zone. When you specify a location filter, it must be an Availability Zone for the current Region.
availability-zone-id - The AZ ID. When you specify a location filter, it must be an AZ ID for the current Region.
outpost - The Outpost ARN. When you specify a location filter, it must be an Outpost ARN for the current Region.
region - The current Region. If you specify a location filter, it must match the current Region.
The instance types offered.
+The instance types offered in the location.
*/ @property (nonatomic, strong) NSArrayThe instance types. For more information, see Instance types in the Amazon EC2 User Guide.
+The instance types.
*/ @property (nonatomic, strong) NSArrayThe instance type. For more information, see Instance types in the Amazon EC2 User Guide.
+The instance type.
*/ @property (nonatomic, strong) NSArrayThe ID of the launch template.
To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
+The ID of the launch template.
To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateId; /** -The name of the launch template.
To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
+The name of the launch template.
To describe one or more versions of a specified launch template, you must specify either the launch template name or the launch template ID, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateName; @@ -22563,6 +22599,11 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @interface AWSEC2DescribeNetworkInterfaceAttributeResult : AWSModel +/** +Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
+ */ +@property (nonatomic, strong) NSNumber * _Nullable associatePublicIpAddress; + /**The attachment (if any) of the network interface.
*/ @@ -22676,7 +22717,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { /** -Information about one or more network interfaces.
+Information about the network interfaces.
*/ @property (nonatomic, strong) NSArrayThe filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type. For a list of possible values, see TagSpecification.
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.
One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.
tag-key - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the AMI.
+ */ +@property (nonatomic, strong) NSString * _Nullable imageId; + +@end + +/** + + */ +@interface AWSEC2DisableImageDeregistrationProtectionResult : AWSModel + + +/** +Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the AMI.
+ */ +@property (nonatomic, strong) NSString * _Nullable imageId; + +/** +If true, enforces deregistration protection for 24 hours after deregistration protection is disabled.
Returns true if the request succeeds; otherwise, it returns an error.
Specify this parameter to verify whether the request will succeed, without actually making the request. If the request will succeed, the response is DryRunOperation. Otherwise, the response is UnauthorizedOperation.
The ID of the instance for which to get the public endorsement key.
+ */ +@property (nonatomic, strong) NSString * _Nullable instanceId; + +/** +The required public endorsement key format. Specify der for a DER-encoded public key that is compatible with OpenSSL. Specify tpmt for a TPM 2.0 format that is compatible with tpm2-tools. The returned key is base64 encoded.
The required public endorsement key type.
+ */ +@property (nonatomic, assign) AWSEC2EkPubKeyType keyType; + +@end + +/** + + */ +@interface AWSEC2GetInstanceTpmEkPubResult : AWSModel + + +/** +The ID of the instance.
+ */ +@property (nonatomic, strong) NSString * _Nullable instanceId; + +/** +The public endorsement key format.
+ */ +@property (nonatomic, assign) AWSEC2EkPubKeyFormat keyFormat; + +/** +The public endorsement key type.
+ */ +@property (nonatomic, assign) AWSEC2EkPubKeyType keyType; + +/** +The public endorsement key material.
+ */ +@property (nonatomic, strong) NSString * _Nullable keyValue; + +@end + /** */ @@ -33411,6 +33575,11 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { */ @property (nonatomic, strong) NSString * _Nullable deprecationTime; +/** +Indicates whether deregistration protection is enabled for the AMI.
+ */ +@property (nonatomic, strong) NSString * _Nullable deregistrationProtection; + /**The description of the AMI that was provided during image creation.
*/ @@ -33456,6 +33625,11 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { */ @property (nonatomic, strong) NSString * _Nullable kernelId; +/** +The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.
lastLaunchedTime data is available starting April 2017.
The name of the AMI that was provided during image creation.
*/ @@ -33559,6 +33733,11 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { */ @property (nonatomic, strong) AWSEC2AttributeValue * _Nullable bootMode; +/** +Indicates whether deregistration protection is enabled for the AMI.
+ */ +@property (nonatomic, strong) AWSEC2AttributeValue * _Nullable deregistrationProtection; + /**A description for the AMI.
*/ @@ -36474,6 +36653,11 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { */ @property (nonatomic, assign) AWSEC2NitroTpmSupport nitroTpmSupport; +/** +Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported.
+ */ +@property (nonatomic, assign) AWSEC2PhcSupport phcSupport; + /**Describes the placement group settings for the instance type.
*/ @@ -38816,7 +39000,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) NSString * _Nullable detail; /** -The device index for the network interface attachment.
+The device index for the network interface attachment. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.
*/ @property (nonatomic, strong) NSNumber * _Nullable deviceIndex; @@ -39124,23 +39308,23 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @end /** -The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.
+Describes the launch template to use.
*/ @interface AWSEC2LaunchTemplateSpecification : AWSModel /** -The ID of the launch template.
You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateId; /** -The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateName; /** -The launch template version number, $Latest, or $Default.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
Default: The default version of the launch template.
+The launch template version number, $Latest, or $Default.
A value of $Latest uses the latest version of the launch template.
A value of $Default uses the default version of the launch template.
Default: The default version of the launch template.
*/ @property (nonatomic, strong) NSString * _Nullable version; @@ -41194,7 +41378,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, assign) AWSEC2DefaultInstanceMetadataEndpointState httpEndpoint; /** -The maximum number of hops that the metadata token can travel.
Minimum: 1
Maximum: 64
The maximum number of hops that the metadata token can travel. To indicate no preference, specify -1.
Possible values: Integers from 1 to 64, and -1 to indicate no preference
The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateId; /** -The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
*/ @property (nonatomic, strong) NSString * _Nullable launchTemplateName; @@ -41765,6 +41949,11 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @interface AWSEC2ModifyNetworkInterfaceAttributeRequest : AWSRequest +/** +Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
+ */ +@property (nonatomic, strong) NSNumber * _Nullable associatePublicIpAddress; + /**Information about the interface attachment. If modifying the delete on termination attribute, you must specify the ID of the interface attachment.
One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
+The network interfaces for the instance.
*/ @property (nonatomic, strong) NSArrayOne or more security group IDs. You can create a security group using CreateSecurityGroup.
+The IDs of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
*/ @property (nonatomic, strong) NSArrayOne or more security group names. For a nondefault VPC, you must use security group IDs instead.
+The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
*/ @property (nonatomic, strong) NSArrayDeprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
An elastic GPU to associate with the instance.
Amazon Elastic Graphics reached end of life on January 8, 2024.
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
An elastic inference accelerator to associate with the instance.
Amazon Elastic Inference (EI) is no longer available to new customers. For more information, see Amazon Elastic Inference FAQs.
The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
+The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.
*/ @property (nonatomic, strong) AWSEC2LaunchTemplateSpecification * _Nullable launchTemplate; @@ -50089,7 +50278,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) AWSEC2RunInstancesMonitoringEnabled * _Nullable monitoring; /** -The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
+The network interfaces to associate with the instance.
*/ @property (nonatomic, strong) NSArrayThe IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
+The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
*/ @property (nonatomic, strong) NSArray[Default VPC] The names of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
+[Default VPC] The names of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
Default: Amazon EC2 uses the default security group.
*/ @property (nonatomic, strong) NSArrayThe ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
+The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.
*/ @property (nonatomic, strong) NSString * _Nullable subnetId; @@ -50872,7 +51061,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) NSArrayThe maximum number of routes to return.
+The maximum number of routes to return. If a value is not provided, the default is 1000.
*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; @@ -51949,7 +52138,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) AWSEC2SpotFleetMonitoring * _Nullable monitoring; /** -One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
The network interfaces.
SpotFleetLaunchSpecification does not support Elastic Fabric Adapter (EFA). You must use LaunchTemplateConfig instead.
The security groups.
+The security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
*/ @property (nonatomic, strong) NSArrayThe IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
+The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.
*/ @property (nonatomic, strong) NSString * _Nullable subnetId; @@ -56710,7 +56899,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { /** -Information about the volume attachments.
+This parameter is not returned by CreateVolume.
Information about the volume attachments.
*/ @property (nonatomic, strong) NSArrayIndicates whether the volume was created using fast snapshot restore.
+This parameter is not returned by CreateVolume.
Indicates whether the volume was created using fast snapshot restore.
*/ @property (nonatomic, strong) NSNumber * _Nullable fastRestored; @@ -56765,7 +56954,7 @@ typedef NS_ENUM(NSInteger, AWSEC2scope) { @property (nonatomic, strong) NSString * _Nullable snapshotId; /** -Reserved for future use.
+This parameter is not returned by CreateVolume.
Reserved for future use.
*/ @property (nonatomic, assign) AWSEC2SSEType sseType; diff --git a/AWSEC2/AWSEC2Model.m b/AWSEC2/AWSEC2Model.m index 7df709ff9b2..59eaef0c3d8 100644 --- a/AWSEC2/AWSEC2Model.m +++ b/AWSEC2/AWSEC2Model.m @@ -6458,6 +6458,7 @@ + (BOOL)supportsSecureCoding { + (NSDictionary *)JSONKeyPathsByPropertyKey { return @{ @"bgpAsn" : @"BgpAsn", + @"bgpAsnExtended" : @"BgpAsnExtended", @"certificateArn" : @"CertificateArn", @"deviceName" : @"DeviceName", @"dryRun" : @"DryRun", @@ -14978,6 +14979,7 @@ + (BOOL)supportsSecureCoding { + (NSDictionary *)JSONKeyPathsByPropertyKey { return @{ @"bgpAsn" : @"BgpAsn", + @"bgpAsnExtended" : @"BgpAsnExtended", @"certificateArn" : @"CertificateArn", @"customerGatewayId" : @"CustomerGatewayId", @"deviceName" : @"DeviceName", @@ -23845,6 +23847,9 @@ + (NSValueTransformer *)attributeJSONTransformer { if ([value caseInsensitiveCompare:@"imdsSupport"] == NSOrderedSame) { return @(AWSEC2ImageAttributeNameImdsSupport); } + if ([value caseInsensitiveCompare:@"deregistrationProtection"] == NSOrderedSame) { + return @(AWSEC2ImageAttributeNameDeregistrationProtection); + } return @(AWSEC2ImageAttributeNameUnknown); } reverseBlock:^NSString *(NSNumber *value) { switch ([value integerValue]) { @@ -23872,6 +23877,8 @@ + (NSValueTransformer *)attributeJSONTransformer { return @"lastLaunchedTime"; case AWSEC2ImageAttributeNameImdsSupport: return @"imdsSupport"; + case AWSEC2ImageAttributeNameDeregistrationProtection: + return @"deregistrationProtection"; default: return nil; } @@ -25678,6 +25685,9 @@ + (NSValueTransformer *)attributeJSONTransformer { if ([value caseInsensitiveCompare:@"attachment"] == NSOrderedSame) { return @(AWSEC2NetworkInterfaceAttributeAttachment); } + if ([value caseInsensitiveCompare:@"associatePublicIpAddress"] == NSOrderedSame) { + return @(AWSEC2NetworkInterfaceAttributeAssociatePublicIpAddress); + } return @(AWSEC2NetworkInterfaceAttributeUnknown); } reverseBlock:^NSString *(NSNumber *value) { switch ([value integerValue]) { @@ -25689,6 +25699,8 @@ + (NSValueTransformer *)attributeJSONTransformer { return @"sourceDestCheck"; case AWSEC2NetworkInterfaceAttributeAttachment: return @"attachment"; + case AWSEC2NetworkInterfaceAttributeAssociatePublicIpAddress: + return @"associatePublicIpAddress"; default: return nil; } @@ -25705,6 +25717,7 @@ + (BOOL)supportsSecureCoding { + (NSDictionary *)JSONKeyPathsByPropertyKey { return @{ + @"associatePublicIpAddress" : @"AssociatePublicIpAddress", @"attachment" : @"Attachment", @"detail" : @"Description", @"groups" : @"Groups", @@ -33560,6 +33573,35 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey { @end +@implementation AWSEC2DisableImageDeregistrationProtectionRequest + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"dryRun" : @"DryRun", + @"imageId" : @"ImageId", + }; +} + +@end + +@implementation AWSEC2DisableImageDeregistrationProtectionResult + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"returned" : @"Return", + }; +} + +@end + @implementation AWSEC2DisableImageRequest + (BOOL)supportsSecureCoding { @@ -35707,6 +35749,36 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey { @end +@implementation AWSEC2EnableImageDeregistrationProtectionRequest + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"dryRun" : @"DryRun", + @"imageId" : @"ImageId", + @"withCooldown" : @"WithCooldown", + }; +} + +@end + +@implementation AWSEC2EnableImageDeregistrationProtectionResult + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"returned" : @"Return", + }; +} + +@end + @implementation AWSEC2EnableImageRequest + (BOOL)supportsSecureCoding { @@ -50458,6 +50530,124 @@ + (NSValueTransformer *)accountLevelJSONTransformer { @end +@implementation AWSEC2GetInstanceTpmEkPubRequest + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"dryRun" : @"DryRun", + @"instanceId" : @"InstanceId", + @"keyFormat" : @"KeyFormat", + @"keyType" : @"KeyType", + }; +} + ++ (NSValueTransformer *)keyFormatJSONTransformer { + return [AWSMTLValueTransformer reversibleTransformerWithForwardBlock:^NSNumber *(NSString *value) { + if ([value caseInsensitiveCompare:@"der"] == NSOrderedSame) { + return @(AWSEC2EkPubKeyFormatDer); + } + if ([value caseInsensitiveCompare:@"tpmt"] == NSOrderedSame) { + return @(AWSEC2EkPubKeyFormatTpmt); + } + return @(AWSEC2EkPubKeyFormatUnknown); + } reverseBlock:^NSString *(NSNumber *value) { + switch ([value integerValue]) { + case AWSEC2EkPubKeyFormatDer: + return @"der"; + case AWSEC2EkPubKeyFormatTpmt: + return @"tpmt"; + default: + return nil; + } + }]; +} + ++ (NSValueTransformer *)keyTypeJSONTransformer { + return [AWSMTLValueTransformer reversibleTransformerWithForwardBlock:^NSNumber *(NSString *value) { + if ([value caseInsensitiveCompare:@"rsa-2048"] == NSOrderedSame) { + return @(AWSEC2EkPubKeyTypeRsa2048); + } + if ([value caseInsensitiveCompare:@"ecc-sec-p384"] == NSOrderedSame) { + return @(AWSEC2EkPubKeyTypeEccSecP384); + } + return @(AWSEC2EkPubKeyTypeUnknown); + } reverseBlock:^NSString *(NSNumber *value) { + switch ([value integerValue]) { + case AWSEC2EkPubKeyTypeRsa2048: + return @"rsa-2048"; + case AWSEC2EkPubKeyTypeEccSecP384: + return @"ecc-sec-p384"; + default: + return nil; + } + }]; +} + +@end + +@implementation AWSEC2GetInstanceTpmEkPubResult + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"instanceId" : @"InstanceId", + @"keyFormat" : @"KeyFormat", + @"keyType" : @"KeyType", + @"keyValue" : @"KeyValue", + }; +} + ++ (NSValueTransformer *)keyFormatJSONTransformer { + return [AWSMTLValueTransformer reversibleTransformerWithForwardBlock:^NSNumber *(NSString *value) { + if ([value caseInsensitiveCompare:@"der"] == NSOrderedSame) { + return @(AWSEC2EkPubKeyFormatDer); + } + if ([value caseInsensitiveCompare:@"tpmt"] == NSOrderedSame) { + return @(AWSEC2EkPubKeyFormatTpmt); + } + return @(AWSEC2EkPubKeyFormatUnknown); + } reverseBlock:^NSString *(NSNumber *value) { + switch ([value integerValue]) { + case AWSEC2EkPubKeyFormatDer: + return @"der"; + case AWSEC2EkPubKeyFormatTpmt: + return @"tpmt"; + default: + return nil; + } + }]; +} + ++ (NSValueTransformer *)keyTypeJSONTransformer { + return [AWSMTLValueTransformer reversibleTransformerWithForwardBlock:^NSNumber *(NSString *value) { + if ([value caseInsensitiveCompare:@"rsa-2048"] == NSOrderedSame) { + return @(AWSEC2EkPubKeyTypeRsa2048); + } + if ([value caseInsensitiveCompare:@"ecc-sec-p384"] == NSOrderedSame) { + return @(AWSEC2EkPubKeyTypeEccSecP384); + } + return @(AWSEC2EkPubKeyTypeUnknown); + } reverseBlock:^NSString *(NSNumber *value) { + switch ([value integerValue]) { + case AWSEC2EkPubKeyTypeRsa2048: + return @"rsa-2048"; + case AWSEC2EkPubKeyTypeEccSecP384: + return @"ecc-sec-p384"; + default: + return nil; + } + }]; +} + +@end + @implementation AWSEC2GetInstanceTypesFromInstanceRequirementsRequest + (BOOL)supportsSecureCoding { @@ -52681,6 +52871,7 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey { @"bootMode" : @"BootMode", @"creationDate" : @"CreationDate", @"deprecationTime" : @"DeprecationTime", + @"deregistrationProtection" : @"DeregistrationProtection", @"detail" : @"Description", @"enaSupport" : @"EnaSupport", @"hypervisor" : @"Hypervisor", @@ -52690,6 +52881,7 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey { @"imageType" : @"ImageType", @"imdsSupport" : @"ImdsSupport", @"kernelId" : @"KernelId", + @"lastLaunchedTime" : @"LastLaunchedTime", @"name" : @"Name", @"ownerId" : @"OwnerId", @"platform" : @"Platform", @@ -52988,6 +53180,7 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey { return @{ @"blockDeviceMappings" : @"BlockDeviceMappings", @"bootMode" : @"BootMode", + @"deregistrationProtection" : @"DeregistrationProtection", @"detail" : @"Description", @"imageId" : @"ImageId", @"imdsSupport" : @"ImdsSupport", @@ -53010,6 +53203,10 @@ + (NSValueTransformer *)bootModeJSONTransformer { return [NSValueTransformer awsmtl_JSONDictionaryTransformerWithModelClass:[AWSEC2AttributeValue class]]; } ++ (NSValueTransformer *)deregistrationProtectionJSONTransformer { + return [NSValueTransformer awsmtl_JSONDictionaryTransformerWithModelClass:[AWSEC2AttributeValue class]]; +} + + (NSValueTransformer *)detailJSONTransformer { return [NSValueTransformer awsmtl_JSONDictionaryTransformerWithModelClass:[AWSEC2AttributeValue class]]; } @@ -64424,6 +64621,7 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey { @"nitroEnclavesSupport" : @"NitroEnclavesSupport", @"nitroTpmInfo" : @"NitroTpmInfo", @"nitroTpmSupport" : @"NitroTpmSupport", + @"phcSupport" : @"PhcSupport", @"placementGroupInfo" : @"PlacementGroupInfo", @"processorInfo" : @"ProcessorInfo", @"supportedBootModes" : @"SupportedBootModes", @@ -68528,6 +68726,27 @@ + (NSValueTransformer *)nitroTpmSupportJSONTransformer { }]; } ++ (NSValueTransformer *)phcSupportJSONTransformer { + return [AWSMTLValueTransformer reversibleTransformerWithForwardBlock:^NSNumber *(NSString *value) { + if ([value caseInsensitiveCompare:@"unsupported"] == NSOrderedSame) { + return @(AWSEC2PhcSupportUnsupported); + } + if ([value caseInsensitiveCompare:@"supported"] == NSOrderedSame) { + return @(AWSEC2PhcSupportSupported); + } + return @(AWSEC2PhcSupportUnknown); + } reverseBlock:^NSString *(NSNumber *value) { + switch ([value integerValue]) { + case AWSEC2PhcSupportUnsupported: + return @"unsupported"; + case AWSEC2PhcSupportSupported: + return @"supported"; + default: + return nil; + } + }]; +} + + (NSValueTransformer *)placementGroupInfoJSONTransformer { return [NSValueTransformer awsmtl_JSONDictionaryTransformerWithModelClass:[AWSEC2PlacementGroupInfo class]]; } @@ -87843,6 +88062,7 @@ + (BOOL)supportsSecureCoding { + (NSDictionary *)JSONKeyPathsByPropertyKey { return @{ + @"associatePublicIpAddress" : @"AssociatePublicIpAddress", @"attachment" : @"Attachment", @"connectionTrackingSpecification" : @"ConnectionTrackingSpecification", @"detail" : @"Description", diff --git a/AWSEC2/AWSEC2Resources.m b/AWSEC2/AWSEC2Resources.m index 729116deadc..115de9810d2 100644 --- a/AWSEC2/AWSEC2Resources.m +++ b/AWSEC2/AWSEC2Resources.m @@ -564,7 +564,7 @@ - (NSString *)definitionString { },\ \"input\":{\"shape\":\"CancelSpotFleetRequestsRequest\"},\ \"output\":{\"shape\":\"CancelSpotFleetRequestsResponse\"},\ - \"documentation\":\"Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Restrictions
You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.
Creates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options.
The following are the individual DHCP options you can specify. For more information, see DHCP options sets in the Amazon VPC User Guide.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in any other Region, specify region.compute.internal. Otherwise, specify a custom domain name. This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name.
domain-name-servers - The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your instances receive custom DNS hostnames as specified in domain-name, you must specify a custom DNS server.
ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4 addresses and four IPv6 addresses).
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2. Broadcast and multicast are not supported. For more information about NetBIOS node types, see RFC 2132.
ipv6-preferred-lease-time - A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
Creates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options.
The following are the individual DHCP options you can specify. For more information, see DHCP options sets in the Amazon VPC User Guide.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in any other Region, specify region.compute.internal. Otherwise, specify a custom domain name. This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name.
domain-name-servers - The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your instances receive custom DNS hostnames as specified in domain-name, you must specify a custom DNS server.
ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4 addresses and four IPv6 addresses).
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2. Broadcast and multicast are not supported. For more information about NetBIOS node types, see RFC 2132.
ipv6-address-preferred-lease-time - A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
\"\ + \"documentation\":\"Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
To clone an existing launch template as the basis for a new launch template, use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
\"\ },\ \"CreateLaunchTemplateVersion\":{\ \"name\":\"CreateLaunchTemplateVersion\",\ @@ -884,7 +884,7 @@ - (NSString *)definitionString { },\ \"input\":{\"shape\":\"CreateLaunchTemplateVersionRequest\"},\ \"output\":{\"shape\":\"CreateLaunchTemplateVersionResult\"},\ - \"documentation\":\"Creates a new version of a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
Launch templates are immutable; after you create a launch template, you can't modify it. Instead, you can create a new version of the launch template that includes any changes you require.
For more information, see Modify a launch template (manage launch template versions) in the Amazon Elastic Compute Cloud User Guide.
\"\ + \"documentation\":\"Creates a new version of a launch template. You must specify an existing launch template, either by name or ID. You can determine whether the new version inherits parameters from a source version, and add or overwrite parameters as needed.
Launch template versions are numbered in the order in which they are created. You can't specify, change, or replace the numbering of launch template versions.
Launch templates are immutable; after you create a launch template, you can't modify it. Instead, you can create a new version of the launch template that includes the changes that you require.
For more information, see Modify a launch template (manage launch template versions) in the Amazon Elastic Compute Cloud User Guide.
\"\ },\ \"CreateLocalGatewayRoute\":{\ \"name\":\"CreateLocalGatewayRoute\",\ @@ -1519,7 +1519,7 @@ - (NSString *)definitionString { },\ \"input\":{\"shape\":\"DeleteFleetsRequest\"},\ \"output\":{\"shape\":\"DeleteFleetsResult\"},\ - \"documentation\":\"Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
\"\ + \"documentation\":\"Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. Up to 1000 instances can be terminated in a single request to delete instant fleets. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 fleets of type instant in a single request.
You can delete up to 100 fleets of type maintain or request in a single request.
You can delete up to 125 fleets in a single request, provided you do not exceed the quota for each fleet type, as specified above.
If you exceed the specified number of fleets to delete, no fleets are deleted.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
\"\ },\ \"DeleteFlowLogs\":{\ \"name\":\"DeleteFlowLogs\",\ @@ -2007,7 +2007,7 @@ - (NSString *)definitionString { },\ \"input\":{\"shape\":\"DeleteTransitGatewayRouteTableRequest\"},\ \"output\":{\"shape\":\"DeleteTransitGatewayRouteTableResult\"},\ - \"documentation\":\"Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
\"\ + \"documentation\":\"Deletes the specified transit gateway route table. If there are any route tables associated with the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.
\"\ },\ \"DeleteTransitGatewayRouteTableAnnouncement\":{\ \"name\":\"DeleteTransitGatewayRouteTableAnnouncement\",\ @@ -2661,7 +2661,7 @@ - (NSString *)definitionString { },\ \"input\":{\"shape\":\"DescribeImagesRequest\"},\ \"output\":{\"shape\":\"DescribeImagesResult\"},\ - \"documentation\":\"Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.
\"\ + \"documentation\":\"Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.
\"\ },\ \"DescribeInstanceTypes\":{\ \"name\":\"DescribeInstanceTypes\",\ @@ -2771,7 +2771,7 @@ - (NSString *)definitionString { },\ \"input\":{\"shape\":\"DescribeInstanceTypesRequest\"},\ \"output\":{\"shape\":\"DescribeInstanceTypesResult\"},\ - \"documentation\":\"Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types.
\"\ + \"documentation\":\"Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.
\"\ },\ \"DescribeInstances\":{\ \"name\":\"DescribeInstances\",\ @@ -2781,7 +2781,7 @@ - (NSString *)definitionString { },\ \"input\":{\"shape\":\"DescribeInstancesRequest\"},\ \"output\":{\"shape\":\"DescribeInstancesResult\"},\ - \"documentation\":\"Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes one or more of your network interfaces.
If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, private-dns-name, subnet-id, or vpc-id.
Describes one or more of your network interfaces.
If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, private-dns-name, subnet-id, or vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
\"\ + \"documentation\":\"Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
\"\ },\ + \"DisableImageDeregistrationProtection\":{\ + \"name\":\"DisableImageDeregistrationProtection\",\ + \"http\":{\ + \"method\":\"POST\",\ + \"requestUri\":\"/\"\ + },\ + \"input\":{\"shape\":\"DisableImageDeregistrationProtectionRequest\"},\ + \"output\":{\"shape\":\"DisableImageDeregistrationProtectionResult\"},\ + \"documentation\":\"Disables deregistration protection for an AMI. When deregistration protection is disabled, the AMI can be deregistered.
If you chose to include a 24-hour cooldown period when you enabled deregistration protection for the AMI, then, when you disable deregistration protection, you wonât immediately be able to deregister the AMI.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
\"\ + },\ \"DisableIpamOrganizationAdminAccount\":{\ \"name\":\"DisableIpamOrganizationAdminAccount\",\ \"http\":{\ @@ -4167,6 +4177,16 @@ - (NSString *)definitionString { \"output\":{\"shape\":\"EnableImageDeprecationResult\"},\ \"documentation\":\"Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
\"\ },\ + \"EnableImageDeregistrationProtection\":{\ + \"name\":\"EnableImageDeregistrationProtection\",\ + \"http\":{\ + \"method\":\"POST\",\ + \"requestUri\":\"/\"\ + },\ + \"input\":{\"shape\":\"EnableImageDeregistrationProtectionRequest\"},\ + \"output\":{\"shape\":\"EnableImageDeregistrationProtectionResult\"},\ + \"documentation\":\"Enables deregistration protection for an AMI. When deregistration protection is enabled, the AMI can't be deregistered.
To allow the AMI to be deregistered, you must first disable deregistration protection using DisableImageDeregistrationProtection.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
\"\ + },\ \"EnableIpamOrganizationAdminAccount\":{\ \"name\":\"EnableIpamOrganizationAdminAccount\",\ \"http\":{\ @@ -4363,7 +4383,7 @@ - (NSString *)definitionString { },\ \"input\":{\"shape\":\"GetConsoleScreenshotRequest\"},\ \"output\":{\"shape\":\"GetConsoleScreenshotResult\"},\ - \"documentation\":\"Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
\"\ + \"documentation\":\"Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
For more information, see Instance console output in the Amazon EC2 User Guide.
\"\ },\ \"GetDefaultCreditSpecification\":{\ \"name\":\"GetDefaultCreditSpecification\",\ @@ -4445,6 +4465,16 @@ - (NSString *)definitionString { \"output\":{\"shape\":\"GetInstanceMetadataDefaultsResult\"},\ \"documentation\":\"Gets the default instance metadata service (IMDS) settings that are set at the account level in the specified Amazon Web Services Region.
For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
\"\ },\ + \"GetInstanceTpmEkPub\":{\ + \"name\":\"GetInstanceTpmEkPub\",\ + \"http\":{\ + \"method\":\"POST\",\ + \"requestUri\":\"/\"\ + },\ + \"input\":{\"shape\":\"GetInstanceTpmEkPubRequest\"},\ + \"output\":{\"shape\":\"GetInstanceTpmEkPubResult\"},\ + \"documentation\":\"Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance.
\"\ + },\ \"GetInstanceTypesFromInstanceRequirements\":{\ \"name\":\"GetInstanceTypesFromInstanceRequirements\",\ \"http\":{\ @@ -5059,7 +5089,7 @@ - (NSString *)definitionString { },\ \"input\":{\"shape\":\"ModifyInstanceMetadataDefaultsRequest\"},\ \"output\":{\"shape\":\"ModifyInstanceMetadataDefaultsResult\"},\ - \"documentation\":\"Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference. At instance launch, the value will come from the AMI, or from the launch parameter if specified. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference. If an account-level setting is cleared with no-preference, then the instance launch considers the other instance metadata settings. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle is stored. The object key is formated as follows: role_arn/certificate_arn.
The key of the Amazon S3 object where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: role_arn/certificate_arn.
The ID of the KMS customer master key (CMK) used to encrypt the private key.
\",\ + \"documentation\":\"The ID of the KMS key used to encrypt the private key.
\",\ \"locationName\":\"encryptionKmsKeyId\"\ }\ },\ @@ -10009,7 +10039,7 @@ - (NSString *)definitionString { },\ \"SpotFleetRequestIds\":{\ \"shape\":\"SpotFleetRequestIdList\",\ - \"documentation\":\"The IDs of the Spot Fleet requests.
\",\ + \"documentation\":\"The IDs of the Spot Fleet requests.
Constraint: You can specify up to 100 IDs in a single request.
\",\ \"locationName\":\"spotFleetRequestId\"\ },\ \"TerminateInstances\":{\ @@ -12560,7 +12590,7 @@ - (NSString *)definitionString { \"members\":{\ \"BgpAsn\":{\ \"shape\":\"Integer\",\ - \"documentation\":\"For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
\"\ + \"documentation\":\"For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.
Default: 65000
Valid values: 1 to 2,147,483,647
IPv4 address for the customer gateway device's outside interface. The address must be static.
\"\ + \"documentation\":\"IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.
Valid values: 2,147,483,648 to 4,294,967,295
Contains the parameters for CreateCustomerGateway.
\"\ @@ -12737,12 +12771,12 @@ - (NSString *)definitionString { },\ \"ErrorCode\":{\ \"shape\":\"String\",\ - \"documentation\":\"The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
\",\ + \"documentation\":\"The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
\",\ \"locationName\":\"errorCode\"\ },\ \"ErrorMessage\":{\ \"shape\":\"String\",\ - \"documentation\":\"The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
\",\ + \"documentation\":\"The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
\",\ \"locationName\":\"errorMessage\"\ }\ },\ @@ -13490,7 +13524,7 @@ - (NSString *)definitionString { },\ \"TagSpecifications\":{\ \"shape\":\"TagSpecificationList\",\ - \"documentation\":\"The tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template.
To specify the tags for the resources that are created when an instance is launched, you must use the TagSpecifications parameter in the launch template data structure.
The tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template.
To specify the tags for the resources that are created when an instance is launched, you must use the TagSpecifications parameter in the launch template data structure.
The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
\"\ },\ \"LaunchTemplateName\":{\ \"shape\":\"LaunchTemplateName\",\ - \"documentation\":\"The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
\"\ },\ \"SourceVersion\":{\ \"shape\":\"String\",\ - \"documentation\":\"The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.
The version of the launch template on which to base the new version. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.
If you specify this parameter, the new version inherits the launch parameters from the source version. If you specify additional launch parameters for the new version, they overwrite any corresponding launch parameters inherited from the source version.
If you omit this parameter, the new version contains only the launch parameters that you specify for the new version.
\"\ },\ \"VersionDescription\":{\ \"shape\":\"VersionDescription\",\ @@ -16416,7 +16450,7 @@ - (NSString *)definitionString { \"members\":{\ \"BgpAsn\":{\ \"shape\":\"String\",\ - \"documentation\":\"The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
\",\ + \"documentation\":\"The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Valid values: 1 to 2,147,483,647
The IP address of the customer gateway device's outside interface.
\",\ + \"documentation\":\" IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
Any tags assigned to the customer gateway.
\",\ \"locationName\":\"tagSet\"\ + },\ + \"BgpAsnExtended\":{\ + \"shape\":\"String\",\ + \"documentation\":\"The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Valid values: 2,147,483,648 to 4,294,967,295
Describes a customer gateway.
\"\ @@ -16903,7 +16942,7 @@ - (NSString *)definitionString { },\ \"FleetIds\":{\ \"shape\":\"FleetIdSet\",\ - \"documentation\":\"The IDs of the EC2 Fleets.
\",\ + \"documentation\":\"The IDs of the EC2 Fleets.
Constraints: In a single request, you can specify up to 25 instant fleet IDs and up to 100 maintain or request fleet IDs.
The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
\"\ },\ \"LaunchTemplateName\":{\ \"shape\":\"LaunchTemplateName\",\ - \"documentation\":\"The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
\"\ }\ }\ },\ @@ -17218,11 +17257,11 @@ - (NSString *)definitionString { },\ \"LaunchTemplateId\":{\ \"shape\":\"LaunchTemplateId\",\ - \"documentation\":\"The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
\"\ },\ \"LaunchTemplateName\":{\ \"shape\":\"LaunchTemplateName\",\ - \"documentation\":\"The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
\"\ },\ \"Versions\":{\ \"shape\":\"VersionStringList\",\ @@ -21171,11 +21210,11 @@ - (NSString *)definitionString { },\ \"LocationType\":{\ \"shape\":\"LocationType\",\ - \"documentation\":\"The location type.
\"\ + \"documentation\":\"The location type.
availability-zone - The Availability Zone. When you specify a location filter, it must be an Availability Zone for the current Region.
availability-zone-id - The AZ ID. When you specify a location filter, it must be an AZ ID for the current Region.
outpost - The Outpost ARN. When you specify a location filter, it must be an Outpost ARN for the current Region.
region - The current Region. If you specify a location filter, it must match the current Region.
One or more filters. Filter names and values are case-sensitive.
location - This depends on the location type. For example, if the location type is region (default), the location is the Region code (for example, us-east-2.)
instance-type - The instance type. For example, c5.2xlarge.
One or more filters. Filter names and values are case-sensitive.
instance-type - The instance type. For a list of possible values, see Instance.
location - The location. For a list of possible identifiers, see Regions and Zones.
The instance types offered.
\",\ + \"documentation\":\"The instance types offered in the location.
\",\ \"locationName\":\"instanceTypeOfferingSet\"\ },\ \"NextToken\":{\ @@ -21212,7 +21251,7 @@ - (NSString *)definitionString { },\ \"InstanceTypes\":{\ \"shape\":\"RequestInstanceTypeList\",\ - \"documentation\":\"The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
\",\ + \"documentation\":\"The instance types.
\",\ \"locationName\":\"InstanceType\"\ },\ \"Filters\":{\ @@ -21235,7 +21274,7 @@ - (NSString *)definitionString { \"members\":{\ \"InstanceTypes\":{\ \"shape\":\"InstanceTypeInfoList\",\ - \"documentation\":\"The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
\",\ + \"documentation\":\"The instance type.
\",\ \"locationName\":\"instanceTypeSet\"\ },\ \"NextToken\":{\ @@ -21675,11 +21714,11 @@ - (NSString *)definitionString { },\ \"LaunchTemplateId\":{\ \"shape\":\"LaunchTemplateId\",\ - \"documentation\":\"The ID of the launch template.
To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
\"\ + \"documentation\":\"The ID of the launch template.
To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
\"\ },\ \"LaunchTemplateName\":{\ \"shape\":\"LaunchTemplateName\",\ - \"documentation\":\"The name of the launch template.
To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
\"\ + \"documentation\":\"The name of the launch template.
To describe one or more versions of a specified launch template, you must specify either the launch template name or the launch template ID, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
\"\ },\ \"Versions\":{\ \"shape\":\"VersionStringList\",\ @@ -22549,6 +22588,11 @@ - (NSString *)definitionString { \"shape\":\"AttributeBooleanValue\",\ \"documentation\":\"Indicates whether source/destination checking is enabled.
\",\ \"locationName\":\"sourceDestCheck\"\ + },\ + \"AssociatePublicIpAddress\":{\ + \"shape\":\"Boolean\",\ + \"documentation\":\"Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
\",\ + \"locationName\":\"associatePublicIpAddress\"\ }\ },\ \"documentation\":\"Contains the output of DescribeNetworkInterfaceAttribute.
\"\ @@ -22637,7 +22681,7 @@ - (NSString *)definitionString { \"members\":{\ \"NetworkInterfaces\":{\ \"shape\":\"NetworkInterfaceList\",\ - \"documentation\":\"Information about one or more network interfaces.
\",\ + \"documentation\":\"Information about the network interfaces.
\",\ \"locationName\":\"networkInterfaceSet\"\ },\ \"NextToken\":{\ @@ -23959,7 +24003,7 @@ - (NSString *)definitionString { },\ \"Filters\":{\ \"shape\":\"FilterList\",\ - \"documentation\":\"The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
tag:<key> - The key/value combination of the tag. For example, specify \\\"tag:Owner\\\" for the filter name and \\\"TeamA\\\" for the filter value to find resources with the tag \\\"Owner=TeamA\\\".
value - The tag value.
The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type. For a list of possible values, see TagSpecification.
tag:<key> - The key/value combination of the tag. For example, specify \\\"tag:Owner\\\" for the filter name and \\\"TeamA\\\" for the filter value to find resources with the tag \\\"Owner=TeamA\\\".
value - The tag value.
One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.
One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.
tag-key - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The ID of the AMI.
\"\ + },\ + \"DryRun\":{\ + \"shape\":\"Boolean\",\ + \"documentation\":\"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the AMI.
\"\ + },\ + \"WithCooldown\":{\ + \"shape\":\"Boolean\",\ + \"documentation\":\"If true, enforces deregistration protection for 24 hours after deregistration protection is disabled.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the instance for which to get the public endorsement key.
\"\ + },\ + \"KeyType\":{\ + \"shape\":\"EkPubKeyType\",\ + \"documentation\":\"The required public endorsement key type.
\"\ + },\ + \"KeyFormat\":{\ + \"shape\":\"EkPubKeyFormat\",\ + \"documentation\":\"The required public endorsement key format. Specify der for a DER-encoded public key that is compatible with OpenSSL. Specify tpmt for a TPM 2.0 format that is compatible with tpm2-tools. The returned key is base64 encoded.
Specify this parameter to verify whether the request will succeed, without actually making the request. If the request will succeed, the response is DryRunOperation. Otherwise, the response is UnauthorizedOperation.
The ID of the instance.
\",\ + \"locationName\":\"instanceId\"\ + },\ + \"KeyType\":{\ + \"shape\":\"EkPubKeyType\",\ + \"documentation\":\"The public endorsement key type.
\",\ + \"locationName\":\"keyType\"\ + },\ + \"KeyFormat\":{\ + \"shape\":\"EkPubKeyFormat\",\ + \"documentation\":\"The public endorsement key format.
\",\ + \"locationName\":\"keyFormat\"\ + },\ + \"KeyValue\":{\ + \"shape\":\"EkPubKeyValue\",\ + \"documentation\":\"The public endorsement key material.
\",\ + \"locationName\":\"keyValue\"\ + }\ + }\ + },\ \"GetInstanceTypesFromInstanceRequirementsRequest\":{\ \"type\":\"structure\",\ \"required\":[\ @@ -33092,6 +33257,16 @@ - (NSString *)definitionString { \"shape\":\"String\",\ \"documentation\":\"The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.
\",\ \"locationName\":\"sourceInstanceId\"\ + },\ + \"DeregistrationProtection\":{\ + \"shape\":\"String\",\ + \"documentation\":\"Indicates whether deregistration protection is enabled for the AMI.
\",\ + \"locationName\":\"deregistrationProtection\"\ + },\ + \"LastLaunchedTime\":{\ + \"shape\":\"String\",\ + \"documentation\":\"The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.
lastLaunchedTime data is available starting April 2017.
Describes an image.
\"\ @@ -33163,6 +33338,11 @@ - (NSString *)definitionString { \"shape\":\"AttributeValue\",\ \"documentation\":\"If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Indicates whether deregistration protection is enabled for the AMI.
\",\ + \"locationName\":\"deregistrationProtection\"\ }\ },\ \"documentation\":\"Describes an image attribute.
\"\ @@ -33181,7 +33361,8 @@ - (NSString *)definitionString { \"tpmSupport\",\ \"uefiData\",\ \"lastLaunchedTime\",\ - \"imdsSupport\"\ + \"imdsSupport\",\ + \"deregistrationProtection\"\ ]\ },\ \"ImageBlockPublicAccessDisabledState\":{\ @@ -37163,6 +37344,11 @@ - (NSString *)definitionString { \"shape\":\"NeuronInfo\",\ \"documentation\":\"Describes the Neuron accelerator settings for the instance type.
\",\ \"locationName\":\"neuronInfo\"\ + },\ + \"PhcSupport\":{\ + \"shape\":\"PhcSupport\",\ + \"documentation\":\"Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported.
\",\ + \"locationName\":\"phcSupport\"\ }\ },\ \"documentation\":\"Describes the instance type.
\"\ @@ -40056,7 +40242,7 @@ - (NSString *)definitionString { },\ \"DeviceIndex\":{\ \"shape\":\"Integer\",\ - \"documentation\":\"The device index for the network interface attachment.
\"\ + \"documentation\":\"The device index for the network interface attachment. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.
\"\ },\ \"Groups\":{\ \"shape\":\"SecurityGroupIdStringList\",\ @@ -40379,18 +40565,18 @@ - (NSString *)definitionString { \"members\":{\ \"LaunchTemplateId\":{\ \"shape\":\"LaunchTemplateId\",\ - \"documentation\":\"The ID of the launch template.
You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
\"\ },\ \"LaunchTemplateName\":{\ \"shape\":\"String\",\ - \"documentation\":\"The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
\"\ },\ \"Version\":{\ \"shape\":\"String\",\ - \"documentation\":\"The launch template version number, $Latest, or $Default.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
Default: The default version of the launch template.
\"\ + \"documentation\":\"The launch template version number, $Latest, or $Default.
A value of $Latest uses the latest version of the launch template.
A value of $Default uses the default version of the launch template.
Default: The default version of the launch template.
\"\ }\ },\ - \"documentation\":\"The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.
\"\ + \"documentation\":\"Describes the launch template to use.
\"\ },\ \"LaunchTemplateSpotMarketOptions\":{\ \"type\":\"structure\",\ @@ -42537,7 +42723,7 @@ - (NSString *)definitionString { },\ \"HttpPutResponseHopLimit\":{\ \"shape\":\"BoxedInteger\",\ - \"documentation\":\"The maximum number of hops that the metadata token can travel.
Minimum: 1
Maximum: 64
The maximum number of hops that the metadata token can travel. To indicate no preference, specify -1.
Possible values: Integers from 1 to 64, and -1 to indicate no preference
The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
\"\ },\ \"LaunchTemplateName\":{\ \"shape\":\"LaunchTemplateName\",\ - \"documentation\":\"The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
\"\ },\ \"DefaultVersion\":{\ \"shape\":\"String\",\ @@ -43047,6 +43233,10 @@ - (NSString *)definitionString { \"ConnectionTrackingSpecification\":{\ \"shape\":\"ConnectionTrackingSpecificationRequest\",\ \"documentation\":\"A connection tracking specification.
\"\ + },\ + \"AssociatePublicIpAddress\":{\ + \"shape\":\"Boolean\",\ + \"documentation\":\"Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
\"\ }\ },\ \"documentation\":\"Contains the parameters for ModifyNetworkInterfaceAttribute.
\"\ @@ -45856,7 +46046,8 @@ - (NSString *)definitionString { \"description\",\ \"groupSet\",\ \"sourceDestCheck\",\ - \"attachment\"\ + \"attachment\",\ + \"associatePublicIpAddress\"\ ]\ },\ \"NetworkInterfaceCount\":{\ @@ -47031,6 +47222,13 @@ - (NSString *)definitionString { },\ \"documentation\":\"Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.
\"\ },\ + \"PhcSupport\":{\ + \"type\":\"string\",\ + \"enum\":[\ + \"unsupported\",\ + \"supported\"\ + ]\ + },\ \"Placement\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -49502,7 +49700,7 @@ - (NSString *)definitionString { },\ \"NetworkInterfaces\":{\ \"shape\":\"LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList\",\ - \"documentation\":\"One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
\",\ + \"documentation\":\"The network interfaces for the instance.
\",\ \"locationName\":\"NetworkInterface\"\ },\ \"ImageId\":{\ @@ -49558,12 +49756,12 @@ - (NSString *)definitionString { },\ \"SecurityGroupIds\":{\ \"shape\":\"SecurityGroupIdStringList\",\ - \"documentation\":\"One or more security group IDs. You can create a security group using CreateSecurityGroup.
\",\ + \"documentation\":\"The IDs of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
\",\ \"locationName\":\"SecurityGroupId\"\ },\ \"SecurityGroups\":{\ \"shape\":\"SecurityGroupStringList\",\ - \"documentation\":\"One or more security group names. For a nondefault VPC, you must use security group IDs instead.
\",\ + \"documentation\":\"The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
\",\ \"locationName\":\"SecurityGroup\"\ },\ \"InstanceMarketOptions\":{\ @@ -51710,17 +51908,17 @@ - (NSString *)definitionString { },\ \"SecurityGroupIds\":{\ \"shape\":\"SecurityGroupIdStringList\",\ - \"documentation\":\"The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
\",\ + \"documentation\":\"The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
\",\ \"locationName\":\"SecurityGroupId\"\ },\ \"SecurityGroups\":{\ \"shape\":\"SecurityGroupStringList\",\ - \"documentation\":\"[Default VPC] The names of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
\",\ + \"documentation\":\"[Default VPC] The names of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
Default: Amazon EC2 uses the default security group.
\",\ \"locationName\":\"SecurityGroup\"\ },\ \"SubnetId\":{\ \"shape\":\"SubnetId\",\ - \"documentation\":\"The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
\"\ + \"documentation\":\"The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.
\"\ },\ \"UserData\":{\ \"shape\":\"RunInstancesUserData\",\ @@ -51764,7 +51962,7 @@ - (NSString *)definitionString { },\ \"NetworkInterfaces\":{\ \"shape\":\"InstanceNetworkInterfaceSpecificationList\",\ - \"documentation\":\"The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
\",\ + \"documentation\":\"The network interfaces to associate with the instance.
\",\ \"locationName\":\"networkInterface\"\ },\ \"PrivateIpAddress\":{\ @@ -51774,11 +51972,11 @@ - (NSString *)definitionString { },\ \"ElasticGpuSpecification\":{\ \"shape\":\"ElasticGpuSpecifications\",\ - \"documentation\":\"Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
An elastic GPU to associate with the instance.
Amazon Elastic Graphics reached end of life on January 8, 2024.
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
An elastic inference accelerator to associate with the instance.
Amazon Elastic Inference (EI) is no longer available to new customers. For more information, see Amazon Elastic Inference FAQs.
The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
\"\ + \"documentation\":\"The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.
\"\ },\ \"InstanceMarketOptions\":{\ \"shape\":\"InstanceMarketOptionsRequest\",\ @@ -52554,7 +52752,7 @@ - (NSString *)definitionString { },\ \"MaxResults\":{\ \"shape\":\"TransitGatewayMaxResults\",\ - \"documentation\":\"The maximum number of routes to return.
\"\ + \"documentation\":\"The maximum number of routes to return. If a value is not provided, the default is 1000.
\"\ },\ \"DryRun\":{\ \"shape\":\"Boolean\",\ @@ -53743,7 +53941,7 @@ - (NSString *)definitionString { \"members\":{\ \"SecurityGroups\":{\ \"shape\":\"GroupIdentifierList\",\ - \"documentation\":\"The security groups.
\",\ + \"documentation\":\"The security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
\",\ \"locationName\":\"groupSet\"\ },\ \"AddressingType\":{\ @@ -53793,7 +53991,7 @@ - (NSString *)definitionString { },\ \"NetworkInterfaces\":{\ \"shape\":\"InstanceNetworkInterfaceSpecificationList\",\ - \"documentation\":\"One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
The network interfaces.
SpotFleetLaunchSpecification does not support Elastic Fabric Adapter (EFA). You must use LaunchTemplateConfig instead.
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \\\"subnet-1234abcdeexample1, subnet-0987cdef6example2\\\".
\",\ + \"documentation\":\"The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \\\"subnet-1234abcdeexample1, subnet-0987cdef6example2\\\".
If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.
\",\ \"locationName\":\"subnetId\"\ },\ \"UserData\":{\ @@ -59389,7 +59587,7 @@ - (NSString *)definitionString { \"members\":{\ \"Attachments\":{\ \"shape\":\"VolumeAttachmentList\",\ - \"documentation\":\"Information about the volume attachments.
\",\ + \"documentation\":\"This parameter is not returned by CreateVolume.
Information about the volume attachments.
\",\ \"locationName\":\"attachmentSet\"\ },\ \"AvailabilityZone\":{\ @@ -59454,7 +59652,7 @@ - (NSString *)definitionString { },\ \"FastRestored\":{\ \"shape\":\"Boolean\",\ - \"documentation\":\"Indicates whether the volume was created using fast snapshot restore.
\",\ + \"documentation\":\"This parameter is not returned by CreateVolume.
Indicates whether the volume was created using fast snapshot restore.
\",\ \"locationName\":\"fastRestored\"\ },\ \"MultiAttachEnabled\":{\ @@ -59469,7 +59667,7 @@ - (NSString *)definitionString { },\ \"SseType\":{\ \"shape\":\"SSEType\",\ - \"documentation\":\"Reserved for future use.
\",\ + \"documentation\":\"This parameter is not returned by CreateVolume.
Reserved for future use.
\",\ \"locationName\":\"sseType\"\ }\ },\ diff --git a/AWSEC2/AWSEC2Service.h b/AWSEC2/AWSEC2Service.h index c180b3aaaf2..3ead062f3d8 100644 --- a/AWSEC2/AWSEC2Service.h +++ b/AWSEC2/AWSEC2Service.h @@ -1388,7 +1388,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (void)cancelReservedInstancesListing:(AWSEC2CancelReservedInstancesListingRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2CancelReservedInstancesListingResult * _Nullable response, NSError * _Nullable error))completionHandler; /** -Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Restrictions
You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Restrictions
You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.
Creates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options.
The following are the individual DHCP options you can specify. For more information, see DHCP options sets in the Amazon VPC User Guide.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in any other Region, specify region.compute.internal. Otherwise, specify a custom domain name. This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name.
domain-name-servers - The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your instances receive custom DNS hostnames as specified in domain-name, you must specify a custom DNS server.
ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4 addresses and four IPv6 addresses).
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2. Broadcast and multicast are not supported. For more information about NetBIOS node types, see RFC 2132.
ipv6-preferred-lease-time - A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
Creates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options.
The following are the individual DHCP options you can specify. For more information, see DHCP options sets in the Amazon VPC User Guide.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in any other Region, specify region.compute.internal. Otherwise, specify a custom domain name. This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name.
domain-name-servers - The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your instances receive custom DNS hostnames as specified in domain-name, you must specify a custom DNS server.
ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4 addresses and four IPv6 addresses).
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2. Broadcast and multicast are not supported. For more information about NetBIOS node types, see RFC 2132.
ipv6-address-preferred-lease-time - A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
Creates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options.
The following are the individual DHCP options you can specify. For more information, see DHCP options sets in the Amazon VPC User Guide.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in any other Region, specify region.compute.internal. Otherwise, specify a custom domain name. This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name.
domain-name-servers - The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your instances receive custom DNS hostnames as specified in domain-name, you must specify a custom DNS server.
ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4 addresses and four IPv6 addresses).
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2. Broadcast and multicast are not supported. For more information about NetBIOS node types, see RFC 2132.
ipv6-preferred-lease-time - A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
Creates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options.
The following are the individual DHCP options you can specify. For more information, see DHCP options sets in the Amazon VPC User Guide.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in any other Region, specify region.compute.internal. Otherwise, specify a custom domain name. This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name.
domain-name-servers - The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your instances receive custom DNS hostnames as specified in domain-name, you must specify a custom DNS server.
ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4 addresses and four IPv6 addresses).
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2. Broadcast and multicast are not supported. For more information about NetBIOS node types, see RFC 2132.
ipv6-address-preferred-lease-time - A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
+Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
To clone an existing launch template as the basis for a new launch template, use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
@param request A container for the necessary parameters to execute the CreateLaunchTemplate service method. @@ -2175,7 +2175,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (AWSTaskCreates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
+Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
To clone an existing launch template as the basis for a new launch template, use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
@param request A container for the necessary parameters to execute the CreateLaunchTemplate service method. @param completionHandler The completion handler to call when the load request is complete. @@ -2188,7 +2188,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (void)createLaunchTemplate:(AWSEC2CreateLaunchTemplateRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2CreateLaunchTemplateResult * _Nullable response, NSError * _Nullable error))completionHandler; /** -Creates a new version of a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
Launch templates are immutable; after you create a launch template, you can't modify it. Instead, you can create a new version of the launch template that includes any changes you require.
For more information, see Modify a launch template (manage launch template versions) in the Amazon Elastic Compute Cloud User Guide.
+Creates a new version of a launch template. You must specify an existing launch template, either by name or ID. You can determine whether the new version inherits parameters from a source version, and add or overwrite parameters as needed.
Launch template versions are numbered in the order in which they are created. You can't specify, change, or replace the numbering of launch template versions.
Launch templates are immutable; after you create a launch template, you can't modify it. Instead, you can create a new version of the launch template that includes the changes that you require.
For more information, see Modify a launch template (manage launch template versions) in the Amazon Elastic Compute Cloud User Guide.
@param request A container for the necessary parameters to execute the CreateLaunchTemplateVersion service method. @@ -2200,7 +2200,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (AWSTaskCreates a new version of a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
Launch templates are immutable; after you create a launch template, you can't modify it. Instead, you can create a new version of the launch template that includes any changes you require.
For more information, see Modify a launch template (manage launch template versions) in the Amazon Elastic Compute Cloud User Guide.
+Creates a new version of a launch template. You must specify an existing launch template, either by name or ID. You can determine whether the new version inherits parameters from a source version, and add or overwrite parameters as needed.
Launch template versions are numbered in the order in which they are created. You can't specify, change, or replace the numbering of launch template versions.
Launch templates are immutable; after you create a launch template, you can't modify it. Instead, you can create a new version of the launch template that includes the changes that you require.
For more information, see Modify a launch template (manage launch template versions) in the Amazon Elastic Compute Cloud User Guide.
@param request A container for the necessary parameters to execute the CreateLaunchTemplateVersion service method. @param completionHandler The completion handler to call when the load request is complete. @@ -3773,7 +3773,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (void)deleteEgressOnlyInternetGateway:(AWSEC2DeleteEgressOnlyInternetGatewayRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2DeleteEgressOnlyInternetGatewayResult * _Nullable response, NSError * _Nullable error))completionHandler; /** -Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
+Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. Up to 1000 instances can be terminated in a single request to delete instant fleets. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 fleets of type instant in a single request.
You can delete up to 100 fleets of type maintain or request in a single request.
You can delete up to 125 fleets in a single request, provided you do not exceed the quota for each fleet type, as specified above.
If you exceed the specified number of fleets to delete, no fleets are deleted.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
@param request A container for the necessary parameters to execute the DeleteFleets service method. @@ -3785,7 +3785,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (AWSTaskDeletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
+Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. Up to 1000 instances can be terminated in a single request to delete instant fleets. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 fleets of type instant in a single request.
You can delete up to 100 fleets of type maintain or request in a single request.
You can delete up to 125 fleets in a single request, provided you do not exceed the quota for each fleet type, as specified above.
If you exceed the specified number of fleets to delete, no fleets are deleted.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
@param request A container for the necessary parameters to execute the DeleteFleets service method. @param completionHandler The completion handler to call when the load request is complete. @@ -4987,7 +4987,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (void)deleteTransitGatewayRoute:(AWSEC2DeleteTransitGatewayRouteRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2DeleteTransitGatewayRouteResult * _Nullable response, NSError * _Nullable error))completionHandler; /** -Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
+Deletes the specified transit gateway route table. If there are any route tables associated with the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.
@param request A container for the necessary parameters to execute the DeleteTransitGatewayRouteTable service method. @@ -4999,7 +4999,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (AWSTaskDeletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
+Deletes the specified transit gateway route table. If there are any route tables associated with the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.
@param request A container for the necessary parameters to execute the DeleteTransitGatewayRouteTable service method. @param completionHandler The completion handler to call when the load request is complete. @@ -6619,7 +6619,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (void)describeImageAttribute:(AWSEC2DescribeImageAttributeRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2ImageAttribute * _Nullable response, NSError * _Nullable error))completionHandler; /** -Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.
+Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.
@param request A container for the necessary parameters to execute the DescribeInstanceTypeOfferings service method. @@ -6881,7 +6881,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (AWSTaskReturns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.
+Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.
@param request A container for the necessary parameters to execute the DescribeInstanceTypeOfferings service method. @param completionHandler The completion handler to call when the load request is complete. @@ -6894,7 +6894,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (void)describeInstanceTypeOfferings:(AWSEC2DescribeInstanceTypeOfferingsRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2DescribeInstanceTypeOfferingsResult * _Nullable response, NSError * _Nullable error))completionHandler; /** -Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types.
+Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.
@param request A container for the necessary parameters to execute the DescribeInstanceTypes service method. @@ -6906,7 +6906,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (AWSTaskDescribes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types.
+Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.
@param request A container for the necessary parameters to execute the DescribeInstanceTypes service method. @param completionHandler The completion handler to call when the load request is complete. @@ -6919,7 +6919,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (void)describeInstanceTypes:(AWSEC2DescribeInstanceTypesRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2DescribeInstanceTypesResult * _Nullable response, NSError * _Nullable error))completionHandler; /** -Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes one or more of your network interfaces.
If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, private-dns-name, subnet-id, or vpc-id.
Describes one or more of your network interfaces.
If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, private-dns-name, subnet-id, or vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Describes one or more of your network interfaces.
If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, private-dns-name, subnet-id, or vpc-id.
Describes one or more of your network interfaces.
If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, private-dns-name, subnet-id, or vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
+Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
+Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Disables deregistration protection for an AMI. When deregistration protection is disabled, the AMI can be deregistered.
If you chose to include a 24-hour cooldown period when you enabled deregistration protection for the AMI, then, when you disable deregistration protection, you won’t immediately be able to deregister the AMI.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
+ + @param request A container for the necessary parameters to execute the DisableImageDeregistrationProtection service method. + + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DisableImageDeregistrationProtectionResult`. + + @see AWSEC2DisableImageDeregistrationProtectionRequest + @see AWSEC2DisableImageDeregistrationProtectionResult + */ +- (AWSTaskDisables deregistration protection for an AMI. When deregistration protection is disabled, the AMI can be deregistered.
If you chose to include a 24-hour cooldown period when you enabled deregistration protection for the AMI, then, when you disable deregistration protection, you won’t immediately be able to deregister the AMI.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
+ + @param request A container for the necessary parameters to execute the DisableImageDeregistrationProtection service method. + @param completionHandler The completion handler to call when the load request is complete. + `response` - A response object, or `nil` if the request failed. + `error` - An error object that indicates why the request failed, or `nil` if the request was successful. + + @see AWSEC2DisableImageDeregistrationProtectionRequest + @see AWSEC2DisableImageDeregistrationProtectionResult + */ +- (void)disableImageDeregistrationProtection:(AWSEC2DisableImageDeregistrationProtectionRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2DisableImageDeregistrationProtectionResult * _Nullable response, NSError * _Nullable error))completionHandler; + /**Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.
@@ -10400,6 +10425,31 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; */ - (void)enableImageDeprecation:(AWSEC2EnableImageDeprecationRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2EnableImageDeprecationResult * _Nullable response, NSError * _Nullable error))completionHandler; +/** +Enables deregistration protection for an AMI. When deregistration protection is enabled, the AMI can't be deregistered.
To allow the AMI to be deregistered, you must first disable deregistration protection using DisableImageDeregistrationProtection.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
+ + @param request A container for the necessary parameters to execute the EnableImageDeregistrationProtection service method. + + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSEC2EnableImageDeregistrationProtectionResult`. + + @see AWSEC2EnableImageDeregistrationProtectionRequest + @see AWSEC2EnableImageDeregistrationProtectionResult + */ +- (AWSTaskEnables deregistration protection for an AMI. When deregistration protection is enabled, the AMI can't be deregistered.
To allow the AMI to be deregistered, you must first disable deregistration protection using DisableImageDeregistrationProtection.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
+ + @param request A container for the necessary parameters to execute the EnableImageDeregistrationProtection service method. + @param completionHandler The completion handler to call when the load request is complete. + `response` - A response object, or `nil` if the request failed. + `error` - An error object that indicates why the request failed, or `nil` if the request was successful. + + @see AWSEC2EnableImageDeregistrationProtectionRequest + @see AWSEC2EnableImageDeregistrationProtectionResult + */ +- (void)enableImageDeregistrationProtection:(AWSEC2EnableImageDeregistrationProtectionRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2EnableImageDeregistrationProtectionResult * _Nullable response, NSError * _Nullable error))completionHandler; + /**Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.
@@ -10870,7 +10920,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (void)getConsoleOutput:(AWSEC2GetConsoleOutputRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2GetConsoleOutputResult * _Nullable response, NSError * _Nullable error))completionHandler; /** -Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
+Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
For more information, see Instance console output in the Amazon EC2 User Guide.
@param request A container for the necessary parameters to execute the GetConsoleScreenshot service method. @@ -10882,7 +10932,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (AWSTaskRetrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
+Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
For more information, see Instance console output in the Amazon EC2 User Guide.
@param request A container for the necessary parameters to execute the GetConsoleScreenshot service method. @param completionHandler The completion handler to call when the load request is complete. @@ -11094,6 +11144,31 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; */ - (void)getInstanceMetadataDefaults:(AWSEC2GetInstanceMetadataDefaultsRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2GetInstanceMetadataDefaultsResult * _Nullable response, NSError * _Nullable error))completionHandler; +/** +Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance.
+ + @param request A container for the necessary parameters to execute the GetInstanceTpmEkPub service method. + + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSEC2GetInstanceTpmEkPubResult`. + + @see AWSEC2GetInstanceTpmEkPubRequest + @see AWSEC2GetInstanceTpmEkPubResult + */ +- (AWSTaskGets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance.
+ + @param request A container for the necessary parameters to execute the GetInstanceTpmEkPub service method. + @param completionHandler The completion handler to call when the load request is complete. + `response` - A response object, or `nil` if the request failed. + `error` - An error object that indicates why the request failed, or `nil` if the request was successful. + + @see AWSEC2GetInstanceTpmEkPubRequest + @see AWSEC2GetInstanceTpmEkPubResult + */ +- (void)getInstanceTpmEkPub:(AWSEC2GetInstanceTpmEkPubRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2GetInstanceTpmEkPubResult * _Nullable response, NSError * _Nullable error))completionHandler; + /**Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
@@ -12608,7 +12683,7 @@ FOUNDATION_EXPORT NSString *const AWSEC2SDKVersion; - (void)modifyInstanceMaintenanceOptions:(AWSEC2ModifyInstanceMaintenanceOptionsRequest *)request completionHandler:(void (^ _Nullable)(AWSEC2ModifyInstanceMaintenanceOptionsResult * _Nullable response, NSError * _Nullable error))completionHandler; /** -Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference. At instance launch, the value will come from the AMI, or from the launch parameter if specified. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference. If an account-level setting is cleared with no-preference, then the instance launch considers the other instance metadata settings. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference. At instance launch, the value will come from the AMI, or from the launch parameter if specified. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference. If an account-level setting is cleared with no-preference, then the instance launch considers the other instance metadata settings. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
Note: Internal load balancers must use the ipv4 IP address type.
[Application Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).
[Network Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
[Gateway Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
[Application Load Balancers] The type of IP addresses used for public or private connections by the subnets attached to your load balancer. The possible values are ipv4 (for only IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).
[Network Load Balancers and Gateway Load Balancers] The type of IP addresses used for public or private connections by the subnets attached to your load balancer. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
Note: Internal load balancers must use the ipv4 IP address type.
[Application Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).
[Network Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
[Gateway Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
[Network Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
[Gateway Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
[Application Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).
[Network Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
[Gateway Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
[Network Load Balancers] The IP address type.
[Gateway Load Balancers] The IP address type.
+[Application Load Balancers] The IP address type.
[Network Load Balancers] The IP address type.
[Gateway Load Balancers] The IP address type.
*/ @property (nonatomic, assign) AWSElasticLoadBalancingIpAddressType ipAddressType; diff --git a/AWSElasticLoadBalancing/AWSElasticLoadBalancingModel.m b/AWSElasticLoadBalancing/AWSElasticLoadBalancingModel.m index 360a05e608a..3a21248db67 100644 --- a/AWSElasticLoadBalancing/AWSElasticLoadBalancingModel.m +++ b/AWSElasticLoadBalancing/AWSElasticLoadBalancingModel.m @@ -532,6 +532,9 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { if ([value caseInsensitiveCompare:@"dualstack"] == NSOrderedSame) { return @(AWSElasticLoadBalancingIpAddressTypeDualstack); } + if ([value caseInsensitiveCompare:@"dualstack-without-public-ipv4"] == NSOrderedSame) { + return @(AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4); + } return @(AWSElasticLoadBalancingIpAddressTypeUnknown); } reverseBlock:^NSString *(NSNumber *value) { switch ([value integerValue]) { @@ -539,6 +542,8 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { return @"ipv4"; case AWSElasticLoadBalancingIpAddressTypeDualstack: return @"dualstack"; + case AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4: + return @"dualstack-without-public-ipv4"; default: return nil; } @@ -1874,6 +1879,9 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { if ([value caseInsensitiveCompare:@"dualstack"] == NSOrderedSame) { return @(AWSElasticLoadBalancingIpAddressTypeDualstack); } + if ([value caseInsensitiveCompare:@"dualstack-without-public-ipv4"] == NSOrderedSame) { + return @(AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4); + } return @(AWSElasticLoadBalancingIpAddressTypeUnknown); } reverseBlock:^NSString *(NSNumber *value) { switch ([value integerValue]) { @@ -1881,6 +1889,8 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { return @"ipv4"; case AWSElasticLoadBalancingIpAddressTypeDualstack: return @"dualstack"; + case AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4: + return @"dualstack-without-public-ipv4"; default: return nil; } @@ -2715,6 +2725,9 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { if ([value caseInsensitiveCompare:@"dualstack"] == NSOrderedSame) { return @(AWSElasticLoadBalancingIpAddressTypeDualstack); } + if ([value caseInsensitiveCompare:@"dualstack-without-public-ipv4"] == NSOrderedSame) { + return @(AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4); + } return @(AWSElasticLoadBalancingIpAddressTypeUnknown); } reverseBlock:^NSString *(NSNumber *value) { switch ([value integerValue]) { @@ -2722,6 +2735,8 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { return @"ipv4"; case AWSElasticLoadBalancingIpAddressTypeDualstack: return @"dualstack"; + case AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4: + return @"dualstack-without-public-ipv4"; default: return nil; } @@ -2750,6 +2765,9 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { if ([value caseInsensitiveCompare:@"dualstack"] == NSOrderedSame) { return @(AWSElasticLoadBalancingIpAddressTypeDualstack); } + if ([value caseInsensitiveCompare:@"dualstack-without-public-ipv4"] == NSOrderedSame) { + return @(AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4); + } return @(AWSElasticLoadBalancingIpAddressTypeUnknown); } reverseBlock:^NSString *(NSNumber *value) { switch ([value integerValue]) { @@ -2757,6 +2775,8 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { return @"ipv4"; case AWSElasticLoadBalancingIpAddressTypeDualstack: return @"dualstack"; + case AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4: + return @"dualstack-without-public-ipv4"; default: return nil; } @@ -2897,6 +2917,9 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { if ([value caseInsensitiveCompare:@"dualstack"] == NSOrderedSame) { return @(AWSElasticLoadBalancingIpAddressTypeDualstack); } + if ([value caseInsensitiveCompare:@"dualstack-without-public-ipv4"] == NSOrderedSame) { + return @(AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4); + } return @(AWSElasticLoadBalancingIpAddressTypeUnknown); } reverseBlock:^NSString *(NSNumber *value) { switch ([value integerValue]) { @@ -2904,6 +2927,8 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { return @"ipv4"; case AWSElasticLoadBalancingIpAddressTypeDualstack: return @"dualstack"; + case AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4: + return @"dualstack-without-public-ipv4"; default: return nil; } @@ -2941,6 +2966,9 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { if ([value caseInsensitiveCompare:@"dualstack"] == NSOrderedSame) { return @(AWSElasticLoadBalancingIpAddressTypeDualstack); } + if ([value caseInsensitiveCompare:@"dualstack-without-public-ipv4"] == NSOrderedSame) { + return @(AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4); + } return @(AWSElasticLoadBalancingIpAddressTypeUnknown); } reverseBlock:^NSString *(NSNumber *value) { switch ([value integerValue]) { @@ -2948,6 +2976,8 @@ + (NSValueTransformer *)ipAddressTypeJSONTransformer { return @"ipv4"; case AWSElasticLoadBalancingIpAddressTypeDualstack: return @"dualstack"; + case AWSElasticLoadBalancingIpAddressTypeDualstackWithoutPublicIpv4: + return @"dualstack-without-public-ipv4"; default: return nil; } diff --git a/AWSElasticLoadBalancing/AWSElasticLoadBalancingResources.m b/AWSElasticLoadBalancing/AWSElasticLoadBalancingResources.m index 4e3c5901e86..d537e54020e 100644 --- a/AWSElasticLoadBalancing/AWSElasticLoadBalancingResources.m +++ b/AWSElasticLoadBalancing/AWSElasticLoadBalancingResources.m @@ -62,6 +62,7 @@ - (NSString *)definitionString { \"apiVersion\":\"2015-12-01\",\ \"endpointPrefix\":\"elasticloadbalancing\",\ \"protocol\":\"query\",\ + \"protocols\":[\"query\"],\ \"serviceAbbreviation\":\"Elastic Load Balancing v2\",\ \"serviceFullName\":\"Elastic Load Balancing\",\ \"serviceId\":\"Elastic Load Balancing v2\",\ @@ -1434,7 +1435,7 @@ - (NSString *)definitionString { },\ \"IpAddressType\":{\ \"shape\":\"IpAddressType\",\ - \"documentation\":\"The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
Note: Internal load balancers must use the ipv4 IP address type.
[Application Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).
[Network Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You canât specify dualstack for a load balancer with a UDP or TCP_UDP listener.
[Gateway Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
[Application Load Balancers] The type of IP addresses used for public or private connections by the subnets attached to your load balancer. The possible values are ipv4 (for only IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).
[Network Load Balancers and Gateway Load Balancers] The type of IP addresses used for public or private connections by the subnets attached to your load balancer. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You canât specify dualstack for a load balancer with a UDP or TCP_UDP listener.
Note: Internal load balancers must use the ipv4 IP address type.
[Application Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).
[Network Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You canât specify dualstack for a load balancer with a UDP or TCP_UDP listener.
[Gateway Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
[Network Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You canât specify dualstack for a load balancer with a UDP or TCP_UDP listener.
[Gateway Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
[Application Load Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).
[Network Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You canât specify dualstack for a load balancer with a UDP or TCP_UDP listener.
[Gateway Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
[Network Load Balancers] The IP address type.
[Gateway Load Balancers] The IP address type.
\"\ + \"documentation\":\"[Application Load Balancers] The IP address type.
[Network Load Balancers] The IP address type.
[Gateway Load Balancers] The IP address type.
\"\ }\ }\ },\ From e037af9b44bce01b318cf84cc7324cdb183ee5ed Mon Sep 17 00:00:00 2001 From: AWS Mobile SDK Bot <46607340+awsmobilesdk@users.noreply.github.com> Date: Wed, 5 Jun 2024 07:09:17 -0700 Subject: [PATCH 10/14] feat(AWSPolly): update models to latest (#5327) --- AWSPolly.podspec | 2 +- AWSPolly/AWSPollyModel.h | 17 +++++++++-------- AWSPolly/AWSPollyModel.m | 20 ++++++++++++++++++++ AWSPolly/AWSPollyResources.m | 21 +++++++++++---------- 4 files changed, 41 insertions(+), 19 deletions(-) diff --git a/AWSPolly.podspec b/AWSPolly.podspec index 010660f164a..f7d72691a2b 100644 --- a/AWSPolly.podspec +++ b/AWSPolly.podspec @@ -14,5 +14,5 @@ Pod::Spec.new do |s| s.requires_arc = true s.dependency 'AWSCore', '2.36.2' s.source_files = 'AWSPolly/*.{h,m}' - s.resource_bundle = { 'AWSPolly' => ['AWSPolly/PrivacyInfo.xcprivacy']} + s.resource_bundle = { 'AWSPolly' => ['AWSPolly/PrivacyInfo.xcprivacy'] } end diff --git a/AWSPolly/AWSPollyModel.h b/AWSPolly/AWSPollyModel.h index 80394453075..0cd81ca6b9e 100644 --- a/AWSPolly/AWSPollyModel.h +++ b/AWSPolly/AWSPollyModel.h @@ -51,6 +51,7 @@ typedef NS_ENUM(NSInteger, AWSPollyEngine) { AWSPollyEngineStandard, AWSPollyEngineNeural, AWSPollyEngineLongForm, + AWSPollyEngineGenerative, }; typedef NS_ENUM(NSInteger, AWSPollyGender) { @@ -284,7 +285,7 @@ typedef NS_ENUM(NSInteger, AWSPollyVoiceId) { /** -Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.
Specifies the engine (standard, neural, long-form or generative) used by Amazon Polly when processing input text for speech synthesis.
Specifies the engine (standard, neural or long-form) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
+The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
*/ @property (nonatomic, strong) NSString * _Nullable sampleRate; @@ -645,7 +646,7 @@ typedef NS_ENUM(NSInteger, AWSPollyVoiceId) { @property (nonatomic, strong) NSDate * _Nullable creationTime; /** -Specifies the engine (standard, neural or long-form) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
+The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
*/ @property (nonatomic, strong) NSString * _Nullable sampleRate; @@ -723,7 +724,7 @@ typedef NS_ENUM(NSInteger, AWSPollyVoiceId) { /** -Specifies the engine (standard, neural or long-form) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
NTTS-only voices
When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.
long-form-only voices
When using long-form-only voices such as Danielle (en-US), this parameter is required and must be set to long-form. If the engine is not specified, or is set to standard or neural, this will result in an error.
Type: String
Valid Values: standard | neural | long-form
Required: Yes
Standard voices
For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.
Specifies the engine (standard, neural, long-form, or generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
Type: String
Valid Values: standard | neural | long-form | generative
Required: Yes
*/ @property (nonatomic, assign) AWSPollyEngine engine; @@ -743,7 +744,7 @@ typedef NS_ENUM(NSInteger, AWSPollyVoiceId) { @property (nonatomic, assign) AWSPollyOutputFormat outputFormat; /** -The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
+The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
*/ @property (nonatomic, strong) NSString * _Nullable sampleRate; @@ -829,7 +830,7 @@ typedef NS_ENUM(NSInteger, AWSPollyVoiceId) { @property (nonatomic, strong) NSString * _Nullable name; /** -Specifies which engines (standard, neural or long-form) are supported by a given voice.
Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.
Specifies the engine (standard, neural, long-form or generative) used by Amazon Polly when processing input text for speech synthesis.
Specifies the engine (standard, neural or long-form) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \\\"8000\\\", \\\"16000\\\", \\\"22050\\\", and \\\"24000\\\". The default value for standard voices is \\\"22050\\\". The default value for neural voices is \\\"24000\\\". The default value for long-form voices is \\\"24000\\\".
Valid values for pcm are \\\"8000\\\" and \\\"16000\\\" The default value is \\\"16000\\\".
\"\ + \"documentation\":\"The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \\\"8000\\\", \\\"16000\\\", \\\"22050\\\", and \\\"24000\\\". The default value for standard voices is \\\"22050\\\". The default value for neural voices is \\\"24000\\\". The default value for long-form voices is \\\"24000\\\". The default value for generative voices is \\\"24000\\\".
Valid values for pcm are \\\"8000\\\" and \\\"16000\\\" The default value is \\\"16000\\\".
\"\ },\ \"SnsTopicArn\":{\ \"shape\":\"SnsTopicArn\",\ @@ -848,7 +849,7 @@ - (NSString *)definitionString { \"members\":{\ \"Engine\":{\ \"shape\":\"Engine\",\ - \"documentation\":\"Specifies the engine (standard, neural or long-form) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \\\"8000\\\", \\\"16000\\\", \\\"22050\\\", and \\\"24000\\\". The default value for standard voices is \\\"22050\\\". The default value for neural voices is \\\"24000\\\". The default value for long-form voices is \\\"24000\\\".
Valid values for pcm are \\\"8000\\\" and \\\"16000\\\" The default value is \\\"16000\\\".
\"\ + \"documentation\":\"The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \\\"8000\\\", \\\"16000\\\", \\\"22050\\\", and \\\"24000\\\". The default value for standard voices is \\\"22050\\\". The default value for neural voices is \\\"24000\\\". The default value for long-form voices is \\\"24000\\\". The default value for generative voices is \\\"24000\\\".
Valid values for pcm are \\\"8000\\\" and \\\"16000\\\" The default value is \\\"16000\\\".
\"\ },\ \"SpeechMarkTypes\":{\ \"shape\":\"SpeechMarkTypeList\",\ @@ -932,7 +933,7 @@ - (NSString *)definitionString { \"members\":{\ \"Engine\":{\ \"shape\":\"Engine\",\ - \"documentation\":\"Specifies the engine (standard, neural or long-form) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
NTTS-only voices
When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.
long-form-only voices
When using long-form-only voices such as Danielle (en-US), this parameter is required and must be set to long-form. If the engine is not specified, or is set to standard or neural, this will result in an error.
Type: String
Valid Values: standard | neural | long-form
Required: Yes
Standard voices
For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.
Specifies the engine (standard, neural, long-form, or generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
Type: String
Valid Values: standard | neural | long-form | generative
Required: Yes
\"\ },\ \"LanguageCode\":{\ \"shape\":\"LanguageCode\",\ @@ -948,7 +949,7 @@ - (NSString *)definitionString { },\ \"SampleRate\":{\ \"shape\":\"SampleRate\",\ - \"documentation\":\"The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \\\"8000\\\", \\\"16000\\\", \\\"22050\\\", and \\\"24000\\\". The default value for standard voices is \\\"22050\\\". The default value for neural voices is \\\"24000\\\". The default value for long-form voices is \\\"24000\\\".
Valid values for pcm are \\\"8000\\\" and \\\"16000\\\" The default value is \\\"16000\\\".
\"\ + \"documentation\":\"The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \\\"8000\\\", \\\"16000\\\", \\\"22050\\\", and \\\"24000\\\". The default value for standard voices is \\\"22050\\\". The default value for neural voices is \\\"24000\\\". The default value for long-form voices is \\\"24000\\\". The default value for generative voices is \\\"24000\\\".
Valid values for pcm are \\\"8000\\\" and \\\"16000\\\" The default value is \\\"16000\\\".
\"\ },\ \"SpeechMarkTypes\":{\ \"shape\":\"SpeechMarkTypeList\",\ @@ -1068,7 +1069,7 @@ - (NSString *)definitionString { },\ \"SupportedEngines\":{\ \"shape\":\"EngineList\",\ - \"documentation\":\"Specifies which engines (standard, neural or long-form) are supported by a given voice.
Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
Description of the voice.
\"\ From 26ed44748e1570d2f834536998520c48c2b44a9c Mon Sep 17 00:00:00 2001 From: AWS Mobile SDK Bot <46607340+awsmobilesdk@users.noreply.github.com> Date: Wed, 5 Jun 2024 07:11:37 -0700 Subject: [PATCH 11/14] feat(AWSCognitoIdentityProvider): update models to latest (#5325) --- AWSCognitoIdentityProvider.podspec | 2 +- .../AWSCognitoIdentityProviderModel.h | 49 ++++++++--------- .../AWSCognitoIdentityProviderModel.m | 10 ++++ .../AWSCognitoIdentityProviderResources.m | 53 ++++++++++--------- .../AWSCognitoIdentityProviderService.h | 4 +- 5 files changed, 66 insertions(+), 52 deletions(-) diff --git a/AWSCognitoIdentityProvider.podspec b/AWSCognitoIdentityProvider.podspec index 4599434dccb..2981e797d56 100644 --- a/AWSCognitoIdentityProvider.podspec +++ b/AWSCognitoIdentityProvider.podspec @@ -19,5 +19,5 @@ Pod::Spec.new do |s| s.source_files = 'AWSCognitoIdentityProvider/**/*.{h,m,c}' s.public_header_files = 'AWSCognitoIdentityProvider/*.h' s.private_header_files = 'AWSCognitoIdentityProvider/Internal/*.h' - s.resource_bundle = { 'AWSCognitoIdentityProvider' => ['AWSCognitoIdentityProvider/PrivacyInfo.xcprivacy']} + s.resource_bundle = { 'AWSCognitoIdentityProvider' => ['AWSCognitoIdentityProvider/PrivacyInfo.xcprivacy'] } end diff --git a/AWSCognitoIdentityProvider/AWSCognitoIdentityProviderModel.h b/AWSCognitoIdentityProvider/AWSCognitoIdentityProviderModel.h index 5cf01da5100..4afbe53d310 100644 --- a/AWSCognitoIdentityProvider/AWSCognitoIdentityProviderModel.h +++ b/AWSCognitoIdentityProvider/AWSCognitoIdentityProviderModel.h @@ -336,6 +336,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderUserStatusType) { AWSCognitoIdentityProviderUserStatusTypeCompromised, AWSCognitoIdentityProviderUserStatusTypeResetRequired, AWSCognitoIdentityProviderUserStatusTypeForceChangePassword, + AWSCognitoIdentityProviderUserStatusTypeExternalProvider, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderUsernameAttributeType) { @@ -1112,7 +1113,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderVerifySoftwareTokenResponse @property (nonatomic, strong) NSDate * _Nullable userCreateDate; /** -The date and time, in ISO 8601 format, when the item was modified.
+The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
+The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com.
A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
+The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
For more information, see Default redirect URI.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
*/ @property (nonatomic, strong) NSString * _Nullable defaultRedirectURI; @@ -2968,7 +2969,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderVerifySoftwareTokenResponse /** -The identifier for the resource server
+A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.
The date and time, in ISO 8601 format, when the item was modified.
+The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
+The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
+The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
+The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
+The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
+The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The identifier for the resource server.
+A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.
The date and time, in ISO 8601 format, when the item was modified.
+The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
+The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
+The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The identifier for the resource server.
+A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.
The date and time, in ISO 8601 format, when the item was created.
+The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
+The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
+The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
+The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
+The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
+The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
+The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
+The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
\"\ + \"documentation\":\"The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
\"\ + \"documentation\":\"The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com.
A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
\"\ + \"documentation\":\"The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
For more information, see Default redirect URI.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
\"\ },\ \"AllowedOAuthFlows\":{\ \"shape\":\"OAuthFlowsType\",\ @@ -4476,7 +4478,7 @@ - (NSString *)definitionString { },\ \"Identifier\":{\ \"shape\":\"ResourceServerIdentifierType\",\ - \"documentation\":\"The identifier for the resource server
\"\ + \"documentation\":\"A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.
The date and time, in ISO 8601 format, when the item was modified.
\"\ + \"documentation\":\"The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
\"\ + \"documentation\":\"The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
\"\ + \"documentation\":\"The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The group type.
\"\ @@ -5444,11 +5446,11 @@ - (NSString *)definitionString { },\ \"LastModifiedDate\":{\ \"shape\":\"DateType\",\ - \"documentation\":\"The date and time, in ISO 8601 format, when the item was modified.
\"\ + \"documentation\":\"The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
\"\ + \"documentation\":\"The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
A container for information about an IdP.
\"\ @@ -6404,7 +6406,7 @@ - (NSString *)definitionString { },\ \"CreationDate\":{\ \"shape\":\"DateType\",\ - \"documentation\":\"The date and time, in ISO 8601 format, when the item was created.
\"\ + \"documentation\":\"The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
A container for IdP details.
\"\ @@ -6618,7 +6620,7 @@ - (NSString *)definitionString { },\ \"Identifier\":{\ \"shape\":\"ResourceServerIdentifierType\",\ - \"documentation\":\"The identifier for the resource server.
\"\ + \"documentation\":\"A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.
The date and time, in ISO 8601 format, when the item was modified.
\"\ + \"documentation\":\"The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The risk configuration type.
\"\ @@ -7431,11 +7433,11 @@ - (NSString *)definitionString { },\ \"LastModifiedDate\":{\ \"shape\":\"DateType\",\ - \"documentation\":\"The date and time, in ISO 8601 format, when the item was modified.
\"\ + \"documentation\":\"The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
\"\ + \"documentation\":\"The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
A container for the UI customization information for a user pool's built-in app UI.
\"\ @@ -7672,7 +7674,7 @@ - (NSString *)definitionString { },\ \"Identifier\":{\ \"shape\":\"ResourceServerIdentifierType\",\ - \"documentation\":\"The identifier for the resource server.
\"\ + \"documentation\":\"A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.
The date and time, in ISO 8601 format, when the item was created.
\"\ + \"documentation\":\"The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
\"\ + \"documentation\":\"The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
\"\ + \"documentation\":\"The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
\"\ + \"documentation\":\"The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
\"\ + \"documentation\":\"The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
A user pool description.
\"\ @@ -8384,11 +8386,11 @@ - (NSString *)definitionString { },\ \"LastModifiedDate\":{\ \"shape\":\"DateType\",\ - \"documentation\":\"The date and time, in ISO 8601 format, when the item was modified.
\"\ + \"documentation\":\"The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
\"\ + \"documentation\":\"The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
\"\ + \"documentation\":\"The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.