Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
", "ResumeContact": "Allows resuming a task contact in a paused state.
", "ResumeContactRecording": "When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
", + "SearchAgentStatuses": "Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
", "SearchAvailablePhoneNumbers": "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": "Searches the contact flows in an Amazon Connect instance, with optional filtering.
", @@ -187,6 +188,7 @@ "SearchResourceTags": "Searches tags used in an Amazon Connect instance using optional search criteria.
", "SearchRoutingProfiles": "Searches routing profiles in an Amazon Connect instance, with optional filtering.
", "SearchSecurityProfiles": "Searches security profiles in an Amazon Connect instance, with optional filtering.
", + "SearchUserHierarchyGroups": "Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
The UserHierarchyGroup with \"LevelId\": \"0\" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit is returned in milliseconds.
Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.
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.
", @@ -570,6 +572,7 @@ "AgentStatus": { "base": "Contains information about an agent status.
", "refs": { + "AgentStatusList$member": null, "DescribeAgentStatusResponse$AgentStatus": "The agent status.
" } }, @@ -591,6 +594,12 @@ "UpdateAgentStatusRequest$AgentStatusId": "The identifier of the agent status.
" } }, + "AgentStatusList": { + "base": null, + "refs": { + "SearchAgentStatusesResponse$AgentStatuses": "The search criteria to be used to return agent statuses.
" + } + }, "AgentStatusName": { "base": null, "refs": { @@ -616,6 +625,26 @@ "UserData$Status": "The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
" } }, + "AgentStatusSearchConditionList": { + "base": null, + "refs": { + "AgentStatusSearchCriteria$OrConditions": "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,
description, state, type, displayOrder,
and resourceID.
The search criteria to be used to return agent statuses.
", + "refs": { + "AgentStatusSearchConditionList$member": null, + "SearchAgentStatusesRequest$SearchCriteria": "The search criteria to be used to return agent statuses.
" + } + }, + "AgentStatusSearchFilter": { + "base": "Filters to be applied to search results.
", + "refs": { + "SearchAgentStatusesRequest$SearchFilter": "Filters to be applied to search results.
" + } + }, "AgentStatusState": { "base": null, "refs": { @@ -747,6 +776,7 @@ "refs": { "GetCurrentMetricDataResponse$ApproximateTotalCount": "The total count of the result, regardless of the current page size.
", "GetCurrentUserDataResponse$ApproximateTotalCount": "The total count of the result, regardless of the current page size.
", + "SearchAgentStatusesResponse$ApproximateTotalCount": "The total number of agent statuses which matched your search query.
", "SearchContactFlowModulesResponse$ApproximateTotalCount": "The total number of contact flows which matched your search query.
", "SearchContactFlowsResponse$ApproximateTotalCount": "The total number of contact flows which matched your search query.
", "SearchHoursOfOperationsResponse$ApproximateTotalCount": "The total number of hours of operations which matched your search query.
", @@ -756,6 +786,7 @@ "SearchQuickConnectsResponse$ApproximateTotalCount": "The total number of quick connects which matched your search query.
", "SearchRoutingProfilesResponse$ApproximateTotalCount": "The total number of routing profiles which matched your search query.
", "SearchSecurityProfilesResponse$ApproximateTotalCount": "The total number of security profiles which matched your search query.
", + "SearchUserHierarchyGroupsResponse$ApproximateTotalCount": "The total number of userHierarchyGroups which matched your search query.
", "SearchUsersResponse$ApproximateTotalCount": "The total number of users who matched your search query.
" } }, @@ -1344,6 +1375,19 @@ "UpdatePhoneNumberRequest$ClientToken": "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.
" } }, + "CommonAttributeAndCondition": { + "base": "A list of conditions which would be applied together with an AND condition.
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 number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE: Minimum value of 1. Maximum value of 1.
Valid Range for CHAT: Minimum value of 1. Maximum value of 10.
Valid Range for TASK: Minimum value of 1. Maximum value of 10.
A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and ProficiencyLimit.
", + "refs": { + "Conditions$member": null + } + }, + "Conditions": { + "base": null, + "refs": { + "ListCondition$Conditions": "A list of Condition objects which would be applied together with an AND condition.
" + } + }, "ConflictException": { "base": "Operation cannot be performed at this time as there is a conflict with another operation or contact state.
", "refs": { @@ -1825,6 +1881,13 @@ "RealTimeContactAnalysisAttachment$ContentType": "Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
" } }, + "ControlPlaneAttributeFilter": { + "base": "An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
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 information about a hierarchy group.
", "refs": { - "DescribeUserHierarchyGroupResponse$HierarchyGroup": "Information about the hierarchy group.
" + "DescribeUserHierarchyGroupResponse$HierarchyGroup": "Information about the hierarchy group.
", + "UserHierarchyGroupList$member": null } }, "HierarchyGroupCondition": { @@ -4222,6 +4286,7 @@ "ResumeContactRecordingRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "ResumeContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "SearchAgentStatusesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "SearchAvailablePhoneNumbersRequest$InstanceId": "The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchContactFlowsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", @@ -4233,6 +4298,7 @@ "SearchQuickConnectsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchRoutingProfilesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchSecurityProfilesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "SearchUserHierarchyGroupsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "SearchUsersRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
InstanceID is a required field. The \"Required: No\" below is incorrect.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SecurityProfile$OrganizationResourceId": "The organization resource identifier for the security profile.
", @@ -4623,6 +4689,12 @@ "refs": { } }, + "ListCondition": { + "base": "A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
", + "refs": { + "UserSearchCriteria$ListCondition": "A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
" + } + }, "ListContactEvaluationsRequest": { "base": null, "refs": { @@ -5084,6 +5156,7 @@ "ListTaskTemplatesRequest$MaxResults": "The maximum number of results to return per page.
It is not expected that you set this.
The maximum number of results to return per page.
", "ListUserProficienciesRequest$MaxResults": "The maximum number of results to return per page.
", + "SearchAgentStatusesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchContactFlowModulesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchContactFlowsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchContactsRequest$MaxResults": "The maximum number of results to return per page.
", @@ -5093,6 +5166,7 @@ "SearchQuickConnectsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchResourceTagsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchSecurityProfilesRequest$MaxResults": "The maximum number of results to return per page.
", + "SearchUserHierarchyGroupsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchVocabulariesRequest$MaxResults": "The maximum number of results to return per page.
" } }, @@ -5316,7 +5390,7 @@ "MetricsV2": { "base": null, "refs": { - "GetMetricDataV2Request$Metrics": "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
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, 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: This metric is not available in Amazon Connect admin website.
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: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
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: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
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: 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: 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: 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: 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 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
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, 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\").
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: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
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: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
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: 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: 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: 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: 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 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.
", "GetMetricDataV2Response$NextToken": "If there are additional results, this is the token for the next set of results.
", + "SearchAgentStatusesRequest$NextToken": "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.
", + "SearchAgentStatusesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchContactFlowModulesRequest$NextToken": "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.
", "SearchContactFlowModulesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchContactFlowsRequest$NextToken": "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.
", @@ -5490,6 +5566,8 @@ "SearchRoutingProfilesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchSecurityProfilesRequest$NextToken": "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.
", "SearchSecurityProfilesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", + "SearchUserHierarchyGroupsRequest$NextToken": "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.
", + "SearchUserHierarchyGroupsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchUsersRequest$NextToken": "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.
", "SearchUsersResponse$NextToken": "If there are additional results, this is the token for the next set of results.
" } @@ -5518,6 +5596,25 @@ "AttributeCondition$ProficiencyLevel": "The proficiency level of the condition.
" } }, + "NullableProficiencyLimitValue": { + "base": null, + "refs": { + "NumberCondition$MinValue": "The minValue to be used while evaluating the number condition.
", + "NumberCondition$MaxValue": "The maxValue to be used while evaluating the number condition.
" + } + }, + "NumberComparisonType": { + "base": null, + "refs": { + "NumberCondition$ComparisonType": "The type of comparison to be made when evaluating the number condition.
" + } + }, + "NumberCondition": { + "base": "A leaf node condition which can be used to specify a numeric condition.
The currently supported value for FieldName is limit.
A leaf node condition which can be used to specify a numeric condition.
" + } + }, "NumberReference": { "base": "Information about a reference when the referenceType is NUMBER. Otherwise, null.
The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.
" + "SearchResourceTagsRequest$ResourceTypes": "The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.
Supported resource types
AGENT
ROUTING_PROFILE
STANDARD_QUEUE
SECURITY_PROFILE
OPERATING_HOURS
PROMPT
CONTACT_FLOW
FLOW_MODULE
The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
" } }, + "SearchAgentStatusesRequest": { + "base": null, + "refs": { + } + }, + "SearchAgentStatusesResponse": { + "base": null, + "refs": { + } + }, "SearchAvailablePhoneNumbersRequest": { "base": null, "refs": { @@ -7303,6 +7410,16 @@ "TranscriptCriteria$SearchText": "The words or phrases used to search within a transcript.
" } }, + "SearchUserHierarchyGroupsRequest": { + "base": null, + "refs": { + } + }, + "SearchUserHierarchyGroupsResponse": { + "base": null, + "refs": { + } + }, "SearchUsersRequest": { "base": null, "refs": { @@ -7781,6 +7898,7 @@ "IntervalDetails$TimeZone": "The timezone applied to requested metrics.
", "MetricFilterV2$MetricFilterKey": "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.
The name of the field in the number condition.
", "PropertyValidationExceptionProperty$PropertyPath": "The full property path.
", "ResourceTypeList$member": null, "StringCondition$FieldName": "The name of the field in the string condition.
", @@ -7800,8 +7918,10 @@ } }, "StringCondition": { - "base": "A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name and description.
A leaf node condition which can be used to specify a string condition.
", "refs": { + "AgentStatusSearchCriteria$StringCondition": "A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name,
description, state, type, displayOrder,
and resourceID.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name and
value.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name, description, timezone, and resourceID.
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.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are name,
parentId, levelId, and resourceID.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName are Username, FirstName, LastName, RoutingProfileId, SecurityProfileId, ResourceId.
A leaf node condition which can be used to specify a tag condition.
", + "CommonAttributeAndCondition$TagConditions": "A leaf node condition which can be used to specify a tag condition.
", "ControlPlaneTagFilter$AndConditions": "A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
A leaf node condition which can be used to specify a tag condition.
", "ControlPlaneUserAttributeFilter$TagCondition": null, "TagAndConditionList$member": null @@ -8036,6 +8159,12 @@ "SearchResourceTagsResponse$Tags": "A list of tags used in the Amazon Connect instance.
" } }, + "TargetListType": { + "base": null, + "refs": { + "ListCondition$TargetListType": "The type of target list that will be used to filter the users.
" + } + }, "TaskActionDefinition": { "base": "Information about the task action.
", "refs": { @@ -8942,6 +9071,32 @@ "GetCurrentUserDataResponse$UserDataList": "A list of the user data that is returned.
" } }, + "UserHierarchyGroupList": { + "base": null, + "refs": { + "SearchUserHierarchyGroupsResponse$UserHierarchyGroups": "Information about the userHierarchyGroups.
" + } + }, + "UserHierarchyGroupSearchConditionList": { + "base": null, + "refs": { + "UserHierarchyGroupSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
", + "UserHierarchyGroupSearchCriteria$AndConditions": "A list of conditions which would be applied together with an AND condition.
" + } + }, + "UserHierarchyGroupSearchCriteria": { + "base": "The search criteria to be used to return userHierarchyGroup.
", + "refs": { + "SearchUserHierarchyGroupsRequest$SearchCriteria": "The search criteria to be used to return UserHierarchyGroups.
", + "UserHierarchyGroupSearchConditionList$member": null + } + }, + "UserHierarchyGroupSearchFilter": { + "base": "Filters to be applied to search results.
", + "refs": { + "SearchUserHierarchyGroupsRequest$SearchFilter": "Filters to be applied to search results.
" + } + }, "UserId": { "base": null, "refs": { diff --git a/models/apis/connect/2017-08-08/paginators-1.json b/models/apis/connect/2017-08-08/paginators-1.json index c80e204037e..57eee6360b2 100644 --- a/models/apis/connect/2017-08-08/paginators-1.json +++ b/models/apis/connect/2017-08-08/paginators-1.json @@ -295,6 +295,15 @@ "output_token": "NextToken", "result_key": "ViewsSummaryList" }, + "SearchAgentStatuses": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "non_aggregate_keys": [ + "ApproximateTotalCount" + ], + "output_token": "NextToken", + "result_key": "AgentStatuses" + }, "SearchAvailablePhoneNumbers": { "input_token": "NextToken", "limit_key": "MaxResults", @@ -397,6 +406,15 @@ "output_token": "NextToken", "result_key": "SecurityProfiles" }, + "SearchUserHierarchyGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "non_aggregate_keys": [ + "ApproximateTotalCount" + ], + "output_token": "NextToken", + "result_key": "UserHierarchyGroups" + }, "SearchUsers": { "input_token": "NextToken", "limit_key": "MaxResults", diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index 878ff1774f5..2b89c1c2fcc 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -694,6 +694,15 @@ "input":{"shape":"CreateIpamRequest"}, "output":{"shape":"CreateIpamResult"} }, + "CreateIpamExternalResourceVerificationToken":{ + "name":"CreateIpamExternalResourceVerificationToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIpamExternalResourceVerificationTokenRequest"}, + "output":{"shape":"CreateIpamExternalResourceVerificationTokenResult"} + }, "CreateIpamPool":{ "name":"CreateIpamPool", "http":{ @@ -1372,6 +1381,15 @@ "input":{"shape":"DeleteIpamRequest"}, "output":{"shape":"DeleteIpamResult"} }, + "DeleteIpamExternalResourceVerificationToken":{ + "name":"DeleteIpamExternalResourceVerificationToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIpamExternalResourceVerificationTokenRequest"}, + "output":{"shape":"DeleteIpamExternalResourceVerificationTokenResult"} + }, "DeleteIpamPool":{ "name":"DeleteIpamPool", "http":{ @@ -2471,6 +2489,15 @@ "input":{"shape":"DescribeIpamByoasnRequest"}, "output":{"shape":"DescribeIpamByoasnResult"} }, + "DescribeIpamExternalResourceVerificationTokens":{ + "name":"DescribeIpamExternalResourceVerificationTokens", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIpamExternalResourceVerificationTokensRequest"}, + "output":{"shape":"DescribeIpamExternalResourceVerificationTokensResult"} + }, "DescribeIpamPools":{ "name":"DescribeIpamPools", "http":{ @@ -10951,6 +10978,31 @@ } } }, + "CreateIpamExternalResourceVerificationTokenRequest":{ + "type":"structure", + "required":["IpamId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamId":{"shape":"IpamId"}, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "locationName":"TagSpecification" + }, + "ClientToken":{ + "shape":"String", + "idempotencyToken":true + } + } + }, + "CreateIpamExternalResourceVerificationTokenResult":{ + "type":"structure", + "members":{ + "IpamExternalResourceVerificationToken":{ + "shape":"IpamExternalResourceVerificationToken", + "locationName":"ipamExternalResourceVerificationToken" + } + } + }, "CreateIpamPoolRequest":{ "type":"structure", "required":[ @@ -13475,6 +13527,23 @@ } } }, + "DeleteIpamExternalResourceVerificationTokenRequest":{ + "type":"structure", + "required":["IpamExternalResourceVerificationTokenId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamExternalResourceVerificationTokenId":{"shape":"IpamExternalResourceVerificationTokenId"} + } + }, + "DeleteIpamExternalResourceVerificationTokenResult":{ + "type":"structure", + "members":{ + "IpamExternalResourceVerificationToken":{ + "shape":"IpamExternalResourceVerificationToken", + "locationName":"ipamExternalResourceVerificationToken" + } + } + }, "DeleteIpamPoolRequest":{ "type":"structure", "required":["IpamPoolId"], @@ -16623,6 +16692,35 @@ } } }, + "DescribeIpamExternalResourceVerificationTokensRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "Filters":{ + "shape":"FilterList", + "locationName":"Filter" + }, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"IpamMaxResults"}, + "IpamExternalResourceVerificationTokenIds":{ + "shape":"ValueStringList", + "locationName":"IpamExternalResourceVerificationTokenId" + } + } + }, + "DescribeIpamExternalResourceVerificationTokensResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "locationName":"nextToken" + }, + "IpamExternalResourceVerificationTokens":{ + "shape":"IpamExternalResourceVerificationTokenSet", + "locationName":"ipamExternalResourceVerificationTokenSet" + } + } + }, "DescribeIpamPoolsRequest":{ "type":"structure", "members":{ @@ -29547,6 +29645,74 @@ } } }, + "IpamExternalResourceVerificationToken":{ + "type":"structure", + "members":{ + "IpamExternalResourceVerificationTokenId":{ + "shape":"IpamExternalResourceVerificationTokenId", + "locationName":"ipamExternalResourceVerificationTokenId" + }, + "IpamExternalResourceVerificationTokenArn":{ + "shape":"ResourceArn", + "locationName":"ipamExternalResourceVerificationTokenArn" + }, + "IpamId":{ + "shape":"IpamId", + "locationName":"ipamId" + }, + "IpamArn":{ + "shape":"ResourceArn", + "locationName":"ipamArn" + }, + "IpamRegion":{ + "shape":"String", + "locationName":"ipamRegion" + }, + "TokenValue":{ + "shape":"String", + "locationName":"tokenValue" + }, + "TokenName":{ + "shape":"String", + "locationName":"tokenName" + }, + "NotAfter":{ + "shape":"MillisecondDateTime", + "locationName":"notAfter" + }, + "Status":{ + "shape":"TokenState", + "locationName":"status" + }, + "Tags":{ + "shape":"TagList", + "locationName":"tagSet" + }, + "State":{ + "shape":"IpamExternalResourceVerificationTokenState", + "locationName":"state" + } + } + }, + "IpamExternalResourceVerificationTokenId":{"type":"string"}, + "IpamExternalResourceVerificationTokenSet":{ + "type":"list", + "member":{ + "shape":"IpamExternalResourceVerificationToken", + "locationName":"item" + } + }, + "IpamExternalResourceVerificationTokenState":{ + "type":"string", + "enum":[ + "create-in-progress", + "create-complete", + "create-failed", + "delete-in-progress", + "delete-complete", + "delete-failed" + ] + }, "IpamId":{"type":"string"}, "IpamManagementState":{ "type":"string", @@ -37053,7 +37219,9 @@ "ClientToken":{ "shape":"String", "idempotencyToken":true - } + }, + "VerificationMethod":{"shape":"VerificationMethod"}, + "IpamExternalResourceVerificationTokenId":{"shape":"IpamExternalResourceVerificationTokenId"} } }, "ProvisionIpamPoolCidrResult":{ @@ -39219,7 +39387,8 @@ "vpc-encryption-control", "ipam-resource-discovery", "ipam-resource-discovery-association", - "instance-connect-endpoint" + "instance-connect-endpoint", + "ipam-external-resource-verification-token" ] }, "ResponseError":{ @@ -43098,6 +43267,13 @@ "permanent-restore-failed" ] }, + "TokenState":{ + "type":"string", + "enum":[ + "valid", + "expired" + ] + }, "TotalLocalStorageGB":{ "type":"structure", "members":{ @@ -45484,6 +45660,13 @@ "locationName":"item" } }, + "VerificationMethod":{ + "type":"string", + "enum":[ + "remarks-x509", + "dns-token" + ] + }, "VerifiedAccessEndpoint":{ "type":"structure", "members":{ diff --git a/models/apis/ec2/2016-11-15/docs-2.json b/models/apis/ec2/2016-11-15/docs-2.json index 0adea954289..14ac36f431e 100755 --- a/models/apis/ec2/2016-11-15/docs-2.json +++ b/models/apis/ec2/2016-11-15/docs-2.json @@ -78,6 +78,7 @@ "CreateInstanceExportTask": "Exports a running or stopped instance to an Amazon S3 bucket.
For information about the prerequisites for your Amazon S3 bucket, supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
", "CreateInternetGateway": "Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information, see Internet gateways in the Amazon VPC User Guide.
", "CreateIpam": "Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
", + "CreateIpamExternalResourceVerificationToken": "Create a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
", "CreateIpamPool": "Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
", "CreateIpamResourceDiscovery": "Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
", "CreateIpamScope": "Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see Add a scope in the Amazon VPC IPAM User Guide.
", @@ -154,6 +155,7 @@ "DeleteInstanceEventWindow": "Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
", "DeleteInternetGateway": "Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
", "DeleteIpam": "Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.
For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.
", + "DeleteIpamExternalResourceVerificationToken": "Delete a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
", "DeleteIpamPool": "Delete an IPAM pool.
You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.
For more information, see Delete a pool in the Amazon VPC IPAM User Guide.
", "DeleteIpamResourceDiscovery": "Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
", "DeleteIpamScope": "Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
", @@ -278,6 +280,7 @@ "DescribeInstances": "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 your internet gateways. The default is to describe all your internet gateways. Alternatively, you can specify specific internet gateway IDs or filter the results to include only the internet gateways that match specific criteria.
", "DescribeIpamByoasn": "Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
", + "DescribeIpamExternalResourceVerificationTokens": "Describe verification tokens. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
", "DescribeIpamPools": "Get information about your IPAM pools.
", "DescribeIpamResourceDiscoveries": "Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
", "DescribeIpamResourceDiscoveryAssociations": "Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..
", @@ -306,7 +309,7 @@ "DescribeNetworkInterfaceAttribute": "Describes a network interface attribute. You can specify only one attribute at a time.
", "DescribeNetworkInterfacePermissions": "Describes the permissions for your network interfaces.
", "DescribeNetworkInterfaces": "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 placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.
", + "DescribePlacementGroups": "Describes the specified placement groups or all of your placement groups.
To describe a specific placement group that is shared with your account, you must specify the ID of the placement group using the GroupId parameter. Specifying the name of a shared placement group using the GroupNames parameter will result in an error.
For more information, see Placement groups in the Amazon EC2 User Guide.
", "DescribePrefixLists": "Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
We recommend that you use DescribeManagedPrefixLists instead.
", "DescribePrincipalIdFormat": "Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Describes the specified IPv4 address pools.
", @@ -358,7 +361,7 @@ "DescribeVolumeAttribute": "Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
", "DescribeVolumeStatus": "Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitor the status of your volumes in the Amazon EBS User Guide.
Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.
Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)
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 most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.
For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.
", + "DescribeVolumesModifications": "Describes the most recent volume modification request for the specified EBS volumes.
For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.
", "DescribeVpcAttribute": "Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
", "DescribeVpcClassicLink": "This action is deprecated.
Describes the ClassicLink status of the specified VPCs.
", "DescribeVpcClassicLinkDnsSupport": "This action is deprecated.
Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance.
", @@ -436,7 +439,7 @@ "GetAwsNetworkPerformanceData": "Gets network performance data.
", "GetCapacityReservationUsage": "Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.
", "GetCoipPoolUsage": "Describes the allocations from the specified customer-owned address pool.
", - "GetConsoleOutput": "Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide.
", + "GetConsoleOutput": "Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
For more information, see Instance console output in the Amazon EC2 User Guide.
", "GetConsoleScreenshot": "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": "Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
", "GetEbsDefaultKmsKeyId": "Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
", @@ -2067,6 +2070,7 @@ "CreateInstanceConnectEndpointRequest$PreserveClientIp": "Indicates whether the client IP address is preserved as the source. The following are the possible values.
true - Use the client IP address as the source.
false - Use the network interface IP address as the source.
Default: false
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.
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.
A check for 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.
A check for 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.
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
", "CreateIpamPoolRequest$PubliclyAdvertisable": "Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.
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.
Specify true to force delete the event window. Use the force delete parameter if the event window is currently associated with targets.
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.
A check for 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.
A check for 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.
Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
You can only use this option to delete pools in the private scope or pools in the public scope with a source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
A check for 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.
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.
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.
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.
A check for 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.
A check for 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.
A check for 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.
A check for 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 number of capacity units fulfilled by the Capacity Reservation. For more information, see Total target capacity in the Amazon EC2 User Guide.
", "FleetData$FulfilledCapacity": "The number of units fulfilled by this request compared to the set target capacity.
", "FleetData$FulfilledOnDemandCapacity": "The number of units fulfilled by this request compared to the set target On-Demand capacity.
", - "FleetLaunchTemplateOverrides$WeightedCapacity": "The number of units provided by the specified instance type.
When specifying weights, the price used in the lowest-price and price-capacity-optimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
When specifying weights, the price used in the lowest-price and price-capacity-optimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
The number of units provided by the specified instance type.
When specifying weights, the price used in the lowest-price and price-capacity-optimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
When specifying weights, the price used in the lowest-price and price-capacity-optimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
The number of units provided by the specified instance type.
When specifying weights, the price used in the lowest-price and price-capacity-optimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
When specifying weights, the price used in the lowestPrice and priceCapacityOptimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
The priority for the launch template override. The highest priority is launched first.
If OnDemandAllocationStrategy is set to prioritized, Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.
", "MemoryGiBPerVCpu$Max": "The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.
", @@ -8600,7 +8636,7 @@ "ReservedInstanceLimitPrice$Amount": "Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
", "SnapshotDetail$DiskImageSize": "The size of the disk in the snapshot, in GiB.
", "SnapshotTaskDetail$DiskImageSize": "The size of the disk in the snapshot, in GiB.
", - "SpotFleetLaunchSpecification$WeightedCapacity": "The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
", + "SpotFleetLaunchSpecification$WeightedCapacity": "The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
When specifying weights, the price used in the lowestPrice and priceCapacityOptimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
", "SpotFleetRequestConfigData$OnDemandFulfilledCapacity": "The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
", "TotalLocalStorageGB$Min": "The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.
", @@ -9521,6 +9557,7 @@ "DescribeInstanceTypesRequest$Filters": "One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, \"25 Gigabit\").
nitro-enclaves-support - Indicates whether Nitro Enclaves is supported (supported | unsupported).
nitro-tpm-support - Indicates whether NitroTPM is supported (supported | unsupported).
nitro-tpm-info.supported-versions - The supported NitroTPM version (2.0).
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
processor-info.supported-features - The supported CPU features (amd-sev-snp).
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
boot-mode - The boot mode that was specified by the AMI (legacy-bios | uefi | uefi-preferred).
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity Reservation preference (open | none).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn - The ARN of the targeted Capacity Reservation group.
client-token - The idempotency token you provided when you launched the instance.
current-instance-boot-mode - The boot mode that is used to launch the instance at launch or start (legacy-bios | uefi).
dns-name - The public DNS name of the instance.
ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.
enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.
iam-instance-profile.name - The instance profile associated with the instance. Specified as an name.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (spot | scheduled | capacity-block).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
ipv6-address - The IPv6 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (disabled | default).
metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)
metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (disabled | enabled).
metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (disabled | enabled).
metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata (enabled | disabled)
metadata-options.state - The state of the metadata option changes (pending | applied).
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.association.allocation-id - The allocation ID.
network-interface.addresses.association.association-id - The association ID.
network-interface.addresses.association.carrier-ip - The carrier IP address.
network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.addresses.association.public-dns-name - The public DNS name.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.private-dns-name - The private DNS name.
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.association.carrier-ip - The customer-owned IP address.
network-interface.association.customer-owned-ip - The customer-owned IP address.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.public-dns-name - The public DNS name.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.network-card-index - The index of the network card.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.
network-interface.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the primary IPv6 address.
network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network interface.
network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.outpost-arn - The ARN of the Outpost.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.private-ip-address - The private IPv4 address.
network-interface.public-dns-name - The public DNS name.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.tag-key - The key of a tag assigned to the network interface.
network-interface.tag-value - The value of a tag assigned to the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with SQL Server Enterprise and HA | Red Hat Enterprise Linux with SQL Server Standard | Red Hat Enterprise Linux with SQL Server Web | Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise | SQL Server Standard | SQL Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web).
private-dns-name - The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type - The type of hostname (ip-name | resource-name).
private-ip-address - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter network-interface.addresses.private-ip-address.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
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.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).
usage-operation - The usage operation value for the instance (RunInstances | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 | RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 | RunInstances:0110 | RunInstances:0100 | RunInstances:0004 | RunInstances:0200 | RunInstances:000g | RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 | RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
usage-operation-update-time - The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z.
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet 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.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
Available filters:
ipam-arn
ipam-external-resource-verification-token-arn
ipam-external-resource-verification-token-id
ipam-id
ipam-region
state
status
token-name
token-value
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", "DescribeIpamResourceDiscoveriesRequest$Filters": "The resource discovery filters.
", "DescribeIpamResourceDiscoveryAssociationsRequest$Filters": "The resource discovery association filters.
", @@ -12696,7 +12733,7 @@ "IpamCidrAuthorizationContext": { "base": "A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
", "refs": { - "ProvisionIpamPoolCidrRequest$CidrAuthorizationContext": "A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
" + "ProvisionIpamPoolCidrRequest$CidrAuthorizationContext": "A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.
" } }, "IpamComplianceStatus": { @@ -12754,15 +12791,45 @@ "IpamDiscoveredAccount$FailureReason": "The resource discovery failure reason.
" } }, + "IpamExternalResourceVerificationToken": { + "base": "A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
", + "refs": { + "CreateIpamExternalResourceVerificationTokenResult$IpamExternalResourceVerificationToken": "The verification token.
", + "DeleteIpamExternalResourceVerificationTokenResult$IpamExternalResourceVerificationToken": "The verification token.
", + "IpamExternalResourceVerificationTokenSet$member": null + } + }, + "IpamExternalResourceVerificationTokenId": { + "base": null, + "refs": { + "DeleteIpamExternalResourceVerificationTokenRequest$IpamExternalResourceVerificationTokenId": "The token ID.
", + "IpamExternalResourceVerificationToken$IpamExternalResourceVerificationTokenId": "The ID of the token.
", + "ProvisionIpamPoolCidrRequest$IpamExternalResourceVerificationTokenId": "Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.
" + } + }, + "IpamExternalResourceVerificationTokenSet": { + "base": null, + "refs": { + "DescribeIpamExternalResourceVerificationTokensResult$IpamExternalResourceVerificationTokens": "Verification tokens.
" + } + }, + "IpamExternalResourceVerificationTokenState": { + "base": null, + "refs": { + "IpamExternalResourceVerificationToken$State": "Token state.
" + } + }, "IpamId": { "base": null, "refs": { "AssociateIpamResourceDiscoveryRequest$IpamId": "An IPAM ID.
", "Byoasn$IpamId": "An IPAM ID.
", + "CreateIpamExternalResourceVerificationTokenRequest$IpamId": "The ID of the IPAM that will create the token.
", "CreateIpamScopeRequest$IpamId": "The ID of the IPAM for which you're creating this scope.
", "DeleteIpamRequest$IpamId": "The ID of the IPAM to delete.
", "DeprovisionIpamByoasnRequest$IpamId": "The IPAM ID.
", "Ipam$IpamId": "The ID of the IPAM.
", + "IpamExternalResourceVerificationToken$IpamId": "The ID of the IPAM that created the token.
", "IpamResourceCidr$IpamId": "The IPAM ID for an IPAM resource.
", "IpamResourceDiscoveryAssociation$IpamId": "The IPAM ID.
", "ModifyIpamRequest$IpamId": "The ID of the IPAM you want to modify.
", @@ -12778,6 +12845,7 @@ "IpamMaxResults": { "base": null, "refs": { + "DescribeIpamExternalResourceVerificationTokensRequest$MaxResults": "The maximum number of tokens to return in one page of results.
", "DescribeIpamPoolsRequest$MaxResults": "The maximum number of results to return in the request.
", "DescribeIpamResourceDiscoveriesRequest$MaxResults": "The maximum number of resource discoveries to return in one page of results.
", "DescribeIpamResourceDiscoveryAssociationsRequest$MaxResults": "The maximum number of resource discovery associations to return in one page of results.
", @@ -12807,7 +12875,7 @@ "IpamNetworkInterfaceAttachmentStatus": { "base": null, "refs": { - "IpamDiscoveredResourceCidr$NetworkInterfaceAttachmentStatus": "For elastic IP addresses, this is the status of an attached network interface.
" + "IpamDiscoveredResourceCidr$NetworkInterfaceAttachmentStatus": "For elastic network interfaces, this is the status of whether or not the elastic network interface is attached.
" } }, "IpamOperatingRegion": { @@ -14714,6 +14782,7 @@ "IpamDiscoveredAccount$LastSuccessfulDiscoveryTime": "The last successful resource discovery time.
", "IpamDiscoveredPublicAddress$SampleTime": "The last successful resource discovery time.
", "IpamDiscoveredResourceCidr$SampleTime": "The last successful resource discovery time.
", + "IpamExternalResourceVerificationToken$NotAfter": "Token expiration.
", "KeyPairInfo$CreateTime": "If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone.
If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone.
", "LockSnapshotRequest$ExpirationDate": "The date and time at which the snapshot lock is to automatically expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
You must specify either this parameter or LockDuration, but not both.
", "LockSnapshotResult$CoolOffPeriodExpiresOn": "The date and time at which the compliance mode cooling-off period expires, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "DescribeInstanceTypesResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token for the next page of results.
", + "DescribeIpamExternalResourceVerificationTokensRequest$NextToken": "The token for the next page of results.
", + "DescribeIpamExternalResourceVerificationTokensResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next page of results.
", "DescribeIpamPoolsResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Specify the pagination token from a previous request to retrieve the next page of results.
", @@ -16669,7 +16740,7 @@ "PlacementGroupStringList": { "base": null, "refs": { - "DescribePlacementGroupsRequest$GroupNames": "The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
" + "DescribePlacementGroupsRequest$GroupNames": "The names of the placement groups.
Constraints:
You can specify a name only if the placement group is owned by your account.
If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.
The ARN of the stateful rule group.
", "FirewallStatelessRule$RuleGroupArn": "The ARN of the stateless rule group.
", "Ipam$IpamArn": "The Amazon Resource Name (ARN) of the IPAM.
", + "IpamExternalResourceVerificationToken$IpamExternalResourceVerificationTokenArn": "Token ARN.
", + "IpamExternalResourceVerificationToken$IpamArn": "ARN of the IPAM that created the token.
", "IpamPool$IpamPoolArn": "The Amazon Resource Name (ARN) of the IPAM pool.
", "IpamPool$IpamScopeArn": "The ARN of the scope of the IPAM pool.
", "IpamPool$IpamArn": "The ARN of the IPAM.
", @@ -19672,7 +19745,8 @@ "CreateInstanceConnectEndpointResult$ClientToken": "Unique, case-sensitive idempotency token provided by the client in the the request.
", "CreateInstanceEventWindowRequest$Name": "The name of the event window.
", "CreateInstanceExportTaskRequest$Description": "A description for the conversion task or the resource being exported. The maximum length is 255 characters.
", - "CreateIpamPoolRequest$Locale": "In IPAM, the locale is the Amazon Web Services Region or, for IPAM IPv4 pools in the public scope, the network border group for an Amazon Web Services Local Zone where you want to make an IPAM pool available for allocations (supported Local Zones). If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
", + "CreateIpamExternalResourceVerificationTokenRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", + "CreateIpamPoolRequest$Locale": "The locale for the pool should be one of the following:
An Amazon Web Services Region where you want this IPAM pool to be available for allocations.
The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.
If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone.
", "CreateIpamPoolRequest$Description": "A description for the IPAM pool.
", "CreateIpamPoolRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "CreateIpamRequest$Description": "A description for the IPAM.
", @@ -20503,10 +20577,13 @@ "IpamDiscoveredResourceCidr$VpcId": "The VPC ID.
", "IpamDiscoveredResourceCidr$AvailabilityZoneId": "The Availability Zone ID.
", "IpamDiscoveryFailureReason$Message": "The discovery failure message.
", + "IpamExternalResourceVerificationToken$IpamRegion": "Region of the IPAM that created the token.
", + "IpamExternalResourceVerificationToken$TokenValue": "Token value.
", + "IpamExternalResourceVerificationToken$TokenName": "Token name.
", "IpamOperatingRegion$RegionName": "The name of the operating Region.
", "IpamPool$OwnerId": "The Amazon Web Services account ID of the owner of the IPAM pool.
", "IpamPool$IpamRegion": "The Amazon Web Services Region of the IPAM pool.
", - "IpamPool$Locale": "The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region or, for IPAM IPv4 pools in the public scope, the network border group for an Amazon Web Services Local Zone where you want to make an IPAM pool available for allocations (supported Local Zones). If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
", + "IpamPool$Locale": "The locale of the IPAM pool.
The locale for the pool should be one of the following:
An Amazon Web Services Region where you want this IPAM pool to be available for allocations.
The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.
If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
", "IpamPool$StateMessage": "The state message.
", "IpamPool$Description": "The description of the IPAM pool.
", "IpamPoolAllocation$Cidr": "The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.
The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window.
", "InternetGateway$Tags": "Any tags assigned to the internet gateway.
", "Ipam$Tags": "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.
Token tags.
", "IpamPool$Tags": "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.
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
", "IpamResourceDiscoveryAssociation$Tags": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
", @@ -21875,6 +21953,7 @@ "CreateInstanceEventWindowRequest$TagSpecifications": "The tags to apply to the event window.
", "CreateInstanceExportTaskRequest$TagSpecifications": "The tags to apply to the export instance task during creation.
", "CreateInternetGatewayRequest$TagSpecifications": "The tags to assign to the internet gateway.
", + "CreateIpamExternalResourceVerificationTokenRequest$TagSpecifications": "Token tags.
", "CreateIpamPoolRequest$TagSpecifications": "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 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.
Tag specifications for the IPAM resource discovery.
", @@ -22129,6 +22208,12 @@ "SnapshotTierStatus$LastTieringOperationStatus": "The status of the last archive or restore process.
" } }, + "TokenState": { + "base": null, + "refs": { + "IpamExternalResourceVerificationToken$Status": "Token status.
" + } + }, "TotalLocalStorageGB": { "base": "The minimum and maximum amount of total local storage, in GB.
", "refs": { @@ -23456,6 +23541,7 @@ "CreateVpcEndpointServiceConfigurationRequest$SupportedIpAddressTypes": "The supported IP address types. The possible values are ipv4 and ipv6.
The IDs of the target network associations.
", "DescribeInstanceConnectEndpointsRequest$InstanceConnectEndpointIds": "One or more EC2 Instance Connect Endpoint IDs.
", + "DescribeIpamExternalResourceVerificationTokensRequest$IpamExternalResourceVerificationTokenIds": "Verification token IDs.
", "DescribeIpamPoolsRequest$IpamPoolIds": "The IDs of the IPAM pools you would like information on.
", "DescribeIpamResourceDiscoveriesRequest$IpamResourceDiscoveryIds": "The IPAM resource discovery IDs.
", "DescribeIpamResourceDiscoveryAssociationsRequest$IpamResourceDiscoveryAssociationIds": "The resource discovery association IDs.
", @@ -23526,6 +23612,12 @@ "VpcEndpointConnection$GatewayLoadBalancerArns": "The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
" } }, + "VerificationMethod": { + "base": null, + "refs": { + "ProvisionIpamPoolCidrRequest$VerificationMethod": "The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.
An Amazon Web Services Verified Access endpoint specifies the application that Amazon Web Services Verified Access provides access to. It must be attached to an Amazon Web Services Verified Access group. An Amazon Web Services Verified Access endpoint must also have an attached access policy before you attached it to a group.
", "refs": { @@ -23960,7 +24052,7 @@ } }, "VolumeModification": { - "base": "Describes the modification status of an EBS volume.
If the volume has never been modified, some element values will be null.
", + "base": "Describes the modification status of an EBS volume.
", "refs": { "ModifyVolumeResult$VolumeModification": "Information about the volume modification.
", "VolumeModificationList$member": null @@ -23975,7 +24067,7 @@ "VolumeModificationState": { "base": null, "refs": { - "VolumeModification$ModificationState": "The current modification state. The modification state is null for unmodified volumes.
" + "VolumeModification$ModificationState": "The current modification state.
" } }, "VolumeState": { diff --git a/models/apis/firehose/2015-08-04/api-2.json b/models/apis/firehose/2015-08-04/api-2.json index 8723cc879a9..01e79847962 100644 --- a/models/apis/firehose/2015-08-04/api-2.json +++ b/models/apis/firehose/2015-08-04/api-2.json @@ -447,6 +447,12 @@ "IntervalInSeconds":{"shape":"IntervalInSeconds"} } }, + "CatalogConfiguration":{ + "type":"structure", + "members":{ + "CatalogARN":{"shape":"GlueDataCatalogARN"} + } + }, "CloudWatchLoggingOptions":{ "type":"structure", "members":{ @@ -533,7 +539,8 @@ "Tags":{"shape":"TagDeliveryStreamInputTagList"}, "AmazonOpenSearchServerlessDestinationConfiguration":{"shape":"AmazonOpenSearchServerlessDestinationConfiguration"}, "MSKSourceConfiguration":{"shape":"MSKSourceConfiguration"}, - "SnowflakeDestinationConfiguration":{"shape":"SnowflakeDestinationConfiguration"} + "SnowflakeDestinationConfiguration":{"shape":"SnowflakeDestinationConfiguration"}, + "IcebergDestinationConfiguration":{"shape":"IcebergDestinationConfiguration"} } }, "CreateDeliveryStreamOutput":{ @@ -749,7 +756,8 @@ "SplunkDestinationDescription":{"shape":"SplunkDestinationDescription"}, "HttpEndpointDestinationDescription":{"shape":"HttpEndpointDestinationDescription"}, "SnowflakeDestinationDescription":{"shape":"SnowflakeDestinationDescription"}, - "AmazonOpenSearchServerlessDestinationDescription":{"shape":"AmazonOpenSearchServerlessDestinationDescription"} + "AmazonOpenSearchServerlessDestinationDescription":{"shape":"AmazonOpenSearchServerlessDestinationDescription"}, + "IcebergDestinationDescription":{"shape":"IcebergDestinationDescription"} } }, "DestinationDescriptionList":{ @@ -762,6 +770,23 @@ "min":1, "pattern":"[a-zA-Z0-9-]+" }, + "DestinationTableConfiguration":{ + "type":"structure", + "required":[ + "DestinationTableName", + "DestinationDatabaseName" + ], + "members":{ + "DestinationTableName":{"shape":"NonEmptyStringWithoutWhitespace"}, + "DestinationDatabaseName":{"shape":"NonEmptyStringWithoutWhitespace"}, + "UniqueKeys":{"shape":"ListOfNonEmptyStringsWithoutWhitespace"}, + "S3ErrorOutputPrefix":{"shape":"ErrorOutputPrefix"} + } + }, + "DestinationTableConfigurationList":{ + "type":"list", + "member":{"shape":"DestinationTableConfiguration"} + }, "DocumentIdOptions":{ "type":"structure", "required":["DefaultDocumentIdFormat"], @@ -1008,6 +1033,12 @@ "min":0, "pattern":"^$|\\.[0-9a-z!\\-_.*'()]+" }, + "GlueDataCatalogARN":{ + "type":"string", + "max":512, + "min":1, + "pattern":"arn:.*" + }, "HECAcknowledgmentTimeoutInSeconds":{ "type":"integer", "max":600, @@ -1196,6 +1227,60 @@ "pattern":"https://.*", "sensitive":true }, + "IcebergDestinationConfiguration":{ + "type":"structure", + "required":[ + "RoleARN", + "CatalogConfiguration", + "S3Configuration" + ], + "members":{ + "DestinationTableConfigurationList":{"shape":"DestinationTableConfigurationList"}, + "BufferingHints":{"shape":"BufferingHints"}, + "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}, + "ProcessingConfiguration":{"shape":"ProcessingConfiguration"}, + "S3BackupMode":{"shape":"IcebergS3BackupMode"}, + "RetryOptions":{"shape":"RetryOptions"}, + "RoleARN":{"shape":"RoleARN"}, + "CatalogConfiguration":{"shape":"CatalogConfiguration"}, + "S3Configuration":{"shape":"S3DestinationConfiguration"} + } + }, + "IcebergDestinationDescription":{ + "type":"structure", + "members":{ + "DestinationTableConfigurationList":{"shape":"DestinationTableConfigurationList"}, + "BufferingHints":{"shape":"BufferingHints"}, + "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}, + "ProcessingConfiguration":{"shape":"ProcessingConfiguration"}, + "S3BackupMode":{"shape":"IcebergS3BackupMode"}, + "RetryOptions":{"shape":"RetryOptions"}, + "RoleARN":{"shape":"RoleARN"}, + "CatalogConfiguration":{"shape":"CatalogConfiguration"}, + "S3DestinationDescription":{"shape":"S3DestinationDescription"} + } + }, + "IcebergDestinationUpdate":{ + "type":"structure", + "members":{ + "DestinationTableConfigurationList":{"shape":"DestinationTableConfigurationList"}, + "BufferingHints":{"shape":"BufferingHints"}, + "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}, + "ProcessingConfiguration":{"shape":"ProcessingConfiguration"}, + "S3BackupMode":{"shape":"IcebergS3BackupMode"}, + "RetryOptions":{"shape":"RetryOptions"}, + "RoleARN":{"shape":"RoleARN"}, + "CatalogConfiguration":{"shape":"CatalogConfiguration"}, + "S3Configuration":{"shape":"S3DestinationConfiguration"} + } + }, + "IcebergS3BackupMode":{ + "type":"string", + "enum":[ + "FailedDataOnly", + "AllData" + ] + }, "InputFormatConfiguration":{ "type":"structure", "members":{ @@ -1367,7 +1452,8 @@ "members":{ "MSKClusterARN":{"shape":"MSKClusterARN"}, "TopicName":{"shape":"TopicName"}, - "AuthenticationConfiguration":{"shape":"AuthenticationConfiguration"} + "AuthenticationConfiguration":{"shape":"AuthenticationConfiguration"}, + "ReadFromTimestamp":{"shape":"ReadFromTimestamp"} } }, "MSKSourceDescription":{ @@ -1376,7 +1462,8 @@ "MSKClusterARN":{"shape":"MSKClusterARN"}, "TopicName":{"shape":"TopicName"}, "AuthenticationConfiguration":{"shape":"AuthenticationConfiguration"}, - "DeliveryStartTimestamp":{"shape":"DeliveryStartTimestamp"} + "DeliveryStartTimestamp":{"shape":"DeliveryStartTimestamp"}, + "ReadFromTimestamp":{"shape":"ReadFromTimestamp"} } }, "NoEncryptionConfig":{ @@ -1632,6 +1719,7 @@ "type":"string", "min":1 }, + "ReadFromTimestamp":{"type":"timestamp"}, "Record":{ "type":"structure", "required":["Data"], @@ -1866,6 +1954,23 @@ "pattern":".+?\\.snowflakecomputing\\.com", "sensitive":true }, + "SnowflakeBufferingHints":{ + "type":"structure", + "members":{ + "SizeInMBs":{"shape":"SnowflakeBufferingSizeInMBs"}, + "IntervalInSeconds":{"shape":"SnowflakeBufferingIntervalInSeconds"} + } + }, + "SnowflakeBufferingIntervalInSeconds":{ + "type":"integer", + "max":900, + "min":0 + }, + "SnowflakeBufferingSizeInMBs":{ + "type":"integer", + "max":128, + "min":1 + }, "SnowflakeContentColumnName":{ "type":"string", "max":255, @@ -1915,7 +2020,8 @@ "RetryOptions":{"shape":"SnowflakeRetryOptions"}, "S3BackupMode":{"shape":"SnowflakeS3BackupMode"}, "S3Configuration":{"shape":"S3DestinationConfiguration"}, - "SecretsManagerConfiguration":{"shape":"SecretsManagerConfiguration"} + "SecretsManagerConfiguration":{"shape":"SecretsManagerConfiguration"}, + "BufferingHints":{"shape":"SnowflakeBufferingHints"} } }, "SnowflakeDestinationDescription":{ @@ -1937,7 +2043,8 @@ "RetryOptions":{"shape":"SnowflakeRetryOptions"}, "S3BackupMode":{"shape":"SnowflakeS3BackupMode"}, "S3DestinationDescription":{"shape":"S3DestinationDescription"}, - "SecretsManagerConfiguration":{"shape":"SecretsManagerConfiguration"} + "SecretsManagerConfiguration":{"shape":"SecretsManagerConfiguration"}, + "BufferingHints":{"shape":"SnowflakeBufferingHints"} } }, "SnowflakeDestinationUpdate":{ @@ -1960,7 +2067,8 @@ "RetryOptions":{"shape":"SnowflakeRetryOptions"}, "S3BackupMode":{"shape":"SnowflakeS3BackupMode"}, "S3Update":{"shape":"S3DestinationUpdate"}, - "SecretsManagerConfiguration":{"shape":"SecretsManagerConfiguration"} + "SecretsManagerConfiguration":{"shape":"SecretsManagerConfiguration"}, + "BufferingHints":{"shape":"SnowflakeBufferingHints"} } }, "SnowflakeKeyPassphrase":{ @@ -2264,7 +2372,8 @@ "SplunkDestinationUpdate":{"shape":"SplunkDestinationUpdate"}, "HttpEndpointDestinationUpdate":{"shape":"HttpEndpointDestinationUpdate"}, "AmazonOpenSearchServerlessDestinationUpdate":{"shape":"AmazonOpenSearchServerlessDestinationUpdate"}, - "SnowflakeDestinationUpdate":{"shape":"SnowflakeDestinationUpdate"} + "SnowflakeDestinationUpdate":{"shape":"SnowflakeDestinationUpdate"}, + "IcebergDestinationUpdate":{"shape":"IcebergDestinationUpdate"} } }, "UpdateDestinationOutput":{ diff --git a/models/apis/firehose/2015-08-04/docs-2.json b/models/apis/firehose/2015-08-04/docs-2.json index 2e733191152..30dc78a9625 100644 --- a/models/apis/firehose/2015-08-04/docs-2.json +++ b/models/apis/firehose/2015-08-04/docs-2.json @@ -250,11 +250,22 @@ "ExtendedS3DestinationConfiguration$BufferingHints": "The buffering option.
", "ExtendedS3DestinationDescription$BufferingHints": "The buffering option.
", "ExtendedS3DestinationUpdate$BufferingHints": "The buffering option.
", + "IcebergDestinationConfiguration$BufferingHints": null, + "IcebergDestinationDescription$BufferingHints": null, + "IcebergDestinationUpdate$BufferingHints": null, "S3DestinationConfiguration$BufferingHints": "The buffering option. If no value is specified, BufferingHints object default values are used.
The buffering option. If no value is specified, BufferingHints object default values are used.
The buffering option. If no value is specified, BufferingHints object default values are used.
Describes the containers where the destination Apache Iceberg Tables are persisted.
Amazon Data Firehose is in preview release and is subject to change.
", + "refs": { + "IcebergDestinationConfiguration$CatalogConfiguration": "Configuration describing where the destination Apache Iceberg Tables are persisted.
Amazon Data Firehose is in preview release and is subject to change.
", + "IcebergDestinationDescription$CatalogConfiguration": "Configuration describing where the destination Iceberg tables are persisted.
Amazon Data Firehose is in preview release and is subject to change.
", + "IcebergDestinationUpdate$CatalogConfiguration": "Configuration describing where the destination Iceberg tables are persisted.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, "CloudWatchLoggingOptions": { "base": "Describes the Amazon CloudWatch logging options for your delivery stream.
", "refs": { @@ -273,6 +284,9 @@ "HttpEndpointDestinationConfiguration$CloudWatchLoggingOptions": null, "HttpEndpointDestinationDescription$CloudWatchLoggingOptions": null, "HttpEndpointDestinationUpdate$CloudWatchLoggingOptions": null, + "IcebergDestinationConfiguration$CloudWatchLoggingOptions": null, + "IcebergDestinationDescription$CloudWatchLoggingOptions": null, + "IcebergDestinationUpdate$CloudWatchLoggingOptions": null, "RedshiftDestinationConfiguration$CloudWatchLoggingOptions": "The CloudWatch logging options for your delivery stream.
", "RedshiftDestinationDescription$CloudWatchLoggingOptions": "The Amazon CloudWatch logging options for your delivery stream.
", "RedshiftDestinationUpdate$CloudWatchLoggingOptions": "The Amazon CloudWatch logging options for your delivery stream.
", @@ -536,6 +550,20 @@ "UpdateDestinationInput$DestinationId": "The ID of the destination.
" } }, + "DestinationTableConfiguration": { + "base": "Describes the configuration of a destination in Apache Iceberg Tables.
Amazon Data Firehose is in preview release and is subject to change.
", + "refs": { + "DestinationTableConfigurationList$member": null + } + }, + "DestinationTableConfigurationList": { + "base": null, + "refs": { + "IcebergDestinationConfiguration$DestinationTableConfigurationList": " Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg tables.
Amazon Data Firehose is in preview release and is subject to change.
", + "IcebergDestinationDescription$DestinationTableConfigurationList": " Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg tables.
Amazon Data Firehose is in preview release and is subject to change.
", + "IcebergDestinationUpdate$DestinationTableConfigurationList": " Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg tables.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, "DocumentIdOptions": { "base": "Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
", "refs": { @@ -690,6 +718,7 @@ "ErrorOutputPrefix": { "base": null, "refs": { + "DestinationTableConfiguration$S3ErrorOutputPrefix": "The table specific S3 error output prefix. All the errors that occurred while delivering to this table will be prefixed with this value in S3 destination.
Amazon Data Firehose is in preview release and is subject to change.
", "ExtendedS3DestinationConfiguration$ErrorOutputPrefix": "A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
", "ExtendedS3DestinationDescription$ErrorOutputPrefix": "A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
", "ExtendedS3DestinationUpdate$ErrorOutputPrefix": "A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
", @@ -731,6 +760,12 @@ "ExtendedS3DestinationUpdate$FileExtension": "Specify a file extension. It will override the default file extension
" } }, + "GlueDataCatalogARN": { + "base": null, + "refs": { + "CatalogConfiguration$CatalogARN": " Specifies the Glue catalog ARN indentifier of the destination Apache Iceberg Tables. You must specify the ARN in the format arn:aws:glue:region:account-id:catalog.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, "HECAcknowledgmentTimeoutInSeconds": { "base": null, "refs": { @@ -894,6 +929,32 @@ "HttpEndpointDescription$Url": "The URL of the HTTP endpoint selected as the destination.
" } }, + "IcebergDestinationConfiguration": { + "base": "Specifies the destination configure settings for Apache Iceberg Table.
Amazon Data Firehose is in preview release and is subject to change.
", + "refs": { + "CreateDeliveryStreamInput$IcebergDestinationConfiguration": "Configure Apache Iceberg Tables destination.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, + "IcebergDestinationDescription": { + "base": "Describes a destination in Apache Iceberg Tables.
Amazon Data Firehose is in preview release and is subject to change.
", + "refs": { + "DestinationDescription$IcebergDestinationDescription": "Describes a destination in Apache Iceberg Tables.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, + "IcebergDestinationUpdate": { + "base": "Describes an update for a destination in Apache Iceberg Tables.
Amazon Data Firehose is in preview release and is subject to change.
", + "refs": { + "UpdateDestinationInput$IcebergDestinationUpdate": "Describes an update for a destination in Apache Iceberg Tables.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, + "IcebergS3BackupMode": { + "base": null, + "refs": { + "IcebergDestinationConfiguration$S3BackupMode": " Describes how Firehose will backup records. Currently,Firehose only supports FailedDataOnly for preview.
Amazon Data Firehose is in preview release and is subject to change.
", + "IcebergDestinationDescription$S3BackupMode": " Describes how Firehose will backup records. Currently,Firehose only supports FailedDataOnly for preview.
Amazon Data Firehose is in preview release and is subject to change.
", + "IcebergDestinationUpdate$S3BackupMode": " Describes how Firehose will backup records. Currently,Firehose only supports FailedDataOnly for preview.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, "InputFormatConfiguration": { "base": "Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true.
A list of unique keys for a given Apache Iceberg table. Firehose will use these for running Create/Update/Delete operations on the given Iceberg table.
Amazon Data Firehose is in preview release and is subject to change.
", "OrcSerDe$BloomFilterColumns": "The column names for which you want Firehose to create bloom filters. The default is null.
Specifies the name of the Apache Iceberg Table.
Amazon Data Firehose is in preview release and is subject to change.
", + "DestinationTableConfiguration$DestinationDatabaseName": "The name of the Apache Iceberg database.
Amazon Data Firehose is in preview release and is subject to change.
", "ListOfNonEmptyStringsWithoutWhitespace$member": null, "SchemaConfiguration$RoleARN": "The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.
If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.
The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.
", @@ -1178,6 +1242,9 @@ "HttpEndpointDestinationConfiguration$ProcessingConfiguration": null, "HttpEndpointDestinationDescription$ProcessingConfiguration": null, "HttpEndpointDestinationUpdate$ProcessingConfiguration": null, + "IcebergDestinationConfiguration$ProcessingConfiguration": null, + "IcebergDestinationDescription$ProcessingConfiguration": null, + "IcebergDestinationUpdate$ProcessingConfiguration": null, "RedshiftDestinationConfiguration$ProcessingConfiguration": "The data processing configuration.
", "RedshiftDestinationDescription$ProcessingConfiguration": "The data processing configuration.
", "RedshiftDestinationUpdate$ProcessingConfiguration": "The data processing configuration.
", @@ -1284,6 +1351,13 @@ "PutRecordOutput$RecordId": "The ID of the record.
" } }, + "ReadFromTimestamp": { + "base": null, + "refs": { + "MSKSourceConfiguration$ReadFromTimestamp": "The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.
If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).
The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.
If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestampUTC parameter to Epoch (1970-01-01T00:00:00Z).
The unit of data in a delivery stream.
", "refs": { @@ -1350,7 +1424,10 @@ "RetryOptions": { "base": "The retry behavior in case Firehose is unable to deliver data to an Amazon S3 prefix.
", "refs": { - "DynamicPartitioningConfiguration$RetryOptions": "The retry behavior in case Firehose is unable to deliver data to an Amazon S3 prefix.
" + "DynamicPartitioningConfiguration$RetryOptions": "The retry behavior in case Firehose is unable to deliver data to an Amazon S3 prefix.
", + "IcebergDestinationConfiguration$RetryOptions": null, + "IcebergDestinationDescription$RetryOptions": null, + "IcebergDestinationUpdate$RetryOptions": null } }, "RoleARN": { @@ -1372,6 +1449,9 @@ "HttpEndpointDestinationConfiguration$RoleARN": "Firehose uses this IAM role for all the permissions that the delivery stream needs.
", "HttpEndpointDestinationDescription$RoleARN": "Firehose uses this IAM role for all the permissions that the delivery stream needs.
", "HttpEndpointDestinationUpdate$RoleARN": "Firehose uses this IAM role for all the permissions that the delivery stream needs.
", + "IcebergDestinationConfiguration$RoleARN": "The Amazon Resource Name (ARN) of the Apache Iceberg tables role.
Amazon Data Firehose is in preview release and is subject to change.
", + "IcebergDestinationDescription$RoleARN": "The Amazon Resource Name (ARN) of the Apache Iceberg Tables role.
Amazon Data Firehose is in preview release and is subject to change.
", + "IcebergDestinationUpdate$RoleARN": "The Amazon Resource Name (ARN) of the Apache Iceberg Tables role.
Amazon Data Firehose is in preview release and is subject to change.
", "KinesisStreamSourceConfiguration$RoleARN": "The ARN of the role that provides access to the source Kinesis data stream. For more information, see Amazon Web Services Identity and Access Management (IAM) ARN Format.
", "KinesisStreamSourceDescription$RoleARN": "The ARN of the role used by the source Kinesis data stream. For more information, see Amazon Web Services Identity and Access Management (IAM) ARN Format.
", "RedshiftDestinationConfiguration$RoleARN": "The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
", @@ -1405,6 +1485,8 @@ "ElasticsearchDestinationConfiguration$S3Configuration": "The configuration for the backup Amazon S3 location.
", "ExtendedS3DestinationConfiguration$S3BackupConfiguration": "The configuration for backup in Amazon S3.
", "HttpEndpointDestinationConfiguration$S3Configuration": null, + "IcebergDestinationConfiguration$S3Configuration": null, + "IcebergDestinationUpdate$S3Configuration": null, "RedshiftDestinationConfiguration$S3Configuration": "The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
The configuration for backup in Amazon S3.
", "SnowflakeDestinationConfiguration$S3Configuration": null, @@ -1420,6 +1502,7 @@ "ElasticsearchDestinationDescription$S3DestinationDescription": "The Amazon S3 destination.
", "ExtendedS3DestinationDescription$S3BackupDescription": "The configuration for backup in Amazon S3.
", "HttpEndpointDestinationDescription$S3DestinationDescription": null, + "IcebergDestinationDescription$S3DestinationDescription": null, "RedshiftDestinationDescription$S3DestinationDescription": "The Amazon S3 destination.
", "RedshiftDestinationDescription$S3BackupDescription": "The configuration for backup in Amazon S3.
", "SnowflakeDestinationDescription$S3DestinationDescription": null, @@ -1502,6 +1585,26 @@ "SnowflakeDestinationUpdate$AccountUrl": "URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.
" } }, + "SnowflakeBufferingHints": { + "base": "Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.
", + "refs": { + "SnowflakeDestinationConfiguration$BufferingHints": "Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.
", + "SnowflakeDestinationDescription$BufferingHints": "Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.
", + "SnowflakeDestinationUpdate$BufferingHints": "Describes the buffering to perform before delivering data to the Snowflake destination.
" + } + }, + "SnowflakeBufferingIntervalInSeconds": { + "base": null, + "refs": { + "SnowflakeBufferingHints$IntervalInSeconds": "Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 0.
" + } + }, + "SnowflakeBufferingSizeInMBs": { + "base": null, + "refs": { + "SnowflakeBufferingHints$SizeInMBs": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 1.
" + } + }, "SnowflakeContentColumnName": { "base": null, "refs": { diff --git a/models/apis/ivschat/2020-07-14/api-2.json b/models/apis/ivschat/2020-07-14/api-2.json index 443746b290d..a8a3ae9cd69 100644 --- a/models/apis/ivschat/2020-07-14/api-2.json +++ b/models/apis/ivschat/2020-07-14/api-2.json @@ -2,9 +2,10 @@ "version":"2.0", "metadata":{ "apiVersion":"2020-07-14", + "auth":["aws.auth#sigv4"], "endpointPrefix":"ivschat", - "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceAbbreviation":"ivschat", "serviceFullName":"Amazon Interactive Video Service Chat", "serviceId":"ivschat", @@ -303,7 +304,7 @@ "type":"string", "max":63, "min":3, - "pattern":"^[a-z0-9-.]+$" + "pattern":"[a-z0-9-.]+" }, "ChatToken":{ "type":"string", @@ -359,27 +360,27 @@ "userId" ], "members":{ - "attributes":{"shape":"ChatTokenAttributes"}, - "capabilities":{"shape":"ChatTokenCapabilities"}, "roomIdentifier":{"shape":"RoomIdentifier"}, + "userId":{"shape":"UserID"}, + "capabilities":{"shape":"ChatTokenCapabilities"}, "sessionDurationInMinutes":{"shape":"SessionDurationInMinutes"}, - "userId":{"shape":"UserID"} + "attributes":{"shape":"ChatTokenAttributes"} } }, "CreateChatTokenResponse":{ "type":"structure", "members":{ - "sessionExpirationTime":{"shape":"Time"}, "token":{"shape":"ChatToken"}, - "tokenExpirationTime":{"shape":"Time"} + "tokenExpirationTime":{"shape":"Time"}, + "sessionExpirationTime":{"shape":"Time"} } }, "CreateLoggingConfigurationRequest":{ "type":"structure", "required":["destinationConfiguration"], "members":{ - "destinationConfiguration":{"shape":"DestinationConfiguration"}, "name":{"shape":"LoggingConfigurationName"}, + "destinationConfiguration":{"shape":"DestinationConfiguration"}, "tags":{"shape":"Tags"} } }, @@ -387,13 +388,13 @@ "type":"structure", "members":{ "arn":{"shape":"LoggingConfigurationArn"}, - "createTime":{"shape":"Time"}, - "destinationConfiguration":{"shape":"DestinationConfiguration"}, "id":{"shape":"LoggingConfigurationID"}, + "createTime":{"shape":"Time"}, + "updateTime":{"shape":"Time"}, "name":{"shape":"LoggingConfigurationName"}, + "destinationConfiguration":{"shape":"DestinationConfiguration"}, "state":{"shape":"CreateLoggingConfigurationState"}, - "tags":{"shape":"Tags"}, - "updateTime":{"shape":"Time"} + "tags":{"shape":"Tags"} } }, "CreateLoggingConfigurationState":{ @@ -403,27 +404,27 @@ "CreateRoomRequest":{ "type":"structure", "members":{ - "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, - "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, + "name":{"shape":"RoomName"}, "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, + "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, "messageReviewHandler":{"shape":"MessageReviewHandler"}, - "name":{"shape":"RoomName"}, - "tags":{"shape":"Tags"} + "tags":{"shape":"Tags"}, + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"} } }, "CreateRoomResponse":{ "type":"structure", "members":{ "arn":{"shape":"RoomArn"}, - "createTime":{"shape":"Time"}, "id":{"shape":"RoomID"}, - "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, - "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, + "name":{"shape":"RoomName"}, + "createTime":{"shape":"Time"}, + "updateTime":{"shape":"Time"}, "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, + "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, "messageReviewHandler":{"shape":"MessageReviewHandler"}, - "name":{"shape":"RoomName"}, "tags":{"shape":"Tags"}, - "updateTime":{"shape":"Time"} + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"} } }, "DeleteLoggingConfigurationRequest":{ @@ -436,13 +437,13 @@ "DeleteMessageRequest":{ "type":"structure", "required":[ - "id", - "roomIdentifier" + "roomIdentifier", + "id" ], "members":{ + "roomIdentifier":{"shape":"RoomIdentifier"}, "id":{"shape":"MessageID"}, - "reason":{"shape":"Reason"}, - "roomIdentifier":{"shape":"RoomIdentifier"} + "reason":{"shape":"Reason"} } }, "DeleteMessageResponse":{ @@ -462,14 +463,14 @@ "type":"string", "max":64, "min":1, - "pattern":"^[a-zA-Z0-9_.-]+$" + "pattern":"[a-zA-Z0-9_.-]+" }, "DestinationConfiguration":{ "type":"structure", "members":{ + "s3":{"shape":"S3DestinationConfiguration"}, "cloudWatchLogs":{"shape":"CloudWatchLogsDestinationConfiguration"}, - "firehose":{"shape":"FirehoseDestinationConfiguration"}, - "s3":{"shape":"S3DestinationConfiguration"} + "firehose":{"shape":"FirehoseDestinationConfiguration"} }, "union":true }, @@ -480,9 +481,9 @@ "userId" ], "members":{ - "reason":{"shape":"Reason"}, "roomIdentifier":{"shape":"RoomIdentifier"}, - "userId":{"shape":"UserID"} + "userId":{"shape":"UserID"}, + "reason":{"shape":"Reason"} } }, "DisconnectUserResponse":{ @@ -527,13 +528,13 @@ "type":"structure", "members":{ "arn":{"shape":"LoggingConfigurationArn"}, - "createTime":{"shape":"Time"}, - "destinationConfiguration":{"shape":"DestinationConfiguration"}, "id":{"shape":"LoggingConfigurationID"}, + "createTime":{"shape":"Time"}, + "updateTime":{"shape":"Time"}, "name":{"shape":"LoggingConfigurationName"}, + "destinationConfiguration":{"shape":"DestinationConfiguration"}, "state":{"shape":"LoggingConfigurationState"}, - "tags":{"shape":"Tags"}, - "updateTime":{"shape":"Time"} + "tags":{"shape":"Tags"} } }, "GetRoomRequest":{ @@ -547,22 +548,22 @@ "type":"structure", "members":{ "arn":{"shape":"RoomArn"}, - "createTime":{"shape":"Time"}, "id":{"shape":"RoomID"}, - "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, - "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, + "name":{"shape":"RoomName"}, + "createTime":{"shape":"Time"}, + "updateTime":{"shape":"Time"}, "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, + "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, "messageReviewHandler":{"shape":"MessageReviewHandler"}, - "name":{"shape":"RoomName"}, "tags":{"shape":"Tags"}, - "updateTime":{"shape":"Time"} + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"} } }, "ID":{ "type":"string", "max":12, "min":12, - "pattern":"^[a-zA-Z0-9]+$" + "pattern":"[a-zA-Z0-9]+" }, "InternalServerException":{ "type":"structure", @@ -578,14 +579,14 @@ "type":"string", "max":170, "min":0, - "pattern":"^$|^arn:aws:lambda:[a-z0-9-]+:[0-9]{12}:function:.+" + "pattern":"$|^arn:aws:lambda:[a-z0-9-]+:[0-9]{12}:function:.+.*" }, "Limit":{"type":"integer"}, "ListLoggingConfigurationsRequest":{ "type":"structure", "members":{ - "maxResults":{"shape":"MaxLoggingConfigurationResults"}, - "nextToken":{"shape":"PaginationToken"} + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"MaxLoggingConfigurationResults"} } }, "ListLoggingConfigurationsResponse":{ @@ -599,19 +600,19 @@ "ListRoomsRequest":{ "type":"structure", "members":{ - "loggingConfigurationIdentifier":{"shape":"LoggingConfigurationIdentifier"}, + "name":{"shape":"RoomName"}, + "nextToken":{"shape":"PaginationToken"}, "maxResults":{"shape":"MaxRoomResults"}, "messageReviewHandlerUri":{"shape":"LambdaArn"}, - "name":{"shape":"RoomName"}, - "nextToken":{"shape":"PaginationToken"} + "loggingConfigurationIdentifier":{"shape":"LoggingConfigurationIdentifier"} } }, "ListRoomsResponse":{ "type":"structure", "required":["rooms"], "members":{ - "nextToken":{"shape":"PaginationToken"}, - "rooms":{"shape":"RoomList"} + "rooms":{"shape":"RoomList"}, + "nextToken":{"shape":"PaginationToken"} } }, "ListTagsForResourceRequest":{ @@ -636,25 +637,25 @@ "type":"string", "max":512, "min":1, - "pattern":"^[\\.\\-_/#A-Za-z0-9]+$" + "pattern":"[\\.\\-_/#A-Za-z0-9]+" }, "LoggingConfigurationArn":{ "type":"string", "max":128, "min":1, - "pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$" + "pattern":"arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+" }, "LoggingConfigurationID":{ "type":"string", "max":12, "min":12, - "pattern":"^[a-zA-Z0-9]+$" + "pattern":"[a-zA-Z0-9]+" }, "LoggingConfigurationIdentifier":{ "type":"string", "max":128, "min":1, - "pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$" + "pattern":"arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+" }, "LoggingConfigurationIdentifierList":{ "type":"list", @@ -670,7 +671,7 @@ "type":"string", "max":128, "min":0, - "pattern":"^[a-zA-Z0-9-_]*$" + "pattern":"[a-zA-Z0-9-_]*" }, "LoggingConfigurationState":{ "type":"string", @@ -688,13 +689,13 @@ "type":"structure", "members":{ "arn":{"shape":"LoggingConfigurationArn"}, - "createTime":{"shape":"Time"}, - "destinationConfiguration":{"shape":"DestinationConfiguration"}, "id":{"shape":"LoggingConfigurationID"}, + "createTime":{"shape":"Time"}, + "updateTime":{"shape":"Time"}, "name":{"shape":"LoggingConfigurationName"}, + "destinationConfiguration":{"shape":"DestinationConfiguration"}, "state":{"shape":"LoggingConfigurationState"}, - "tags":{"shape":"Tags"}, - "updateTime":{"shape":"Time"} + "tags":{"shape":"Tags"} } }, "MaxLoggingConfigurationResults":{ @@ -713,13 +714,13 @@ "type":"string", "max":12, "min":12, - "pattern":"^[a-zA-Z0-9]+$" + "pattern":"[a-zA-Z0-9]+" }, "MessageReviewHandler":{ "type":"structure", "members":{ - "fallbackResult":{"shape":"FallbackResult"}, - "uri":{"shape":"LambdaArn"} + "uri":{"shape":"LambdaArn"}, + "fallbackResult":{"shape":"FallbackResult"} } }, "PaginationToken":{ @@ -748,11 +749,11 @@ "type":"string", "max":128, "min":1, - "pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" + "pattern":"arn:aws:ivschat:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+" }, "ResourceId":{ "type":"string", - "pattern":"^[a-zA-Z0-9]+$" + "pattern":"[a-zA-Z0-9]+" }, "ResourceNotFoundException":{ "type":"structure", @@ -780,19 +781,19 @@ "type":"string", "max":128, "min":1, - "pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$" + "pattern":"arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+" }, "RoomID":{ "type":"string", "max":12, "min":12, - "pattern":"^[a-zA-Z0-9]+$" + "pattern":"[a-zA-Z0-9]+" }, "RoomIdentifier":{ "type":"string", "max":128, "min":1, - "pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$" + "pattern":"arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+" }, "RoomList":{ "type":"list", @@ -814,19 +815,19 @@ "type":"string", "max":128, "min":0, - "pattern":"^[a-zA-Z0-9-_]*$" + "pattern":"[a-zA-Z0-9-_]*" }, "RoomSummary":{ "type":"structure", "members":{ "arn":{"shape":"RoomArn"}, - "createTime":{"shape":"Time"}, "id":{"shape":"RoomID"}, - "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, - "messageReviewHandler":{"shape":"MessageReviewHandler"}, "name":{"shape":"RoomName"}, + "messageReviewHandler":{"shape":"MessageReviewHandler"}, + "createTime":{"shape":"Time"}, + "updateTime":{"shape":"Time"}, "tags":{"shape":"Tags"}, - "updateTime":{"shape":"Time"} + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"} } }, "S3DestinationConfiguration":{ @@ -839,13 +840,13 @@ "SendEventRequest":{ "type":"structure", "required":[ - "eventName", - "roomIdentifier" + "roomIdentifier", + "eventName" ], "members":{ - "attributes":{"shape":"EventAttributes"}, + "roomIdentifier":{"shape":"RoomIdentifier"}, "eventName":{"shape":"EventName"}, - "roomIdentifier":{"shape":"RoomIdentifier"} + "attributes":{"shape":"EventAttributes"} } }, "SendEventResponse":{ @@ -857,16 +858,16 @@ "ServiceQuotaExceededException":{ "type":"structure", "required":[ - "limit", "message", "resourceId", - "resourceType" + "resourceType", + "limit" ], "members":{ - "limit":{"shape":"Limit"}, "message":{"shape":"ErrorMessage"}, "resourceId":{"shape":"ResourceId"}, - "resourceType":{"shape":"ResourceType"} + "resourceType":{"shape":"ResourceType"}, + "limit":{"shape":"Limit"} }, "error":{ "httpStatusCode":402, @@ -927,16 +928,16 @@ "ThrottlingException":{ "type":"structure", "required":[ - "limit", "message", "resourceId", - "resourceType" + "resourceType", + "limit" ], "members":{ - "limit":{"shape":"Limit"}, "message":{"shape":"ErrorMessage"}, "resourceId":{"shape":"ResourceId"}, - "resourceType":{"shape":"ResourceType"} + "resourceType":{"shape":"ResourceType"}, + "limit":{"shape":"Limit"} }, "error":{ "httpStatusCode":429, @@ -976,22 +977,22 @@ "type":"structure", "required":["identifier"], "members":{ - "destinationConfiguration":{"shape":"DestinationConfiguration"}, "identifier":{"shape":"LoggingConfigurationIdentifier"}, - "name":{"shape":"LoggingConfigurationName"} + "name":{"shape":"LoggingConfigurationName"}, + "destinationConfiguration":{"shape":"DestinationConfiguration"} } }, "UpdateLoggingConfigurationResponse":{ "type":"structure", "members":{ "arn":{"shape":"LoggingConfigurationArn"}, - "createTime":{"shape":"Time"}, - "destinationConfiguration":{"shape":"DestinationConfiguration"}, "id":{"shape":"LoggingConfigurationID"}, + "createTime":{"shape":"Time"}, + "updateTime":{"shape":"Time"}, "name":{"shape":"LoggingConfigurationName"}, + "destinationConfiguration":{"shape":"DestinationConfiguration"}, "state":{"shape":"UpdateLoggingConfigurationState"}, - "tags":{"shape":"Tags"}, - "updateTime":{"shape":"Time"} + "tags":{"shape":"Tags"} } }, "UpdateLoggingConfigurationState":{ @@ -1003,26 +1004,26 @@ "required":["identifier"], "members":{ "identifier":{"shape":"RoomIdentifier"}, - "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, - "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, + "name":{"shape":"RoomName"}, "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, + "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, "messageReviewHandler":{"shape":"MessageReviewHandler"}, - "name":{"shape":"RoomName"} + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"} } }, "UpdateRoomResponse":{ "type":"structure", "members":{ "arn":{"shape":"RoomArn"}, - "createTime":{"shape":"Time"}, "id":{"shape":"RoomID"}, - "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, - "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, + "name":{"shape":"RoomName"}, + "createTime":{"shape":"Time"}, + "updateTime":{"shape":"Time"}, "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, + "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, "messageReviewHandler":{"shape":"MessageReviewHandler"}, - "name":{"shape":"RoomName"}, "tags":{"shape":"Tags"}, - "updateTime":{"shape":"Time"} + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"} } }, "UserID":{ @@ -1038,9 +1039,9 @@ "reason" ], "members":{ - "fieldList":{"shape":"ValidationExceptionFieldList"}, "message":{"shape":"ErrorMessage"}, - "reason":{"shape":"ValidationExceptionReason"} + "reason":{"shape":"ValidationExceptionReason"}, + "fieldList":{"shape":"ValidationExceptionFieldList"} }, "error":{ "httpStatusCode":400, @@ -1051,12 +1052,12 @@ "ValidationExceptionField":{ "type":"structure", "required":[ - "message", - "name" + "name", + "message" ], "members":{ - "message":{"shape":"ErrorMessage"}, - "name":{"shape":"FieldName"} + "name":{"shape":"FieldName"}, + "message":{"shape":"ErrorMessage"} } }, "ValidationExceptionFieldList":{ diff --git a/models/apis/ivschat/2020-07-14/docs-2.json b/models/apis/ivschat/2020-07-14/docs-2.json index 95b97cb2351..b0ffcfb2084 100644 --- a/models/apis/ivschat/2020-07-14/docs-2.json +++ b/models/apis/ivschat/2020-07-14/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "Introduction
The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.
The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.
Notes on terminology:
You create service applications using the Amazon IVS Chat API. We refer to these as applications.
You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.
Key Concepts
LoggingConfiguration — A configuration that allows customers to store and record sent messages in a chat room.
Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Room.
At most 50 tags can be applied to a resource.
API Access Security
Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:
Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.
Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.
Signing API Requests
HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.
You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the ivschat:DeleteMessage permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
Messaging Endpoints
DeleteMessage — Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
DisconnectUser — Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
SendEvent — Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
Chat Token Endpoint
CreateChatToken — Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.
Room Endpoints
CreateRoom — Creates a room that allows clients to connect and pass messages.
DeleteRoom — Deletes the specified room.
GetRoom — Gets the specified room.
ListRooms — Gets summary information about all your rooms in the AWS region where the API request is processed.
UpdateRoom — Updates a room’s configuration.
Logging Configuration Endpoints
CreateLoggingConfiguration — Creates a logging configuration that allows clients to store and record sent messages.
DeleteLoggingConfiguration — Deletes the specified logging configuration.
GetLoggingConfiguration — Gets the specified logging configuration.
ListLoggingConfigurations — Gets summary information about all your logging configurations in the AWS region where the API request is processed.
UpdateLoggingConfiguration — Updates a specified logging configuration.
Tags Endpoints
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
All the above are HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API Reference.
", + "service": "Introduction
The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.
The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.
This document describes HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API Reference.
Notes on terminology:
You create service applications using the Amazon IVS Chat API. We refer to these as applications.
You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.
Resources
The following resources are part of Amazon IVS Chat:
LoggingConfiguration — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.
Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Room.
At most 50 tags can be applied to a resource.
API Access Security
Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:
Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.
Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.
Signing API Requests
HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.
You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the ivschat:DeleteMessage permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
", "operations": { "CreateChatToken": "Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.
Use the capabilities field to permit an end user to send messages or moderate a room.
The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.
Encryption keys are owned by Amazon IVS Chat and never used directly by your application.
", "CreateLoggingConfiguration": "Creates a logging configuration that allows clients to store and record sent messages.
", @@ -590,8 +590,8 @@ "Time": { "base": null, "refs": { - "CreateChatTokenResponse$sessionExpirationTime": "Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; note that this is returned as a string.
", "CreateChatTokenResponse$tokenExpirationTime": "Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "CreateChatTokenResponse$sessionExpirationTime": "Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; note that this is returned as a string.
", "CreateLoggingConfigurationResponse$createTime": "Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", "CreateLoggingConfigurationResponse$updateTime": "Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
", "CreateRoomResponse$createTime": "Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", diff --git a/models/apis/ivschat/2020-07-14/smoke.json b/models/apis/ivschat/2020-07-14/smoke.json new file mode 100644 index 00000000000..a9756813e4a --- /dev/null +++ b/models/apis/ivschat/2020-07-14/smoke.json @@ -0,0 +1,6 @@ +{ + "version": 1, + "defaultRegion": "us-west-2", + "testCases": [ + ] +} diff --git a/models/apis/ivschat/2020-07-14/waiters-2.json b/models/apis/ivschat/2020-07-14/waiters-2.json new file mode 100644 index 00000000000..13f60ee66be --- /dev/null +++ b/models/apis/ivschat/2020-07-14/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/models/apis/medialive/2017-10-14/api-2.json b/models/apis/medialive/2017-10-14/api-2.json index 6ca0b774464..c5df7f6daff 100644 --- a/models/apis/medialive/2017-10-14/api-2.json +++ b/models/apis/medialive/2017-10-14/api-2.json @@ -9,7 +9,10 @@ "uid": "medialive-2017-10-14", "signatureVersion": "v4", "serviceAbbreviation": "MediaLive", - "jsonVersion": "1.1" + "jsonVersion": "1.1", + "auth": [ + "aws.auth#sigv4" + ] }, "operations": { "AcceptInputDeviceTransfer": { @@ -5296,6 +5299,10 @@ "Vpc": { "shape": "InputVpcRequest", "locationName": "vpc" + }, + "SrtSettings": { + "shape": "SrtSettingsRequest", + "locationName": "srtSettings" } } }, @@ -5346,6 +5353,10 @@ "Vpc": { "shape": "InputVpcRequest", "locationName": "vpc" + }, + "SrtSettings": { + "shape": "SrtSettingsRequest", + "locationName": "srtSettings" } } }, @@ -6303,6 +6314,10 @@ "Type": { "shape": "InputType", "locationName": "type" + }, + "SrtSettings": { + "shape": "SrtSettings", + "locationName": "srtSettings" } } }, @@ -9101,6 +9116,10 @@ "Type": { "shape": "InputType", "locationName": "type" + }, + "SrtSettings": { + "shape": "SrtSettings", + "locationName": "srtSettings" } } }, @@ -10017,7 +10036,8 @@ "MEDIACONNECT", "INPUT_DEVICE", "AWS_CDI", - "TS_FILE" + "TS_FILE", + "SRT_CALLER" ] }, "InputVpcRequest": { @@ -14531,6 +14551,10 @@ "Sources": { "shape": "__listOfInputSourceRequest", "locationName": "sources" + }, + "SrtSettings": { + "shape": "SrtSettingsRequest", + "locationName": "srtSettings" } } }, @@ -14688,6 +14712,10 @@ "Sources": { "shape": "__listOfInputSourceRequest", "locationName": "sources" + }, + "SrtSettings": { + "shape": "SrtSettingsRequest", + "locationName": "srtSettings" } }, "required": [ @@ -19990,6 +20018,120 @@ "ALL_OUTPUT_GROUPS", "SCTE35_ENABLED_OUTPUT_GROUPS" ] + }, + "Algorithm": { + "type": "string", + "enum": [ + "AES128", + "AES192", + "AES256" + ] + }, + "SrtCallerDecryption": { + "type": "structure", + "members": { + "Algorithm": { + "shape": "Algorithm", + "locationName": "algorithm" + }, + "PassphraseSecretArn": { + "shape": "__string", + "locationName": "passphraseSecretArn" + } + } + }, + "SrtCallerDecryptionRequest": { + "type": "structure", + "members": { + "Algorithm": { + "shape": "Algorithm", + "locationName": "algorithm" + }, + "PassphraseSecretArn": { + "shape": "__string", + "locationName": "passphraseSecretArn" + } + } + }, + "SrtCallerSource": { + "type": "structure", + "members": { + "Decryption": { + "shape": "SrtCallerDecryption", + "locationName": "decryption" + }, + "MinimumLatency": { + "shape": "__integer", + "locationName": "minimumLatency" + }, + "SrtListenerAddress": { + "shape": "__string", + "locationName": "srtListenerAddress" + }, + "SrtListenerPort": { + "shape": "__string", + "locationName": "srtListenerPort" + }, + "StreamId": { + "shape": "__string", + "locationName": "streamId" + } + } + }, + "SrtCallerSourceRequest": { + "type": "structure", + "members": { + "Decryption": { + "shape": "SrtCallerDecryptionRequest", + "locationName": "decryption" + }, + "MinimumLatency": { + "shape": "__integer", + "locationName": "minimumLatency" + }, + "SrtListenerAddress": { + "shape": "__string", + "locationName": "srtListenerAddress" + }, + "SrtListenerPort": { + "shape": "__string", + "locationName": "srtListenerPort" + }, + "StreamId": { + "shape": "__string", + "locationName": "streamId" + } + } + }, + "SrtSettings": { + "type": "structure", + "members": { + "SrtCallerSources": { + "shape": "__listOfSrtCallerSource", + "locationName": "srtCallerSources" + } + } + }, + "SrtSettingsRequest": { + "type": "structure", + "members": { + "SrtCallerSources": { + "shape": "__listOfSrtCallerSourceRequest", + "locationName": "srtCallerSources" + } + } + }, + "__listOfSrtCallerSource": { + "type": "list", + "member": { + "shape": "SrtCallerSource" + } + }, + "__listOfSrtCallerSourceRequest": { + "type": "list", + "member": { + "shape": "SrtCallerSourceRequest" + } } } -} +} \ No newline at end of file diff --git a/models/apis/medialive/2017-10-14/docs-2.json b/models/apis/medialive/2017-10-14/docs-2.json index 9932e3ea0b1..057a47d682a 100644 --- a/models/apis/medialive/2017-10-14/docs-2.json +++ b/models/apis/medialive/2017-10-14/docs-2.json @@ -1272,7 +1272,7 @@ "H264FilterSettings": { "base": "H264 Filter Settings", "refs": { - "H264Settings$FilterSettings": "Optional filters that you can apply to an encode." + "H264Settings$FilterSettings": "Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. We\nrecommend that you try both filters and observe the results to decide which one to use.\n\nThe Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptual\nfiltering and motion compensated temporal filtering (MCTF). It operates independently of the compression level.\n\nThe Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the current\ncompression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower." } }, "H264FlickerAq": { @@ -1416,7 +1416,7 @@ "H265FilterSettings": { "base": "H265 Filter Settings", "refs": { - "H265Settings$FilterSettings": "Optional filters that you can apply to an encode." + "H265Settings$FilterSettings": "Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. We\nrecommend that you try both filters and observe the results to decide which one to use.\n\nThe Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptual\nfiltering and motion compensated temporal filtering (MCTF). It operates independently of the compression level.\n\nThe Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the current\ncompression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower." } }, "H265FlickerAq": { @@ -3746,7 +3746,7 @@ "AacSettings$Bitrate": "Average bitrate in bits/second. Valid values depend on rate control mode and profile.", "AacSettings$SampleRate": "Sample rate in Hz. Valid values depend on rate control mode and profile.", "Ac3Settings$Bitrate": "Average bitrate in bits/second. Valid bitrates depend on the coding mode.", - "Eac3AtmosSettings$Bitrate": "Average bitrate in bits/second. Valid bitrates depend on the coding mode.\n// * @affectsRightSizing true", + "Eac3AtmosSettings$Bitrate": "Average bitrate in bits/second. Valid bitrates depend on the coding mode.", "Eac3AtmosSettings$HeightTrim": "Height dimensional trim. Sets the maximum amount to attenuate the height channels when the downstream player isn??t configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels.", "Eac3AtmosSettings$SurroundTrim": "Surround dimensional trim. Sets the maximum amount to attenuate the surround channels when the downstream player isn't configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels.", "Eac3Settings$Bitrate": "Average bitrate in bits/second. Valid bitrates depend on the coding mode.", @@ -3880,7 +3880,9 @@ "InputDeviceConfigurableAudioChannelPairConfig$Id": "The ID for one audio pair configuration, a value from 1 to 8.", "InputDeviceUhdAudioChannelPairConfig$Id": "The ID for one audio pair configuration, a value from 1 to 8.", "CloudWatchAlarmTemplateGroupSummary$TemplateCount": "The number of templates in a group.", - "EventBridgeRuleTemplateGroupSummary$TemplateCount": "The number of templates in a group." + "EventBridgeRuleTemplateGroupSummary$TemplateCount": "The number of templates in a group.", + "SrtCallerSource$MinimumLatency": "The preferred latency (in milliseconds) for implementing packet loss and recovery. Packet recovery is a key feature of SRT.", + "SrtCallerSourceRequest$MinimumLatency": "The preferred latency (in milliseconds) for implementing packet loss and recovery. Packet recovery is a key feature of SRT. Obtain this value from the operator at the upstream system." } }, "__integerMin0": { @@ -5009,7 +5011,15 @@ "InternalServerErrorExceptionResponseContent$Message": "Exception error message.", "NotFoundExceptionResponseContent$Message": "Exception error message.", "TagMap$member": null, - "TooManyRequestsExceptionResponseContent$Message": "Exception error message." + "TooManyRequestsExceptionResponseContent$Message": "Exception error message.", + "SrtCallerDecryption$PassphraseSecretArn": "The ARN for the secret in Secrets Manager. Someone in your organization must create a secret and provide you with its ARN. The secret holds the passphrase that MediaLive uses to decrypt the source content.", + "SrtCallerDecryptionRequest$PassphraseSecretArn": "The ARN for the secret in Secrets Manager. Someone in your organization must create a secret and provide you with its ARN. This secret holds the passphrase that MediaLive will use to decrypt the source content.", + "SrtCallerSource$SrtListenerAddress": "The IP address at the upstream system (the listener) that MediaLive (the caller) connects to.", + "SrtCallerSource$SrtListenerPort": "The port at the upstream system (the listener) that MediaLive (the caller) connects to.", + "SrtCallerSource$StreamId": "The stream ID, if the upstream system uses this identifier.", + "SrtCallerSourceRequest$SrtListenerAddress": "The IP address at the upstream system (the listener) that MediaLive (the caller) will connect to.", + "SrtCallerSourceRequest$SrtListenerPort": "The port at the upstream system (the listener) that MediaLive (the caller) will connect to.", + "SrtCallerSourceRequest$StreamId": "This value is required if the upstream system uses this identifier because without it, the SRT handshake between MediaLive (the caller) and the upstream system (the listener) might fail." } }, "__stringMax1000": { @@ -5970,6 +5980,62 @@ "refs": { "AvailConfiguration$Scte35SegmentationScope": "Configures whether SCTE 35 passthrough triggers segment breaks in all output groups that use segmented outputs. Insertion of a SCTE 35 message typically results in a segment break, in addition to the regular cadence of breaks. The segment breaks appear in video outputs, audio outputs, and captions outputs (if any).\n\nALL_OUTPUT_GROUPS: Default. Insert the segment break in in all output groups that have segmented outputs. This is the legacy behavior.\nSCTE35_ENABLED_OUTPUT_GROUPS: Insert the segment break only in output groups that have SCTE 35 passthrough enabled. This is the recommended value, because it reduces unnecessary segment breaks." } + }, + "Algorithm": { + "base": null, + "refs": { + "SrtCallerDecryption$Algorithm": "The algorithm used to encrypt content.", + "SrtCallerDecryptionRequest$Algorithm": "The algorithm used to encrypt content." + } + }, + "SrtCallerDecryption": { + "base": "The decryption settings for the SRT caller source. Present only if the source has decryption enabled.", + "refs": { + "SrtCallerSource$Decryption": null + } + }, + "SrtCallerDecryptionRequest": { + "base": "Complete these parameters only if the content is encrypted.", + "refs": { + "SrtCallerSourceRequest$Decryption": null + } + }, + "SrtCallerSource": { + "base": "The configuration for a source that uses SRT as the connection protocol. In terms of establishing the connection, MediaLive is always caller and the upstream system is always the listener. In terms of transmission of the source content, MediaLive is always the receiver and the upstream system is always the sender.", + "refs": { + "__listOfSrtCallerSource$member": null + } + }, + "SrtCallerSourceRequest": { + "base": "Configures the connection for a source that uses SRT as the connection protocol. In terms of establishing the connection, MediaLive is always the caller and the upstream system is always the listener. In terms of transmission of the source content, MediaLive is always the receiver and the upstream system is always the sender.", + "refs": { + "__listOfSrtCallerSourceRequest$member": null + } + }, + "SrtSettings": { + "base": "The configured sources for this SRT input.", + "refs": { + "Input$SrtSettings": "The settings associated with an SRT input." + } + }, + "SrtSettingsRequest": { + "base": "Configures the sources for this SRT input. For a single-pipeline input, include one srtCallerSource in the array. For a standard-pipeline input, include two srtCallerSource.", + "refs": { + "CreateInput$SrtSettings": "The settings associated with an SRT input.", + "UpdateInput$SrtSettings": "The settings associated with an SRT input." + } + }, + "__listOfSrtCallerSource": { + "base": null, + "refs": { + "SrtSettings$SrtCallerSources": null + } + }, + "__listOfSrtCallerSourceRequest": { + "base": null, + "refs": { + "SrtSettingsRequest$SrtCallerSources": null + } } }, "documentation": "API for AWS Elemental MediaLive" diff --git a/models/apis/rds/2014-10-31/docs-2.json b/models/apis/rds/2014-10-31/docs-2.json index f6c9d80c541..bba68e15096 100644 --- a/models/apis/rds/2014-10-31/docs-2.json +++ b/models/apis/rds/2014-10-31/docs-2.json @@ -96,7 +96,7 @@ "DescribeOptionGroupOptions": "Describes all available options for the specified engine.
", "DescribeOptionGroups": "Describes the available option groups.
", "DescribeOrderableDBInstanceOptions": "Describes the orderable DB instance options for a specified DB engine.
", - "DescribePendingMaintenanceActions": "Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
", + "DescribePendingMaintenanceActions": "Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This API follows an eventual consistency model. This means that the result of the DescribePendingMaintenanceActions command might not be immediately visible to all subsequent RDS commands. Keep this in mind when you use DescribePendingMaintenanceActions immediately after using a previous API command such as ApplyPendingMaintenanceActions.
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
", "DescribeReservedDBInstancesOfferings": "Lists available reserved DB instance offerings.
", "DescribeSourceRegions": "Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see DescribeRegions in the Amazon EC2 API Reference.
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
", "DBInstance$MultiAZ": "Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
", "DBInstance$AutoMinorVersionUpgrade": "Indicates whether minor version patches are applied automatically.
", - "DBInstance$PubliclyAccessible": "Indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
", + "DBInstance$PubliclyAccessible": "Indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
", "DBInstance$StorageEncrypted": "Indicates whether the DB instance is encrypted.
", "DBInstance$CopyTagsToSnapshot": "Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
", @@ -571,7 +571,7 @@ "CreateDBClusterMessage$EnableHttpEndpoint": "Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
RDS Data API is supported with the following DB clusters:
Aurora PostgreSQL Serverless v2 and provisioned
Aurora PostgreSQL and Aurora MySQL Serverless v1
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
", "CreateDBClusterMessage$CopyTagsToSnapshot": "Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", "CreateDBClusterMessage$EnableGlobalWriteForwarding": "Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
", - "CreateDBClusterMessage$PubliclyAccessible": "Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
", "CreateDBClusterMessage$EnablePerformanceInsights": "Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
", "CreateDBClusterMessage$EnableLimitlessDatabase": "Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
", @@ -579,7 +579,7 @@ "CreateDBClusterMessage$EnableLocalWriteForwarding": "Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
", "CreateDBInstanceMessage$MultiAZ": "Specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to the following DB instances:
Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
RDS Custom
Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
Specifes whether the DB instance is encrypted. By default, it isn't encrypted.
For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.
This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.
", "CreateDBInstanceMessage$CopyTagsToSnapshot": "Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
", "CreateDBInstanceMessage$EnableIAMDatabaseAuthentication": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)
RDS Custom
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
", "DBCluster$CrossAccountClone": "Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
", "DBCluster$GlobalWriteForwardingRequested": "Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
", + "DBCluster$PubliclyAccessible": "Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
", "DBCluster$PerformanceInsightsEnabled": "Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
", "DBEngineVersion$SupportsCertificateRotationWithoutRestart": "Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
", "DBEngineVersion$SupportsLocalWriteForwarding": "Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
", @@ -625,7 +625,7 @@ "DBShardGroup$PubliclyAccessible": "Indicates whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
For more information, see CreateDBShardGroup.
This setting is only for Aurora Limitless Database.
", "DBSnapshot$MultiTenant": "Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
", "DeleteBlueGreenDeploymentRequest$DeleteTarget": "Specifies whether to delete the resources in the green environment. You can't specify this option if the blue/green deployment status is SWITCHOVER_COMPLETED.
Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.
", + "DeleteDBClusterMessage$DeleteAutomatedBackups": "Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.
You must delete automated backups for Amazon RDS Multi-AZ DB clusters. For more information about managing automated backups for RDS Multi-AZ DB clusters, see Managing automated backups.
Specifies whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
", "DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
", "DescribeDBEngineVersionsMessage$ListSupportedTimezones": "Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
", @@ -653,7 +653,7 @@ "ModifyDBInstanceMessage$MultiAZ": "Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
This setting doesn't apply to RDS Custom DB instances.
", "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": "Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
", "ModifyDBInstanceMessage$CopyTagsToSnapshot": "Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.
Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
Specifies whether to remove the DB instance from the Active Directory domain.
", "ModifyDBInstanceMessage$EnableIAMDatabaseAuthentication": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
", "ModifyDBInstanceMessage$EnablePerformanceInsights": "Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
", @@ -5115,7 +5115,7 @@ "DescribeDBClusterParameterGroupsMessage$DBClusterParameterGroupName": "The name of a specific DB cluster parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A specific source to return parameters for.
Valid Values:
customer
engine
service
A specific source to return parameters for.
Valid Values:
user
engine
service
An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the DB cluster snapshot to describe the attributes for.
", "DescribeDBClusterSnapshotsMessage$DBClusterIdentifier": "The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue.
To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as AccessDeniedException while attempting to retrieve any of the secrets, you can see the errors in Errors in the response.
Secrets Manager generates CloudTrail GetSecretValue log entries for each secret you request when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:BatchGetSecretValue, and you must have secretsmanager:GetSecretValue for each secret. If you use filters, you must also have secretsmanager:ListSecrets. If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for the keys. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. You might need to remove the staging label AWSPENDING from the partially created version. You also need to determine whether to roll back to the previous version of the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING. To determine which version has a specific staging label, call ListSecretVersionIds. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation works.
To turn on automatic rotation again, call RotateSecret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:CancelRotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Creates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
For secrets that use managed rotation, you need to create the secret through the managing service. For more information, see Secrets Manager secrets managed by other Amazon Web Services services.
For information about creating a secret in the console, see Create a secret.
To create a secret, you can provide the secret value to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT to it.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the JSON you store in the SecretString matches the JSON structure of a database secret.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:CreateSecret. If you include tags in the secret, you also need secretsmanager:TagResource. To add replica Regions, you must also have secretsmanager:ReplicateSecretToRegions. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.
Creates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
For secrets that use managed rotation, you need to create the secret through the managing service. For more information, see Secrets Manager secrets managed by other Amazon Web Services services.
For information about creating a secret in the console, see Create a secret.
To create a secret, you can provide the secret value to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT to it.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the JSON you store in the SecretString matches the JSON structure of a database secret.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:CreateSecret. If you include tags in the secret, you also need secretsmanager:TagResource. To add replica Regions, you must also have secretsmanager:ReplicateSecretToRegions. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.
You can't delete a primary secret that is replicated to other Regions. You must first delete the replicas using RemoveRegionsFromReplication, and then delete the primary secret. When you delete a replica, it is deleted immediately.
You can't directly delete a version of a secret. Instead, you remove all staging labels from the version using UpdateSecretVersionStage. This marks the version as deprecated, and then Secrets Manager can automatically delete the version in the background.
To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during the recovery window. For more information, see Monitor secrets scheduled for deletion.
Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.
At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.
When a secret is scheduled for deletion, you cannot retrieve the secret value. You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DescribeSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager concepts: Versions.
To list the secrets in the account, use ListSecrets.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ListSecretVersionIds. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret.
To list the versions of a secret, use ListSecretVersionIds.
To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.
For information about finding secrets in the console, see Find secrets in Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ListSecrets. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager
For information about attaching a policy in the console, see Attach a permissions policy to a secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value.
We recommend you avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages. If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT to it. If this operation moves the staging label AWSCURRENT from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
This operation is idempotent. If you call this operation with a ClientRequestToken that matches an existing version's VersionId, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't modify an existing version; you can only create new ones.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary, SecretString, or RotationToken because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutSecretValue. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value.
We recommend you avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages. If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT to it. If this operation moves the staging label AWSCURRENT from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
This operation is idempotent. If you call this operation with a ClientRequestToken that matches an existing version's VersionId, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't modify an existing version; you can only create new ones.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary, SecretString, or RotationToken because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutSecretValue. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RemoveRegionsFromReplication. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Replicates the secret to a new Regions. See Multi-Region secrets.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ReplicateSecretToRegions. If the primary secret is encrypted with a KMS key other than aws/secretsmanager, you also need kms:Decrypt permission to the key. To encrypt the replicated secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Encrypt to the key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RestoreSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
You must call this operation from the Region in which you want to promote the replica to a primary secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:StopReplicationToReplica. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.
For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference guide.
If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Removes specific tags from a secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UntagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
To change the rotation configuration of a secret, use RotateSecret instead.
To change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services.
We recommend you avoid calling UpdateSecret at a sustained rate of more than once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically moves the staging label AWSCURRENT to the new version. Then it attaches the label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If you call this operation with a ClientRequestToken that matches an existing version's VersionId, the operation results in an error. You can't modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UpdateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. If you use a customer managed key, you must also have kms:GenerateDataKey, kms:Encrypt, and kms:Decrypt permissions on the key. If you change the KMS key and you don't have kms:Encrypt permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information, see Secret encryption and decryption.
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
To change the rotation configuration of a secret, use RotateSecret instead.
To change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services.
We recommend you avoid calling UpdateSecret at a sustained rate of more than once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically moves the staging label AWSCURRENT to the new version. Then it attaches the label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If you call this operation with a ClientRequestToken that matches an existing version's VersionId, the operation results in an error. You can't modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UpdateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. If you use a customer managed key, you must also have kms:GenerateDataKey, kms:Encrypt, and kms:Decrypt permissions on the key. If you change the KMS key and you don't have kms:Encrypt permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more information, see Secret encryption and decryption.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels for the version.
You can move the AWSCURRENT staging label to this version by including it in this call.
Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UpdateSecretVersionStage. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets.
The API performs three checks when validating the policy:
Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal.
Checks for correct syntax in a policy.
Verifies the policy does not lock out a caller.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ValidateResourcePolicy and secretsmanager:PutResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.
Can be an ARN, Key ID, or Alias.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions with the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. If you don't have kms:Encrypt permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information about versions and staging labels, see Concepts: Version.
A key alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see About aliases.
If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result.
You can only use the Amazon Web Services managed key aws/secretsmanager if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions with the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. If you don't have kms:Encrypt permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more information about versions and staging labels, see Concepts: Version.
A key alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see About aliases.
If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result.
You can only use the Amazon Web Services managed key aws/secretsmanager if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
The pricing model for queries in your account.
", - "UpdateAccountSettingsRequest$QueryPricingModel": "The pricing model for queries in an account.
", + "UpdateAccountSettingsRequest$QueryPricingModel": "The pricing model for queries in an account.
The QueryPricingModel parameter is used by several Timestream operations; however, the UpdateAccountSettings API operation doesn't recognize any values other than COMPUTE_UNITS.
The pricing model for an account.
" } }, diff --git a/models/apis/workspaces-thin-client/2023-08-22/api-2.json b/models/apis/workspaces-thin-client/2023-08-22/api-2.json index 1375ab9da3e..ec80e3bfa8e 100644 --- a/models/apis/workspaces-thin-client/2023-08-22/api-2.json +++ b/models/apis/workspaces-thin-client/2023-08-22/api-2.json @@ -2,6 +2,7 @@ "version":"2.0", "metadata":{ "apiVersion":"2023-08-22", + "auth":["aws.auth#sigv4"], "endpointPrefix":"thinclient", "protocol":"rest-json", "protocols":["rest-json"], diff --git a/models/apis/workspaces-thin-client/2023-08-22/docs-2.json b/models/apis/workspaces-thin-client/2023-08-22/docs-2.json index 48ee1ed6657..faa9e84fd97 100644 --- a/models/apis/workspaces-thin-client/2023-08-22/docs-2.json +++ b/models/apis/workspaces-thin-client/2023-08-22/docs-2.json @@ -157,7 +157,7 @@ "base": null, "refs": { "CreateEnvironmentRequest$deviceCreationTags": "A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
", - "Environment$deviceCreationTags": "\"The tag keys and optional values for the newly created devices for this environment.\"
", + "Environment$deviceCreationTags": "The tag keys and optional values for the newly created devices for this environment.
", "UpdateEnvironmentRequest$deviceCreationTags": "A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
" } }, diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 1c2a7de7aec..de4927d664d 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -7586,6 +7586,7 @@ } ] }, "eu-central-1" : { }, + "eu-central-2" : { }, "eu-north-1" : { }, "eu-south-1" : { }, "eu-south-2" : { }, @@ -13164,6 +13165,7 @@ "tags" : [ "fips" ] } ] }, + "ca-west-1" : { }, "eu-central-1" : { }, "eu-central-2" : { }, "eu-north-1" : { }, @@ -14315,6 +14317,12 @@ }, "hostname" : "portal.sso.ca-central-1.amazonaws.com" }, + "ca-west-1" : { + "credentialScope" : { + "region" : "ca-west-1" + }, + "hostname" : "portal.sso.ca-west-1.amazonaws.com" + }, "eu-central-1" : { "credentialScope" : { "region" : "eu-central-1" @@ -19599,6 +19607,18 @@ "us-west-2" : { } } }, + "tax" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "tax.us-east-1.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, "textract" : { "endpoints" : { "ap-northeast-2" : { @@ -24452,17 +24472,31 @@ }, "directconnect" : { "endpoints" : { - "us-gov-east-1" : { + "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, - "hostname" : "directconnect.us-gov-east-1.amazonaws.com" + "deprecated" : true, + "hostname" : "directconnect-fips.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { + "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, - "hostname" : "directconnect.us-gov-west-1.amazonaws.com" + "deprecated" : true, + "hostname" : "directconnect-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "directconnect-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "directconnect-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, diff --git a/service/acmpca/waiters.go b/service/acmpca/waiters.go index 107d6fc36f1..88f6325c531 100644 --- a/service/acmpca/waiters.go +++ b/service/acmpca/waiters.go @@ -28,7 +28,7 @@ func (c *ACMPCA) WaitUntilAuditReportCreated(input *DescribeCertificateAuthority func (c *ACMPCA) WaitUntilAuditReportCreatedWithContext(ctx aws.Context, input *DescribeCertificateAuthorityAuditReportInput, opts ...request.WaiterOption) error { w := request.Waiter{ Name: "WaitUntilAuditReportCreated", - MaxAttempts: 40, + MaxAttempts: 60, Delay: request.ConstantWaiterDelay(3 * time.Second), Acceptors: []request.WaiterAcceptor{ { @@ -84,13 +84,13 @@ func (c *ACMPCA) WaitUntilCertificateAuthorityCSRCreated(input *GetCertificateAu func (c *ACMPCA) WaitUntilCertificateAuthorityCSRCreatedWithContext(ctx aws.Context, input *GetCertificateAuthorityCsrInput, opts ...request.WaiterOption) error { w := request.Waiter{ Name: "WaitUntilCertificateAuthorityCSRCreated", - MaxAttempts: 40, + MaxAttempts: 60, Delay: request.ConstantWaiterDelay(3 * time.Second), Acceptors: []request.WaiterAcceptor{ { State: request.SuccessWaiterState, - Matcher: request.ErrorWaiterMatch, - Expected: false, + Matcher: request.StatusWaiterMatch, + Expected: 200, }, { State: request.RetryWaiterState, @@ -140,13 +140,13 @@ func (c *ACMPCA) WaitUntilCertificateIssued(input *GetCertificateInput) error { func (c *ACMPCA) WaitUntilCertificateIssuedWithContext(ctx aws.Context, input *GetCertificateInput, opts ...request.WaiterOption) error { w := request.Waiter{ Name: "WaitUntilCertificateIssued", - MaxAttempts: 120, + MaxAttempts: 60, Delay: request.ConstantWaiterDelay(1 * time.Second), Acceptors: []request.WaiterAcceptor{ { State: request.SuccessWaiterState, - Matcher: request.ErrorWaiterMatch, - Expected: false, + Matcher: request.StatusWaiterMatch, + Expected: 200, }, { State: request.RetryWaiterState, diff --git a/service/connect/api.go b/service/connect/api.go index acdc81c5178..1284145c850 100644 --- a/service/connect/api.go +++ b/service/connect/api.go @@ -19284,6 +19284,154 @@ func (c *Connect) ResumeContactRecordingWithContext(ctx aws.Context, input *Resu return out, req.Send() } +const opSearchAgentStatuses = "SearchAgentStatuses" + +// SearchAgentStatusesRequest generates a "aws/request.Request" representing the +// client's request for the SearchAgentStatuses operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See SearchAgentStatuses for more information on using the SearchAgentStatuses +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the SearchAgentStatusesRequest method. +// req, resp := client.SearchAgentStatusesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchAgentStatuses +func (c *Connect) SearchAgentStatusesRequest(input *SearchAgentStatusesInput) (req *request.Request, output *SearchAgentStatusesOutput) { + op := &request.Operation{ + Name: opSearchAgentStatuses, + HTTPMethod: "POST", + HTTPPath: "/search-agent-statuses", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &SearchAgentStatusesInput{} + } + + output = &SearchAgentStatusesOutput{} + req = c.newRequest(op, input, output) + return +} + +// SearchAgentStatuses API operation for Amazon Connect Service. +// +// Searches AgentStatuses in an Amazon Connect instance, with optional filtering. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Connect Service's +// API operation SearchAgentStatuses for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// The request is not valid. +// +// - InvalidParameterException +// One or more of the specified parameters are not valid. +// +// - ResourceNotFoundException +// The specified resource was not found. +// +// - ThrottlingException +// The throttling limit has been exceeded. +// +// - InternalServiceException +// Request processing failed because of an error or failure with the service. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchAgentStatuses +func (c *Connect) SearchAgentStatuses(input *SearchAgentStatusesInput) (*SearchAgentStatusesOutput, error) { + req, out := c.SearchAgentStatusesRequest(input) + return out, req.Send() +} + +// SearchAgentStatusesWithContext is the same as SearchAgentStatuses with the addition of +// the ability to pass a context and additional request options. +// +// See SearchAgentStatuses for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Connect) SearchAgentStatusesWithContext(ctx aws.Context, input *SearchAgentStatusesInput, opts ...request.Option) (*SearchAgentStatusesOutput, error) { + req, out := c.SearchAgentStatusesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// SearchAgentStatusesPages iterates over the pages of a SearchAgentStatuses operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See SearchAgentStatuses method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a SearchAgentStatuses operation. +// pageNum := 0 +// err := client.SearchAgentStatusesPages(params, +// func(page *connect.SearchAgentStatusesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Connect) SearchAgentStatusesPages(input *SearchAgentStatusesInput, fn func(*SearchAgentStatusesOutput, bool) bool) error { + return c.SearchAgentStatusesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// SearchAgentStatusesPagesWithContext same as SearchAgentStatusesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Connect) SearchAgentStatusesPagesWithContext(ctx aws.Context, input *SearchAgentStatusesInput, fn func(*SearchAgentStatusesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *SearchAgentStatusesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.SearchAgentStatusesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*SearchAgentStatusesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opSearchAvailablePhoneNumbers = "SearchAvailablePhoneNumbers" // SearchAvailablePhoneNumbersRequest generates a "aws/request.Request" representing the @@ -21065,6 +21213,159 @@ func (c *Connect) SearchSecurityProfilesPagesWithContext(ctx aws.Context, input return p.Err() } +const opSearchUserHierarchyGroups = "SearchUserHierarchyGroups" + +// SearchUserHierarchyGroupsRequest generates a "aws/request.Request" representing the +// client's request for the SearchUserHierarchyGroups operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See SearchUserHierarchyGroups for more information on using the SearchUserHierarchyGroups +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the SearchUserHierarchyGroupsRequest method. +// req, resp := client.SearchUserHierarchyGroupsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchUserHierarchyGroups +func (c *Connect) SearchUserHierarchyGroupsRequest(input *SearchUserHierarchyGroupsInput) (req *request.Request, output *SearchUserHierarchyGroupsOutput) { + op := &request.Operation{ + Name: opSearchUserHierarchyGroups, + HTTPMethod: "POST", + HTTPPath: "/search-user-hierarchy-groups", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &SearchUserHierarchyGroupsInput{} + } + + output = &SearchUserHierarchyGroupsOutput{} + req = c.newRequest(op, input, output) + return +} + +// SearchUserHierarchyGroups API operation for Amazon Connect Service. +// +// Searches UserHierarchyGroups in an Amazon Connect instance, with optional +// filtering. +// +// The UserHierarchyGroup with "LevelId": "0" is the foundation for building +// levels on top of an instance. It is not user-definable, nor is it visible +// in the UI. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Connect Service's +// API operation SearchUserHierarchyGroups for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// The request is not valid. +// +// - InvalidParameterException +// One or more of the specified parameters are not valid. +// +// - ResourceNotFoundException +// The specified resource was not found. +// +// - ThrottlingException +// The throttling limit has been exceeded. +// +// - InternalServiceException +// Request processing failed because of an error or failure with the service. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchUserHierarchyGroups +func (c *Connect) SearchUserHierarchyGroups(input *SearchUserHierarchyGroupsInput) (*SearchUserHierarchyGroupsOutput, error) { + req, out := c.SearchUserHierarchyGroupsRequest(input) + return out, req.Send() +} + +// SearchUserHierarchyGroupsWithContext is the same as SearchUserHierarchyGroups with the addition of +// the ability to pass a context and additional request options. +// +// See SearchUserHierarchyGroups for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Connect) SearchUserHierarchyGroupsWithContext(ctx aws.Context, input *SearchUserHierarchyGroupsInput, opts ...request.Option) (*SearchUserHierarchyGroupsOutput, error) { + req, out := c.SearchUserHierarchyGroupsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// SearchUserHierarchyGroupsPages iterates over the pages of a SearchUserHierarchyGroups operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See SearchUserHierarchyGroups method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a SearchUserHierarchyGroups operation. +// pageNum := 0 +// err := client.SearchUserHierarchyGroupsPages(params, +// func(page *connect.SearchUserHierarchyGroupsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Connect) SearchUserHierarchyGroupsPages(input *SearchUserHierarchyGroupsInput, fn func(*SearchUserHierarchyGroupsOutput, bool) bool) error { + return c.SearchUserHierarchyGroupsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// SearchUserHierarchyGroupsPagesWithContext same as SearchUserHierarchyGroupsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Connect) SearchUserHierarchyGroupsPagesWithContext(ctx aws.Context, input *SearchUserHierarchyGroupsInput, fn func(*SearchUserHierarchyGroupsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *SearchUserHierarchyGroupsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.SearchUserHierarchyGroupsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*SearchUserHierarchyGroupsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opSearchUsers = "SearchUsers" // SearchUsersRequest generates a "aws/request.Request" representing the @@ -28637,6 +28938,101 @@ func (s *AgentStatusReference) SetStatusStartTimestamp(v time.Time) *AgentStatus return s } +// The search criteria to be used to return agent statuses. +type AgentStatusSearchCriteria struct { + _ struct{} `type:"structure"` + + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name, description, state, + // type, displayOrder, and resourceID. + AndConditions []*AgentStatusSearchCriteria `type:"list"` + + // A list of conditions which would be applied together with an OR condition. + OrConditions []*AgentStatusSearchCriteria `type:"list"` + + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name, description, state, + // type, displayOrder, and resourceID. + StringCondition *StringCondition `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AgentStatusSearchCriteria) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AgentStatusSearchCriteria) GoString() string { + return s.String() +} + +// SetAndConditions sets the AndConditions field's value. +func (s *AgentStatusSearchCriteria) SetAndConditions(v []*AgentStatusSearchCriteria) *AgentStatusSearchCriteria { + s.AndConditions = v + return s +} + +// SetOrConditions sets the OrConditions field's value. +func (s *AgentStatusSearchCriteria) SetOrConditions(v []*AgentStatusSearchCriteria) *AgentStatusSearchCriteria { + s.OrConditions = v + return s +} + +// SetStringCondition sets the StringCondition field's value. +func (s *AgentStatusSearchCriteria) SetStringCondition(v *StringCondition) *AgentStatusSearchCriteria { + s.StringCondition = v + return s +} + +// Filters to be applied to search results. +type AgentStatusSearchFilter struct { + _ struct{} `type:"structure"` + + // An object that can be used to specify Tag conditions inside the SearchFilter. + // This accepts an OR of AND (List of List) input where: + // + // * The top level list specifies conditions that need to be applied with + // OR operator. + // + // * The inner list specifies conditions that need to be applied with AND + // operator. + AttributeFilter *ControlPlaneAttributeFilter `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AgentStatusSearchFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AgentStatusSearchFilter) GoString() string { + return s.String() +} + +// SetAttributeFilter sets the AttributeFilter field's value. +func (s *AgentStatusSearchFilter) SetAttributeFilter(v *ControlPlaneAttributeFilter) *AgentStatusSearchFilter { + s.AttributeFilter = v + return s +} + // Summary information for an agent status. type AgentStatusSummary struct { _ struct{} `type:"structure"` @@ -32508,6 +32904,38 @@ func (s *ClaimedPhoneNumberSummary) SetTargetArn(v string) *ClaimedPhoneNumberSu return s } +// A list of conditions which would be applied together with an AND condition. +type CommonAttributeAndCondition struct { + _ struct{} `type:"structure"` + + // A leaf node condition which can be used to specify a tag condition. + TagConditions []*TagCondition `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CommonAttributeAndCondition) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CommonAttributeAndCondition) GoString() string { + return s.String() +} + +// SetTagConditions sets the TagConditions field's value. +func (s *CommonAttributeAndCondition) SetTagConditions(v []*TagCondition) *CommonAttributeAndCondition { + s.TagConditions = v + return s +} + // Request to CompleteAttachedFileUpload API type CompleteAttachedFileUploadInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -32615,6 +33043,50 @@ func (s CompleteAttachedFileUploadOutput) GoString() string { return s.String() } +// A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue +// and ProficiencyLimit. +type Condition struct { + _ struct{} `type:"structure"` + + // A leaf node condition which can be used to specify a numeric condition. + NumberCondition *NumberCondition `type:"structure"` + + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name and value. + StringCondition *StringCondition `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Condition) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Condition) GoString() string { + return s.String() +} + +// SetNumberCondition sets the NumberCondition field's value. +func (s *Condition) SetNumberCondition(v *NumberCondition) *Condition { + s.NumberCondition = v + return s +} + +// SetStringCondition sets the StringCondition field's value. +func (s *Condition) SetStringCondition(v *StringCondition) *Condition { + s.StringCondition = v + return s +} + // Operation cannot be performed at this time as there is a conflict with another // operation or contact state. type ConflictException struct { @@ -33455,8 +33927,6 @@ type ContactFlowModuleSearchCriteria struct { OrConditions []*ContactFlowModuleSearchCriteria `type:"list"` // A leaf node condition which can be used to specify a string condition. - // - // The currently supported values for FieldName are name and description. StringCondition *StringCondition `type:"structure"` } @@ -33674,8 +34144,6 @@ type ContactFlowSearchCriteria struct { StatusCondition *string `type:"string" enum:"ContactFlowStatus"` // A leaf node condition which can be used to specify a string condition. - // - // The currently supported values for FieldName are name and description. StringCondition *StringCondition `type:"structure"` // The type of flow. @@ -34133,6 +34601,64 @@ func (s *ContactSearchSummaryQueueInfo) SetId(v string) *ContactSearchSummaryQue return s } +// An object that can be used to specify Tag conditions inside the SearchFilter. +// This accepts an OR or AND (List of List) input where: +// +// - The top level list specifies conditions that need to be applied with +// OR operator. +// +// - The inner list specifies conditions that need to be applied with AND +// operator. +type ControlPlaneAttributeFilter struct { + _ struct{} `type:"structure"` + + // A list of conditions which would be applied together with an AND condition. + AndCondition *CommonAttributeAndCondition `type:"structure"` + + // A list of conditions which would be applied together with an OR condition. + OrConditions []*CommonAttributeAndCondition `type:"list"` + + // A leaf node condition which can be used to specify a tag condition, for example, + // HAVE BPO = 123. + TagCondition *TagCondition `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ControlPlaneAttributeFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ControlPlaneAttributeFilter) GoString() string { + return s.String() +} + +// SetAndCondition sets the AndCondition field's value. +func (s *ControlPlaneAttributeFilter) SetAndCondition(v *CommonAttributeAndCondition) *ControlPlaneAttributeFilter { + s.AndCondition = v + return s +} + +// SetOrConditions sets the OrConditions field's value. +func (s *ControlPlaneAttributeFilter) SetOrConditions(v []*CommonAttributeAndCondition) *ControlPlaneAttributeFilter { + s.OrConditions = v + return s +} + +// SetTagCondition sets the TagCondition field's value. +func (s *ControlPlaneAttributeFilter) SetTagCondition(v *TagCondition) *ControlPlaneAttributeFilter { + s.TagCondition = v + return s +} + // An object that can be used to specify Tag conditions inside the SearchFilter. // This accepts an OR of AND (List of List) input where: // @@ -50264,7 +50790,7 @@ type GetMetricDataV2Input struct { // 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: This metric is not available in Amazon Connect admin website. + // UI name: Contacts removed from queue in X seconds (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-removed-historical) // // CONTACTS_RESOLVED_IN_X // @@ -54799,6 +55325,48 @@ func (s *ListBotsOutput) SetNextToken(v string) *ListBotsOutput { return s } +// A leaf node condition which can be used to specify a List condition to search +// users with attributes included in Lists like Proficiencies. +type ListCondition struct { + _ struct{} `type:"structure"` + + // A list of Condition objects which would be applied together with an AND condition. + Conditions []*Condition `type:"list"` + + // The type of target list that will be used to filter the users. + TargetListType *string `type:"string" enum:"TargetListType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListCondition) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListCondition) GoString() string { + return s.String() +} + +// SetConditions sets the Conditions field's value. +func (s *ListCondition) SetConditions(v []*Condition) *ListCondition { + s.Conditions = v + return s +} + +// SetTargetListType sets the TargetListType field's value. +func (s *ListCondition) SetTargetListType(v string) *ListCondition { + s.TargetListType = &v + return s +} + type ListContactEvaluationsInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -60890,6 +61458,67 @@ func (s *NotificationRecipientType) SetUserTags(v map[string]*string) *Notificat return s } +// A leaf node condition which can be used to specify a numeric condition. +// +// The currently supported value for FieldName is limit. +type NumberCondition struct { + _ struct{} `type:"structure"` + + // The type of comparison to be made when evaluating the number condition. + ComparisonType *string `type:"string" enum:"NumberComparisonType"` + + // The name of the field in the number condition. + FieldName *string `type:"string"` + + // The maxValue to be used while evaluating the number condition. + MaxValue *int64 `type:"integer"` + + // The minValue to be used while evaluating the number condition. + MinValue *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NumberCondition) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NumberCondition) GoString() string { + return s.String() +} + +// SetComparisonType sets the ComparisonType field's value. +func (s *NumberCondition) SetComparisonType(v string) *NumberCondition { + s.ComparisonType = &v + return s +} + +// SetFieldName sets the FieldName field's value. +func (s *NumberCondition) SetFieldName(v string) *NumberCondition { + s.FieldName = &v + return s +} + +// SetMaxValue sets the MaxValue field's value. +func (s *NumberCondition) SetMaxValue(v int64) *NumberCondition { + s.MaxValue = &v + return s +} + +// SetMinValue sets the MinValue field's value. +func (s *NumberCondition) SetMinValue(v int64) *NumberCondition { + s.MinValue = &v + return s +} + // Information about a reference when the referenceType is NUMBER. Otherwise, // null. type NumberReference struct { @@ -61928,8 +62557,6 @@ type PredefinedAttributeSearchCriteria struct { OrConditions []*PredefinedAttributeSearchCriteria `type:"list"` // A leaf node condition which can be used to specify a string condition. - // - // The currently supported values for FieldName are name and description. StringCondition *StringCondition `type:"structure"` } @@ -66421,6 +67048,148 @@ func (s *S3Config) SetEncryptionConfig(v *EncryptionConfig) *S3Config { return s } +type SearchAgentStatusesInput struct { + _ struct{} `type:"structure"` + + // The identifier of the Amazon Connect instance. You can find the instanceId + // in the ARN of the instance. + // + // InstanceId is a required field + InstanceId *string `min:"1" type:"string" required:"true"` + + // The maximum number of results to return per page. + MaxResults *int64 `min:"1" type:"integer"` + + // 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. + NextToken *string `min:"1" type:"string"` + + // The search criteria to be used to return agent statuses. + SearchCriteria *AgentStatusSearchCriteria `type:"structure"` + + // Filters to be applied to search results. + SearchFilter *AgentStatusSearchFilter `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchAgentStatusesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchAgentStatusesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchAgentStatusesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchAgentStatusesInput"} + if s.InstanceId == nil { + invalidParams.Add(request.NewErrParamRequired("InstanceId")) + } + if s.InstanceId != nil && len(*s.InstanceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetInstanceId sets the InstanceId field's value. +func (s *SearchAgentStatusesInput) SetInstanceId(v string) *SearchAgentStatusesInput { + s.InstanceId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *SearchAgentStatusesInput) SetMaxResults(v int64) *SearchAgentStatusesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchAgentStatusesInput) SetNextToken(v string) *SearchAgentStatusesInput { + s.NextToken = &v + return s +} + +// SetSearchCriteria sets the SearchCriteria field's value. +func (s *SearchAgentStatusesInput) SetSearchCriteria(v *AgentStatusSearchCriteria) *SearchAgentStatusesInput { + s.SearchCriteria = v + return s +} + +// SetSearchFilter sets the SearchFilter field's value. +func (s *SearchAgentStatusesInput) SetSearchFilter(v *AgentStatusSearchFilter) *SearchAgentStatusesInput { + s.SearchFilter = v + return s +} + +type SearchAgentStatusesOutput struct { + _ struct{} `type:"structure"` + + // The search criteria to be used to return agent statuses. + AgentStatuses []*AgentStatus `type:"list"` + + // The total number of agent statuses which matched your search query. + ApproximateTotalCount *int64 `type:"long"` + + // If there are additional results, this is the token for the next set of results. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchAgentStatusesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchAgentStatusesOutput) GoString() string { + return s.String() +} + +// SetAgentStatuses sets the AgentStatuses field's value. +func (s *SearchAgentStatusesOutput) SetAgentStatuses(v []*AgentStatus) *SearchAgentStatusesOutput { + s.AgentStatuses = v + return s +} + +// SetApproximateTotalCount sets the ApproximateTotalCount field's value. +func (s *SearchAgentStatusesOutput) SetApproximateTotalCount(v int64) *SearchAgentStatusesOutput { + s.ApproximateTotalCount = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchAgentStatusesOutput) SetNextToken(v string) *SearchAgentStatusesOutput { + s.NextToken = &v + return s +} + type SearchAvailablePhoneNumbersInput struct { _ struct{} `type:"structure"` @@ -67967,6 +68736,24 @@ type SearchResourceTagsInput struct { // The list of resource types to be used to search tags from. If not provided // or if any empty list is provided, this API will search from all supported // resource types. + // + // Supported resource types + // + // * AGENT + // + // * ROUTING_PROFILE + // + // * STANDARD_QUEUE + // + // * SECURITY_PROFILE + // + // * OPERATING_HOURS + // + // * PROMPT + // + // * CONTACT_FLOW + // + // * FLOW_MODULE ResourceTypes []*string `type:"list"` // The search criteria to be used to return tags. @@ -68379,6 +69166,148 @@ func (s *SearchSecurityProfilesOutput) SetSecurityProfiles(v []*SecurityProfileS return s } +type SearchUserHierarchyGroupsInput struct { + _ struct{} `type:"structure"` + + // The identifier of the Amazon Connect instance. You can find the instanceId + // in the ARN of the instance. + // + // InstanceId is a required field + InstanceId *string `min:"1" type:"string" required:"true"` + + // The maximum number of results to return per page. + MaxResults *int64 `min:"1" type:"integer"` + + // 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. + NextToken *string `min:"1" type:"string"` + + // The search criteria to be used to return UserHierarchyGroups. + SearchCriteria *UserHierarchyGroupSearchCriteria `type:"structure"` + + // Filters to be applied to search results. + SearchFilter *UserHierarchyGroupSearchFilter `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchUserHierarchyGroupsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchUserHierarchyGroupsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchUserHierarchyGroupsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchUserHierarchyGroupsInput"} + if s.InstanceId == nil { + invalidParams.Add(request.NewErrParamRequired("InstanceId")) + } + if s.InstanceId != nil && len(*s.InstanceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetInstanceId sets the InstanceId field's value. +func (s *SearchUserHierarchyGroupsInput) SetInstanceId(v string) *SearchUserHierarchyGroupsInput { + s.InstanceId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *SearchUserHierarchyGroupsInput) SetMaxResults(v int64) *SearchUserHierarchyGroupsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchUserHierarchyGroupsInput) SetNextToken(v string) *SearchUserHierarchyGroupsInput { + s.NextToken = &v + return s +} + +// SetSearchCriteria sets the SearchCriteria field's value. +func (s *SearchUserHierarchyGroupsInput) SetSearchCriteria(v *UserHierarchyGroupSearchCriteria) *SearchUserHierarchyGroupsInput { + s.SearchCriteria = v + return s +} + +// SetSearchFilter sets the SearchFilter field's value. +func (s *SearchUserHierarchyGroupsInput) SetSearchFilter(v *UserHierarchyGroupSearchFilter) *SearchUserHierarchyGroupsInput { + s.SearchFilter = v + return s +} + +type SearchUserHierarchyGroupsOutput struct { + _ struct{} `type:"structure"` + + // The total number of userHierarchyGroups which matched your search query. + ApproximateTotalCount *int64 `type:"long"` + + // If there are additional results, this is the token for the next set of results. + NextToken *string `min:"1" type:"string"` + + // Information about the userHierarchyGroups. + UserHierarchyGroups []*HierarchyGroup `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchUserHierarchyGroupsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchUserHierarchyGroupsOutput) GoString() string { + return s.String() +} + +// SetApproximateTotalCount sets the ApproximateTotalCount field's value. +func (s *SearchUserHierarchyGroupsOutput) SetApproximateTotalCount(v int64) *SearchUserHierarchyGroupsOutput { + s.ApproximateTotalCount = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchUserHierarchyGroupsOutput) SetNextToken(v string) *SearchUserHierarchyGroupsOutput { + s.NextToken = &v + return s +} + +// SetUserHierarchyGroups sets the UserHierarchyGroups field's value. +func (s *SearchUserHierarchyGroupsOutput) SetUserHierarchyGroups(v []*HierarchyGroup) *SearchUserHierarchyGroupsOutput { + s.UserHierarchyGroups = v + return s +} + type SearchUsersInput struct { _ struct{} `type:"structure"` @@ -69012,8 +69941,6 @@ type SecurityProfileSearchCriteria struct { OrConditions []*SecurityProfileSearchCriteria `type:"list"` // A leaf node condition which can be used to specify a string condition. - // - // The currently supported values for FieldName are name and description. StringCondition *StringCondition `type:"structure"` } @@ -71927,8 +72854,6 @@ func (s StopContactStreamingOutput) GoString() string { } // A leaf node condition which can be used to specify a string condition. -// -// The currently supported values for FieldName are name and description. type StringCondition struct { _ struct{} `type:"structure"` @@ -80608,6 +81533,98 @@ func (s *UserDataFilters) SetUserHierarchyGroups(v []*string) *UserDataFilters { return s } +// The search criteria to be used to return userHierarchyGroup. +type UserHierarchyGroupSearchCriteria struct { + _ struct{} `type:"structure"` + + // A list of conditions which would be applied together with an AND condition. + AndConditions []*UserHierarchyGroupSearchCriteria `type:"list"` + + // A list of conditions which would be applied together with an OR condition. + OrConditions []*UserHierarchyGroupSearchCriteria `type:"list"` + + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name, parentId, levelId, + // and resourceID. + StringCondition *StringCondition `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UserHierarchyGroupSearchCriteria) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UserHierarchyGroupSearchCriteria) GoString() string { + return s.String() +} + +// SetAndConditions sets the AndConditions field's value. +func (s *UserHierarchyGroupSearchCriteria) SetAndConditions(v []*UserHierarchyGroupSearchCriteria) *UserHierarchyGroupSearchCriteria { + s.AndConditions = v + return s +} + +// SetOrConditions sets the OrConditions field's value. +func (s *UserHierarchyGroupSearchCriteria) SetOrConditions(v []*UserHierarchyGroupSearchCriteria) *UserHierarchyGroupSearchCriteria { + s.OrConditions = v + return s +} + +// SetStringCondition sets the StringCondition field's value. +func (s *UserHierarchyGroupSearchCriteria) SetStringCondition(v *StringCondition) *UserHierarchyGroupSearchCriteria { + s.StringCondition = v + return s +} + +// Filters to be applied to search results. +type UserHierarchyGroupSearchFilter struct { + _ struct{} `type:"structure"` + + // An object that can be used to specify Tag conditions inside the SearchFilter. + // This accepts an OR or AND (List of List) input where: + // + // * The top level list specifies conditions that need to be applied with + // OR operator. + // + // * The inner list specifies conditions that need to be applied with AND + // operator. + AttributeFilter *ControlPlaneAttributeFilter `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UserHierarchyGroupSearchFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UserHierarchyGroupSearchFilter) GoString() string { + return s.String() +} + +// SetAttributeFilter sets the AttributeFilter field's value. +func (s *UserHierarchyGroupSearchFilter) SetAttributeFilter(v *ControlPlaneAttributeFilter) *UserHierarchyGroupSearchFilter { + s.AttributeFilter = v + return s +} + // Contains information about the identity of a user. // // For Amazon Connect instances that are created with the EXISTING_DIRECTORY @@ -81183,6 +82200,10 @@ type UserSearchCriteria struct { // A leaf node condition which can be used to specify a hierarchy group condition. HierarchyGroupCondition *HierarchyGroupCondition `type:"structure"` + // A leaf node condition which can be used to specify a List condition to search + // users with attributes included in Lists like Proficiencies. + ListCondition *ListCondition `type:"structure"` + // A list of conditions which would be applied together with an OR condition. OrConditions []*UserSearchCriteria `type:"list"` @@ -81223,6 +82244,12 @@ func (s *UserSearchCriteria) SetHierarchyGroupCondition(v *HierarchyGroupConditi return s } +// SetListCondition sets the ListCondition field's value. +func (s *UserSearchCriteria) SetListCondition(v *ListCondition) *UserSearchCriteria { + s.ListCondition = v + return s +} + // SetOrConditions sets the OrConditions field's value. func (s *UserSearchCriteria) SetOrConditions(v []*UserSearchCriteria) *UserSearchCriteria { s.OrConditions = v @@ -83475,6 +84502,42 @@ func NotificationDeliveryType_Values() []string { } } +const ( + // NumberComparisonTypeGreaterOrEqual is a NumberComparisonType enum value + NumberComparisonTypeGreaterOrEqual = "GREATER_OR_EQUAL" + + // NumberComparisonTypeGreater is a NumberComparisonType enum value + NumberComparisonTypeGreater = "GREATER" + + // NumberComparisonTypeLesserOrEqual is a NumberComparisonType enum value + NumberComparisonTypeLesserOrEqual = "LESSER_OR_EQUAL" + + // NumberComparisonTypeLesser is a NumberComparisonType enum value + NumberComparisonTypeLesser = "LESSER" + + // NumberComparisonTypeEqual is a NumberComparisonType enum value + NumberComparisonTypeEqual = "EQUAL" + + // NumberComparisonTypeNotEqual is a NumberComparisonType enum value + NumberComparisonTypeNotEqual = "NOT_EQUAL" + + // NumberComparisonTypeRange is a NumberComparisonType enum value + NumberComparisonTypeRange = "RANGE" +) + +// NumberComparisonType_Values returns all elements of the NumberComparisonType enum +func NumberComparisonType_Values() []string { + return []string{ + NumberComparisonTypeGreaterOrEqual, + NumberComparisonTypeGreater, + NumberComparisonTypeLesserOrEqual, + NumberComparisonTypeLesser, + NumberComparisonTypeEqual, + NumberComparisonTypeNotEqual, + NumberComparisonTypeRange, + } +} + const ( // NumericQuestionPropertyAutomationLabelOverallCustomerSentimentScore is a NumericQuestionPropertyAutomationLabel enum value NumericQuestionPropertyAutomationLabelOverallCustomerSentimentScore = "OVERALL_CUSTOMER_SENTIMENT_SCORE" @@ -85127,6 +86190,18 @@ func StringComparisonType_Values() []string { } } +const ( + // TargetListTypeProficiencies is a TargetListType enum value + TargetListTypeProficiencies = "PROFICIENCIES" +) + +// TargetListType_Values returns all elements of the TargetListType enum +func TargetListType_Values() []string { + return []string{ + TargetListTypeProficiencies, + } +} + const ( // TaskTemplateFieldTypeName is a TaskTemplateFieldType enum value TaskTemplateFieldTypeName = "NAME" diff --git a/service/connect/connectiface/interface.go b/service/connect/connectiface/interface.go index f3106149a6c..11db384617e 100644 --- a/service/connect/connectiface/interface.go +++ b/service/connect/connectiface/interface.go @@ -893,6 +893,13 @@ type ConnectAPI interface { ResumeContactRecordingWithContext(aws.Context, *connect.ResumeContactRecordingInput, ...request.Option) (*connect.ResumeContactRecordingOutput, error) ResumeContactRecordingRequest(*connect.ResumeContactRecordingInput) (*request.Request, *connect.ResumeContactRecordingOutput) + SearchAgentStatuses(*connect.SearchAgentStatusesInput) (*connect.SearchAgentStatusesOutput, error) + SearchAgentStatusesWithContext(aws.Context, *connect.SearchAgentStatusesInput, ...request.Option) (*connect.SearchAgentStatusesOutput, error) + SearchAgentStatusesRequest(*connect.SearchAgentStatusesInput) (*request.Request, *connect.SearchAgentStatusesOutput) + + SearchAgentStatusesPages(*connect.SearchAgentStatusesInput, func(*connect.SearchAgentStatusesOutput, bool) bool) error + SearchAgentStatusesPagesWithContext(aws.Context, *connect.SearchAgentStatusesInput, func(*connect.SearchAgentStatusesOutput, bool) bool, ...request.Option) error + SearchAvailablePhoneNumbers(*connect.SearchAvailablePhoneNumbersInput) (*connect.SearchAvailablePhoneNumbersOutput, error) SearchAvailablePhoneNumbersWithContext(aws.Context, *connect.SearchAvailablePhoneNumbersInput, ...request.Option) (*connect.SearchAvailablePhoneNumbersOutput, error) SearchAvailablePhoneNumbersRequest(*connect.SearchAvailablePhoneNumbersInput) (*request.Request, *connect.SearchAvailablePhoneNumbersOutput) @@ -977,6 +984,13 @@ type ConnectAPI interface { SearchSecurityProfilesPages(*connect.SearchSecurityProfilesInput, func(*connect.SearchSecurityProfilesOutput, bool) bool) error SearchSecurityProfilesPagesWithContext(aws.Context, *connect.SearchSecurityProfilesInput, func(*connect.SearchSecurityProfilesOutput, bool) bool, ...request.Option) error + SearchUserHierarchyGroups(*connect.SearchUserHierarchyGroupsInput) (*connect.SearchUserHierarchyGroupsOutput, error) + SearchUserHierarchyGroupsWithContext(aws.Context, *connect.SearchUserHierarchyGroupsInput, ...request.Option) (*connect.SearchUserHierarchyGroupsOutput, error) + SearchUserHierarchyGroupsRequest(*connect.SearchUserHierarchyGroupsInput) (*request.Request, *connect.SearchUserHierarchyGroupsOutput) + + SearchUserHierarchyGroupsPages(*connect.SearchUserHierarchyGroupsInput, func(*connect.SearchUserHierarchyGroupsOutput, bool) bool) error + SearchUserHierarchyGroupsPagesWithContext(aws.Context, *connect.SearchUserHierarchyGroupsInput, func(*connect.SearchUserHierarchyGroupsOutput, bool) bool, ...request.Option) error + SearchUsers(*connect.SearchUsersInput) (*connect.SearchUsersOutput, error) SearchUsersWithContext(aws.Context, *connect.SearchUsersInput, ...request.Option) (*connect.SearchUsersOutput, error) SearchUsersRequest(*connect.SearchUsersInput) (*request.Request, *connect.SearchUsersOutput) diff --git a/service/ec2/api.go b/service/ec2/api.go index 813b1c058b7..02e0ebd835e 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -6172,6 +6172,83 @@ func (c *EC2) CreateIpamWithContext(ctx aws.Context, input *CreateIpamInput, opt return out, req.Send() } +const opCreateIpamExternalResourceVerificationToken = "CreateIpamExternalResourceVerificationToken" + +// CreateIpamExternalResourceVerificationTokenRequest generates a "aws/request.Request" representing the +// client's request for the CreateIpamExternalResourceVerificationToken operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateIpamExternalResourceVerificationToken for more information on using the CreateIpamExternalResourceVerificationToken +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateIpamExternalResourceVerificationTokenRequest method. +// req, resp := client.CreateIpamExternalResourceVerificationTokenRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken +func (c *EC2) CreateIpamExternalResourceVerificationTokenRequest(input *CreateIpamExternalResourceVerificationTokenInput) (req *request.Request, output *CreateIpamExternalResourceVerificationTokenOutput) { + op := &request.Operation{ + Name: opCreateIpamExternalResourceVerificationToken, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateIpamExternalResourceVerificationTokenInput{} + } + + output = &CreateIpamExternalResourceVerificationTokenOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateIpamExternalResourceVerificationToken API operation for Amazon Elastic Compute Cloud. +// +// Create a verification token. A verification token is an Amazon Web Services-generated +// random value that you can use to prove ownership of an external resource. +// For example, you can use a verification token to validate that you control +// a public IP address range when you bring an IP address range to Amazon Web +// Services (BYOIP). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation CreateIpamExternalResourceVerificationToken for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken +func (c *EC2) CreateIpamExternalResourceVerificationToken(input *CreateIpamExternalResourceVerificationTokenInput) (*CreateIpamExternalResourceVerificationTokenOutput, error) { + req, out := c.CreateIpamExternalResourceVerificationTokenRequest(input) + return out, req.Send() +} + +// CreateIpamExternalResourceVerificationTokenWithContext is the same as CreateIpamExternalResourceVerificationToken with the addition of +// the ability to pass a context and additional request options. +// +// See CreateIpamExternalResourceVerificationToken for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EC2) CreateIpamExternalResourceVerificationTokenWithContext(ctx aws.Context, input *CreateIpamExternalResourceVerificationTokenInput, opts ...request.Option) (*CreateIpamExternalResourceVerificationTokenOutput, error) { + req, out := c.CreateIpamExternalResourceVerificationTokenRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateIpamPool = "CreateIpamPool" // CreateIpamPoolRequest generates a "aws/request.Request" representing the @@ -12296,6 +12373,83 @@ func (c *EC2) DeleteIpamWithContext(ctx aws.Context, input *DeleteIpamInput, opt return out, req.Send() } +const opDeleteIpamExternalResourceVerificationToken = "DeleteIpamExternalResourceVerificationToken" + +// DeleteIpamExternalResourceVerificationTokenRequest generates a "aws/request.Request" representing the +// client's request for the DeleteIpamExternalResourceVerificationToken operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteIpamExternalResourceVerificationToken for more information on using the DeleteIpamExternalResourceVerificationToken +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteIpamExternalResourceVerificationTokenRequest method. +// req, resp := client.DeleteIpamExternalResourceVerificationTokenRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken +func (c *EC2) DeleteIpamExternalResourceVerificationTokenRequest(input *DeleteIpamExternalResourceVerificationTokenInput) (req *request.Request, output *DeleteIpamExternalResourceVerificationTokenOutput) { + op := &request.Operation{ + Name: opDeleteIpamExternalResourceVerificationToken, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteIpamExternalResourceVerificationTokenInput{} + } + + output = &DeleteIpamExternalResourceVerificationTokenOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteIpamExternalResourceVerificationToken API operation for Amazon Elastic Compute Cloud. +// +// Delete a verification token. A verification token is an Amazon Web Services-generated +// random value that you can use to prove ownership of an external resource. +// For example, you can use a verification token to validate that you control +// a public IP address range when you bring an IP address range to Amazon Web +// Services (BYOIP). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation DeleteIpamExternalResourceVerificationToken for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken +func (c *EC2) DeleteIpamExternalResourceVerificationToken(input *DeleteIpamExternalResourceVerificationTokenInput) (*DeleteIpamExternalResourceVerificationTokenOutput, error) { + req, out := c.DeleteIpamExternalResourceVerificationTokenRequest(input) + return out, req.Send() +} + +// DeleteIpamExternalResourceVerificationTokenWithContext is the same as DeleteIpamExternalResourceVerificationToken with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteIpamExternalResourceVerificationToken for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EC2) DeleteIpamExternalResourceVerificationTokenWithContext(ctx aws.Context, input *DeleteIpamExternalResourceVerificationTokenInput, opts ...request.Option) (*DeleteIpamExternalResourceVerificationTokenOutput, error) { + req, out := c.DeleteIpamExternalResourceVerificationTokenRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteIpamPool = "DeleteIpamPool" // DeleteIpamPoolRequest generates a "aws/request.Request" representing the @@ -24055,6 +24209,83 @@ func (c *EC2) DescribeIpamByoasnWithContext(ctx aws.Context, input *DescribeIpam return out, req.Send() } +const opDescribeIpamExternalResourceVerificationTokens = "DescribeIpamExternalResourceVerificationTokens" + +// DescribeIpamExternalResourceVerificationTokensRequest generates a "aws/request.Request" representing the +// client's request for the DescribeIpamExternalResourceVerificationTokens operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeIpamExternalResourceVerificationTokens for more information on using the DescribeIpamExternalResourceVerificationTokens +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DescribeIpamExternalResourceVerificationTokensRequest method. +// req, resp := client.DescribeIpamExternalResourceVerificationTokensRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens +func (c *EC2) DescribeIpamExternalResourceVerificationTokensRequest(input *DescribeIpamExternalResourceVerificationTokensInput) (req *request.Request, output *DescribeIpamExternalResourceVerificationTokensOutput) { + op := &request.Operation{ + Name: opDescribeIpamExternalResourceVerificationTokens, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeIpamExternalResourceVerificationTokensInput{} + } + + output = &DescribeIpamExternalResourceVerificationTokensOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeIpamExternalResourceVerificationTokens API operation for Amazon Elastic Compute Cloud. +// +// Describe verification tokens. A verification token is an Amazon Web Services-generated +// random value that you can use to prove ownership of an external resource. +// For example, you can use a verification token to validate that you control +// a public IP address range when you bring an IP address range to Amazon Web +// Services (BYOIP). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation DescribeIpamExternalResourceVerificationTokens for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens +func (c *EC2) DescribeIpamExternalResourceVerificationTokens(input *DescribeIpamExternalResourceVerificationTokensInput) (*DescribeIpamExternalResourceVerificationTokensOutput, error) { + req, out := c.DescribeIpamExternalResourceVerificationTokensRequest(input) + return out, req.Send() +} + +// DescribeIpamExternalResourceVerificationTokensWithContext is the same as DescribeIpamExternalResourceVerificationTokens with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeIpamExternalResourceVerificationTokens for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EC2) DescribeIpamExternalResourceVerificationTokensWithContext(ctx aws.Context, input *DescribeIpamExternalResourceVerificationTokensInput, opts ...request.Option) (*DescribeIpamExternalResourceVerificationTokensOutput, error) { + req, out := c.DescribeIpamExternalResourceVerificationTokensRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeIpamPools = "DescribeIpamPools" // DescribeIpamPoolsRequest generates a "aws/request.Request" representing the @@ -27608,6 +27839,12 @@ func (c *EC2) DescribePlacementGroupsRequest(input *DescribePlacementGroupsInput // DescribePlacementGroups API operation for Amazon Elastic Compute Cloud. // // Describes the specified placement groups or all of your placement groups. +// +// To describe a specific placement group that is shared with your account, +// you must specify the ID of the placement group using the GroupId parameter. +// Specifying the name of a shared placement group using the GroupNames parameter +// will result in an error. +// // For more information, see Placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) // in the Amazon EC2 User Guide. // @@ -34046,10 +34283,6 @@ func (c *EC2) DescribeVolumesModificationsRequest(input *DescribeVolumesModifica // Describes the most recent volume modification request for the specified EBS // volumes. // -// If a volume has never been modified, some information in the output will -// be null. If a volume has been modified more than once, the output includes -// only the most recent modification request. -// // For more information, see Monitor the progress of volume modifications (https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html) // in the Amazon EBS User Guide. // @@ -40709,15 +40942,6 @@ func (c *EC2) GetConsoleOutputRequest(input *GetConsoleOutputInput) (req *reques // instances, the instance console output includes the last three system event // log errors. // -// By default, the console output returns buffered information that was posted -// shortly after an instance transition state (start, stop, reboot, or terminate). -// This information is available for at least one hour after the most recent -// post. Only the most recent 64 KB of console output is available. -// -// You can optionally retrieve the latest serial console output at any time -// during the instance lifecycle. This option is supported on instance types -// that use the Nitro hypervisor. -// // For more information, see Instance console output (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#instance-console-console-output) // in the Amazon EC2 User Guide. // @@ -73802,6 +74026,114 @@ func (s *CreateInternetGatewayOutput) SetInternetGateway(v *InternetGateway) *Cr return s } +type CreateIpamExternalResourceVerificationTokenInput struct { + _ struct{} `type:"structure"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). + ClientToken *string `type:"string" idempotencyToken:"true"` + + // A check for 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. + DryRun *bool `type:"boolean"` + + // The ID of the IPAM that will create the token. + // + // IpamId is a required field + IpamId *string `type:"string" required:"true"` + + // Token tags. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateIpamExternalResourceVerificationTokenInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateIpamExternalResourceVerificationTokenInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateIpamExternalResourceVerificationTokenInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateIpamExternalResourceVerificationTokenInput"} + if s.IpamId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateIpamExternalResourceVerificationTokenInput) SetClientToken(v string) *CreateIpamExternalResourceVerificationTokenInput { + s.ClientToken = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *CreateIpamExternalResourceVerificationTokenInput) SetDryRun(v bool) *CreateIpamExternalResourceVerificationTokenInput { + s.DryRun = &v + return s +} + +// SetIpamId sets the IpamId field's value. +func (s *CreateIpamExternalResourceVerificationTokenInput) SetIpamId(v string) *CreateIpamExternalResourceVerificationTokenInput { + s.IpamId = &v + return s +} + +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *CreateIpamExternalResourceVerificationTokenInput) SetTagSpecifications(v []*TagSpecification) *CreateIpamExternalResourceVerificationTokenInput { + s.TagSpecifications = v + return s +} + +type CreateIpamExternalResourceVerificationTokenOutput struct { + _ struct{} `type:"structure"` + + // The verification token. + IpamExternalResourceVerificationToken *IpamExternalResourceVerificationToken `locationName:"ipamExternalResourceVerificationToken" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateIpamExternalResourceVerificationTokenOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateIpamExternalResourceVerificationTokenOutput) GoString() string { + return s.String() +} + +// SetIpamExternalResourceVerificationToken sets the IpamExternalResourceVerificationToken field's value. +func (s *CreateIpamExternalResourceVerificationTokenOutput) SetIpamExternalResourceVerificationToken(v *IpamExternalResourceVerificationToken) *CreateIpamExternalResourceVerificationTokenOutput { + s.IpamExternalResourceVerificationToken = v + return s +} + type CreateIpamInput struct { _ struct{} `type:"structure"` @@ -73993,14 +74325,21 @@ type CreateIpamPoolInput struct { // IpamScopeId is a required field IpamScopeId *string `type:"string" required:"true"` - // In IPAM, the locale is the Amazon Web Services Region or, for IPAM IPv4 pools - // in the public scope, the network border group for an Amazon Web Services - // Local Zone where you want to make an IPAM pool available for allocations - // (supported Local Zones (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail)). + // The locale for the pool should be one of the following: + // + // * An Amazon Web Services Region where you want this IPAM pool to be available + // for allocations. + // + // * The network border group for an Amazon Web Services Local Zone where + // you want this IPAM pool to be available for allocations (supported Local + // Zones (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail)). + // This option is only available for IPAM IPv4 pools in the public scope. + // // If you do not choose a locale, resources in Regions others than the IPAM's // home region cannot use CIDRs from this pool. // - // Possible values: Any Amazon Web Services Region, such as us-east-1. + // Possible values: Any Amazon Web Services Region or supported Amazon Web Services + // Local Zone. Locale *string `type:"string"` // The IP address source for pools in the public scope. Only used for provisioning @@ -85227,6 +85566,95 @@ func (s DeleteInternetGatewayOutput) GoString() string { return s.String() } +type DeleteIpamExternalResourceVerificationTokenInput struct { + _ struct{} `type:"structure"` + + // A check for 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. + DryRun *bool `type:"boolean"` + + // The token ID. + // + // IpamExternalResourceVerificationTokenId is a required field + IpamExternalResourceVerificationTokenId *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteIpamExternalResourceVerificationTokenInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteIpamExternalResourceVerificationTokenInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteIpamExternalResourceVerificationTokenInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteIpamExternalResourceVerificationTokenInput"} + if s.IpamExternalResourceVerificationTokenId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamExternalResourceVerificationTokenId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DeleteIpamExternalResourceVerificationTokenInput) SetDryRun(v bool) *DeleteIpamExternalResourceVerificationTokenInput { + s.DryRun = &v + return s +} + +// SetIpamExternalResourceVerificationTokenId sets the IpamExternalResourceVerificationTokenId field's value. +func (s *DeleteIpamExternalResourceVerificationTokenInput) SetIpamExternalResourceVerificationTokenId(v string) *DeleteIpamExternalResourceVerificationTokenInput { + s.IpamExternalResourceVerificationTokenId = &v + return s +} + +type DeleteIpamExternalResourceVerificationTokenOutput struct { + _ struct{} `type:"structure"` + + // The verification token. + IpamExternalResourceVerificationToken *IpamExternalResourceVerificationToken `locationName:"ipamExternalResourceVerificationToken" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteIpamExternalResourceVerificationTokenOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteIpamExternalResourceVerificationTokenOutput) GoString() string { + return s.String() +} + +// SetIpamExternalResourceVerificationToken sets the IpamExternalResourceVerificationToken field's value. +func (s *DeleteIpamExternalResourceVerificationTokenOutput) SetIpamExternalResourceVerificationToken(v *IpamExternalResourceVerificationToken) *DeleteIpamExternalResourceVerificationTokenOutput { + s.IpamExternalResourceVerificationToken = v + return s +} + type DeleteIpamInput struct { _ struct{} `type:"structure"` @@ -100197,6 +100625,151 @@ func (s *DescribeIpamByoasnOutput) SetNextToken(v string) *DescribeIpamByoasnOut return s } +type DescribeIpamExternalResourceVerificationTokensInput struct { + _ struct{} `type:"structure"` + + // A check for 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. + DryRun *bool `type:"boolean"` + + // One or more filters for the request. For more information about filtering, + // see Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + // + // Available filters: + // + // * ipam-arn + // + // * ipam-external-resource-verification-token-arn + // + // * ipam-external-resource-verification-token-id + // + // * ipam-id + // + // * ipam-region + // + // * state + // + // * status + // + // * token-name + // + // * token-value + Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"` + + // Verification token IDs. + IpamExternalResourceVerificationTokenIds []*string `locationName:"IpamExternalResourceVerificationTokenId" locationNameList:"item" type:"list"` + + // The maximum number of tokens to return in one page of results. + MaxResults *int64 `min:"5" type:"integer"` + + // The token for the next page of results. + NextToken *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeIpamExternalResourceVerificationTokensInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeIpamExternalResourceVerificationTokensInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeIpamExternalResourceVerificationTokensInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeIpamExternalResourceVerificationTokensInput"} + if s.MaxResults != nil && *s.MaxResults < 5 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DescribeIpamExternalResourceVerificationTokensInput) SetDryRun(v bool) *DescribeIpamExternalResourceVerificationTokensInput { + s.DryRun = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *DescribeIpamExternalResourceVerificationTokensInput) SetFilters(v []*Filter) *DescribeIpamExternalResourceVerificationTokensInput { + s.Filters = v + return s +} + +// SetIpamExternalResourceVerificationTokenIds sets the IpamExternalResourceVerificationTokenIds field's value. +func (s *DescribeIpamExternalResourceVerificationTokensInput) SetIpamExternalResourceVerificationTokenIds(v []*string) *DescribeIpamExternalResourceVerificationTokensInput { + s.IpamExternalResourceVerificationTokenIds = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *DescribeIpamExternalResourceVerificationTokensInput) SetMaxResults(v int64) *DescribeIpamExternalResourceVerificationTokensInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeIpamExternalResourceVerificationTokensInput) SetNextToken(v string) *DescribeIpamExternalResourceVerificationTokensInput { + s.NextToken = &v + return s +} + +type DescribeIpamExternalResourceVerificationTokensOutput struct { + _ struct{} `type:"structure"` + + // Verification tokens. + IpamExternalResourceVerificationTokens []*IpamExternalResourceVerificationToken `locationName:"ipamExternalResourceVerificationTokenSet" locationNameList:"item" type:"list"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeIpamExternalResourceVerificationTokensOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeIpamExternalResourceVerificationTokensOutput) GoString() string { + return s.String() +} + +// SetIpamExternalResourceVerificationTokens sets the IpamExternalResourceVerificationTokens field's value. +func (s *DescribeIpamExternalResourceVerificationTokensOutput) SetIpamExternalResourceVerificationTokens(v []*IpamExternalResourceVerificationToken) *DescribeIpamExternalResourceVerificationTokensOutput { + s.IpamExternalResourceVerificationTokens = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeIpamExternalResourceVerificationTokensOutput) SetNextToken(v string) *DescribeIpamExternalResourceVerificationTokensOutput { + s.NextToken = &v + return s +} + type DescribeIpamPoolsInput struct { _ struct{} `type:"structure"` @@ -104283,7 +104856,13 @@ type DescribePlacementGroupsInput struct { // The names of the placement groups. // - // Default: Describes all your placement groups, or only those otherwise specified. + // Constraints: + // + // * You can specify a name only if the placement group is owned by your + // account. + // + // * If a placement group is shared with your account, specifying the name + // results in an error. You must use the GroupId parameter instead. GroupNames []*string `locationName:"groupName" type:"list"` } @@ -124171,7 +124750,13 @@ type FleetLaunchTemplateOverrides struct { // The ID of the subnet in which to launch the instances. SubnetId *string `locationName:"subnetId" type:"string"` - // The number of units provided by the specified instance type. + // The number of units provided by the specified instance type. These are the + // same units that you chose to set the target capacity in terms of instances, + // or a performance characteristic such as vCPUs, memory, or I/O. + // + // If the target capacity divided by this value is not a whole number, Amazon + // EC2 rounds the number of instances to the next whole number. If this value + // is not specified, the default is 1. // // When specifying weights, the price used in the lowest-price and price-capacity-optimized // allocation strategies is per unit hour (where the instance price is divided @@ -124312,7 +124897,13 @@ type FleetLaunchTemplateOverridesRequest struct { // A request of type instant can have only one subnet ID. SubnetId *string `type:"string"` - // The number of units provided by the specified instance type. + // The number of units provided by the specified instance type. These are the + // same units that you chose to set the target capacity in terms of instances, + // or a performance characteristic such as vCPUs, memory, or I/O. + // + // If the target capacity divided by this value is not a whole number, Amazon + // EC2 rounds the number of instances to the next whole number. If this value + // is not specified, the default is 1. // // When specifying weights, the price used in the lowest-price and price-capacity-optimized // allocation strategies is per unit hour (where the instance price is divided @@ -140934,7 +141525,8 @@ type IpamDiscoveredResourceCidr struct { // The resource discovery ID. IpamResourceDiscoveryId *string `locationName:"ipamResourceDiscoveryId" type:"string"` - // For elastic IP addresses, this is the status of an attached network interface. + // For elastic network interfaces, this is the status of whether or not the + // elastic network interface is attached. NetworkInterfaceAttachmentStatus *string `locationName:"networkInterfaceAttachmentStatus" type:"string" enum:"IpamNetworkInterfaceAttachmentStatus"` // The resource CIDR. @@ -141107,6 +141699,131 @@ func (s *IpamDiscoveryFailureReason) SetMessage(v string) *IpamDiscoveryFailureR return s } +// A verification token is an Amazon Web Services-generated random value that +// you can use to prove ownership of an external resource. For example, you +// can use a verification token to validate that you control a public IP address +// range when you bring an IP address range to Amazon Web Services (BYOIP). +type IpamExternalResourceVerificationToken struct { + _ struct{} `type:"structure"` + + // ARN of the IPAM that created the token. + IpamArn *string `locationName:"ipamArn" min:"1" type:"string"` + + // Token ARN. + IpamExternalResourceVerificationTokenArn *string `locationName:"ipamExternalResourceVerificationTokenArn" min:"1" type:"string"` + + // The ID of the token. + IpamExternalResourceVerificationTokenId *string `locationName:"ipamExternalResourceVerificationTokenId" type:"string"` + + // The ID of the IPAM that created the token. + IpamId *string `locationName:"ipamId" type:"string"` + + // Region of the IPAM that created the token. + IpamRegion *string `locationName:"ipamRegion" type:"string"` + + // Token expiration. + NotAfter *time.Time `locationName:"notAfter" type:"timestamp"` + + // Token state. + State *string `locationName:"state" type:"string" enum:"IpamExternalResourceVerificationTokenState"` + + // Token status. + Status *string `locationName:"status" type:"string" enum:"TokenState"` + + // Token tags. + Tags []*Tag `locationName:"tagSet" locationNameList:"item" type:"list"` + + // Token name. + TokenName *string `locationName:"tokenName" type:"string"` + + // Token value. + TokenValue *string `locationName:"tokenValue" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IpamExternalResourceVerificationToken) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IpamExternalResourceVerificationToken) GoString() string { + return s.String() +} + +// SetIpamArn sets the IpamArn field's value. +func (s *IpamExternalResourceVerificationToken) SetIpamArn(v string) *IpamExternalResourceVerificationToken { + s.IpamArn = &v + return s +} + +// SetIpamExternalResourceVerificationTokenArn sets the IpamExternalResourceVerificationTokenArn field's value. +func (s *IpamExternalResourceVerificationToken) SetIpamExternalResourceVerificationTokenArn(v string) *IpamExternalResourceVerificationToken { + s.IpamExternalResourceVerificationTokenArn = &v + return s +} + +// SetIpamExternalResourceVerificationTokenId sets the IpamExternalResourceVerificationTokenId field's value. +func (s *IpamExternalResourceVerificationToken) SetIpamExternalResourceVerificationTokenId(v string) *IpamExternalResourceVerificationToken { + s.IpamExternalResourceVerificationTokenId = &v + return s +} + +// SetIpamId sets the IpamId field's value. +func (s *IpamExternalResourceVerificationToken) SetIpamId(v string) *IpamExternalResourceVerificationToken { + s.IpamId = &v + return s +} + +// SetIpamRegion sets the IpamRegion field's value. +func (s *IpamExternalResourceVerificationToken) SetIpamRegion(v string) *IpamExternalResourceVerificationToken { + s.IpamRegion = &v + return s +} + +// SetNotAfter sets the NotAfter field's value. +func (s *IpamExternalResourceVerificationToken) SetNotAfter(v time.Time) *IpamExternalResourceVerificationToken { + s.NotAfter = &v + return s +} + +// SetState sets the State field's value. +func (s *IpamExternalResourceVerificationToken) SetState(v string) *IpamExternalResourceVerificationToken { + s.State = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *IpamExternalResourceVerificationToken) SetStatus(v string) *IpamExternalResourceVerificationToken { + s.Status = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *IpamExternalResourceVerificationToken) SetTags(v []*Tag) *IpamExternalResourceVerificationToken { + s.Tags = v + return s +} + +// SetTokenName sets the TokenName field's value. +func (s *IpamExternalResourceVerificationToken) SetTokenName(v string) *IpamExternalResourceVerificationToken { + s.TokenName = &v + return s +} + +// SetTokenValue sets the TokenValue field's value. +func (s *IpamExternalResourceVerificationToken) SetTokenValue(v string) *IpamExternalResourceVerificationToken { + s.TokenValue = &v + return s +} + // The operating Regions for an IPAM. Operating Regions are Amazon Web Services // Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers // and monitors resources in the Amazon Web Services Regions you select as operating @@ -141223,10 +141940,18 @@ type IpamPool struct { // overlap or conflict. IpamScopeType *string `locationName:"ipamScopeType" type:"string" enum:"IpamScopeType"` - // The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services - // Region or, for IPAM IPv4 pools in the public scope, the network border group - // for an Amazon Web Services Local Zone where you want to make an IPAM pool - // available for allocations (supported Local Zones (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail)). + // The locale of the IPAM pool. + // + // The locale for the pool should be one of the following: + // + // * An Amazon Web Services Region where you want this IPAM pool to be available + // for allocations. + // + // * The network border group for an Amazon Web Services Local Zone where + // you want this IPAM pool to be available for allocations (supported Local + // Zones (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail)). + // This option is only available for IPAM IPv4 pools in the public scope. + // // If you choose an Amazon Web Services Region for locale that has not been // configured as an operating Region for the IPAM, you'll get an error. Locale *string `locationName:"locale" type:"string"` @@ -145453,9 +146178,15 @@ type LaunchTemplateOverrides struct { // The ID of the subnet in which to launch the instances. SubnetId *string `locationName:"subnetId" type:"string"` - // The number of units provided by the specified instance type. + // The number of units provided by the specified instance type. These are the + // same units that you chose to set the target capacity in terms of instances, + // or a performance characteristic such as vCPUs, memory, or I/O. // - // When specifying weights, the price used in the lowest-price and price-capacity-optimized + // If the target capacity divided by this value is not a whole number, Amazon + // EC2 rounds the number of instances to the next whole number. If this value + // is not specified, the default is 1. + // + // When specifying weights, the price used in the lowestPrice and priceCapacityOptimized // allocation strategies is per unit hour (where the instance price is divided // by the specified weight). However, if all the specified weights are above // the requested TargetCapacity, resulting in only 1 instance being launched, @@ -163842,8 +164573,8 @@ type ProvisionIpamPoolCidrInput struct { Cidr *string `type:"string"` // A signed document that proves that you are authorized to bring a specified - // IP address range to Amazon using BYOIP. This option applies to public pools - // only. + // IP address range to Amazon using BYOIP. This option only applies to IPv4 + // and IPv6 pools in the public scope. CidrAuthorizationContext *IpamCidrAuthorizationContext `type:"structure"` // A unique, case-sensitive identifier that you provide to ensure the idempotency @@ -163856,6 +164587,10 @@ type ProvisionIpamPoolCidrInput struct { // is UnauthorizedOperation. DryRun *bool `type:"boolean"` + // Verification token ID. This option only applies to IPv4 and IPv6 pools in + // the public scope. + IpamExternalResourceVerificationTokenId *string `type:"string"` + // The ID of the IPAM pool to which you want to assign a CIDR. // // IpamPoolId is a required field @@ -163866,6 +164601,11 @@ type ProvisionIpamPoolCidrInput struct { // provisioning CIDRs to pools with source pools. Cannot be used to provision // BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required. NetmaskLength *int64 `type:"integer"` + + // The method for verifying control of a public IP address range. Defaults to + // remarks-x509 if not specified. This option only applies to IPv4 and IPv6 + // pools in the public scope. + VerificationMethod *string `type:"string" enum:"VerificationMethod"` } // String returns the string representation. @@ -163923,6 +164663,12 @@ func (s *ProvisionIpamPoolCidrInput) SetDryRun(v bool) *ProvisionIpamPoolCidrInp return s } +// SetIpamExternalResourceVerificationTokenId sets the IpamExternalResourceVerificationTokenId field's value. +func (s *ProvisionIpamPoolCidrInput) SetIpamExternalResourceVerificationTokenId(v string) *ProvisionIpamPoolCidrInput { + s.IpamExternalResourceVerificationTokenId = &v + return s +} + // SetIpamPoolId sets the IpamPoolId field's value. func (s *ProvisionIpamPoolCidrInput) SetIpamPoolId(v string) *ProvisionIpamPoolCidrInput { s.IpamPoolId = &v @@ -163935,6 +164681,12 @@ func (s *ProvisionIpamPoolCidrInput) SetNetmaskLength(v int64) *ProvisionIpamPoo return s } +// SetVerificationMethod sets the VerificationMethod field's value. +func (s *ProvisionIpamPoolCidrInput) SetVerificationMethod(v string) *ProvisionIpamPoolCidrInput { + s.VerificationMethod = &v + return s +} + type ProvisionIpamPoolCidrOutput struct { _ struct{} `type:"structure"` @@ -177629,6 +178381,12 @@ type SpotFleetLaunchSpecification struct { // If the target capacity divided by this value is not a whole number, Amazon // EC2 rounds the number of instances to the next whole number. If this value // is not specified, the default is 1. + // + // When specifying weights, the price used in the lowestPrice and priceCapacityOptimized + // allocation strategies is per unit hour (where the instance price is divided + // by the specified weight). However, if all the specified weights are above + // the requested TargetCapacity, resulting in only 1 instance being launched, + // the price used is per instance hour. WeightedCapacity *float64 `locationName:"weightedCapacity" type:"double"` } @@ -189002,16 +189760,13 @@ func (s *VolumeDetail) SetSize(v int64) *VolumeDetail { } // Describes the modification status of an EBS volume. -// -// If the volume has never been modified, some element values will be null. type VolumeModification struct { _ struct{} `type:"structure"` // The modification completion or failure time. EndTime *time.Time `locationName:"endTime" type:"timestamp"` - // The current modification state. The modification state is null for unmodified - // volumes. + // The current modification state. ModificationState *string `locationName:"modificationState" type:"string" enum:"VolumeModificationState"` // The original IOPS rate of the volume. @@ -198041,6 +198796,38 @@ func IpamDiscoveryFailureCode_Values() []string { } } +const ( + // IpamExternalResourceVerificationTokenStateCreateInProgress is a IpamExternalResourceVerificationTokenState enum value + IpamExternalResourceVerificationTokenStateCreateInProgress = "create-in-progress" + + // IpamExternalResourceVerificationTokenStateCreateComplete is a IpamExternalResourceVerificationTokenState enum value + IpamExternalResourceVerificationTokenStateCreateComplete = "create-complete" + + // IpamExternalResourceVerificationTokenStateCreateFailed is a IpamExternalResourceVerificationTokenState enum value + IpamExternalResourceVerificationTokenStateCreateFailed = "create-failed" + + // IpamExternalResourceVerificationTokenStateDeleteInProgress is a IpamExternalResourceVerificationTokenState enum value + IpamExternalResourceVerificationTokenStateDeleteInProgress = "delete-in-progress" + + // IpamExternalResourceVerificationTokenStateDeleteComplete is a IpamExternalResourceVerificationTokenState enum value + IpamExternalResourceVerificationTokenStateDeleteComplete = "delete-complete" + + // IpamExternalResourceVerificationTokenStateDeleteFailed is a IpamExternalResourceVerificationTokenState enum value + IpamExternalResourceVerificationTokenStateDeleteFailed = "delete-failed" +) + +// IpamExternalResourceVerificationTokenState_Values returns all elements of the IpamExternalResourceVerificationTokenState enum +func IpamExternalResourceVerificationTokenState_Values() []string { + return []string{ + IpamExternalResourceVerificationTokenStateCreateInProgress, + IpamExternalResourceVerificationTokenStateCreateComplete, + IpamExternalResourceVerificationTokenStateCreateFailed, + IpamExternalResourceVerificationTokenStateDeleteInProgress, + IpamExternalResourceVerificationTokenStateDeleteComplete, + IpamExternalResourceVerificationTokenStateDeleteFailed, + } +} + const ( // IpamManagementStateManaged is a IpamManagementState enum value IpamManagementStateManaged = "managed" @@ -200338,6 +201125,9 @@ const ( // ResourceTypeInstanceConnectEndpoint is a ResourceType enum value ResourceTypeInstanceConnectEndpoint = "instance-connect-endpoint" + + // ResourceTypeIpamExternalResourceVerificationToken is a ResourceType enum value + ResourceTypeIpamExternalResourceVerificationToken = "ipam-external-resource-verification-token" ) // ResourceType_Values returns all elements of the ResourceType enum @@ -200430,6 +201220,7 @@ func ResourceType_Values() []string { ResourceTypeIpamResourceDiscovery, ResourceTypeIpamResourceDiscoveryAssociation, ResourceTypeInstanceConnectEndpoint, + ResourceTypeIpamExternalResourceVerificationToken, } } @@ -201213,6 +202004,22 @@ func TieringOperationStatus_Values() []string { } } +const ( + // TokenStateValid is a TokenState enum value + TokenStateValid = "valid" + + // TokenStateExpired is a TokenState enum value + TokenStateExpired = "expired" +) + +// TokenState_Values returns all elements of the TokenState enum +func TokenState_Values() []string { + return []string{ + TokenStateValid, + TokenStateExpired, + } +} + const ( // TpmSupportValuesV20 is a TpmSupportValues enum value TpmSupportValuesV20 = "v2.0" @@ -201901,6 +202708,22 @@ func UserTrustProviderType_Values() []string { } } +const ( + // VerificationMethodRemarksX509 is a VerificationMethod enum value + VerificationMethodRemarksX509 = "remarks-x509" + + // VerificationMethodDnsToken is a VerificationMethod enum value + VerificationMethodDnsToken = "dns-token" +) + +// VerificationMethod_Values returns all elements of the VerificationMethod enum +func VerificationMethod_Values() []string { + return []string{ + VerificationMethodRemarksX509, + VerificationMethodDnsToken, + } +} + const ( // VerifiedAccessEndpointAttachmentTypeVpc is a VerifiedAccessEndpointAttachmentType enum value VerifiedAccessEndpointAttachmentTypeVpc = "vpc" diff --git a/service/ec2/ec2iface/interface.go b/service/ec2/ec2iface/interface.go index 3efee85fa1c..032a3d79d35 100644 --- a/service/ec2/ec2iface/interface.go +++ b/service/ec2/ec2iface/interface.go @@ -364,6 +364,10 @@ type EC2API interface { CreateIpamWithContext(aws.Context, *ec2.CreateIpamInput, ...request.Option) (*ec2.CreateIpamOutput, error) CreateIpamRequest(*ec2.CreateIpamInput) (*request.Request, *ec2.CreateIpamOutput) + CreateIpamExternalResourceVerificationToken(*ec2.CreateIpamExternalResourceVerificationTokenInput) (*ec2.CreateIpamExternalResourceVerificationTokenOutput, error) + CreateIpamExternalResourceVerificationTokenWithContext(aws.Context, *ec2.CreateIpamExternalResourceVerificationTokenInput, ...request.Option) (*ec2.CreateIpamExternalResourceVerificationTokenOutput, error) + CreateIpamExternalResourceVerificationTokenRequest(*ec2.CreateIpamExternalResourceVerificationTokenInput) (*request.Request, *ec2.CreateIpamExternalResourceVerificationTokenOutput) + CreateIpamPool(*ec2.CreateIpamPoolInput) (*ec2.CreateIpamPoolOutput, error) CreateIpamPoolWithContext(aws.Context, *ec2.CreateIpamPoolInput, ...request.Option) (*ec2.CreateIpamPoolOutput, error) CreateIpamPoolRequest(*ec2.CreateIpamPoolInput) (*request.Request, *ec2.CreateIpamPoolOutput) @@ -668,6 +672,10 @@ type EC2API interface { DeleteIpamWithContext(aws.Context, *ec2.DeleteIpamInput, ...request.Option) (*ec2.DeleteIpamOutput, error) DeleteIpamRequest(*ec2.DeleteIpamInput) (*request.Request, *ec2.DeleteIpamOutput) + DeleteIpamExternalResourceVerificationToken(*ec2.DeleteIpamExternalResourceVerificationTokenInput) (*ec2.DeleteIpamExternalResourceVerificationTokenOutput, error) + DeleteIpamExternalResourceVerificationTokenWithContext(aws.Context, *ec2.DeleteIpamExternalResourceVerificationTokenInput, ...request.Option) (*ec2.DeleteIpamExternalResourceVerificationTokenOutput, error) + DeleteIpamExternalResourceVerificationTokenRequest(*ec2.DeleteIpamExternalResourceVerificationTokenInput) (*request.Request, *ec2.DeleteIpamExternalResourceVerificationTokenOutput) + DeleteIpamPool(*ec2.DeleteIpamPoolInput) (*ec2.DeleteIpamPoolOutput, error) DeleteIpamPoolWithContext(aws.Context, *ec2.DeleteIpamPoolInput, ...request.Option) (*ec2.DeleteIpamPoolOutput, error) DeleteIpamPoolRequest(*ec2.DeleteIpamPoolInput) (*request.Request, *ec2.DeleteIpamPoolOutput) @@ -1281,6 +1289,10 @@ type EC2API interface { DescribeIpamByoasnWithContext(aws.Context, *ec2.DescribeIpamByoasnInput, ...request.Option) (*ec2.DescribeIpamByoasnOutput, error) DescribeIpamByoasnRequest(*ec2.DescribeIpamByoasnInput) (*request.Request, *ec2.DescribeIpamByoasnOutput) + DescribeIpamExternalResourceVerificationTokens(*ec2.DescribeIpamExternalResourceVerificationTokensInput) (*ec2.DescribeIpamExternalResourceVerificationTokensOutput, error) + DescribeIpamExternalResourceVerificationTokensWithContext(aws.Context, *ec2.DescribeIpamExternalResourceVerificationTokensInput, ...request.Option) (*ec2.DescribeIpamExternalResourceVerificationTokensOutput, error) + DescribeIpamExternalResourceVerificationTokensRequest(*ec2.DescribeIpamExternalResourceVerificationTokensInput) (*request.Request, *ec2.DescribeIpamExternalResourceVerificationTokensOutput) + DescribeIpamPools(*ec2.DescribeIpamPoolsInput) (*ec2.DescribeIpamPoolsOutput, error) DescribeIpamPoolsWithContext(aws.Context, *ec2.DescribeIpamPoolsInput, ...request.Option) (*ec2.DescribeIpamPoolsOutput, error) DescribeIpamPoolsRequest(*ec2.DescribeIpamPoolsInput) (*request.Request, *ec2.DescribeIpamPoolsOutput) diff --git a/service/firehose/api.go b/service/firehose/api.go index a7ba464afbf..32e0ff9e229 100644 --- a/service/firehose/api.go +++ b/service/firehose/api.go @@ -2735,6 +2735,57 @@ func (s *BufferingHints) SetSizeInMBs(v int64) *BufferingHints { return s } +// Describes the containers where the destination Apache Iceberg Tables are +// persisted. +// +// Amazon Data Firehose is in preview release and is subject to change. +type CatalogConfiguration struct { + _ struct{} `type:"structure"` + + // Specifies the Glue catalog ARN indentifier of the destination Apache Iceberg + // Tables. You must specify the ARN in the format arn:aws:glue:region:account-id:catalog. + // + // Amazon Data Firehose is in preview release and is subject to change. + CatalogARN *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CatalogConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CatalogConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CatalogConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CatalogConfiguration"} + if s.CatalogARN != nil && len(*s.CatalogARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CatalogARN", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCatalogARN sets the CatalogARN field's value. +func (s *CatalogConfiguration) SetCatalogARN(v string) *CatalogConfiguration { + s.CatalogARN = &v + return s +} + // Describes the Amazon CloudWatch logging options for your delivery stream. type CloudWatchLoggingOptions struct { _ struct{} `type:"structure"` @@ -2980,6 +3031,11 @@ type CreateDeliveryStreamInput struct { // destination. You can specify only one destination. HttpEndpointDestinationConfiguration *HttpEndpointDestinationConfiguration `type:"structure"` + // Configure Apache Iceberg Tables destination. + // + // Amazon Data Firehose is in preview release and is subject to change. + IcebergDestinationConfiguration *IcebergDestinationConfiguration `type:"structure"` + // When a Kinesis data stream is used as the source for the delivery stream, // a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon // Resource Name (ARN) and the role ARN for the source stream. @@ -3088,6 +3144,11 @@ func (s *CreateDeliveryStreamInput) Validate() error { invalidParams.AddNested("HttpEndpointDestinationConfiguration", err.(request.ErrInvalidParams)) } } + if s.IcebergDestinationConfiguration != nil { + if err := s.IcebergDestinationConfiguration.Validate(); err != nil { + invalidParams.AddNested("IcebergDestinationConfiguration", err.(request.ErrInvalidParams)) + } + } if s.KinesisStreamSourceConfiguration != nil { if err := s.KinesisStreamSourceConfiguration.Validate(); err != nil { invalidParams.AddNested("KinesisStreamSourceConfiguration", err.(request.ErrInvalidParams)) @@ -3183,6 +3244,12 @@ func (s *CreateDeliveryStreamInput) SetHttpEndpointDestinationConfiguration(v *H return s } +// SetIcebergDestinationConfiguration sets the IcebergDestinationConfiguration field's value. +func (s *CreateDeliveryStreamInput) SetIcebergDestinationConfiguration(v *IcebergDestinationConfiguration) *CreateDeliveryStreamInput { + s.IcebergDestinationConfiguration = v + return s +} + // SetKinesisStreamSourceConfiguration sets the KinesisStreamSourceConfiguration field's value. func (s *CreateDeliveryStreamInput) SetKinesisStreamSourceConfiguration(v *KinesisStreamSourceConfiguration) *CreateDeliveryStreamInput { s.KinesisStreamSourceConfiguration = v @@ -3933,6 +4000,11 @@ type DestinationDescription struct { // Describes the specified HTTP endpoint destination. HttpEndpointDestinationDescription *HttpEndpointDestinationDescription `type:"structure"` + // Describes a destination in Apache Iceberg Tables. + // + // Amazon Data Firehose is in preview release and is subject to change. + IcebergDestinationDescription *IcebergDestinationDescription `type:"structure"` + // The destination in Amazon Redshift. RedshiftDestinationDescription *RedshiftDestinationDescription `type:"structure"` @@ -4000,6 +4072,12 @@ func (s *DestinationDescription) SetHttpEndpointDestinationDescription(v *HttpEn return s } +// SetIcebergDestinationDescription sets the IcebergDestinationDescription field's value. +func (s *DestinationDescription) SetIcebergDestinationDescription(v *IcebergDestinationDescription) *DestinationDescription { + s.IcebergDestinationDescription = v + return s +} + // SetRedshiftDestinationDescription sets the RedshiftDestinationDescription field's value. func (s *DestinationDescription) SetRedshiftDestinationDescription(v *RedshiftDestinationDescription) *DestinationDescription { s.RedshiftDestinationDescription = v @@ -4024,6 +4102,103 @@ func (s *DestinationDescription) SetSplunkDestinationDescription(v *SplunkDestin return s } +// Describes the configuration of a destination in Apache Iceberg Tables. +// +// Amazon Data Firehose is in preview release and is subject to change. +type DestinationTableConfiguration struct { + _ struct{} `type:"structure"` + + // The name of the Apache Iceberg database. + // + // Amazon Data Firehose is in preview release and is subject to change. + // + // DestinationDatabaseName is a required field + DestinationDatabaseName *string `min:"1" type:"string" required:"true"` + + // Specifies the name of the Apache Iceberg Table. + // + // Amazon Data Firehose is in preview release and is subject to change. + // + // DestinationTableName is a required field + DestinationTableName *string `min:"1" type:"string" required:"true"` + + // The table specific S3 error output prefix. All the errors that occurred while + // delivering to this table will be prefixed with this value in S3 destination. + // + // Amazon Data Firehose is in preview release and is subject to change. + S3ErrorOutputPrefix *string `type:"string"` + + // A list of unique keys for a given Apache Iceberg table. Firehose will use + // these for running Create/Update/Delete operations on the given Iceberg table. + // + // Amazon Data Firehose is in preview release and is subject to change. + UniqueKeys []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DestinationTableConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DestinationTableConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DestinationTableConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DestinationTableConfiguration"} + if s.DestinationDatabaseName == nil { + invalidParams.Add(request.NewErrParamRequired("DestinationDatabaseName")) + } + if s.DestinationDatabaseName != nil && len(*s.DestinationDatabaseName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DestinationDatabaseName", 1)) + } + if s.DestinationTableName == nil { + invalidParams.Add(request.NewErrParamRequired("DestinationTableName")) + } + if s.DestinationTableName != nil && len(*s.DestinationTableName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DestinationTableName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDestinationDatabaseName sets the DestinationDatabaseName field's value. +func (s *DestinationTableConfiguration) SetDestinationDatabaseName(v string) *DestinationTableConfiguration { + s.DestinationDatabaseName = &v + return s +} + +// SetDestinationTableName sets the DestinationTableName field's value. +func (s *DestinationTableConfiguration) SetDestinationTableName(v string) *DestinationTableConfiguration { + s.DestinationTableName = &v + return s +} + +// SetS3ErrorOutputPrefix sets the S3ErrorOutputPrefix field's value. +func (s *DestinationTableConfiguration) SetS3ErrorOutputPrefix(v string) *DestinationTableConfiguration { + s.S3ErrorOutputPrefix = &v + return s +} + +// SetUniqueKeys sets the UniqueKeys field's value. +func (s *DestinationTableConfiguration) SetUniqueKeys(v []*string) *DestinationTableConfiguration { + s.UniqueKeys = v + return s +} + // Indicates the method for setting up document ID. The supported methods are // Firehose generated document ID and OpenSearch Service generated document // ID. @@ -6254,84 +6429,521 @@ func (s *HttpEndpointDestinationUpdate) Validate() error { } } - if invalidParams.Len() > 0 { - return invalidParams - } - return nil + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBufferingHints sets the BufferingHints field's value. +func (s *HttpEndpointDestinationUpdate) SetBufferingHints(v *HttpEndpointBufferingHints) *HttpEndpointDestinationUpdate { + s.BufferingHints = v + return s +} + +// SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value. +func (s *HttpEndpointDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *HttpEndpointDestinationUpdate { + s.CloudWatchLoggingOptions = v + return s +} + +// SetEndpointConfiguration sets the EndpointConfiguration field's value. +func (s *HttpEndpointDestinationUpdate) SetEndpointConfiguration(v *HttpEndpointConfiguration) *HttpEndpointDestinationUpdate { + s.EndpointConfiguration = v + return s +} + +// SetProcessingConfiguration sets the ProcessingConfiguration field's value. +func (s *HttpEndpointDestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *HttpEndpointDestinationUpdate { + s.ProcessingConfiguration = v + return s +} + +// SetRequestConfiguration sets the RequestConfiguration field's value. +func (s *HttpEndpointDestinationUpdate) SetRequestConfiguration(v *HttpEndpointRequestConfiguration) *HttpEndpointDestinationUpdate { + s.RequestConfiguration = v + return s +} + +// SetRetryOptions sets the RetryOptions field's value. +func (s *HttpEndpointDestinationUpdate) SetRetryOptions(v *HttpEndpointRetryOptions) *HttpEndpointDestinationUpdate { + s.RetryOptions = v + return s +} + +// SetRoleARN sets the RoleARN field's value. +func (s *HttpEndpointDestinationUpdate) SetRoleARN(v string) *HttpEndpointDestinationUpdate { + s.RoleARN = &v + return s +} + +// SetS3BackupMode sets the S3BackupMode field's value. +func (s *HttpEndpointDestinationUpdate) SetS3BackupMode(v string) *HttpEndpointDestinationUpdate { + s.S3BackupMode = &v + return s +} + +// SetS3Update sets the S3Update field's value. +func (s *HttpEndpointDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *HttpEndpointDestinationUpdate { + s.S3Update = v + return s +} + +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *HttpEndpointDestinationUpdate) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *HttpEndpointDestinationUpdate { + s.SecretsManagerConfiguration = v + return s +} + +// The configuration of the HTTP endpoint request. +type HttpEndpointRequestConfiguration struct { + _ struct{} `type:"structure"` + + // Describes the metadata sent to the HTTP endpoint destination. + CommonAttributes []*HttpEndpointCommonAttribute `type:"list"` + + // Firehose uses the content encoding to compress the body of a request before + // sending the request to the destination. For more information, see Content-Encoding + // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding) + // in MDN Web Docs, the official Mozilla documentation. + ContentEncoding *string `type:"string" enum:"ContentEncoding"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s HttpEndpointRequestConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s HttpEndpointRequestConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *HttpEndpointRequestConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "HttpEndpointRequestConfiguration"} + if s.CommonAttributes != nil { + for i, v := range s.CommonAttributes { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "CommonAttributes", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCommonAttributes sets the CommonAttributes field's value. +func (s *HttpEndpointRequestConfiguration) SetCommonAttributes(v []*HttpEndpointCommonAttribute) *HttpEndpointRequestConfiguration { + s.CommonAttributes = v + return s +} + +// SetContentEncoding sets the ContentEncoding field's value. +func (s *HttpEndpointRequestConfiguration) SetContentEncoding(v string) *HttpEndpointRequestConfiguration { + s.ContentEncoding = &v + return s +} + +// Describes the retry behavior in case Firehose is unable to deliver data to +// the specified HTTP endpoint destination, or if it doesn't receive a valid +// acknowledgment of receipt from the specified HTTP endpoint destination. +type HttpEndpointRetryOptions struct { + _ struct{} `type:"structure"` + + // The total amount of time that Firehose spends on retries. This duration starts + // after the initial attempt to send data to the custom destination via HTTPS + // endpoint fails. It doesn't include the periods during which Firehose waits + // for acknowledgment from the specified destination after each attempt. + DurationInSeconds *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s HttpEndpointRetryOptions) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s HttpEndpointRetryOptions) GoString() string { + return s.String() +} + +// SetDurationInSeconds sets the DurationInSeconds field's value. +func (s *HttpEndpointRetryOptions) SetDurationInSeconds(v int64) *HttpEndpointRetryOptions { + s.DurationInSeconds = &v + return s +} + +// Specifies the destination configure settings for Apache Iceberg Table. +// +// Amazon Data Firehose is in preview release and is subject to change. +type IcebergDestinationConfiguration struct { + _ struct{} `type:"structure"` + + // Describes hints for the buffering to perform before delivering data to the + // destination. These options are treated as hints, and therefore Firehose might + // choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds + // parameters are optional. However, if specify a value for one of them, you + // must also provide a value for the other. + BufferingHints *BufferingHints `type:"structure"` + + // Configuration describing where the destination Apache Iceberg Tables are + // persisted. + // + // Amazon Data Firehose is in preview release and is subject to change. + // + // CatalogConfiguration is a required field + CatalogConfiguration *CatalogConfiguration `type:"structure" required:"true"` + + // Describes the Amazon CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` + + // Provides a list of DestinationTableConfigurations which Firehose uses to + // deliver data to Apache Iceberg tables. + // + // Amazon Data Firehose is in preview release and is subject to change. + DestinationTableConfigurationList []*DestinationTableConfiguration `type:"list"` + + // Describes a data processing configuration. + ProcessingConfiguration *ProcessingConfiguration `type:"structure"` + + // The retry behavior in case Firehose is unable to deliver data to an Amazon + // S3 prefix. + RetryOptions *RetryOptions `type:"structure"` + + // The Amazon Resource Name (ARN) of the Apache Iceberg tables role. + // + // Amazon Data Firehose is in preview release and is subject to change. + // + // RoleARN is a required field + RoleARN *string `min:"1" type:"string" required:"true"` + + // Describes how Firehose will backup records. Currently,Firehose only supports + // FailedDataOnly for preview. + // + // Amazon Data Firehose is in preview release and is subject to change. + S3BackupMode *string `type:"string" enum:"IcebergS3BackupMode"` + + // Describes the configuration of a destination in Amazon S3. + // + // S3Configuration is a required field + S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IcebergDestinationConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IcebergDestinationConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *IcebergDestinationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "IcebergDestinationConfiguration"} + if s.CatalogConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("CatalogConfiguration")) + } + if s.RoleARN == nil { + invalidParams.Add(request.NewErrParamRequired("RoleARN")) + } + if s.RoleARN != nil && len(*s.RoleARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RoleARN", 1)) + } + if s.S3Configuration == nil { + invalidParams.Add(request.NewErrParamRequired("S3Configuration")) + } + if s.BufferingHints != nil { + if err := s.BufferingHints.Validate(); err != nil { + invalidParams.AddNested("BufferingHints", err.(request.ErrInvalidParams)) + } + } + if s.CatalogConfiguration != nil { + if err := s.CatalogConfiguration.Validate(); err != nil { + invalidParams.AddNested("CatalogConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.DestinationTableConfigurationList != nil { + for i, v := range s.DestinationTableConfigurationList { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DestinationTableConfigurationList", i), err.(request.ErrInvalidParams)) + } + } + } + if s.ProcessingConfiguration != nil { + if err := s.ProcessingConfiguration.Validate(); err != nil { + invalidParams.AddNested("ProcessingConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.S3Configuration != nil { + if err := s.S3Configuration.Validate(); err != nil { + invalidParams.AddNested("S3Configuration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBufferingHints sets the BufferingHints field's value. +func (s *IcebergDestinationConfiguration) SetBufferingHints(v *BufferingHints) *IcebergDestinationConfiguration { + s.BufferingHints = v + return s +} + +// SetCatalogConfiguration sets the CatalogConfiguration field's value. +func (s *IcebergDestinationConfiguration) SetCatalogConfiguration(v *CatalogConfiguration) *IcebergDestinationConfiguration { + s.CatalogConfiguration = v + return s +} + +// SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value. +func (s *IcebergDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *IcebergDestinationConfiguration { + s.CloudWatchLoggingOptions = v + return s +} + +// SetDestinationTableConfigurationList sets the DestinationTableConfigurationList field's value. +func (s *IcebergDestinationConfiguration) SetDestinationTableConfigurationList(v []*DestinationTableConfiguration) *IcebergDestinationConfiguration { + s.DestinationTableConfigurationList = v + return s +} + +// SetProcessingConfiguration sets the ProcessingConfiguration field's value. +func (s *IcebergDestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *IcebergDestinationConfiguration { + s.ProcessingConfiguration = v + return s +} + +// SetRetryOptions sets the RetryOptions field's value. +func (s *IcebergDestinationConfiguration) SetRetryOptions(v *RetryOptions) *IcebergDestinationConfiguration { + s.RetryOptions = v + return s +} + +// SetRoleARN sets the RoleARN field's value. +func (s *IcebergDestinationConfiguration) SetRoleARN(v string) *IcebergDestinationConfiguration { + s.RoleARN = &v + return s +} + +// SetS3BackupMode sets the S3BackupMode field's value. +func (s *IcebergDestinationConfiguration) SetS3BackupMode(v string) *IcebergDestinationConfiguration { + s.S3BackupMode = &v + return s +} + +// SetS3Configuration sets the S3Configuration field's value. +func (s *IcebergDestinationConfiguration) SetS3Configuration(v *S3DestinationConfiguration) *IcebergDestinationConfiguration { + s.S3Configuration = v + return s +} + +// Describes a destination in Apache Iceberg Tables. +// +// Amazon Data Firehose is in preview release and is subject to change. +type IcebergDestinationDescription struct { + _ struct{} `type:"structure"` + + // Describes hints for the buffering to perform before delivering data to the + // destination. These options are treated as hints, and therefore Firehose might + // choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds + // parameters are optional. However, if specify a value for one of them, you + // must also provide a value for the other. + BufferingHints *BufferingHints `type:"structure"` + + // Configuration describing where the destination Iceberg tables are persisted. + // + // Amazon Data Firehose is in preview release and is subject to change. + CatalogConfiguration *CatalogConfiguration `type:"structure"` + + // Describes the Amazon CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` + + // Provides a list of DestinationTableConfigurations which Firehose uses to + // deliver data to Apache Iceberg tables. + // + // Amazon Data Firehose is in preview release and is subject to change. + DestinationTableConfigurationList []*DestinationTableConfiguration `type:"list"` + + // Describes a data processing configuration. + ProcessingConfiguration *ProcessingConfiguration `type:"structure"` + + // The retry behavior in case Firehose is unable to deliver data to an Amazon + // S3 prefix. + RetryOptions *RetryOptions `type:"structure"` + + // The Amazon Resource Name (ARN) of the Apache Iceberg Tables role. + // + // Amazon Data Firehose is in preview release and is subject to change. + RoleARN *string `min:"1" type:"string"` + + // Describes how Firehose will backup records. Currently,Firehose only supports + // FailedDataOnly for preview. + // + // Amazon Data Firehose is in preview release and is subject to change. + S3BackupMode *string `type:"string" enum:"IcebergS3BackupMode"` + + // Describes a destination in Amazon S3. + S3DestinationDescription *S3DestinationDescription `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IcebergDestinationDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IcebergDestinationDescription) GoString() string { + return s.String() } // SetBufferingHints sets the BufferingHints field's value. -func (s *HttpEndpointDestinationUpdate) SetBufferingHints(v *HttpEndpointBufferingHints) *HttpEndpointDestinationUpdate { +func (s *IcebergDestinationDescription) SetBufferingHints(v *BufferingHints) *IcebergDestinationDescription { s.BufferingHints = v return s } +// SetCatalogConfiguration sets the CatalogConfiguration field's value. +func (s *IcebergDestinationDescription) SetCatalogConfiguration(v *CatalogConfiguration) *IcebergDestinationDescription { + s.CatalogConfiguration = v + return s +} + // SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value. -func (s *HttpEndpointDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *HttpEndpointDestinationUpdate { +func (s *IcebergDestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *IcebergDestinationDescription { s.CloudWatchLoggingOptions = v return s } -// SetEndpointConfiguration sets the EndpointConfiguration field's value. -func (s *HttpEndpointDestinationUpdate) SetEndpointConfiguration(v *HttpEndpointConfiguration) *HttpEndpointDestinationUpdate { - s.EndpointConfiguration = v +// SetDestinationTableConfigurationList sets the DestinationTableConfigurationList field's value. +func (s *IcebergDestinationDescription) SetDestinationTableConfigurationList(v []*DestinationTableConfiguration) *IcebergDestinationDescription { + s.DestinationTableConfigurationList = v return s } // SetProcessingConfiguration sets the ProcessingConfiguration field's value. -func (s *HttpEndpointDestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *HttpEndpointDestinationUpdate { +func (s *IcebergDestinationDescription) SetProcessingConfiguration(v *ProcessingConfiguration) *IcebergDestinationDescription { s.ProcessingConfiguration = v return s } -// SetRequestConfiguration sets the RequestConfiguration field's value. -func (s *HttpEndpointDestinationUpdate) SetRequestConfiguration(v *HttpEndpointRequestConfiguration) *HttpEndpointDestinationUpdate { - s.RequestConfiguration = v - return s -} - // SetRetryOptions sets the RetryOptions field's value. -func (s *HttpEndpointDestinationUpdate) SetRetryOptions(v *HttpEndpointRetryOptions) *HttpEndpointDestinationUpdate { +func (s *IcebergDestinationDescription) SetRetryOptions(v *RetryOptions) *IcebergDestinationDescription { s.RetryOptions = v return s } // SetRoleARN sets the RoleARN field's value. -func (s *HttpEndpointDestinationUpdate) SetRoleARN(v string) *HttpEndpointDestinationUpdate { +func (s *IcebergDestinationDescription) SetRoleARN(v string) *IcebergDestinationDescription { s.RoleARN = &v return s } // SetS3BackupMode sets the S3BackupMode field's value. -func (s *HttpEndpointDestinationUpdate) SetS3BackupMode(v string) *HttpEndpointDestinationUpdate { +func (s *IcebergDestinationDescription) SetS3BackupMode(v string) *IcebergDestinationDescription { s.S3BackupMode = &v return s } -// SetS3Update sets the S3Update field's value. -func (s *HttpEndpointDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *HttpEndpointDestinationUpdate { - s.S3Update = v - return s -} - -// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. -func (s *HttpEndpointDestinationUpdate) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *HttpEndpointDestinationUpdate { - s.SecretsManagerConfiguration = v +// SetS3DestinationDescription sets the S3DestinationDescription field's value. +func (s *IcebergDestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *IcebergDestinationDescription { + s.S3DestinationDescription = v return s } -// The configuration of the HTTP endpoint request. -type HttpEndpointRequestConfiguration struct { +// Describes an update for a destination in Apache Iceberg Tables. +// +// Amazon Data Firehose is in preview release and is subject to change. +type IcebergDestinationUpdate struct { _ struct{} `type:"structure"` - // Describes the metadata sent to the HTTP endpoint destination. - CommonAttributes []*HttpEndpointCommonAttribute `type:"list"` + // Describes hints for the buffering to perform before delivering data to the + // destination. These options are treated as hints, and therefore Firehose might + // choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds + // parameters are optional. However, if specify a value for one of them, you + // must also provide a value for the other. + BufferingHints *BufferingHints `type:"structure"` - // Firehose uses the content encoding to compress the body of a request before - // sending the request to the destination. For more information, see Content-Encoding - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding) - // in MDN Web Docs, the official Mozilla documentation. - ContentEncoding *string `type:"string" enum:"ContentEncoding"` + // Configuration describing where the destination Iceberg tables are persisted. + // + // Amazon Data Firehose is in preview release and is subject to change. + CatalogConfiguration *CatalogConfiguration `type:"structure"` + + // Describes the Amazon CloudWatch logging options for your delivery stream. + CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` + + // Provides a list of DestinationTableConfigurations which Firehose uses to + // deliver data to Apache Iceberg tables. + // + // Amazon Data Firehose is in preview release and is subject to change. + DestinationTableConfigurationList []*DestinationTableConfiguration `type:"list"` + + // Describes a data processing configuration. + ProcessingConfiguration *ProcessingConfiguration `type:"structure"` + + // The retry behavior in case Firehose is unable to deliver data to an Amazon + // S3 prefix. + RetryOptions *RetryOptions `type:"structure"` + + // The Amazon Resource Name (ARN) of the Apache Iceberg Tables role. + // + // Amazon Data Firehose is in preview release and is subject to change. + RoleARN *string `min:"1" type:"string"` + + // Describes how Firehose will backup records. Currently,Firehose only supports + // FailedDataOnly for preview. + // + // Amazon Data Firehose is in preview release and is subject to change. + S3BackupMode *string `type:"string" enum:"IcebergS3BackupMode"` + + // Describes the configuration of a destination in Amazon S3. + S3Configuration *S3DestinationConfiguration `type:"structure"` } // String returns the string representation. @@ -6339,7 +6951,7 @@ type HttpEndpointRequestConfiguration struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s HttpEndpointRequestConfiguration) String() string { +func (s IcebergDestinationUpdate) String() string { return awsutil.Prettify(s) } @@ -6348,23 +6960,46 @@ func (s HttpEndpointRequestConfiguration) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s HttpEndpointRequestConfiguration) GoString() string { +func (s IcebergDestinationUpdate) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *HttpEndpointRequestConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "HttpEndpointRequestConfiguration"} - if s.CommonAttributes != nil { - for i, v := range s.CommonAttributes { +func (s *IcebergDestinationUpdate) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "IcebergDestinationUpdate"} + if s.RoleARN != nil && len(*s.RoleARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RoleARN", 1)) + } + if s.BufferingHints != nil { + if err := s.BufferingHints.Validate(); err != nil { + invalidParams.AddNested("BufferingHints", err.(request.ErrInvalidParams)) + } + } + if s.CatalogConfiguration != nil { + if err := s.CatalogConfiguration.Validate(); err != nil { + invalidParams.AddNested("CatalogConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.DestinationTableConfigurationList != nil { + for i, v := range s.DestinationTableConfigurationList { if v == nil { continue } if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "CommonAttributes", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DestinationTableConfigurationList", i), err.(request.ErrInvalidParams)) } } } + if s.ProcessingConfiguration != nil { + if err := s.ProcessingConfiguration.Validate(); err != nil { + invalidParams.AddNested("ProcessingConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.S3Configuration != nil { + if err := s.S3Configuration.Validate(); err != nil { + invalidParams.AddNested("S3Configuration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -6372,52 +7007,57 @@ func (s *HttpEndpointRequestConfiguration) Validate() error { return nil } -// SetCommonAttributes sets the CommonAttributes field's value. -func (s *HttpEndpointRequestConfiguration) SetCommonAttributes(v []*HttpEndpointCommonAttribute) *HttpEndpointRequestConfiguration { - s.CommonAttributes = v +// SetBufferingHints sets the BufferingHints field's value. +func (s *IcebergDestinationUpdate) SetBufferingHints(v *BufferingHints) *IcebergDestinationUpdate { + s.BufferingHints = v return s } -// SetContentEncoding sets the ContentEncoding field's value. -func (s *HttpEndpointRequestConfiguration) SetContentEncoding(v string) *HttpEndpointRequestConfiguration { - s.ContentEncoding = &v +// SetCatalogConfiguration sets the CatalogConfiguration field's value. +func (s *IcebergDestinationUpdate) SetCatalogConfiguration(v *CatalogConfiguration) *IcebergDestinationUpdate { + s.CatalogConfiguration = v return s } -// Describes the retry behavior in case Firehose is unable to deliver data to -// the specified HTTP endpoint destination, or if it doesn't receive a valid -// acknowledgment of receipt from the specified HTTP endpoint destination. -type HttpEndpointRetryOptions struct { - _ struct{} `type:"structure"` +// SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value. +func (s *IcebergDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *IcebergDestinationUpdate { + s.CloudWatchLoggingOptions = v + return s +} - // The total amount of time that Firehose spends on retries. This duration starts - // after the initial attempt to send data to the custom destination via HTTPS - // endpoint fails. It doesn't include the periods during which Firehose waits - // for acknowledgment from the specified destination after each attempt. - DurationInSeconds *int64 `type:"integer"` +// SetDestinationTableConfigurationList sets the DestinationTableConfigurationList field's value. +func (s *IcebergDestinationUpdate) SetDestinationTableConfigurationList(v []*DestinationTableConfiguration) *IcebergDestinationUpdate { + s.DestinationTableConfigurationList = v + return s } -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s HttpEndpointRetryOptions) String() string { - return awsutil.Prettify(s) +// SetProcessingConfiguration sets the ProcessingConfiguration field's value. +func (s *IcebergDestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *IcebergDestinationUpdate { + s.ProcessingConfiguration = v + return s } -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s HttpEndpointRetryOptions) GoString() string { - return s.String() +// SetRetryOptions sets the RetryOptions field's value. +func (s *IcebergDestinationUpdate) SetRetryOptions(v *RetryOptions) *IcebergDestinationUpdate { + s.RetryOptions = v + return s } -// SetDurationInSeconds sets the DurationInSeconds field's value. -func (s *HttpEndpointRetryOptions) SetDurationInSeconds(v int64) *HttpEndpointRetryOptions { - s.DurationInSeconds = &v +// SetRoleARN sets the RoleARN field's value. +func (s *IcebergDestinationUpdate) SetRoleARN(v string) *IcebergDestinationUpdate { + s.RoleARN = &v + return s +} + +// SetS3BackupMode sets the S3BackupMode field's value. +func (s *IcebergDestinationUpdate) SetS3BackupMode(v string) *IcebergDestinationUpdate { + s.S3BackupMode = &v + return s +} + +// SetS3Configuration sets the S3Configuration field's value. +func (s *IcebergDestinationUpdate) SetS3Configuration(v *S3DestinationConfiguration) *IcebergDestinationUpdate { + s.S3Configuration = v return s } @@ -7158,6 +7798,14 @@ type MSKSourceConfiguration struct { // MSKClusterARN is a required field MSKClusterARN *string `min:"1" type:"string" required:"true"` + // The start date and time in UTC for the offset position within your MSK topic + // from where Firehose begins to read. By default, this is set to timestamp + // when Firehose becomes Active. + // + // If you want to create a Firehose stream with Earliest start position from + // SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z). + ReadFromTimestamp *time.Time `type:"timestamp"` + // The topic name within the Amazon MSK cluster. // // TopicName is a required field @@ -7224,6 +7872,12 @@ func (s *MSKSourceConfiguration) SetMSKClusterARN(v string) *MSKSourceConfigurat return s } +// SetReadFromTimestamp sets the ReadFromTimestamp field's value. +func (s *MSKSourceConfiguration) SetReadFromTimestamp(v time.Time) *MSKSourceConfiguration { + s.ReadFromTimestamp = &v + return s +} + // SetTopicName sets the TopicName field's value. func (s *MSKSourceConfiguration) SetTopicName(v string) *MSKSourceConfiguration { s.TopicName = &v @@ -7245,6 +7899,14 @@ type MSKSourceDescription struct { // The ARN of the Amazon MSK cluster. MSKClusterARN *string `min:"1" type:"string"` + // The start date and time in UTC for the offset position within your MSK topic + // from where Firehose begins to read. By default, this is set to timestamp + // when Firehose becomes Active. + // + // If you want to create a Firehose stream with Earliest start position from + // SDK or CLI, you need to set the ReadFromTimestampUTC parameter to Epoch (1970-01-01T00:00:00Z). + ReadFromTimestamp *time.Time `type:"timestamp"` + // The topic name within the Amazon MSK cluster. TopicName *string `min:"1" type:"string"` } @@ -7285,6 +7947,12 @@ func (s *MSKSourceDescription) SetMSKClusterARN(v string) *MSKSourceDescription return s } +// SetReadFromTimestamp sets the ReadFromTimestamp field's value. +func (s *MSKSourceDescription) SetReadFromTimestamp(v time.Time) *MSKSourceDescription { + s.ReadFromTimestamp = &v + return s +} + // SetTopicName sets the TopicName field's value. func (s *MSKSourceDescription) SetTopicName(v string) *MSKSourceDescription { s.TopicName = &v @@ -9696,6 +10364,63 @@ func (s *ServiceUnavailableException) RequestID() string { return s.RespMetadata.RequestID } +// Describes the buffering to perform before delivering data to the Snowflake +// destination. If you do not specify any value, Firehose uses the default values. +type SnowflakeBufferingHints struct { + _ struct{} `type:"structure"` + + // Buffer incoming data for the specified period of time, in seconds, before + // delivering it to the destination. The default value is 0. + IntervalInSeconds *int64 `type:"integer"` + + // Buffer incoming data to the specified size, in MBs, before delivering it + // to the destination. The default value is 1. + SizeInMBs *int64 `min:"1" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SnowflakeBufferingHints) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SnowflakeBufferingHints) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SnowflakeBufferingHints) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SnowflakeBufferingHints"} + if s.SizeInMBs != nil && *s.SizeInMBs < 1 { + invalidParams.Add(request.NewErrParamMinValue("SizeInMBs", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIntervalInSeconds sets the IntervalInSeconds field's value. +func (s *SnowflakeBufferingHints) SetIntervalInSeconds(v int64) *SnowflakeBufferingHints { + s.IntervalInSeconds = &v + return s +} + +// SetSizeInMBs sets the SizeInMBs field's value. +func (s *SnowflakeBufferingHints) SetSizeInMBs(v int64) *SnowflakeBufferingHints { + s.SizeInMBs = &v + return s +} + // Configure Snowflake destination type SnowflakeDestinationConfiguration struct { _ struct{} `type:"structure"` @@ -9711,6 +10436,10 @@ type SnowflakeDestinationConfiguration struct { // AccountUrl is a required field AccountUrl *string `min:"24" type:"string" required:"true" sensitive:"true"` + // Describes the buffering to perform before delivering data to the Snowflake + // destination. If you do not specify any value, Firehose uses the default values. + BufferingHints *SnowflakeBufferingHints `type:"structure"` + // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` @@ -9887,6 +10616,11 @@ func (s *SnowflakeDestinationConfiguration) Validate() error { if s.User != nil && len(*s.User) < 1 { invalidParams.Add(request.NewErrParamMinLen("User", 1)) } + if s.BufferingHints != nil { + if err := s.BufferingHints.Validate(); err != nil { + invalidParams.AddNested("BufferingHints", err.(request.ErrInvalidParams)) + } + } if s.ProcessingConfiguration != nil { if err := s.ProcessingConfiguration.Validate(); err != nil { invalidParams.AddNested("ProcessingConfiguration", err.(request.ErrInvalidParams)) @@ -9925,6 +10659,12 @@ func (s *SnowflakeDestinationConfiguration) SetAccountUrl(v string) *SnowflakeDe return s } +// SetBufferingHints sets the BufferingHints field's value. +func (s *SnowflakeDestinationConfiguration) SetBufferingHints(v *SnowflakeBufferingHints) *SnowflakeDestinationConfiguration { + s.BufferingHints = v + return s +} + // SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value. func (s *SnowflakeDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *SnowflakeDestinationConfiguration { s.CloudWatchLoggingOptions = v @@ -10046,6 +10786,10 @@ type SnowflakeDestinationDescription struct { // String and GoString methods. AccountUrl *string `min:"24" type:"string" sensitive:"true"` + // Describes the buffering to perform before delivering data to the Snowflake + // destination. If you do not specify any value, Firehose uses the default values. + BufferingHints *SnowflakeBufferingHints `type:"structure"` + // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` @@ -10151,6 +10895,12 @@ func (s *SnowflakeDestinationDescription) SetAccountUrl(v string) *SnowflakeDest return s } +// SetBufferingHints sets the BufferingHints field's value. +func (s *SnowflakeDestinationDescription) SetBufferingHints(v *SnowflakeBufferingHints) *SnowflakeDestinationDescription { + s.BufferingHints = v + return s +} + // SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value. func (s *SnowflakeDestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *SnowflakeDestinationDescription { s.CloudWatchLoggingOptions = v @@ -10260,6 +11010,10 @@ type SnowflakeDestinationUpdate struct { // String and GoString methods. AccountUrl *string `min:"24" type:"string" sensitive:"true"` + // Describes the buffering to perform before delivering data to the Snowflake + // destination. + BufferingHints *SnowflakeBufferingHints `type:"structure"` + // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` @@ -10416,6 +11170,11 @@ func (s *SnowflakeDestinationUpdate) Validate() error { if s.User != nil && len(*s.User) < 1 { invalidParams.Add(request.NewErrParamMinLen("User", 1)) } + if s.BufferingHints != nil { + if err := s.BufferingHints.Validate(); err != nil { + invalidParams.AddNested("BufferingHints", err.(request.ErrInvalidParams)) + } + } if s.ProcessingConfiguration != nil { if err := s.ProcessingConfiguration.Validate(); err != nil { invalidParams.AddNested("ProcessingConfiguration", err.(request.ErrInvalidParams)) @@ -10449,6 +11208,12 @@ func (s *SnowflakeDestinationUpdate) SetAccountUrl(v string) *SnowflakeDestinati return s } +// SetBufferingHints sets the BufferingHints field's value. +func (s *SnowflakeDestinationUpdate) SetBufferingHints(v *SnowflakeBufferingHints) *SnowflakeDestinationUpdate { + s.BufferingHints = v + return s +} + // SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value. func (s *SnowflakeDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *SnowflakeDestinationUpdate { s.CloudWatchLoggingOptions = v @@ -11778,6 +12543,11 @@ type UpdateDestinationInput struct { // Describes an update to the specified HTTP endpoint destination. HttpEndpointDestinationUpdate *HttpEndpointDestinationUpdate `type:"structure"` + // Describes an update for a destination in Apache Iceberg Tables. + // + // Amazon Data Firehose is in preview release and is subject to change. + IcebergDestinationUpdate *IcebergDestinationUpdate `type:"structure"` + // Describes an update for a destination in Amazon Redshift. RedshiftDestinationUpdate *RedshiftDestinationUpdate `type:"structure"` @@ -11857,6 +12627,11 @@ func (s *UpdateDestinationInput) Validate() error { invalidParams.AddNested("HttpEndpointDestinationUpdate", err.(request.ErrInvalidParams)) } } + if s.IcebergDestinationUpdate != nil { + if err := s.IcebergDestinationUpdate.Validate(); err != nil { + invalidParams.AddNested("IcebergDestinationUpdate", err.(request.ErrInvalidParams)) + } + } if s.RedshiftDestinationUpdate != nil { if err := s.RedshiftDestinationUpdate.Validate(); err != nil { invalidParams.AddNested("RedshiftDestinationUpdate", err.(request.ErrInvalidParams)) @@ -11932,6 +12707,12 @@ func (s *UpdateDestinationInput) SetHttpEndpointDestinationUpdate(v *HttpEndpoin return s } +// SetIcebergDestinationUpdate sets the IcebergDestinationUpdate field's value. +func (s *UpdateDestinationInput) SetIcebergDestinationUpdate(v *IcebergDestinationUpdate) *UpdateDestinationInput { + s.IcebergDestinationUpdate = v + return s +} + // SetRedshiftDestinationUpdate sets the RedshiftDestinationUpdate field's value. func (s *UpdateDestinationInput) SetRedshiftDestinationUpdate(v *RedshiftDestinationUpdate) *UpdateDestinationInput { s.RedshiftDestinationUpdate = v @@ -12586,6 +13367,22 @@ func HttpEndpointS3BackupMode_Values() []string { } } +const ( + // IcebergS3BackupModeFailedDataOnly is a IcebergS3BackupMode enum value + IcebergS3BackupModeFailedDataOnly = "FailedDataOnly" + + // IcebergS3BackupModeAllData is a IcebergS3BackupMode enum value + IcebergS3BackupModeAllData = "AllData" +) + +// IcebergS3BackupMode_Values returns all elements of the IcebergS3BackupMode enum +func IcebergS3BackupMode_Values() []string { + return []string{ + IcebergS3BackupModeFailedDataOnly, + IcebergS3BackupModeAllData, + } +} + const ( // KeyTypeAwsOwnedCmk is a KeyType enum value KeyTypeAwsOwnedCmk = "AWS_OWNED_CMK" diff --git a/service/ivschat/doc.go b/service/ivschat/doc.go index fcd36aed1e4..5bab3c23b72 100644 --- a/service/ivschat/doc.go +++ b/service/ivschat/doc.go @@ -15,6 +15,10 @@ // the Amazon IVS page (https://docs.aws.amazon.com/general/latest/gr/ivs.html) // in the AWS General Reference. // +// This document describes HTTP operations. There is a separate messaging API +// for managing Chat resources; see the Amazon IVS Chat Messaging API Reference +// (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html). +// // Notes on terminology: // // - You create service applications using the Amazon IVS Chat API. We refer @@ -23,13 +27,17 @@ // - You create front-end client applications (browser and Android/iOS apps) // using the Amazon IVS Chat Messaging API. We refer to these as clients. // -// Key Concepts +// # Resources +// +// The following resources are part of Amazon IVS Chat: // // - LoggingConfiguration — A configuration that allows customers to store -// and record sent messages in a chat room. +// and record sent messages in a chat room. See the Logging Configuration +// endpoints for more information. // // - Room — The central Amazon IVS Chat resource through which clients -// connect to and exchange chat messages. +// connect to and exchange chat messages. See the Room endpoints for more +// information. // // # Tagging // @@ -96,73 +104,6 @@ // and API calls. For more information, see Amazon Resource Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // in the AWS General Reference. // -// Messaging Endpoints -// -// - DeleteMessage — Sends an event to a specific room which directs clients -// to delete a specific message; that is, unrender it from view and delete -// it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. -// This replicates the DeleteMessage (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html) -// WebSocket operation in the Amazon IVS Chat Messaging API. -// -// - DisconnectUser — Disconnects all connections using a specified user -// ID from a room. This replicates the DisconnectUser (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html) -// WebSocket operation in the Amazon IVS Chat Messaging API. -// -// - SendEvent — Sends an event to a room. Use this within your application’s -// business logic to send events to clients of a room; e.g., to notify clients -// to change the way the chat UI is rendered. -// -// Chat Token Endpoint -// -// - CreateChatToken — Creates an encrypted token that is used by a chat -// participant to establish an individual WebSocket chat connection to a -// room. When the token is used to connect to chat, the connection is valid -// for the session duration specified in the request. The token becomes invalid -// at the token-expiration timestamp included in the response. -// -// Room Endpoints -// -// - CreateRoom — Creates a room that allows clients to connect and pass -// messages. -// -// - DeleteRoom — Deletes the specified room. -// -// - GetRoom — Gets the specified room. -// -// - ListRooms — Gets summary information about all your rooms in the AWS -// region where the API request is processed. -// -// - UpdateRoom — Updates a room’s configuration. -// -// Logging Configuration Endpoints -// -// - CreateLoggingConfiguration — Creates a logging configuration that -// allows clients to store and record sent messages. -// -// - DeleteLoggingConfiguration — Deletes the specified logging configuration. -// -// - GetLoggingConfiguration — Gets the specified logging configuration. -// -// - ListLoggingConfigurations — Gets summary information about all your -// logging configurations in the AWS region where the API request is processed. -// -// - UpdateLoggingConfiguration — Updates a specified logging configuration. -// -// Tags Endpoints -// -// - ListTagsForResource — Gets information about AWS tags for the specified -// ARN. -// -// - TagResource — Adds or updates tags for the AWS resource with the specified -// ARN. -// -// - UntagResource — Removes tags from the resource with the specified -// ARN. -// -// All the above are HTTP operations. There is a separate messaging API for -// managing Chat resources; see the Amazon IVS Chat Messaging API Reference -// (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html). -// // See https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14 for more information on this service. // // See ivschat package documentation for more information. diff --git a/service/medialive/api.go b/service/medialive/api.go index 0bfc6c876e2..1c710b3c061 100644 --- a/service/medialive/api.go +++ b/service/medialive/api.go @@ -15376,6 +15376,11 @@ type CreateInputInput struct { Sources []*InputSourceRequest `locationName:"sources" type:"list"` + // Configures the sources for this SRT input. For a single-pipeline input, include + // one srtCallerSource in the array. For a standard-pipeline input, include + // two srtCallerSource. + SrtSettings *SrtSettingsRequest `locationName:"srtSettings" type:"structure"` + Tags map[string]*string `locationName:"tags" type:"map"` // The different types of inputs that AWS Elemental MediaLive supports. @@ -15469,6 +15474,12 @@ func (s *CreateInputInput) SetSources(v []*InputSourceRequest) *CreateInputInput return s } +// SetSrtSettings sets the SrtSettings field's value. +func (s *CreateInputInput) SetSrtSettings(v *SrtSettingsRequest) *CreateInputInput { + s.SrtSettings = v + return s +} + // SetTags sets the Tags field's value. func (s *CreateInputInput) SetTags(v map[string]*string) *CreateInputInput { s.Tags = v @@ -18301,6 +18312,9 @@ type DescribeInputOutput struct { Sources []*InputSource `locationName:"sources" type:"list"` + // The configured sources for this SRT input. + SrtSettings *SrtSettings `locationName:"srtSettings" type:"structure"` + State *string `locationName:"state" type:"string" enum:"InputState"` Tags map[string]*string `locationName:"tags" type:"map"` @@ -18405,6 +18419,12 @@ func (s *DescribeInputOutput) SetSources(v []*InputSource) *DescribeInputOutput return s } +// SetSrtSettings sets the SrtSettings field's value. +func (s *DescribeInputOutput) SetSrtSettings(v *SrtSettings) *DescribeInputOutput { + s.SrtSettings = v + return s +} + // SetState sets the State field's value. func (s *DescribeInputOutput) SetState(v string) *DescribeInputOutput { s.State = &v @@ -19945,8 +19965,7 @@ func (s *DvbTdtSettings) SetRepInterval(v int64) *DvbTdtSettings { type Eac3AtmosSettings struct { _ struct{} `type:"structure"` - // Average bitrate in bits/second. Valid bitrates depend on the coding mode.// - // * @affectsRightSizing true + // Average bitrate in bits/second. Valid bitrates depend on the coding mode. Bitrate *float64 `locationName:"bitrate" type:"double"` // Dolby Digital Plus with Dolby Atmos coding mode. Determines number of channels. @@ -23032,7 +23051,15 @@ type H264Settings struct { // Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. EntropyEncoding *string `locationName:"entropyEncoding" type:"string" enum:"H264EntropyEncoding"` - // Optional filters that you can apply to an encode. + // Optional. Both filters reduce bandwidth by removing imperceptible details. + // You can enable one of the filters. Werecommend that you try both filters + // and observe the results to decide which one to use.The Temporal Filter reduces + // bandwidth by removing imperceptible details in the content. It combines perceptualfiltering + // and motion compensated temporal filtering (MCTF). It operates independently + // of the compression level.The Bandwidth Reduction filter is a perceptual filter + // located within the encoding loop. It adapts to the currentcompression level + // to filter imperceptible signals. This filter works only when the resolution + // is 1080p or lower. FilterSettings *H264FilterSettings `locationName:"filterSettings" type:"structure"` // Four bit AFD value to write on all frames of video in the output stream. @@ -23672,7 +23699,15 @@ type H265Settings struct { // Color Space settings ColorSpaceSettings *H265ColorSpaceSettings `locationName:"colorSpaceSettings" type:"structure"` - // Optional filters that you can apply to an encode. + // Optional. Both filters reduce bandwidth by removing imperceptible details. + // You can enable one of the filters. Werecommend that you try both filters + // and observe the results to decide which one to use.The Temporal Filter reduces + // bandwidth by removing imperceptible details in the content. It combines perceptualfiltering + // and motion compensated temporal filtering (MCTF). It operates independently + // of the compression level.The Bandwidth Reduction filter is a perceptual filter + // located within the encoding loop. It adapts to the currentcompression level + // to filter imperceptible signals. This filter works only when the resolution + // is 1080p or lower. FilterSettings *H265FilterSettings `locationName:"filterSettings" type:"structure"` // Four bit AFD value to write on all frames of video in the output stream. @@ -25528,6 +25563,9 @@ type Input struct { // A list of the sources of the input (PULL-type). Sources []*InputSource `locationName:"sources" type:"list"` + // The settings associated with an SRT input. + SrtSettings *SrtSettings `locationName:"srtSettings" type:"structure"` + State *string `locationName:"state" type:"string" enum:"InputState"` // A collection of key-value pairs. @@ -25633,6 +25671,12 @@ func (s *Input) SetSources(v []*InputSource) *Input { return s } +// SetSrtSettings sets the SrtSettings field's value. +func (s *Input) SetSrtSettings(v *SrtSettings) *Input { + s.SrtSettings = v + return s +} + // SetState sets the State field's value. func (s *Input) SetState(v string) *Input { s.State = &v @@ -36602,6 +36646,311 @@ func (s SmpteTtDestinationSettings) GoString() string { return s.String() } +// The decryption settings for the SRT caller source. Present only if the source +// has decryption enabled. +type SrtCallerDecryption struct { + _ struct{} `type:"structure"` + + // The algorithm used to encrypt content. + Algorithm *string `locationName:"algorithm" type:"string" enum:"Algorithm"` + + // The ARN for the secret in Secrets Manager. Someone in your organization must + // create a secret and provide you with its ARN. The secret holds the passphrase + // that MediaLive uses to decrypt the source content. + PassphraseSecretArn *string `locationName:"passphraseSecretArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtCallerDecryption) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtCallerDecryption) GoString() string { + return s.String() +} + +// SetAlgorithm sets the Algorithm field's value. +func (s *SrtCallerDecryption) SetAlgorithm(v string) *SrtCallerDecryption { + s.Algorithm = &v + return s +} + +// SetPassphraseSecretArn sets the PassphraseSecretArn field's value. +func (s *SrtCallerDecryption) SetPassphraseSecretArn(v string) *SrtCallerDecryption { + s.PassphraseSecretArn = &v + return s +} + +// Complete these parameters only if the content is encrypted. +type SrtCallerDecryptionRequest struct { + _ struct{} `type:"structure"` + + // The algorithm used to encrypt content. + Algorithm *string `locationName:"algorithm" type:"string" enum:"Algorithm"` + + // The ARN for the secret in Secrets Manager. Someone in your organization must + // create a secret and provide you with its ARN. This secret holds the passphrase + // that MediaLive will use to decrypt the source content. + PassphraseSecretArn *string `locationName:"passphraseSecretArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtCallerDecryptionRequest) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtCallerDecryptionRequest) GoString() string { + return s.String() +} + +// SetAlgorithm sets the Algorithm field's value. +func (s *SrtCallerDecryptionRequest) SetAlgorithm(v string) *SrtCallerDecryptionRequest { + s.Algorithm = &v + return s +} + +// SetPassphraseSecretArn sets the PassphraseSecretArn field's value. +func (s *SrtCallerDecryptionRequest) SetPassphraseSecretArn(v string) *SrtCallerDecryptionRequest { + s.PassphraseSecretArn = &v + return s +} + +// The configuration for a source that uses SRT as the connection protocol. +// In terms of establishing the connection, MediaLive is always caller and the +// upstream system is always the listener. In terms of transmission of the source +// content, MediaLive is always the receiver and the upstream system is always +// the sender. +type SrtCallerSource struct { + _ struct{} `type:"structure"` + + // The decryption settings for the SRT caller source. Present only if the source + // has decryption enabled. + Decryption *SrtCallerDecryption `locationName:"decryption" type:"structure"` + + // The preferred latency (in milliseconds) for implementing packet loss and + // recovery. Packet recovery is a key feature of SRT. + MinimumLatency *int64 `locationName:"minimumLatency" type:"integer"` + + // The IP address at the upstream system (the listener) that MediaLive (the + // caller) connects to. + SrtListenerAddress *string `locationName:"srtListenerAddress" type:"string"` + + // The port at the upstream system (the listener) that MediaLive (the caller) + // connects to. + SrtListenerPort *string `locationName:"srtListenerPort" type:"string"` + + // The stream ID, if the upstream system uses this identifier. + StreamId *string `locationName:"streamId" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtCallerSource) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtCallerSource) GoString() string { + return s.String() +} + +// SetDecryption sets the Decryption field's value. +func (s *SrtCallerSource) SetDecryption(v *SrtCallerDecryption) *SrtCallerSource { + s.Decryption = v + return s +} + +// SetMinimumLatency sets the MinimumLatency field's value. +func (s *SrtCallerSource) SetMinimumLatency(v int64) *SrtCallerSource { + s.MinimumLatency = &v + return s +} + +// SetSrtListenerAddress sets the SrtListenerAddress field's value. +func (s *SrtCallerSource) SetSrtListenerAddress(v string) *SrtCallerSource { + s.SrtListenerAddress = &v + return s +} + +// SetSrtListenerPort sets the SrtListenerPort field's value. +func (s *SrtCallerSource) SetSrtListenerPort(v string) *SrtCallerSource { + s.SrtListenerPort = &v + return s +} + +// SetStreamId sets the StreamId field's value. +func (s *SrtCallerSource) SetStreamId(v string) *SrtCallerSource { + s.StreamId = &v + return s +} + +// Configures the connection for a source that uses SRT as the connection protocol. +// In terms of establishing the connection, MediaLive is always the caller and +// the upstream system is always the listener. In terms of transmission of the +// source content, MediaLive is always the receiver and the upstream system +// is always the sender. +type SrtCallerSourceRequest struct { + _ struct{} `type:"structure"` + + // Complete these parameters only if the content is encrypted. + Decryption *SrtCallerDecryptionRequest `locationName:"decryption" type:"structure"` + + // The preferred latency (in milliseconds) for implementing packet loss and + // recovery. Packet recovery is a key feature of SRT. Obtain this value from + // the operator at the upstream system. + MinimumLatency *int64 `locationName:"minimumLatency" type:"integer"` + + // The IP address at the upstream system (the listener) that MediaLive (the + // caller) will connect to. + SrtListenerAddress *string `locationName:"srtListenerAddress" type:"string"` + + // The port at the upstream system (the listener) that MediaLive (the caller) + // will connect to. + SrtListenerPort *string `locationName:"srtListenerPort" type:"string"` + + // This value is required if the upstream system uses this identifier because + // without it, the SRT handshake between MediaLive (the caller) and the upstream + // system (the listener) might fail. + StreamId *string `locationName:"streamId" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtCallerSourceRequest) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtCallerSourceRequest) GoString() string { + return s.String() +} + +// SetDecryption sets the Decryption field's value. +func (s *SrtCallerSourceRequest) SetDecryption(v *SrtCallerDecryptionRequest) *SrtCallerSourceRequest { + s.Decryption = v + return s +} + +// SetMinimumLatency sets the MinimumLatency field's value. +func (s *SrtCallerSourceRequest) SetMinimumLatency(v int64) *SrtCallerSourceRequest { + s.MinimumLatency = &v + return s +} + +// SetSrtListenerAddress sets the SrtListenerAddress field's value. +func (s *SrtCallerSourceRequest) SetSrtListenerAddress(v string) *SrtCallerSourceRequest { + s.SrtListenerAddress = &v + return s +} + +// SetSrtListenerPort sets the SrtListenerPort field's value. +func (s *SrtCallerSourceRequest) SetSrtListenerPort(v string) *SrtCallerSourceRequest { + s.SrtListenerPort = &v + return s +} + +// SetStreamId sets the StreamId field's value. +func (s *SrtCallerSourceRequest) SetStreamId(v string) *SrtCallerSourceRequest { + s.StreamId = &v + return s +} + +// The configured sources for this SRT input. +type SrtSettings struct { + _ struct{} `type:"structure"` + + SrtCallerSources []*SrtCallerSource `locationName:"srtCallerSources" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtSettings) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtSettings) GoString() string { + return s.String() +} + +// SetSrtCallerSources sets the SrtCallerSources field's value. +func (s *SrtSettings) SetSrtCallerSources(v []*SrtCallerSource) *SrtSettings { + s.SrtCallerSources = v + return s +} + +// Configures the sources for this SRT input. For a single-pipeline input, include +// one srtCallerSource in the array. For a standard-pipeline input, include +// two srtCallerSource. +type SrtSettingsRequest struct { + _ struct{} `type:"structure"` + + SrtCallerSources []*SrtCallerSourceRequest `locationName:"srtCallerSources" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtSettingsRequest) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SrtSettingsRequest) GoString() string { + return s.String() +} + +// SetSrtCallerSources sets the SrtCallerSources field's value. +func (s *SrtSettingsRequest) SetSrtCallerSources(v []*SrtCallerSourceRequest) *SrtSettingsRequest { + s.SrtCallerSources = v + return s +} + // Standard Hls Settings type StandardHlsSettings struct { _ struct{} `type:"structure"` @@ -41286,6 +41635,11 @@ type UpdateInputInput struct { RoleArn *string `locationName:"roleArn" type:"string"` Sources []*InputSourceRequest `locationName:"sources" type:"list"` + + // Configures the sources for this SRT input. For a single-pipeline input, include + // one srtCallerSource in the array. For a standard-pipeline input, include + // two srtCallerSource. + SrtSettings *SrtSettingsRequest `locationName:"srtSettings" type:"structure"` } // String returns the string representation. @@ -41370,6 +41724,12 @@ func (s *UpdateInputInput) SetSources(v []*InputSourceRequest) *UpdateInputInput return s } +// SetSrtSettings sets the SrtSettings field's value. +func (s *UpdateInputInput) SetSrtSettings(v *SrtSettingsRequest) *UpdateInputInput { + s.SrtSettings = v + return s +} + type UpdateInputOutput struct { _ struct{} `type:"structure"` @@ -42836,6 +43196,26 @@ func AfdSignaling_Values() []string { } } +const ( + // AlgorithmAes128 is a Algorithm enum value + AlgorithmAes128 = "AES128" + + // AlgorithmAes192 is a Algorithm enum value + AlgorithmAes192 = "AES192" + + // AlgorithmAes256 is a Algorithm enum value + AlgorithmAes256 = "AES256" +) + +// Algorithm_Values returns all elements of the Algorithm enum +func Algorithm_Values() []string { + return []string{ + AlgorithmAes128, + AlgorithmAes192, + AlgorithmAes256, + } +} + // Audio Description Audio Type Control const ( // AudioDescriptionAudioTypeControlFollowInput is a AudioDescriptionAudioTypeControl enum value @@ -46694,6 +47074,9 @@ const ( // InputTypeTsFile is a InputType enum value InputTypeTsFile = "TS_FILE" + + // InputTypeSrtCaller is a InputType enum value + InputTypeSrtCaller = "SRT_CALLER" ) // InputType_Values returns all elements of the InputType enum @@ -46709,6 +47092,7 @@ func InputType_Values() []string { InputTypeInputDevice, InputTypeAwsCdi, InputTypeTsFile, + InputTypeSrtCaller, } } diff --git a/service/rds/api.go b/service/rds/api.go index d8abc098abe..ca7bb44a847 100644 --- a/service/rds/api.go +++ b/service/rds/api.go @@ -10602,6 +10602,11 @@ func (c *RDS) DescribePendingMaintenanceActionsRequest(input *DescribePendingMai // Returns a list of resources (for example, DB instances) that have at least // one pending maintenance action. // +// This API follows an eventual consistency model. This means that the result +// of the DescribePendingMaintenanceActions command might not be immediately +// visible to all subsequent RDS commands. Keep this in mind when you use DescribePendingMaintenanceActions +// immediately after using a previous API command such as ApplyPendingMaintenanceActions. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -22642,12 +22647,13 @@ type CreateDBClusterInput struct { // Specifies whether the DB cluster is publicly accessible. // - // When the DB cluster is publicly accessible, its Domain Name System (DNS) - // endpoint resolves to the private IP address from within the DB cluster's - // virtual private cloud (VPC). It resolves to the public IP address from outside - // of the DB cluster's VPC. Access to the DB cluster is ultimately controlled - // by the security group it uses. That public access isn't permitted if the - // security group assigned to the DB cluster doesn't permit it. + // When the DB cluster is publicly accessible and you connect from outside of + // the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) + // endpoint resolves to the public IP address. When you connect from within + // the same VPC as the DB cluster, the endpoint resolves to the private IP address. + // Access to the DB cluster is ultimately controlled by the security group it + // uses. That public access isn't permitted if the security group assigned to + // the DB cluster doesn't permit it. // // When the DB cluster isn't publicly accessible, it is an internal DB cluster // with a DNS name that resolves to a private IP address. @@ -24489,12 +24495,13 @@ type CreateDBInstanceInput struct { // Specifies whether the DB instance is publicly accessible. // - // When the DB instance is publicly accessible, its Domain Name System (DNS) - // endpoint resolves to the private IP address from within the DB instance's - // virtual private cloud (VPC). It resolves to the public IP address from outside - // of the DB instance's VPC. Access to the DB instance is ultimately controlled - // by the security group it uses. That public access is not permitted if the - // security group assigned to the DB instance doesn't permit it. + // When the DB instance is publicly accessible and you connect from outside + // of the DB instance's virtual private cloud (VPC), its Domain Name System + // (DNS) endpoint resolves to the public IP address. When you connect from within + // the same VPC as the DB instance, the endpoint resolves to the private IP + // address. Access to the DB instance is ultimately controlled by the security + // group it uses. That public access is not permitted if the security group + // assigned to the DB instance doesn't permit it. // // When the DB instance isn't publicly accessible, it is an internal DB instance // with a DNS name that resolves to a private IP address. @@ -28445,12 +28452,13 @@ type DBCluster struct { // Indicates whether the DB cluster is publicly accessible. // - // When the DB cluster is publicly accessible, its Domain Name System (DNS) - // endpoint resolves to the private IP address from within the DB cluster's - // virtual private cloud (VPC). It resolves to the public IP address from outside - // of the DB cluster's VPC. Access to the DB cluster is ultimately controlled - // by the security group it uses. That public access isn't permitted if the - // security group assigned to the DB cluster doesn't permit it. + // When the DB cluster is publicly accessible and you connect from outside of + // the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) + // endpoint resolves to the public IP address. When you connect from within + // the same VPC as the DB cluster, the endpoint resolves to the private IP address. + // Access to the DB cluster is ultimately controlled by the security group it + // uses. That public access isn't permitted if the security group assigned to + // the DB cluster doesn't permit it. // // When the DB cluster isn't publicly accessible, it is an internal DB cluster // with a DNS name that resolves to a private IP address. @@ -30881,12 +30889,13 @@ type DBInstance struct { // Indicates whether the DB instance is publicly accessible. // - // When the DB cluster is publicly accessible, its Domain Name System (DNS) - // endpoint resolves to the private IP address from within the DB cluster's - // virtual private cloud (VPC). It resolves to the public IP address from outside - // of the DB cluster's VPC. Access to the DB cluster is ultimately controlled - // by the security group it uses. That public access isn't permitted if the - // security group assigned to the DB cluster doesn't permit it. + // When the DB instance is publicly accessible and you connect from outside + // of the DB instance's virtual private cloud (VPC), its Domain Name System + // (DNS) endpoint resolves to the public IP address. When you connect from within + // the same VPC as the DB instance, the endpoint resolves to the private IP + // address. Access to the DB cluster is ultimately controlled by the security + // group it uses. That public access isn't permitted if the security group assigned + // to the DB cluster doesn't permit it. // // When the DB instance isn't publicly accessible, it is an internal DB instance // with a DNS name that resolves to a private IP address. @@ -34736,6 +34745,10 @@ type DeleteDBClusterInput struct { // Specifies whether to remove automated backups immediately after the DB cluster // is deleted. This parameter isn't case-sensitive. The default is to remove // automated backups immediately after the DB cluster is deleted. + // + // You must delete automated backups for Amazon RDS Multi-AZ DB clusters. For + // more information about managing automated backups for RDS Multi-AZ DB clusters, + // see Managing automated backups (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ManagingAutomatedBackups.html). DeleteAutomatedBackups *bool `type:"boolean"` // The DB cluster snapshot identifier of the new DB cluster snapshot created @@ -37519,7 +37532,7 @@ type DescribeDBClusterParametersInput struct { // // Valid Values: // - // * customer + // * user // // * engine // @@ -49036,12 +49049,13 @@ type ModifyDBInstanceInput struct { // Specifies whether the DB instance is publicly accessible. // - // When the DB cluster is publicly accessible, its Domain Name System (DNS) - // endpoint resolves to the private IP address from within the DB cluster's - // virtual private cloud (VPC). It resolves to the public IP address from outside - // of the DB cluster's VPC. Access to the DB cluster is ultimately controlled - // by the security group it uses. That public access isn't permitted if the - // security group assigned to the DB cluster doesn't permit it. + // When the DB instance is publicly accessible and you connect from outside + // of the DB instance's virtual private cloud (VPC), its Domain Name System + // (DNS) endpoint resolves to the public IP address. When you connect from within + // the same VPC as the DB instance, the endpoint resolves to the private IP + // address. Access to the DB instance is ultimately controlled by the security + // group it uses. That public access isn't permitted if the security group assigned + // to the DB instance doesn't permit it. // // When the DB instance isn't publicly accessible, it is an internal DB instance // with a DNS name that resolves to a private IP address. diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index 00710bb6b0b..df5c731b55b 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -137125,6 +137125,54 @@ const ( // ProcessingInstanceTypeMlG4dn16xlarge is a ProcessingInstanceType enum value ProcessingInstanceTypeMlG4dn16xlarge = "ml.g4dn.16xlarge" + + // ProcessingInstanceTypeMlG5Xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlG5Xlarge = "ml.g5.xlarge" + + // ProcessingInstanceTypeMlG52xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlG52xlarge = "ml.g5.2xlarge" + + // ProcessingInstanceTypeMlG54xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlG54xlarge = "ml.g5.4xlarge" + + // ProcessingInstanceTypeMlG58xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlG58xlarge = "ml.g5.8xlarge" + + // ProcessingInstanceTypeMlG516xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlG516xlarge = "ml.g5.16xlarge" + + // ProcessingInstanceTypeMlG512xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlG512xlarge = "ml.g5.12xlarge" + + // ProcessingInstanceTypeMlG524xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlG524xlarge = "ml.g5.24xlarge" + + // ProcessingInstanceTypeMlG548xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlG548xlarge = "ml.g5.48xlarge" + + // ProcessingInstanceTypeMlR5dLarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlR5dLarge = "ml.r5d.large" + + // ProcessingInstanceTypeMlR5dXlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlR5dXlarge = "ml.r5d.xlarge" + + // ProcessingInstanceTypeMlR5d2xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlR5d2xlarge = "ml.r5d.2xlarge" + + // ProcessingInstanceTypeMlR5d4xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlR5d4xlarge = "ml.r5d.4xlarge" + + // ProcessingInstanceTypeMlR5d8xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlR5d8xlarge = "ml.r5d.8xlarge" + + // ProcessingInstanceTypeMlR5d12xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlR5d12xlarge = "ml.r5d.12xlarge" + + // ProcessingInstanceTypeMlR5d16xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlR5d16xlarge = "ml.r5d.16xlarge" + + // ProcessingInstanceTypeMlR5d24xlarge is a ProcessingInstanceType enum value + ProcessingInstanceTypeMlR5d24xlarge = "ml.r5d.24xlarge" ) // ProcessingInstanceType_Values returns all elements of the ProcessingInstanceType enum @@ -137174,6 +137222,22 @@ func ProcessingInstanceType_Values() []string { ProcessingInstanceTypeMlG4dn8xlarge, ProcessingInstanceTypeMlG4dn12xlarge, ProcessingInstanceTypeMlG4dn16xlarge, + ProcessingInstanceTypeMlG5Xlarge, + ProcessingInstanceTypeMlG52xlarge, + ProcessingInstanceTypeMlG54xlarge, + ProcessingInstanceTypeMlG58xlarge, + ProcessingInstanceTypeMlG516xlarge, + ProcessingInstanceTypeMlG512xlarge, + ProcessingInstanceTypeMlG524xlarge, + ProcessingInstanceTypeMlG548xlarge, + ProcessingInstanceTypeMlR5dLarge, + ProcessingInstanceTypeMlR5dXlarge, + ProcessingInstanceTypeMlR5d2xlarge, + ProcessingInstanceTypeMlR5d4xlarge, + ProcessingInstanceTypeMlR5d8xlarge, + ProcessingInstanceTypeMlR5d12xlarge, + ProcessingInstanceTypeMlR5d16xlarge, + ProcessingInstanceTypeMlR5d24xlarge, } } @@ -139958,6 +140022,66 @@ const ( // TrainingInstanceTypeMlC6i32xlarge is a TrainingInstanceType enum value TrainingInstanceTypeMlC6i32xlarge = "ml.c6i.32xlarge" + + // TrainingInstanceTypeMlR5dLarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR5dLarge = "ml.r5d.large" + + // TrainingInstanceTypeMlR5dXlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR5dXlarge = "ml.r5d.xlarge" + + // TrainingInstanceTypeMlR5d2xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR5d2xlarge = "ml.r5d.2xlarge" + + // TrainingInstanceTypeMlR5d4xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR5d4xlarge = "ml.r5d.4xlarge" + + // TrainingInstanceTypeMlR5d8xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR5d8xlarge = "ml.r5d.8xlarge" + + // TrainingInstanceTypeMlR5d12xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR5d12xlarge = "ml.r5d.12xlarge" + + // TrainingInstanceTypeMlR5d16xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR5d16xlarge = "ml.r5d.16xlarge" + + // TrainingInstanceTypeMlR5d24xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR5d24xlarge = "ml.r5d.24xlarge" + + // TrainingInstanceTypeMlT3Medium is a TrainingInstanceType enum value + TrainingInstanceTypeMlT3Medium = "ml.t3.medium" + + // TrainingInstanceTypeMlT3Large is a TrainingInstanceType enum value + TrainingInstanceTypeMlT3Large = "ml.t3.large" + + // TrainingInstanceTypeMlT3Xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlT3Xlarge = "ml.t3.xlarge" + + // TrainingInstanceTypeMlT32xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlT32xlarge = "ml.t3.2xlarge" + + // TrainingInstanceTypeMlR5Large is a TrainingInstanceType enum value + TrainingInstanceTypeMlR5Large = "ml.r5.large" + + // TrainingInstanceTypeMlR5Xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR5Xlarge = "ml.r5.xlarge" + + // TrainingInstanceTypeMlR52xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR52xlarge = "ml.r5.2xlarge" + + // TrainingInstanceTypeMlR54xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR54xlarge = "ml.r5.4xlarge" + + // TrainingInstanceTypeMlR58xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR58xlarge = "ml.r5.8xlarge" + + // TrainingInstanceTypeMlR512xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR512xlarge = "ml.r5.12xlarge" + + // TrainingInstanceTypeMlR516xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR516xlarge = "ml.r5.16xlarge" + + // TrainingInstanceTypeMlR524xlarge is a TrainingInstanceType enum value + TrainingInstanceTypeMlR524xlarge = "ml.r5.24xlarge" ) // TrainingInstanceType_Values returns all elements of the TrainingInstanceType enum @@ -140032,6 +140156,26 @@ func TrainingInstanceType_Values() []string { TrainingInstanceTypeMlC6i16xlarge, TrainingInstanceTypeMlC6i24xlarge, TrainingInstanceTypeMlC6i32xlarge, + TrainingInstanceTypeMlR5dLarge, + TrainingInstanceTypeMlR5dXlarge, + TrainingInstanceTypeMlR5d2xlarge, + TrainingInstanceTypeMlR5d4xlarge, + TrainingInstanceTypeMlR5d8xlarge, + TrainingInstanceTypeMlR5d12xlarge, + TrainingInstanceTypeMlR5d16xlarge, + TrainingInstanceTypeMlR5d24xlarge, + TrainingInstanceTypeMlT3Medium, + TrainingInstanceTypeMlT3Large, + TrainingInstanceTypeMlT3Xlarge, + TrainingInstanceTypeMlT32xlarge, + TrainingInstanceTypeMlR5Large, + TrainingInstanceTypeMlR5Xlarge, + TrainingInstanceTypeMlR52xlarge, + TrainingInstanceTypeMlR54xlarge, + TrainingInstanceTypeMlR58xlarge, + TrainingInstanceTypeMlR512xlarge, + TrainingInstanceTypeMlR516xlarge, + TrainingInstanceTypeMlR524xlarge, } } diff --git a/service/secretsmanager/api.go b/service/secretsmanager/api.go index b744f45c770..74f1c7448df 100644 --- a/service/secretsmanager/api.go +++ b/service/secretsmanager/api.go @@ -409,6 +409,12 @@ func (c *SecretsManager) CreateSecretRequest(input *CreateSecretInput) (req *req // To encrypt the secret with a KMS key other than aws/secretsmanager, you need // kms:GenerateDataKey and kms:Decrypt permission to the key. // +// When you enter commands in a command shell, there is a risk of the command +// history being accessed or utilities having access to your command parameters. +// This is a concern if the command includes the value of a secret. Learn how +// to Mitigate the risks of using command-line tools to store Secrets Manager +// secrets (https://docs.aws.amazon.com/secretsmanager/latest/userguide/security_cli-exposure-risks.html). +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1709,6 +1715,12 @@ func (c *SecretsManager) PutSecretValueRequest(input *PutSecretValueInput) (req // see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) // and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). // +// When you enter commands in a command shell, there is a risk of the command +// history being accessed or utilities having access to your command parameters. +// This is a concern if the command includes the value of a secret. Learn how +// to Mitigate the risks of using command-line tools to store Secrets Manager +// secrets (https://docs.aws.amazon.com/secretsmanager/latest/userguide/security_cli-exposure-risks.html). +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2670,9 +2682,15 @@ func (c *SecretsManager) UpdateSecretRequest(input *UpdateSecretInput) (req *req // If you use a customer managed key, you must also have kms:GenerateDataKey, // kms:Encrypt, and kms:Decrypt permissions on the key. If you change the KMS // key and you don't have kms:Encrypt permission to the new key, Secrets Manager -// does not re-ecrypt existing secret versions with the new key. For more information, +// does not re-encrypt existing secret versions with the new key. For more information, // see Secret encryption and decryption (https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html). // +// When you enter commands in a command shell, there is a risk of the command +// history being accessed or utilities having access to your command parameters. +// This is a concern if the command includes the value of a secret. Learn how +// to Mitigate the risks of using command-line tools to store Secrets Manager +// secrets (https://docs.aws.amazon.com/secretsmanager/latest/userguide/security_cli-exposure-risks.html). +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7636,7 +7654,7 @@ type UpdateSecretInput struct { // The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt // new secret versions as well as any existing versions with the staging labels // AWSCURRENT, AWSPENDING, or AWSPREVIOUS. If you don't have kms:Encrypt permission - // to the new key, Secrets Manager does not re-ecrypt existing secret versions + // to the new key, Secrets Manager does not re-encrypt existing secret versions // with the new key. For more information about versions and staging labels, // see Concepts: Version (https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version). // diff --git a/service/timestreamquery/api.go b/service/timestreamquery/api.go index 74220199631..ab653414a51 100644 --- a/service/timestreamquery/api.go +++ b/service/timestreamquery/api.go @@ -5959,6 +5959,10 @@ type UpdateAccountSettingsInput struct { MaxQueryTCU *int64 `type:"integer"` // The pricing model for queries in an account. + // + // The QueryPricingModel parameter is used by several Timestream operations; + // however, the UpdateAccountSettings API operation doesn't recognize any values + // other than COMPUTE_UNITS. QueryPricingModel *string `type:"string" enum:"QueryPricingModel"` } diff --git a/service/workspacesthinclient/api.go b/service/workspacesthinclient/api.go index 943860e5cef..08e685451f4 100644 --- a/service/workspacesthinclient/api.go +++ b/service/workspacesthinclient/api.go @@ -2762,8 +2762,7 @@ type Environment struct { // The type of streaming desktop for the environment. DesktopType *string `locationName:"desktopType" type:"string" enum:"DesktopType"` - // "The tag keys and optional values for the newly created devices for this - // environment." + // The tag keys and optional values for the newly created devices for this environment. // // DeviceCreationTags is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Environment's