This API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
" + "documentation":"Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
" }, "AssociateApprovedOrigin":{ "name":"AssociateApprovedOrigin", @@ -292,7 +292,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"This API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
" + "documentation":"Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
" }, "BatchDisassociateAnalyticsDataSet":{ "name":"BatchDisassociateAnalyticsDataSet", @@ -309,7 +309,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
" + "documentation":"Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
" }, "BatchGetAttachedFileMetadata":{ "name":"BatchGetAttachedFileMetadata", @@ -1308,7 +1308,7 @@ {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"} ], - "documentation":"This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API
This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
" + "documentation":"Removes the dataset ID associated with a given Amazon Connect instance.
" }, "DisassociateApprovedOrigin":{ "name":"DisassociateApprovedOrigin", @@ -2150,7 +2150,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"This API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
" + "documentation":"Lists the association status of requested dataset ID for a given Amazon Connect instance.
" }, "ListApprovedOrigins":{ "name":"ListApprovedOrigins", @@ -3381,6 +3381,25 @@ ], "documentation":"Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
" }, + "StartOutboundChatContact":{ + "name":"StartOutboundChatContact", + "http":{ + "method":"PUT", + "requestUri":"/contact/outbound-chat" + }, + "input":{"shape":"StartOutboundChatContactRequest"}, + "output":{"shape":"StartOutboundChatContactResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Initiates a new outbound SMS contact to a customer. Response of this API provides the ContactId of the outbound SMS contact created.
SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new SMS contact created.
This API can be used to initiate outbound SMS contacts for an agent or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action.
For more information about using SMS in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide:
" + }, "StartOutboundVoiceContact":{ "name":"StartOutboundVoiceContact", "http":{ @@ -10373,7 +10392,8 @@ "enum":[ "TELEPHONE_NUMBER", "VOIP", - "CONTACT_FLOW" + "CONTACT_FLOW", + "CONNECT_PHONENUMBER_ARN" ] }, "ErrorCode":{"type":"string"}, @@ -11922,7 +11942,7 @@ }, "Metrics":{ "shape":"MetricsV2", - "documentation":"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
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid groupings and filters: Campaign, Agent, Queue, Routing Profile
UI name: Average dials per minute
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
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Seconds
Valid groupings and filters: Campaign
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid groupings and filters: Campaign, Agent
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
UI name: Campaign contacts abandoned after X
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Percent
Valid groupings and filters: Campaign, Agent
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
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
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, DISCONNECT_REASON
Valid groupings and filters: Campaign, Agent, Queue, Routing Profile, Answering Machine Detection Status, Disconnect Reason
UI name: Delivery attempts
This metric is available only for contacts analyzed by outbound campaigns analytics, and with the answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, DISCONNECT_REASON
Valid groupings and filters: Campaign, Agent, Answering Machine Detection Status, Disconnect Reason
Answering Machine Detection Status and Disconnect Reason are valid filters but not valid groupings.
UI name: Delivery attempt disposition rate
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
This metric is available only for contacts analyzed by outbound campaigns analytics, and with the answering machine detection enabled.
Unit: Count
Valid groupings and filters: Campaign, Agent
UI name: Human answered
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
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid groupings and filters: Campaign, Agent, Queue, Routing Profile
UI name: Average dials per minute
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
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Seconds
Valid groupings and filters: Campaign
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid groupings and filters: Campaign, Agent
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
UI name: Campaign contacts abandoned after X
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Percent
Valid groupings and filters: Campaign, Agent
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
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 can use LT (for \"Less than\") or LTE (for \"Less than equal\").
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 can use LT (for \"Less than\") or LTE (for \"Less than equal\").
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
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, DISCONNECT_REASON
Valid groupings and filters: Campaign, Agent, Queue, Routing Profile, Answering Machine Detection Status, Disconnect Reason
UI name: Delivery attempts
This metric is available only for contacts analyzed by outbound campaigns analytics, and with the answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, DISCONNECT_REASON
Valid groupings and filters: Campaign, Agent, Answering Machine Detection Status, Disconnect Reason
Answering Machine Detection Status and Disconnect Reason are valid filters but not valid groupings.
UI name: Delivery attempt disposition rate
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
This metric is available only for contacts analyzed by outbound campaigns analytics, and with the answering machine detection enabled.
Unit: Count
Valid groupings and filters: Campaign, Agent
UI name: Human answered
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 can use LT (for \"Less than\") or LTE (for \"Less than equal\").
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 can use LT (for \"Less than\") or LTE (for \"Less than equal\").
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 can use LT (for \"Less than\") or LTE (for \"Less than equal\").
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 values to use for filtering data.
Valid metric filter values for INITIATION_METHOD: INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | API
Valid metric filter values for DISCONNECT_REASON: CUSTOMER_DISCONNECT | AGENT_DISCONNECT | THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED | CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED | API
The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD: INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | API | WEBRTC_API | MONITOR | DISCONNECT | EXTERNAL_OUTBOUND
Valid metric filter values for DISCONNECT_REASON: CUSTOMER_DISCONNECT | AGENT_DISCONNECT | THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED | CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED | API
The property label of the automation.
" } }, - "documentation":"Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question.
Sentiment scores have a minimum value of -5 and maximum value of 5.
Duration labels, such as NON_TALK_TIME, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value of 0 and maximum value of 28800.
Percentages have a minimum value of 0 and maximum value of 100.
NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of 1000.
Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question.
Sentiment scores have a minimum value of -5 and maximum value of 5.
Duration labels, such as NON_TALK_TIME, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value of 0 and maximum value of 63072000.
Percentages have a minimum value of 0 and maximum value of 100.
NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of 1000.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
" + }, + "SegmentAttributes":{ + "shape":"SegmentAttributes", + "documentation":"A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide and connect:SMS.
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
" + }, + "ContactFlowId":{ + "shape":"ContactFlowId", + "documentation":"The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/123ec456-a007-89c0-1234-xxxxxxxxxxxx
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
" + }, + "ParticipantDetails":{"shape":"ParticipantDetails"}, + "InitialSystemMessage":{"shape":"ChatMessage"}, + "RelatedContactId":{ + "shape":"ContactId", + "documentation":"The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
" + }, + "SupportedMessagingContentTypes":{ + "shape":"SupportedMessagingContentTypes", + "documentation":"The supported chat message content types. Supported types are:
text/plain
text/markdown
application/json, application/vnd.amazonaws.connect.message.interactive
application/vnd.amazonaws.connect.message.interactive.response
Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain:
[text/plain, text/markdown, application/json]
[text/markdown, text/plain]
[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
", + "idempotencyToken":true + } + } + }, + "StartOutboundChatContactResponse":{ + "type":"structure", + "members":{ + "ContactId":{ + "shape":"ContactId", + "documentation":"The identifier of this contact within the Amazon Connect instance.
" + } + } + }, "StartOutboundVoiceContactRequest":{ "type":"structure", "required":[ @@ -21007,7 +21085,7 @@ "members":{ "Comparison":{ "shape":"ResourceArnOrId", - "documentation":"The type of comparison. Only \"less than\" (LT) and \"greater than\" (GT) comparisons are supported.
" + "documentation":"The type of comparison. Currently, \"less than\" (LT), \"less than equal\" (LTE), and \"greater than\" (GT) comparisons are supported.
" }, "ThresholdValue":{ "shape":"ThresholdValue", diff --git a/botocore/data/pricing/2017-10-15/service-2.json b/botocore/data/pricing/2017-10-15/service-2.json index e8246251d4..5d84abbba0 100644 --- a/botocore/data/pricing/2017-10-15/service-2.json +++ b/botocore/data/pricing/2017-10-15/service-2.json @@ -2,9 +2,11 @@ "version":"2.0", "metadata":{ "apiVersion":"2017-10-15", + "auth":["aws.auth#sigv4"], "endpointPrefix":"api.pricing", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceAbbreviation":"AWS Pricing", "serviceFullName":"AWS Price List Service", "serviceId":"Pricing", @@ -514,5 +516,5 @@ }, "errorMessage":{"type":"string"} }, - "documentation":"The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:
Build cost control and scenario planning tools
Reconcile billing data
Forecast future spend for budgeting purposes
Provide cost benefit analysis that compare your internal workloads with Amazon Web Services
Use GetServices without a service code to retrieve the service codes for all Amazon Web Services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.
For more information, see Using the Amazon Web Services Price List API in the Billing User Guide.
" + "documentation":"The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:
Build cost control and scenario planning tools
Reconcile billing data
Forecast future spend for budgeting purposes
Provide cost benefit analysis that compare your internal workloads with Amazon Web Services
Use GetServices without a service code to retrieve the service codes for all Amazon Web Services services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.
For more information, see Using the Amazon Web Services Price List API in the Billing User Guide.
" } diff --git a/botocore/data/resource-groups/2017-11-27/paginators-1.json b/botocore/data/resource-groups/2017-11-27/paginators-1.json index 04de8d30fe..1210885d26 100644 --- a/botocore/data/resource-groups/2017-11-27/paginators-1.json +++ b/botocore/data/resource-groups/2017-11-27/paginators-1.json @@ -23,6 +23,18 @@ "output_token": "NextToken", "input_token": "NextToken", "limit_key": "MaxResults" + }, + "ListGroupingStatuses": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "GroupingStatuses" + }, + "ListTagSyncTasks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "TagSyncTasks" } } } diff --git a/botocore/data/resource-groups/2017-11-27/paginators-1.sdk-extras.json b/botocore/data/resource-groups/2017-11-27/paginators-1.sdk-extras.json new file mode 100644 index 0000000000..eaa5232024 --- /dev/null +++ b/botocore/data/resource-groups/2017-11-27/paginators-1.sdk-extras.json @@ -0,0 +1,12 @@ +{ + "version": 1.0, + "merge": { + "pagination": { + "ListGroupingStatuses": { + "non_aggregate_keys": [ + "Group" + ] + } + } + } +} diff --git a/botocore/data/resource-groups/2017-11-27/service-2.json b/botocore/data/resource-groups/2017-11-27/service-2.json index 62ecc5a940..ea7385c456 100644 --- a/botocore/data/resource-groups/2017-11-27/service-2.json +++ b/botocore/data/resource-groups/2017-11-27/service-2.json @@ -4,14 +4,33 @@ "apiVersion":"2017-11-27", "endpointPrefix":"resource-groups", "protocol":"rest-json", + "protocols":["rest-json"], "serviceAbbreviation":"Resource Groups", "serviceFullName":"AWS Resource Groups", "serviceId":"Resource Groups", "signatureVersion":"v4", "signingName":"resource-groups", - "uid":"resource-groups-2017-11-27" + "uid":"resource-groups-2017-11-27", + "auth":["aws.auth#sigv4"] }, "operations":{ + "CancelTagSyncTask":{ + "name":"CancelTagSyncTask", + "http":{ + "method":"POST", + "requestUri":"/cancel-tag-sync-task" + }, + "input":{"shape":"CancelTagSyncTaskInput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"Cancels the specified tag-sync task.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:CancelTagSyncTask on the application group
resource-groups:DeleteGroup
Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroupQuery
Returns information about a specified tag-sync task.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetTagSyncTask on the application group
Returns a list of tags that are associated with a resource group, specified by an ARN.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetTags
Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN).
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetTags
Adds the specified resources to the specified group.
You can use this operation with only resource groups that are configured with the following types:
AWS::EC2::HostManagement
AWS::EC2::CapacityReservationPool
Other resource group type and resource types aren't currently supported by this operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GroupResources
Adds the specified resources to the specified group.
You can only use this operation with the following groups:
AWS::EC2::HostManagement
AWS::EC2::CapacityReservationPool
AWS::ResourceGroups::ApplicationGroup
Other resource group types and resource types are not currently supported by this operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GroupResources
Returns a list of ARNs of the resources that are members of a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroupResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroupResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
Returns the status of the last grouping or ungrouping action for each resource in the specified application group.
" }, "ListGroups":{ "name":"ListGroups", @@ -189,6 +244,24 @@ ], "documentation":"Returns a list of existing Resource Groups in your account.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroups
Returns a list of tag-sync tasks.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListTagSyncTasks with the group passed in the filters as the resource or * if using no filters
Returns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:SearchResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:StartTagSyncTask on the application group
resource-groups:CreateGroup
iam:PassRole on the role provided in the request
Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:Tag
Adds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource group are not changed if they are not specified in the request parameters.
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:Tag
The Resource Groups settings for this Amazon Web Services account.
" }, + "ApplicationArn":{ + "type":"string", + "max":1600, + "min":12, + "pattern":"arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-zA-Z0-9]{22,26}" + }, + "ApplicationTag":{ + "type":"map", + "key":{"shape":"ApplicationTagKey"}, + "value":{"shape":"ApplicationArn"} + }, + "ApplicationTagKey":{ + "type":"string", + "pattern":"awsApplication" + }, "BadRequestException":{ "type":"structure", "members":{ @@ -362,12 +469,22 @@ "error":{"httpStatusCode":400}, "exception":true }, + "CancelTagSyncTaskInput":{ + "type":"structure", + "required":["TaskArn"], + "members":{ + "TaskArn":{ + "shape":"TagSyncTaskArn", + "documentation":"The Amazon resource name (ARN) of the tag-sync task.
" + } + } + }, "CreateGroupInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ - "shape":"GroupName", + "shape":"CreateGroupName", "documentation":"The name of the group, which is the identifier of the group in other operations. You can't change the name of a resource group after you create it. A resource group name can consist of letters, numbers, hyphens, periods, and underscores. The name cannot start with AWS, aws, or any other possible capitalization; these are reserved. A resource group name must be unique within each Amazon Web Services Region in your Amazon Web Services account.
A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see Service configurations for Resource Groups.
A resource group can contain either a Configuration or a ResourceQuery, but not both.
The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization.
" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"The name of the application group, which you can change at any time.
" } } }, + "CreateGroupName":{ + "type":"string", + "max":300, + "min":1, + "pattern":"[a-zA-Z0-9_\\.-]+" + }, "CreateGroupOutput":{ "type":"structure", "members":{ @@ -409,6 +544,11 @@ } } }, + "Criticality":{ + "type":"integer", + "max":10, + "min":1 + }, "DeleteGroupInput":{ "type":"structure", "members":{ @@ -419,8 +559,8 @@ "deprecatedMessage":"This field is deprecated, use Group instead." }, "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to delete.
" + "shape":"GroupStringV2", + "documentation":"The name or the Amazon resource name (ARN) of the resource group to delete.
" } } }, @@ -438,6 +578,12 @@ "max":1024, "pattern":"[\\sa-zA-Z0-9_\\.-]*" }, + "DisplayName":{ + "type":"string", + "max":300, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, "ErrorCode":{ "type":"string", "max":128, @@ -453,7 +599,7 @@ "members":{ "ResourceArn":{ "shape":"ResourceArn", - "documentation":"The ARN of the resource that failed to be added or removed.
" + "documentation":"The Amazon resource name (ARN) of the resource that failed to be added or removed.
" }, "ErrorMessage":{ "shape":"ErrorMessage", @@ -493,7 +639,7 @@ "members":{ "Group":{ "shape":"GroupString", - "documentation":"The name or the ARN of the resource group for which you want to retrive the service configuration.
" + "documentation":"The name or the Amazon resource name (ARN) of the resource group for which you want to retrive the service configuration.
" } } }, @@ -516,8 +662,8 @@ "deprecatedMessage":"This field is deprecated, use Group instead." }, "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to retrieve.
" + "shape":"GroupStringV2", + "documentation":"The name or the Amazon resource name (ARN) of the resource group to retrieve.
" } } }, @@ -541,7 +687,7 @@ }, "Group":{ "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to query.
" + "documentation":"The name or the Amazon resource name (ARN) of the resource group to query.
" } } }, @@ -554,13 +700,64 @@ } } }, + "GetTagSyncTaskInput":{ + "type":"structure", + "required":["TaskArn"], + "members":{ + "TaskArn":{ + "shape":"TagSyncTaskArn", + "documentation":"The Amazon resource name (ARN) of the tag-sync task.
" + } + } + }, + "GetTagSyncTaskOutput":{ + "type":"structure", + "members":{ + "GroupArn":{ + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the application group.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of the application group.
" + }, + "TaskArn":{ + "shape":"TagSyncTaskArn", + "documentation":"The Amazon resource name (ARN) of the tag-sync task.
" + }, + "TagKey":{ + "shape":"TagKey", + "documentation":"The tag key.
" + }, + "TagValue":{ + "shape":"TagValue", + "documentation":"The tag value.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon resource name (ARN) of the role assumed by Resource Groups to tag and untag resources on your behalf.
For more information about this role, review Tag-sync required permissions.
" + }, + "Status":{ + "shape":"TagSyncTaskStatus", + "documentation":"The status of the tag-sync task.
Valid values include:
ACTIVE - The tag-sync task is actively managing resources in the application by adding or removing the awsApplication tag from resources when they are tagged or untagged with the specified tag key-value pair.
ERROR - The tag-sync task is not actively managing resources in the application. Review the ErrorMessage for more information about resolving the error.
The specific error message in cases where the tag-sync task status is ERROR.
The timestamp of when the tag-sync task was created.
" + } + } + }, "GetTagsInput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the resource group whose tags you want to retrieve.
", + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the resource group whose tags you want to retrieve.
", "location":"uri", "locationName":"Arn" } @@ -570,8 +767,8 @@ "type":"structure", "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the tagged resource group.
" + "shape":"GroupArnV2", + "documentation":"TheAmazon resource name (ARN) of the tagged resource group.
" }, "Tags":{ "shape":"Tags", @@ -587,8 +784,8 @@ ], "members":{ "GroupArn":{ - "shape":"GroupArn", - "documentation":"The ARN of the resource group.
" + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the resource group.
" }, "Name":{ "shape":"GroupName", @@ -597,6 +794,22 @@ "Description":{ "shape":"Description", "documentation":"The description of the resource group.
" + }, + "Criticality":{ + "shape":"Criticality", + "documentation":"The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization.
" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"The name of the application group, which you can change at any time.
" + }, + "ApplicationTag":{ + "shape":"ApplicationTag", + "documentation":"A tag that defines the application group membership. This tag is only supported for application groups.
" } }, "documentation":"A resource group that contains Amazon Web Services resources. You can assign resources to the group by associating either of the following elements with the group:
ResourceQuery - Use a resource query to specify a set of tag keys and values. All resources in the same Amazon Web Services Region and Amazon Web Services account that have those keys with the same values are included in the group. You can add a resource query when you create the group, or later by using the PutGroupConfiguration operation.
GroupConfiguration - Use a service configuration to associate the group with an Amazon Web Services service. The configuration specifies which resource types can be included in the group.
The ARN of the resource group.
" + "documentation":"The Amazon resource name (ARN) of the resource group.
" + }, + "Description":{ + "shape":"Description", + "documentation":"The description of the application group.
" + }, + "Criticality":{ + "shape":"Criticality", + "documentation":"The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"A name, email address or other identifier for the person or group who is considered as the owner of this group within your organization.
" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"The name of the application group, which you can change at any time.
" } }, "documentation":"The unique identifiers for a resource group.
" @@ -782,7 +1020,7 @@ "type":"string", "max":300, "min":1, - "pattern":"[a-zA-Z0-9_\\.-]+" + "pattern":"[a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}" }, "GroupParameterList":{ "type":"list", @@ -814,12 +1052,12 @@ ], "members":{ "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to add resources to.
" + "shape":"GroupStringV2", + "documentation":"The name or the Amazon resource name (ARN) of the resource group to add resources to.
" }, "ResourceArns":{ "shape":"ResourceArnList", - "documentation":"The list of ARNs of the resources to be added to the group.
" + "documentation":"The list of Amazon resource names (ARNs) of the resources to be added to the group.
" } } }, @@ -828,15 +1066,15 @@ "members":{ "Succeeded":{ "shape":"ResourceArnList", - "documentation":"A list of ARNs of the resources that this operation successfully added to the group.
" + "documentation":"A list of Amazon resource names (ARNs) of the resources that this operation successfully added to the group.
" }, "Failed":{ "shape":"FailedResourceList", - "documentation":"A list of ARNs of any resources that this operation failed to add to the group.
" + "documentation":"A list of Amazon resource names (ARNs) of any resources that this operation failed to add to the group.
" }, "Pending":{ "shape":"PendingResourceList", - "documentation":"A list of ARNs of any resources that this operation is still in the process adding to the group. These pending additions continue asynchronously. You can check the status of pending additions by using the ListGroupResources operation, and checking the Resources array in the response and the Status field of each object in that array.
A list of Amazon resource names (ARNs) of any resources that this operation is still in the process adding to the group. These pending additions continue asynchronously. You can check the status of pending additions by using the ListGroupResources operation, and checking the Resources array in the response and the Status field of each object in that array.
The Amazon resource name (ARN) of a resource.
" + }, + "Action":{ + "shape":"GroupingType", + "documentation":"Describes the resource grouping action with values of GROUP or UNGROUP.
Describes the resource grouping status with values of SUCCESS, FAILED, IN_PROGRESS, or SKIPPED.
A message that explains the ErrorCode.
Specifies the error code that was raised.
" + }, + "UpdatedAt":{ + "shape":"timestamp", + "documentation":"A timestamp of when the status was last updated.
" + } + }, + "documentation":"The information about a grouping or ungrouping resource action.
" + }, + "GroupingStatusesList":{ + "type":"list", + "member":{"shape":"GroupingStatusesItem"} + }, + "GroupingType":{ + "type":"string", + "enum":[ + "GROUP", + "UNGROUP" + ] }, "InternalServerErrorException":{ "type":"structure", @@ -865,8 +1159,8 @@ "deprecatedMessage":"This field is deprecated, use Group instead." }, "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group
" + "shape":"GroupStringV2", + "documentation":"The name or the Amazon resource name (ARN) of the resource group.
" }, "Filters":{ "shape":"ResourceFilterList", @@ -920,12 +1214,90 @@ } } }, + "ListGroupingStatusesFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"ListGroupingStatusesFilterName", + "documentation":"The name of the filter. Filter names are case-sensitive.
" + }, + "Values":{ + "shape":"ListGroupingStatusesFilterValues", + "documentation":"One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
" + } + }, + "documentation":"A filter name and value pair that is used to obtain more specific results from the list of grouping statuses.
" + }, + "ListGroupingStatusesFilterList":{ + "type":"list", + "member":{"shape":"ListGroupingStatusesFilter"} + }, + "ListGroupingStatusesFilterName":{ + "type":"string", + "enum":[ + "status", + "resource-arn" + ] + }, + "ListGroupingStatusesFilterValue":{ + "type":"string", + "pattern":"SUCCESS|FAILED|IN_PROGRESS|SKIPPED|arn:aws(-[a-z]+)*:[a-z0-9\\-]*:([a-z]{2}(-[a-z]+)+-\\d{1})?:([0-9]{12})?:.+" + }, + "ListGroupingStatusesFilterValues":{ + "type":"list", + "member":{"shape":"ListGroupingStatusesFilterValue"}, + "max":10, + "min":1 + }, + "ListGroupingStatusesInput":{ + "type":"structure", + "required":["Group"], + "members":{ + "Group":{ + "shape":"GroupStringV2", + "documentation":"The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of resources and their statuses returned in the response.
" + }, + "Filters":{ + "shape":"ListGroupingStatusesFilterList", + "documentation":"The filter name and value pair that is used to return more specific results from a list of resources.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.
The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.
" + }, + "GroupingStatuses":{ + "shape":"GroupingStatusesList", + "documentation":"Returns details about the grouping or ungrouping status of the resources in the specified application group.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.
configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:
AWS::AppRegistry::Application
AWS::AppRegistry::ApplicationResourceGroups
AWS::CloudFormation::Stack
AWS::EC2::CapacityReservationPool
AWS::EC2::HostManagement
AWS::NetworkFirewall::RuleGroup
Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.
configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:
AWS::ResourceGroups::ApplicationGroup
AWS::AppRegistry::Application
AWS::AppRegistry::ApplicationResourceGroups
AWS::CloudFormation::Stack
AWS::EC2::CapacityReservationPool
AWS::EC2::HostManagement
AWS::NetworkFirewall::RuleGroup
The Amazon resource name (ARN) of the application group.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of the application group.
" + } + }, + "documentation":"Returns tag-sync tasks filtered by the Amazon resource name (ARN) or name of a specified application group.
" + }, + "ListTagSyncTasksFilterList":{ + "type":"list", + "member":{"shape":"ListTagSyncTasksFilter"} + }, + "ListTagSyncTasksInput":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ListTagSyncTasksFilterList", + "documentation":"The Amazon resource name (ARN) or name of the application group for which you want to return a list of tag-sync tasks.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the response.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.
A list of tag-sync tasks and information about each task.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The name or ARN of the resource group with the configuration that you want to update.
" + "documentation":"The name or Amazon resource name (ARN) of the resource group with the configuration that you want to update.
" }, "Configuration":{ "shape":"GroupConfigurationList", @@ -1117,7 +1543,7 @@ "members":{ "ResourceArn":{ "shape":"ResourceArn", - "documentation":"The ARN of a resource.
" + "documentation":"The Amazon resource name (ARN) of a resource.
" }, "ResourceType":{ "shape":"ResourceType", @@ -1139,7 +1565,7 @@ "members":{ "Type":{ "shape":"QueryType", - "documentation":"The type of the query to perform. This can have one of two values:
CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.
TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.
The type of the query to perform. This can have one of two values:
CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an Amazon resource name (ARN) for a CloudFormation stack.
TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.
The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task.
" + }, + "TagKey":{ + "shape":"TagKey", + "documentation":"The tag key. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application.
" + }, + "TagValue":{ + "shape":"TagValue", + "documentation":"The tag value. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
" + } + } + }, + "StartTagSyncTaskOutput":{ + "type":"structure", + "members":{ + "GroupArn":{ + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the application group for which you want to add or remove resources.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of the application group to onboard and sync resources.
" + }, + "TaskArn":{ + "shape":"TagSyncTaskArn", + "documentation":"The Amazon resource name (ARN) of the new tag-sync task.
" + }, + "TagKey":{ + "shape":"TagKey", + "documentation":"The tag key of the tag-sync task.
" + }, + "TagValue":{ + "shape":"TagValue", + "documentation":"The tag value of the tag-sync task.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
" + } + } + }, "TagInput":{ "type":"structure", "required":[ @@ -1209,8 +1697,8 @@ ], "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the resource group to which to add tags.
", + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the resource group to which to add tags.
", "location":"uri", "locationName":"Arn" }, @@ -1234,8 +1722,8 @@ "type":"structure", "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the tagged resource.
" + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the tagged resource.
" }, "Tags":{ "shape":"Tags", @@ -1243,6 +1731,65 @@ } } }, + "TagSyncTaskArn":{ + "type":"string", + "max":1600, + "min":12, + "pattern":"arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}/tag-sync-task/[a-z0-9]{26}" + }, + "TagSyncTaskItem":{ + "type":"structure", + "members":{ + "GroupArn":{ + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the application group.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of the application group.
" + }, + "TaskArn":{ + "shape":"TagSyncTaskArn", + "documentation":"The Amazon resource name (ARN) of the tag-sync task.
" + }, + "TagKey":{ + "shape":"TagKey", + "documentation":"The tag key.
" + }, + "TagValue":{ + "shape":"TagValue", + "documentation":"The tag value.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
" + }, + "Status":{ + "shape":"TagSyncTaskStatus", + "documentation":"The status of the tag-sync task.
Valid values include:
ACTIVE - The tag-sync task is actively managing resources in the application by adding or removing the awsApplication tag from resources when they are tagged or untagged with the specified tag key-value pair.
ERROR - The tag-sync task is not actively managing resources in the application. Review the ErrorMessage for more information about resolving the error.
The specific error message in cases where the tag-sync task status is Error.
The timestamp of when the tag-sync task was created.
" + } + }, + "documentation":"The Amazon resource name (ARN) of the tag-sync task.
" + }, + "TagSyncTaskList":{ + "type":"list", + "member":{"shape":"TagSyncTaskItem"} + }, + "TagSyncTaskStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "ERROR" + ] + }, "TagValue":{ "type":"string", "max":256, @@ -1280,12 +1827,12 @@ ], "members":{ "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group from which to remove the resources.
" + "shape":"GroupStringV2", + "documentation":"The name or the Amazon resource name (ARN) of the resource group from which to remove the resources.
" }, "ResourceArns":{ "shape":"ResourceArnList", - "documentation":"The ARNs of the resources to be removed from the group.
" + "documentation":"The Amazon resource names (ARNs) of the resources to be removed from the group.
" } } }, @@ -1314,8 +1861,8 @@ ], "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the resource group from which to remove tags. The command removed both the specified keys and any values associated with those keys.
", + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the resource group from which to remove tags. The command removed both the specified keys and any values associated with those keys.
", "location":"uri", "locationName":"Arn" }, @@ -1329,8 +1876,8 @@ "type":"structure", "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the resource group from which tags have been removed.
" + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the resource group from which tags have been removed.
" }, "Keys":{ "shape":"TagKeyList", @@ -1343,7 +1890,7 @@ "members":{ "GroupLifecycleEventsDesiredStatus":{ "shape":"GroupLifecycleEventsDesiredStatus", - "documentation":"Specifies whether you want to turn group lifecycle events on or off.
" + "documentation":"Specifies whether you want to turn group lifecycle events on or off.
You can't turn on group lifecycle events if your resource groups quota is greater than 2,000.
" } } }, @@ -1366,12 +1913,24 @@ "deprecatedMessage":"This field is deprecated, use Group instead." }, "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to modify.
" + "shape":"GroupStringV2", + "documentation":"The name or the ARN of the resource group to update.
" }, "Description":{ "shape":"Description", "documentation":"The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.
" + }, + "Criticality":{ + "shape":"Criticality", + "documentation":"The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization.
" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"The name of the application group, which you can change at any time.
" } } }, @@ -1396,7 +1955,7 @@ }, "Group":{ "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to query.
" + "documentation":"The name or the Amazon resource name (ARN) of the resource group to query.
" }, "ResourceQuery":{ "shape":"ResourceQuery", @@ -1412,7 +1971,8 @@ "documentation":"The updated resource query associated with the resource group after the update.
" } } - } + }, + "timestamp":{"type":"timestamp"} }, - "documentation":"Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member resources.
To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.
For more information about Resource Groups, see the Resource Groups User Guide.
Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.
Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities
Applying, editing, and removing tags from resource groups
Resolving resource group member ARNs so they can be returned as search results
Getting data about resources that are members of a group
Searching Amazon Web Services resources based on a resource query
Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member resources.
To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.
For more information about Resource Groups, see the Resource Groups User Guide.
Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.
Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities
Applying, editing, and removing tags from resource groups
Resolving resource group member Amazon resource names (ARN)s so they can be returned as search results
Getting data about resources that are members of a group
Searching Amazon Web Services resources based on a resource query
CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity. For information on the product_bom entity, see the AWS Supply Chain User Guide.
The CSV file must be located in an Amazon S3 location accessible to AWS Supply Chain. It is recommended to use the same Amazon S3 bucket created during your AWS Supply Chain instance creation.
", "idempotent":true }, + "CreateDataIntegrationFlow":{ + "name":"CreateDataIntegrationFlow", + "http":{ + "method":"PUT", + "requestUri":"/api/data-integration/instance/{instanceId}/data-integration-flows/{name}", + "responseCode":200 + }, + "input":{"shape":"CreateDataIntegrationFlowRequest"}, + "output":{"shape":"CreateDataIntegrationFlowResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Create DataIntegrationFlow to map one or more different sources to one target using the SQL transformation query.
", + "idempotent":true + }, + "CreateDataLakeDataset":{ + "name":"CreateDataLakeDataset", + "http":{ + "method":"PUT", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}", + "responseCode":200 + }, + "input":{"shape":"CreateDataLakeDatasetRequest"}, + "output":{"shape":"CreateDataLakeDatasetResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Create a data lake dataset.
", + "idempotent":true + }, + "DeleteDataIntegrationFlow":{ + "name":"DeleteDataIntegrationFlow", + "http":{ + "method":"DELETE", + "requestUri":"/api/data-integration/instance/{instanceId}/data-integration-flows/{name}", + "responseCode":200 + }, + "input":{"shape":"DeleteDataIntegrationFlowRequest"}, + "output":{"shape":"DeleteDataIntegrationFlowResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Delete the DataIntegrationFlow.
", + "idempotent":true + }, + "DeleteDataLakeDataset":{ + "name":"DeleteDataLakeDataset", + "http":{ + "method":"DELETE", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}", + "responseCode":200 + }, + "input":{"shape":"DeleteDataLakeDatasetRequest"}, + "output":{"shape":"DeleteDataLakeDatasetResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Delete a data lake dataset.
", + "idempotent":true + }, "GetBillOfMaterialsImportJob":{ "name":"GetBillOfMaterialsImportJob", "http":{ @@ -54,6 +138,106 @@ ], "documentation":"Get status and details of a BillOfMaterialsImportJob.
" }, + "GetDataIntegrationFlow":{ + "name":"GetDataIntegrationFlow", + "http":{ + "method":"GET", + "requestUri":"/api/data-integration/instance/{instanceId}/data-integration-flows/{name}", + "responseCode":200 + }, + "input":{"shape":"GetDataIntegrationFlowRequest"}, + "output":{"shape":"GetDataIntegrationFlowResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"View the DataIntegrationFlow details.
" + }, + "GetDataLakeDataset":{ + "name":"GetDataLakeDataset", + "http":{ + "method":"GET", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}", + "responseCode":200 + }, + "input":{"shape":"GetDataLakeDatasetRequest"}, + "output":{"shape":"GetDataLakeDatasetResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Get a data lake dataset.
" + }, + "ListDataIntegrationFlows":{ + "name":"ListDataIntegrationFlows", + "http":{ + "method":"GET", + "requestUri":"/api/data-integration/instance/{instanceId}/data-integration-flows", + "responseCode":200 + }, + "input":{"shape":"ListDataIntegrationFlowsRequest"}, + "output":{"shape":"ListDataIntegrationFlowsResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Lists all the DataIntegrationFlows in a paginated way.
" + }, + "ListDataLakeDatasets":{ + "name":"ListDataLakeDatasets", + "http":{ + "method":"GET", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets", + "responseCode":200 + }, + "input":{"shape":"ListDataLakeDatasetsRequest"}, + "output":{"shape":"ListDataLakeDatasetsResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"List the data lake datasets for a specific instance and name space.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/api/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"List all the tags for an Amazon Web ServicesSupply Chain resource.
" + }, "SendDataIntegrationEvent":{ "name":"SendDataIntegrationEvent", "http":{ @@ -74,6 +258,87 @@ ], "documentation":"Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.
", "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/api/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Create tags for an Amazon Web Services Supply chain resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/api/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Delete tags for an Amazon Web Services Supply chain resource.
", + "idempotent":true + }, + "UpdateDataIntegrationFlow":{ + "name":"UpdateDataIntegrationFlow", + "http":{ + "method":"PATCH", + "requestUri":"/api/data-integration/instance/{instanceId}/data-integration-flows/{name}", + "responseCode":200 + }, + "input":{"shape":"UpdateDataIntegrationFlowRequest"}, + "output":{"shape":"UpdateDataIntegrationFlowResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Update the DataIntegrationFlow.
" + }, + "UpdateDataLakeDataset":{ + "name":"UpdateDataLakeDataset", + "http":{ + "method":"PATCH", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}", + "responseCode":200 + }, + "input":{"shape":"UpdateDataLakeDatasetRequest"}, + "output":{"shape":"UpdateDataLakeDatasetResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Update a data lake dataset.
" } }, "shapes":{ @@ -89,6 +354,12 @@ }, "exception":true }, + "AscResourceArn":{ + "type":"string", + "max":1011, + "min":20, + "pattern":"arn:aws:scn(?::([a-z0-9-]+):([0-9]+):instance)?/([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})[-_./A-Za-z0-9]*" + }, "BillOfMaterialsImportJob":{ "type":"structure", "required":[ @@ -121,6 +392,10 @@ }, "documentation":"The BillOfMaterialsImportJob details.
" }, + "Boolean":{ + "type":"boolean", + "box":true + }, "ClientToken":{ "type":"string", "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", @@ -174,7 +449,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"An idempotency token.
", + "documentation":"An idempotency token ensures the API request is only completed no more than once. This way, retrying the request will not trigger the operation multiple times. A client token is a unique, case-sensitive string of 33 to 128 ASCII characters. To make an idempotent API request, specify a client token in the request. You should not reuse the same client token for other requests. If you retry a successful request with the same client token, the request will succeed with no further actions being taken, and you will receive the same API response as the original successful request.
", "idempotencyToken":true } }, @@ -191,6 +466,117 @@ }, "documentation":"The response parameters of CreateBillOfMaterialsImportJob.
" }, + "CreateDataIntegrationFlowRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name", + "sources", + "transformation", + "target" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"Name of the DataIntegrationFlow.
", + "location":"uri", + "locationName":"name" + }, + "sources":{ + "shape":"DataIntegrationFlowSourceList", + "documentation":"The source configurations for DataIntegrationFlow.
" + }, + "transformation":{ + "shape":"DataIntegrationFlowTransformation", + "documentation":"The transformation configurations for DataIntegrationFlow.
" + }, + "target":{ + "shape":"DataIntegrationFlowTarget", + "documentation":"The target configurations for DataIntegrationFlow.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags of the DataIntegrationFlow to be created
" + } + }, + "documentation":"The request parameters for CreateDataIntegrationFlow.
" + }, + "CreateDataIntegrationFlowResponse":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The name of the DataIntegrationFlow created.
" + } + }, + "documentation":"The response parameters for CreateDataIntegrationFlow.
" + }, + "CreateDataLakeDatasetRequest":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "namespace":{ + "shape":"DataLakeDatasetNamespace", + "documentation":"The name space of the dataset.
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "location":"uri", + "locationName":"name" + }, + "schema":{ + "shape":"DataLakeDatasetSchema", + "documentation":"The custom schema of the data lake dataset and is only required when the name space is default.
" + }, + "description":{ + "shape":"DataLakeDatasetDescription", + "documentation":"The description of the dataset.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags of the dataset.
" + } + }, + "documentation":"The request parameters for CreateDataLakeDataset.
" + }, + "CreateDataLakeDatasetResponse":{ + "type":"structure", + "required":["dataset"], + "members":{ + "dataset":{ + "shape":"DataLakeDataset", + "documentation":"The detail of created dataset.
" + } + }, + "documentation":"The response parameters of CreateDataLakeDataset.
" + }, "DataIntegrationEventData":{ "type":"string", "max":1048576, @@ -222,39 +608,651 @@ "scn.data.supplyplan" ] }, - "GetBillOfMaterialsImportJobRequest":{ + "DataIntegrationFlow":{ "type":"structure", "required":[ "instanceId", - "jobId" + "name", + "sources", + "transformation", + "target", + "createdTime", + "lastModifiedTime" ], "members":{ "instanceId":{ "shape":"UUID", - "documentation":"The AWS Supply Chain instance identifier.
", - "location":"uri", - "locationName":"instanceId" + "documentation":"The DataIntegrationFlow instance ID.
" }, - "jobId":{ - "shape":"UUID", - "documentation":"The BillOfMaterialsImportJob identifier.
", - "location":"uri", - "locationName":"jobId" + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The DataIntegrationFlow name.
" + }, + "sources":{ + "shape":"DataIntegrationFlowSourceList", + "documentation":"The DataIntegrationFlow source configurations.
" + }, + "transformation":{ + "shape":"DataIntegrationFlowTransformation", + "documentation":"The DataIntegrationFlow transformation configurations.
" + }, + "target":{ + "shape":"DataIntegrationFlowTarget", + "documentation":"The DataIntegrationFlow target configuration.
" + }, + "createdTime":{ + "shape":"Timestamp", + "documentation":"The DataIntegrationFlow creation timestamp.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The DataIntegrationFlow last modified timestamp.
" } }, - "documentation":"The request parameters for GetBillOfMaterialsImportJob.
" + "documentation":"The DataIntegrationFlow details.
" }, - "GetBillOfMaterialsImportJobResponse":{ + "DataIntegrationFlowDatasetOptions":{ "type":"structure", - "required":["job"], "members":{ - "job":{ - "shape":"BillOfMaterialsImportJob", + "loadType":{ + "shape":"DataIntegrationFlowLoadType", + "documentation":"The dataset data load type in dataset options.
" + }, + "dedupeRecords":{ + "shape":"Boolean", + "documentation":"The dataset load option to remove duplicates.
" + } + }, + "documentation":"The dataset options used in dataset source and target configurations.
" + }, + "DataIntegrationFlowDatasetSourceConfiguration":{ + "type":"structure", + "required":["datasetIdentifier"], + "members":{ + "datasetIdentifier":{ + "shape":"DatasetIdentifier", + "documentation":"The ARN of the dataset.
" + }, + "options":{ + "shape":"DataIntegrationFlowDatasetOptions", + "documentation":"The dataset DataIntegrationFlow source options.
" + } + }, + "documentation":"The dataset DataIntegrationFlow source configuration parameters.
" + }, + "DataIntegrationFlowDatasetTargetConfiguration":{ + "type":"structure", + "required":["datasetIdentifier"], + "members":{ + "datasetIdentifier":{ + "shape":"DatasetIdentifier", + "documentation":"The dataset ARN.
" + }, + "options":{ + "shape":"DataIntegrationFlowDatasetOptions", + "documentation":"The dataset DataIntegrationFlow target options.
" + } + }, + "documentation":"The dataset DataIntegrationFlow target configuration parameters.
" + }, + "DataIntegrationFlowFileType":{ + "type":"string", + "enum":[ + "CSV", + "PARQUET", + "JSON" + ] + }, + "DataIntegrationFlowList":{ + "type":"list", + "member":{"shape":"DataIntegrationFlow"} + }, + "DataIntegrationFlowLoadType":{ + "type":"string", + "enum":[ + "INCREMENTAL", + "REPLACE" + ] + }, + "DataIntegrationFlowMaxResults":{ + "type":"integer", + "box":true, + "max":20, + "min":0 + }, + "DataIntegrationFlowName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9-]+" + }, + "DataIntegrationFlowNextToken":{ + "type":"string", + "max":65535, + "min":1 + }, + "DataIntegrationFlowS3Options":{ + "type":"structure", + "members":{ + "fileType":{ + "shape":"DataIntegrationFlowFileType", + "documentation":"The Amazon S3 file type in S3 options.
" + } + }, + "documentation":"The Amazon S3 options used in S3 source and target configurations.
" + }, + "DataIntegrationFlowS3Prefix":{ + "type":"string", + "max":700, + "min":0, + "pattern":"[/A-Za-z0-9._-]+" + }, + "DataIntegrationFlowS3SourceConfiguration":{ + "type":"structure", + "required":[ + "bucketName", + "prefix" + ], + "members":{ + "bucketName":{ + "shape":"S3BucketName", + "documentation":"The bucketName of the S3 source objects.
" + }, + "prefix":{ + "shape":"DataIntegrationFlowS3Prefix", + "documentation":"The prefix of the S3 source objects.
" + }, + "options":{ + "shape":"DataIntegrationFlowS3Options", + "documentation":"The other options of the S3 DataIntegrationFlow source.
" + } + }, + "documentation":"The S3 DataIntegrationFlow source configuration parameters.
" + }, + "DataIntegrationFlowS3TargetConfiguration":{ + "type":"structure", + "required":[ + "bucketName", + "prefix" + ], + "members":{ + "bucketName":{ + "shape":"S3BucketName", + "documentation":"The bucketName of the S3 target objects.
" + }, + "prefix":{ + "shape":"DataIntegrationFlowS3Prefix", + "documentation":"The prefix of the S3 target objects.
" + }, + "options":{ + "shape":"DataIntegrationFlowS3Options", + "documentation":"The S3 DataIntegrationFlow target options.
" + } + }, + "documentation":"The S3 DataIntegrationFlow target configuration parameters.
" + }, + "DataIntegrationFlowSQLQuery":{ + "type":"string", + "max":65535, + "min":1 + }, + "DataIntegrationFlowSQLTransformationConfiguration":{ + "type":"structure", + "required":["query"], + "members":{ + "query":{ + "shape":"DataIntegrationFlowSQLQuery", + "documentation":"The transformation SQL query body based on SparkSQL.
" + } + }, + "documentation":"The SQL DataIntegrationFlow transformation configuration parameters.
" + }, + "DataIntegrationFlowSource":{ + "type":"structure", + "required":[ + "sourceType", + "sourceName" + ], + "members":{ + "sourceType":{ + "shape":"DataIntegrationFlowSourceType", + "documentation":"The DataIntegrationFlow source type.
" + }, + "sourceName":{ + "shape":"DataIntegrationFlowSourceName", + "documentation":"The DataIntegrationFlow source name that can be used as table alias in SQL transformation query.
" + }, + "s3Source":{ + "shape":"DataIntegrationFlowS3SourceConfiguration", + "documentation":"The S3 DataIntegrationFlow source.
" + }, + "datasetSource":{ + "shape":"DataIntegrationFlowDatasetSourceConfiguration", + "documentation":"The dataset DataIntegrationFlow source.
" + } + }, + "documentation":"The DataIntegrationFlow source parameters.
" + }, + "DataIntegrationFlowSourceList":{ + "type":"list", + "member":{"shape":"DataIntegrationFlowSource"}, + "max":40, + "min":1 + }, + "DataIntegrationFlowSourceName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_]+" + }, + "DataIntegrationFlowSourceType":{ + "type":"string", + "enum":[ + "S3", + "DATASET" + ] + }, + "DataIntegrationFlowTarget":{ + "type":"structure", + "required":["targetType"], + "members":{ + "targetType":{ + "shape":"DataIntegrationFlowTargetType", + "documentation":"The DataIntegrationFlow target type.
" + }, + "s3Target":{ + "shape":"DataIntegrationFlowS3TargetConfiguration", + "documentation":"The S3 DataIntegrationFlow target.
" + }, + "datasetTarget":{ + "shape":"DataIntegrationFlowDatasetTargetConfiguration", + "documentation":"The dataset DataIntegrationFlow target.
" + } + }, + "documentation":"The DataIntegrationFlow target parameters.
" + }, + "DataIntegrationFlowTargetType":{ + "type":"string", + "enum":[ + "S3", + "DATASET" + ] + }, + "DataIntegrationFlowTransformation":{ + "type":"structure", + "required":["transformationType"], + "members":{ + "transformationType":{ + "shape":"DataIntegrationFlowTransformationType", + "documentation":"The DataIntegrationFlow transformation type.
" + }, + "sqlTransformation":{ + "shape":"DataIntegrationFlowSQLTransformationConfiguration", + "documentation":"The SQL DataIntegrationFlow transformation configuration.
" + } + }, + "documentation":"The DataIntegrationFlow transformation parameters.
" + }, + "DataIntegrationFlowTransformationType":{ + "type":"string", + "enum":[ + "SQL", + "NONE" + ] + }, + "DataLakeDataset":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name", + "arn", + "schema", + "createdTime", + "lastModifiedTime" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
" + }, + "namespace":{ + "shape":"DataLakeDatasetNamespace", + "documentation":"The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
" + }, + "arn":{ + "shape":"AscResourceArn", + "documentation":"The arn of the dataset.
" + }, + "schema":{ + "shape":"DataLakeDatasetSchema", + "documentation":"The schema of the dataset.
" + }, + "description":{ + "shape":"DataLakeDatasetDescription", + "documentation":"The description of the dataset.
" + }, + "createdTime":{ + "shape":"Timestamp", + "documentation":"The creation time of the dataset.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The last modified time of the dataset.
" + } + }, + "documentation":"The data lake dataset details.
" + }, + "DataLakeDatasetDescription":{ + "type":"string", + "max":500, + "min":1 + }, + "DataLakeDatasetList":{ + "type":"list", + "member":{"shape":"DataLakeDataset"}, + "max":20, + "min":1 + }, + "DataLakeDatasetMaxResults":{ + "type":"integer", + "box":true, + "max":20, + "min":0 + }, + "DataLakeDatasetName":{ + "type":"string", + "max":75, + "min":1, + "pattern":"[a-z0-9_]+" + }, + "DataLakeDatasetNamespace":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[a-z]+" + }, + "DataLakeDatasetNextToken":{ + "type":"string", + "max":65535, + "min":1 + }, + "DataLakeDatasetSchema":{ + "type":"structure", + "required":[ + "name", + "fields" + ], + "members":{ + "name":{ + "shape":"DataLakeDatasetSchemaName", + "documentation":"The name of the dataset schema.
" + }, + "fields":{ + "shape":"DataLakeDatasetSchemaFieldList", + "documentation":"The list of field details of the dataset schema.
" + } + }, + "documentation":"The schema details of the dataset.
" + }, + "DataLakeDatasetSchemaField":{ + "type":"structure", + "required":[ + "name", + "type", + "isRequired" + ], + "members":{ + "name":{ + "shape":"DataLakeDatasetSchemaFieldName", + "documentation":"The dataset field name.
" + }, + "type":{ + "shape":"DataLakeDatasetSchemaFieldType", + "documentation":"The dataset field type.
" + }, + "isRequired":{ + "shape":"Boolean", + "documentation":"Indicate if the field is required or not.
" + } + }, + "documentation":"The dataset field details.
" + }, + "DataLakeDatasetSchemaFieldList":{ + "type":"list", + "member":{"shape":"DataLakeDatasetSchemaField"}, + "max":500, + "min":1 + }, + "DataLakeDatasetSchemaFieldName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-z0-9_]+" + }, + "DataLakeDatasetSchemaFieldType":{ + "type":"string", + "enum":[ + "INT", + "DOUBLE", + "STRING", + "TIMESTAMP" + ] + }, + "DataLakeDatasetSchemaName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[A-Za-z0-9]+" + }, + "DatasetIdentifier":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"[-_/A-Za-z0-9:]+" + }, + "DeleteDataIntegrationFlowRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The name of the DataIntegrationFlow to be deleted.
", + "location":"uri", + "locationName":"name" + } + }, + "documentation":"The request parameters for DeleteDataIntegrationFlow.
" + }, + "DeleteDataIntegrationFlowResponse":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The name of the DataIntegrationFlow deleted.
" + } + }, + "documentation":"The response parameters for DeleteDataIntegrationFlow.
" + }, + "DeleteDataLakeDatasetRequest":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The AWS Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "namespace":{ + "shape":"DataLakeDatasetNamespace", + "documentation":"The namespace of the dataset. The available values are:
asc: for AWS Supply Chain supported datasets .
default: for datasets with custom user-defined schemas.
The name of the dataset. If the namespace is asc, the name must be one of the supported data entities .
", + "location":"uri", + "locationName":"name" + } + }, + "documentation":"The request parameters of DeleteDataLakeDataset.
" + }, + "DeleteDataLakeDatasetResponse":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The AWS Supply Chain instance identifier.
" + }, + "namespace":{ + "shape":"DataLakeDatasetNamespace", + "documentation":"The namespace of deleted dataset.
" + }, + "name":{ + "shape":"DataLakeDatasetName", + "documentation":"The name of deleted dataset.
" + } + }, + "documentation":"The response parameters of DeleteDataLakeDataset.
" + }, + "GetBillOfMaterialsImportJobRequest":{ + "type":"structure", + "required":[ + "instanceId", + "jobId" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The AWS Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "jobId":{ + "shape":"UUID", + "documentation":"The BillOfMaterialsImportJob identifier.
", + "location":"uri", + "locationName":"jobId" + } + }, + "documentation":"The request parameters for GetBillOfMaterialsImportJob.
" + }, + "GetBillOfMaterialsImportJobResponse":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{ + "shape":"BillOfMaterialsImportJob", "documentation":"The BillOfMaterialsImportJob.
" } }, "documentation":"The response parameters for GetBillOfMaterialsImportJob.
" }, + "GetDataIntegrationFlowRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The name of the DataIntegrationFlow created.
", + "location":"uri", + "locationName":"name" + } + }, + "documentation":"The request parameters for GetDataIntegrationFlow.
" + }, + "GetDataIntegrationFlowResponse":{ + "type":"structure", + "required":["flow"], + "members":{ + "flow":{ + "shape":"DataIntegrationFlow", + "documentation":"The details of the DataIntegrationFlow returned.
" + } + }, + "documentation":"The response parameters for GetDataIntegrationFlow.
" + }, + "GetDataLakeDatasetRequest":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "namespace":{ + "shape":"DataLakeDatasetNamespace", + "documentation":"The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "location":"uri", + "locationName":"name" + } + }, + "documentation":"The request parameters for GetDataLakeDataset.
" + }, + "GetDataLakeDatasetResponse":{ + "type":"structure", + "required":["dataset"], + "members":{ + "dataset":{ + "shape":"DataLakeDataset", + "documentation":"The fetched dataset details.
" + } + }, + "documentation":"The response parameters for UpdateDataLakeDataset.
" + }, "InternalServerException":{ "type":"structure", "members":{ @@ -266,6 +1264,119 @@ "fault":true, "retryable":{"throttling":false} }, + "ListDataIntegrationFlowsRequest":{ + "type":"structure", + "required":["instanceId"], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "nextToken":{ + "shape":"DataIntegrationFlowNextToken", + "documentation":"The pagination token to fetch the next page of the DataIntegrationFlows.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"DataIntegrationFlowMaxResults", + "documentation":"Specify the maximum number of DataIntegrationFlows to fetch in one paginated request.
", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"The request parameters for ListDataIntegrationFlows.
" + }, + "ListDataIntegrationFlowsResponse":{ + "type":"structure", + "required":["flows"], + "members":{ + "flows":{ + "shape":"DataIntegrationFlowList", + "documentation":"The response parameters for ListDataIntegrationFlows.
" + }, + "nextToken":{ + "shape":"DataIntegrationFlowNextToken", + "documentation":"The pagination token to fetch the next page of the DataIntegrationFlows.
" + } + }, + "documentation":"The response parameters for ListDataIntegrationFlows.
" + }, + "ListDataLakeDatasetsRequest":{ + "type":"structure", + "required":[ + "instanceId", + "namespace" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "namespace":{ + "shape":"DataLakeDatasetNamespace", + "documentation":"The namespace of the dataset. The available values are:
asc: for AWS Supply Chain supported datasets .
default: for datasets with custom user-defined schemas.
The pagination token to fetch next page of datasets.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"DataLakeDatasetMaxResults", + "documentation":"The max number of datasets to fetch in this paginated request.
", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"The request parameters of ListDataLakeDatasets.
" + }, + "ListDataLakeDatasetsResponse":{ + "type":"structure", + "required":["datasets"], + "members":{ + "datasets":{ + "shape":"DataLakeDatasetList", + "documentation":"The list of fetched dataset details.
" + }, + "nextToken":{ + "shape":"DataLakeDatasetNextToken", + "documentation":"The pagination token to fetch next page of datasets.
" + } + }, + "documentation":"The response parameters of ListDataLakeDatasets.
" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"AscResourceArn", + "documentation":"The Amazon Web Services Supply chain resource ARN that needs tags to be listed.
", + "location":"uri", + "locationName":"resourceArn" + } + }, + "documentation":"The request parameters of ListTagsForResource.
" + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"The tags added to an Amazon Web Services Supply Chain resource.
" + } + }, + "documentation":"The response parameters of ListTagsForResource.
" + }, "ResourceNotFoundException":{ "type":"structure", "members":{ @@ -278,6 +1389,12 @@ }, "exception":true }, + "S3BucketName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"[a-z0-9][a-z0-9.-]*[a-z0-9]" + }, "SendDataIntegrationEventRequest":{ "type":"structure", "required":[ @@ -345,6 +1462,55 @@ "type":"timestamp", "timestampFormat":"unixTimestamp" }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"AscResourceArn", + "documentation":"The Amazon Web Services Supply chain resource ARN that needs to be tagged.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags of the Amazon Web Services Supply chain resource to be created.
" + } + }, + "documentation":"The request parameters of TagResource.
" + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"The response parameters for TagResource.
" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, "ThrottlingException":{ "type":"structure", "members":{ @@ -358,12 +1524,130 @@ "exception":true, "retryable":{"throttling":true} }, + "Timestamp":{"type":"timestamp"}, "UUID":{ "type":"string", "max":36, "min":36, "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"AscResourceArn", + "documentation":"The Amazon Web Services Supply chain resource ARN that needs to be untagged.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The list of tag keys to be deleted for an Amazon Web Services Supply Chain resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + }, + "documentation":"The request parameters of UntagResource.
" + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"The response parameters of UntagResource.
" + }, + "UpdateDataIntegrationFlowRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The name of the DataIntegrationFlow to be updated.
", + "location":"uri", + "locationName":"name" + }, + "sources":{ + "shape":"DataIntegrationFlowSourceList", + "documentation":"The new source configurations for the DataIntegrationFlow.
" + }, + "transformation":{ + "shape":"DataIntegrationFlowTransformation", + "documentation":"The new transformation configurations for the DataIntegrationFlow.
" + }, + "target":{ + "shape":"DataIntegrationFlowTarget", + "documentation":"The new target configurations for the DataIntegrationFlow.
" + } + }, + "documentation":"The request parameters for UpdateDataIntegrationFlow.
" + }, + "UpdateDataIntegrationFlowResponse":{ + "type":"structure", + "required":["flow"], + "members":{ + "flow":{ + "shape":"DataIntegrationFlow", + "documentation":"The details of the updated DataIntegrationFlow.
" + } + }, + "documentation":"The response parameters for UpdateDataIntegrationFlow.
" + }, + "UpdateDataLakeDatasetRequest":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "namespace":{ + "shape":"DataLakeDatasetNamespace", + "documentation":"The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"DataLakeDatasetDescription", + "documentation":"The updated description of the data lake dataset.
" + } + }, + "documentation":"The request parameters of UpdateDataLakeDataset.
" + }, + "UpdateDataLakeDatasetResponse":{ + "type":"structure", + "required":["dataset"], + "members":{ + "dataset":{ + "shape":"DataLakeDataset", + "documentation":"The updated dataset details.
" + } + }, + "documentation":"The response parameters of UpdateDataLakeDataset.
" + }, "ValidationException":{ "type":"structure", "members":{ diff --git a/botocore/data/timestream-influxdb/2023-01-27/service-2.json b/botocore/data/timestream-influxdb/2023-01-27/service-2.json index cb240e24e6..95937872ea 100644 --- a/botocore/data/timestream-influxdb/2023-01-27/service-2.json +++ b/botocore/data/timestream-influxdb/2023-01-27/service-2.json @@ -324,6 +324,10 @@ "tags":{ "shape":"RequestTagMap", "documentation":"A list of key-value pairs to associate with the DB instance.
" + }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
Valid Values: 1024-65535
Default: 8086
Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
" } } }, @@ -356,6 +360,10 @@ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections. The default value is 8086.
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" @@ -509,6 +517,10 @@ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type to run InfluxDB on.
" @@ -641,6 +653,10 @@ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" @@ -698,6 +714,38 @@ "WITH_MULTIAZ_STANDBY" ] }, + "Duration":{ + "type":"structure", + "required":[ + "durationType", + "value" + ], + "members":{ + "durationType":{ + "shape":"DurationType", + "documentation":"The type of duration for InfluxDB parameters.
" + }, + "value":{ + "shape":"DurationValueLong", + "documentation":"The value of duration for InfluxDB parameters.
" + } + }, + "documentation":"Duration for InfluxDB parameters in Timestream for InfluxDB.
" + }, + "DurationType":{ + "type":"string", + "enum":[ + "hours", + "minutes", + "seconds", + "milliseconds" + ] + }, + "DurationValueLong":{ + "type":"long", + "box":true, + "min":0 + }, "GetDbInstanceInput":{ "type":"structure", "required":["identifier"], @@ -737,6 +785,10 @@ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" @@ -857,22 +909,220 @@ "metricsDisabled":{ "shape":"Boolean", "documentation":"Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.
Default: false
" + }, + "httpIdleTimeout":{ + "shape":"Duration", + "documentation":"Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.
Default: 3 minutes
" + }, + "httpReadHeaderTimeout":{ + "shape":"Duration", + "documentation":"Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.
Default: 10 seconds
" + }, + "httpReadTimeout":{ + "shape":"Duration", + "documentation":"Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.
Default: 0
" + }, + "httpWriteTimeout":{ + "shape":"Duration", + "documentation":"Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.
Default: 0
" + }, + "influxqlMaxSelectBuckets":{ + "shape":"InfluxDBv2ParametersInfluxqlMaxSelectBucketsLong", + "documentation":"Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.
Default: 0
" + }, + "influxqlMaxSelectPoint":{ + "shape":"InfluxDBv2ParametersInfluxqlMaxSelectPointLong", + "documentation":"Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).
Default: 0
" + }, + "influxqlMaxSelectSeries":{ + "shape":"InfluxDBv2ParametersInfluxqlMaxSelectSeriesLong", + "documentation":"Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.
Default: 0
" + }, + "pprofDisabled":{ + "shape":"Boolean", + "documentation":"Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.
Default: false
" + }, + "queryInitialMemoryBytes":{ + "shape":"InfluxDBv2ParametersQueryInitialMemoryBytesLong", + "documentation":"Initial bytes of memory allocated for a query.
Default: 0
" + }, + "queryMaxMemoryBytes":{ + "shape":"InfluxDBv2ParametersQueryMaxMemoryBytesLong", + "documentation":"Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.
Default: 0
" + }, + "queryMemoryBytes":{ + "shape":"InfluxDBv2ParametersQueryMemoryBytesLong", + "documentation":"Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.
Default: 0
" + }, + "sessionLength":{ + "shape":"InfluxDBv2ParametersSessionLengthInteger", + "documentation":"Specifies the Time to Live (TTL) in minutes for newly created user sessions.
Default: 60
" + }, + "sessionRenewDisabled":{ + "shape":"Boolean", + "documentation":"Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.
Default: false
" + }, + "storageCacheMaxMemorySize":{ + "shape":"InfluxDBv2ParametersStorageCacheMaxMemorySizeLong", + "documentation":"Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.
Default: 1073741824
" + }, + "storageCacheSnapshotMemorySize":{ + "shape":"InfluxDBv2ParametersStorageCacheSnapshotMemorySizeLong", + "documentation":"Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.
Default: 26214400
" + }, + "storageCacheSnapshotWriteColdDuration":{ + "shape":"Duration", + "documentation":"Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.
Default: 10 minutes
" + }, + "storageCompactFullWriteColdDuration":{ + "shape":"Duration", + "documentation":"Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.
Default: 4 hours
" + }, + "storageCompactThroughputBurst":{ + "shape":"InfluxDBv2ParametersStorageCompactThroughputBurstLong", + "documentation":"Rate limit (in bytes per second) that TSM compactions can write to disk.
Default: 50331648
" + }, + "storageMaxConcurrentCompactions":{ + "shape":"InfluxDBv2ParametersStorageMaxConcurrentCompactionsInteger", + "documentation":"Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.
Default: 0
" + }, + "storageMaxIndexLogFileSize":{ + "shape":"InfluxDBv2ParametersStorageMaxIndexLogFileSizeLong", + "documentation":"Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.
Default: 1048576
" + }, + "storageNoValidateFieldSize":{ + "shape":"Boolean", + "documentation":"Skip field size validation on incoming write requests.
Default: false
" + }, + "storageRetentionCheckInterval":{ + "shape":"Duration", + "documentation":"Interval of retention policy enforcement checks. Must be greater than 0.
Default: 30 minutes
" + }, + "storageSeriesFileMaxConcurrentSnapshotCompactions":{ + "shape":"InfluxDBv2ParametersStorageSeriesFileMaxConcurrentSnapshotCompactionsInteger", + "documentation":"Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.
Default: 0
" + }, + "storageSeriesIdSetCacheSize":{ + "shape":"InfluxDBv2ParametersStorageSeriesIdSetCacheSizeLong", + "documentation":"Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.
Default: 100
" + }, + "storageWalMaxConcurrentWrites":{ + "shape":"InfluxDBv2ParametersStorageWalMaxConcurrentWritesInteger", + "documentation":"Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.
Default: 0
" + }, + "storageWalMaxWriteDelay":{ + "shape":"Duration", + "documentation":"Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.
Default: 10 minutes
" + }, + "uiDisabled":{ + "shape":"Boolean", + "documentation":"Disable the InfluxDB user interface (UI). The UI is enabled by default.
Default: false
" } }, "documentation":"All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
" }, + "InfluxDBv2ParametersInfluxqlMaxSelectBucketsLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersInfluxqlMaxSelectPointLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersInfluxqlMaxSelectSeriesLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, "InfluxDBv2ParametersQueryConcurrencyInteger":{ "type":"integer", "box":true, "max":256, "min":0 }, + "InfluxDBv2ParametersQueryInitialMemoryBytesLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersQueryMaxMemoryBytesLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersQueryMemoryBytesLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, "InfluxDBv2ParametersQueryQueueSizeInteger":{ "type":"integer", "box":true, "max":256, "min":0 }, + "InfluxDBv2ParametersSessionLengthInteger":{ + "type":"integer", + "box":true, + "max":2880, + "min":1 + }, + "InfluxDBv2ParametersStorageCacheMaxMemorySizeLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersStorageCacheSnapshotMemorySizeLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersStorageCompactThroughputBurstLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersStorageMaxConcurrentCompactionsInteger":{ + "type":"integer", + "box":true, + "max":64, + "min":0 + }, + "InfluxDBv2ParametersStorageMaxIndexLogFileSizeLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersStorageSeriesFileMaxConcurrentSnapshotCompactionsInteger":{ + "type":"integer", + "box":true, + "max":64, + "min":0 + }, + "InfluxDBv2ParametersStorageSeriesIdSetCacheSizeLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersStorageWalMaxConcurrentWritesInteger":{ + "type":"integer", + "box":true, + "max":256, + "min":0 + }, "Integer":{ "type":"integer", "box":true @@ -1013,6 +1263,12 @@ "pattern":"[a-zA-Z0-9]+", "sensitive":true }, + "Port":{ + "type":"integer", + "box":true, + "max":65535, + "min":1024 + }, "RequestTagMap":{ "type":"map", "key":{"shape":"TagKey"}, @@ -1183,6 +1439,10 @@ "shape":"DbParameterGroupIdentifier", "documentation":"The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
If you change the Port value, your database restarts immediately.
Valid Values: 1024-65535
Default: 8086
Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB DB instance type to run InfluxDB on.
" @@ -1222,6 +1482,10 @@ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" diff --git a/botocore/data/verifiedpermissions/2021-12-01/service-2.json b/botocore/data/verifiedpermissions/2021-12-01/service-2.json index 4c63db0d37..5ec41e26d7 100644 --- a/botocore/data/verifiedpermissions/2021-12-01/service-2.json +++ b/botocore/data/verifiedpermissions/2021-12-01/service-2.json @@ -2,6 +2,7 @@ "version":"2.0", "metadata":{ "apiVersion":"2021-12-01", + "auth":["aws.auth#sigv4"], "endpointPrefix":"verifiedpermissions", "jsonVersion":"1.0", "protocol":"json", @@ -65,7 +66,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP).
After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken or BatchIsAuthorizedWithToken API operations. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions derives information about your user and session from token claims. Access tokens provide action context to your policies, and ID tokens provide principal Attributes.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
To reference a user from this identity source in your Cedar policies, refer to the following syntax examples.
Amazon Cognito user pool: Namespace::[Entity type]::[User pool ID]|[user principal attribute], for example MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
OpenID Connect (OIDC) provider: Namespace::[Entity type]::[principalIdClaim]|[user principal attribute], for example MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP).
After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken or BatchIsAuthorizedWithToken API operations. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions derives information about your user and session from token claims. Access tokens provide action context to your policies, and ID tokens provide principal Attributes.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
To reference a user from this identity source in your Cedar policies, refer to the following syntax examples.
Amazon Cognito user pool: Namespace::[Entity type]::[User pool ID]|[user principal attribute], for example MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
OpenID Connect (OIDC) provider: Namespace::[Entity type]::[entityIdPrefix]|[user principal attribute], for example MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Makes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.
At this time, Verified Permissions accepts tokens from only Amazon Cognito.
Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
Makes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.
Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
The type of the policy. This is one of the following values:
static
templateLinked
The type of the policy. This is one of the following values:
STATIC
TEMPLATE_LINKED
A JSON string representation of the schema supported by applications that use this policy store. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.
" + "documentation":"A JSON string representation of the schema supported by applications that use this policy store. To delete the schema, run PutSchema with {} for this parameter. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.
Contains a list of principal types, resource types, and actions that can be specified in policies stored in the same policy store. If the validation mode for the policy store is set to STRICT, then policies that can't be validated by this schema are rejected by Verified Permissions and can't be stored in the policy store.
The code for the Amazon Web Service that owns the quota.
" + "documentation":"The code for the Amazon Web Services service that owns the quota.
" }, "quotaCode":{ "shape":"String", @@ -2910,7 +2911,7 @@ "message":{"shape":"String"}, "serviceCode":{ "shape":"String", - "documentation":"The code for the Amazon Web Service that owns the quota.
" + "documentation":"The code for the Amazon Web Services service that owns the quota.
" }, "quotaCode":{ "shape":"String", @@ -2995,7 +2996,7 @@ }, "updateConfiguration":{ "shape":"UpdateConfiguration", - "documentation":"Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.
You must specify a userPoolArn, and optionally, a ClientId.
Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
" }, "principalEntityType":{ "shape":"PrincipalEntityType", diff --git a/docs/source/conf.py b/docs/source/conf.py index 74a8dc942d..6fa92d279d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.35.' # The full version, including alpha/beta/rc tags. -release = '1.35.29' +release = '1.35.30' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.