Lists configurations stored in the AppConfig hosted configuration store by version.
" + "documentation":"Lists configurations stored in the AppConfig hosted configuration store by version.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -762,7 +762,7 @@ "documentation":"An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
" } }, - "documentation":"An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point such as ON_CREATE_HOSTED_CONFIGURATION, PRE_DEPLOYMENT, or ON_DEPLOYMENT. Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:
PRE_CREATE_HOSTED_CONFIGURATION_VERSION
PRE_START_DEPLOYMENT
ON_DEPLOYMENT_START
ON_DEPLOYMENT_STEP
ON_DEPLOYMENT_BAKING
ON_DEPLOYMENT_COMPLETE
ON_DEPLOYMENT_ROLLED_BACK
An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point, as shown in the following list:
PRE_CREATE_HOSTED_CONFIGURATION_VERSION
PRE_START_DEPLOYMENT
AT_DEPLOYMENT_TICK
ON_DEPLOYMENT_START
ON_DEPLOYMENT_STEP
ON_DEPLOYMENT_BAKING
ON_DEPLOYMENT_COMPLETE
ON_DEPLOYMENT_ROLLED_BACK
Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension.
" }, "ActionInvocation":{ "type":"structure", @@ -813,6 +813,7 @@ "enum":[ "PRE_CREATE_HOSTED_CONFIGURATION_VERSION", "PRE_START_DEPLOYMENT", + "AT_DEPLOYMENT_TICK", "ON_DEPLOYMENT_START", "ON_DEPLOYMENT_STEP", "ON_DEPLOYMENT_BAKING", @@ -1097,7 +1098,7 @@ }, "LocationUri":{ "shape":"Uri", - "documentation":"A URI to locate the configuration. You can specify the following:
For the AppConfig hosted configuration store and for feature flags, specify hosted.
For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format ssm-parameter://<parameter name> or the ARN.
For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format: codepipeline://<pipeline name>.
For an Secrets Manager secret, specify the URI in the following format: secretsmanager://<secret name>.
For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json
For an SSM document, specify either the document name in the format ssm-document://<document name> or the Amazon Resource Name (ARN).
A URI to locate the configuration. You can specify the following:
For the AppConfig hosted configuration store and for feature flags, specify hosted.
For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format ssm-parameter://<parameter name> or the ARN.
For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format: codepipeline://<pipeline name>.
For an Secrets Manager secret, specify the URI in the following format: secretsmanager://<secret name>.
For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://amzn-s3-demo-bucket/my-app/us-east-1/my-config.json
For an SSM document, specify either the document name in the format ssm-document://<document name> or the Amazon Resource Name (ARN).
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
", + "documentation":"The maximum number of items to return for this call. If MaxResults is not provided in the call, AppConfig returns the maximum of 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.
The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources.
" + }, + "SkipZonalShiftValidation":{ + "shape":"SkipZonalShiftValidation", + "documentation":" If you enable zonal shift with cross-zone disabled load balancers, capacity could become imbalanced across Availability Zones. To skip the validation, specify true. For more information, see Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.
The instance capacity distribution across Availability Zones.
" + }, + "AvailabilityZoneImpairmentPolicy":{ + "shape":"AvailabilityZoneImpairmentPolicy", + "documentation":"The Availability Zone impairment policy.
" } }, "documentation":"Describes an Auto Scaling group.
" @@ -1666,6 +1674,20 @@ }, "documentation":"Describes an Availability Zone distribution.
" }, + "AvailabilityZoneImpairmentPolicy":{ + "type":"structure", + "members":{ + "ZonalShiftEnabled":{ + "shape":"ZonalShiftEnabled", + "documentation":" If true, enable zonal shift for your Auto Scaling group.
Specifies the health check behavior for the impaired Availability Zone in an active zonal shift. If you select Replace unhealthy, instances that appear unhealthy will be replaced in all Availability Zones. If you select Ignore unhealthy, instances will not be replaced in the Availability Zone with the active zonal shift. For more information, see Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.
Describes an Availability Zone impairment policy.
" + }, "AvailabilityZones":{ "type":"list", "member":{"shape":"XmlStringMaxLen255"} @@ -2036,6 +2058,14 @@ "AvailabilityZoneDistribution":{ "shape":"AvailabilityZoneDistribution", "documentation":"The instance capacity distribution across Availability Zones.
" + }, + "AvailabilityZoneImpairmentPolicy":{ + "shape":"AvailabilityZoneImpairmentPolicy", + "documentation":"The policy for Availability Zone impairment.
" + }, + "SkipZonalShiftValidation":{ + "shape":"SkipZonalShiftValidation", + "documentation":" If you enable zonal shift with cross-zone disabled load balancers, capacity could become imbalanced across Availability Zones. To skip the validation, specify true. For more information, see Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.
The instance capacity distribution across Availability Zones.
" + }, + "AvailabilityZoneImpairmentPolicy":{ + "shape":"AvailabilityZoneImpairmentPolicy", + "documentation":"The policy for Availability Zone impairment.
" + }, + "SkipZonalShiftValidation":{ + "shape":"SkipZonalShiftValidation", + "documentation":" If you enable zonal shift with cross-zone disabled load balancers, capacity could become imbalanced across Availability Zones. To skip the validation, specify true. For more information, see Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.
Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
" } diff --git a/botocore/data/cloudformation/2010-05-15/service-2.json b/botocore/data/cloudformation/2010-05-15/service-2.json index 0cdd467667..ae52fef768 100644 --- a/botocore/data/cloudformation/2010-05-15/service-2.json +++ b/botocore/data/cloudformation/2010-05-15/service-2.json @@ -790,6 +790,22 @@ }, "documentation":"Lists your generated templates in this Region.
" }, + "ListHookResults":{ + "name":"ListHookResults", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListHookResultsInput"}, + "output":{ + "shape":"ListHookResultsOutput", + "resultWrapper":"ListHookResultsResult" + }, + "errors":[ + {"shape":"HookResultNotFoundException"} + ], + "documentation":"Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided.
" + }, "ListImports":{ "name":"ListImports", "http":{ @@ -3807,6 +3823,62 @@ "type":"string", "enum":["PRE_PROVISION"] }, + "HookResultId":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + }, + "HookResultNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"The specified target doesn't have any requested Hook invocations.
", + "error":{ + "code":"HookResultNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "HookResultSummaries":{ + "type":"list", + "member":{"shape":"HookResultSummary"} + }, + "HookResultSummary":{ + "type":"structure", + "members":{ + "InvocationPoint":{ + "shape":"HookInvocationPoint", + "documentation":"The exact point in the provisioning logic where the Hook runs.
" + }, + "FailureMode":{ + "shape":"HookFailureMode", + "documentation":"The failure mode of the invocation. The following are potential modes:
FAIL: If the hook invocation returns a failure, then the requested target operation should fail.
WARN: If the hook invocation returns a failure, then the requested target operation should warn.
The type name of the Hook being invoked.
" + }, + "TypeVersionId":{ + "shape":"HookTypeVersionId", + "documentation":"The version of the Hook being invoked.
" + }, + "TypeConfigurationVersionId":{ + "shape":"HookTypeConfigurationVersionId", + "documentation":"The version of the Hook type configuration.
" + }, + "Status":{ + "shape":"HookStatus", + "documentation":"The state of the Hook invocation.
" + }, + "HookStatusReason":{ + "shape":"HookStatusReason", + "documentation":"A description of the Hook results status. For example, if the Hook result is in a FAILED state, this may contain additional information for the FAILED state.
Describes a Hook invocation, its status, and the reason for its status.
" + }, "HookStatus":{ "type":"string", "enum":[ @@ -4077,6 +4149,57 @@ } } }, + "ListHookResultsInput":{ + "type":"structure", + "required":[ + "TargetType", + "TargetId" + ], + "members":{ + "TargetType":{ + "shape":"ListHookResultsTargetType", + "documentation":"The type of operation being targeted by the Hook.
" + }, + "TargetId":{ + "shape":"HookResultId", + "documentation":"The logical ID of the target the operation is acting on by the Hook. If the target is a change set, it's the ARN of the change set.
If the target is a Cloud Control API operation, this will be the HookRequestToken returned by the Cloud Control API operation request. For more information on the HookRequestToken, see ProgressEvent.
A string that identifies the next page of events that you want to retrieve.
" + } + } + }, + "ListHookResultsOutput":{ + "type":"structure", + "members":{ + "TargetType":{ + "shape":"ListHookResultsTargetType", + "documentation":"The type of operation being targeted by the Hook.
" + }, + "TargetId":{ + "shape":"HookResultId", + "documentation":"The logical ID of the target the operation is acting on by the Hook. If the target is a change set, it's the ARN of the change set.
If the target is a Cloud Control API operation, this will be the HooksRequestToken returned by the Cloud Control API operation request. For more information on the HooksRequestToken, see ProgressEvent.
A list of HookResultSummary structures that provides the status and Hook status reason for each Hook invocation for the specified target.
Pagination token, null or empty if no more results.
Creates a flow module for the specified Amazon Connect instance.
" }, + "CreateContactFlowVersion":{ + "name":"CreateContactFlowVersion", + "http":{ + "method":"PUT", + "requestUri":"/contact-flows/{InstanceId}/{ContactFlowId}/version" + }, + "input":{"shape":"CreateContactFlowVersionRequest"}, + "output":{"shape":"CreateContactFlowVersionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If a version of the same flow content already exists, no new version is created and instead the existing version number is returned. If the FlowContentSha256 provided is different from the FlowContentSha256 of the $LATEST published flow content, then an error is returned. This API only supports creating versions for flows of type Campaign.
Provides information about the flow modules for the specified Amazon Connect instance.
" }, + "ListContactFlowVersions":{ + "name":"ListContactFlowVersions", + "http":{ + "method":"GET", + "requestUri":"/contact-flows/{InstanceId}/{ContactFlowId}/versions" + }, + "input":{"shape":"ListContactFlowVersionsRequest"}, + "output":{"shape":"ListContactFlowVersionsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns all the available versions for the specified Amazon Connect instance and flow identifier.
" + }, "ListContactFlows":{ "name":"ListContactFlows", "http":{ @@ -6519,6 +6556,30 @@ "Tags":{ "shape":"TagMap", "documentation":"The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"Amazon Connect includes a set of default flows that have already been published. It uses them to power your contact center.
" + }, + "FlowContentSha256":{ + "shape":"FlowContentSha256", + "documentation":"Indicates the checksum value of the flow content.
" + }, + "Version":{ + "shape":"ResourceVersion", + "documentation":"The identifier of the flow version.
" + }, + "VersionDescription":{ + "shape":"ContactFlowDescription", + "documentation":"The description of the flow version.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The time at which the contact flow was last modified.
" + }, + "LastModifiedRegion":{ + "shape":"RegionName", + "documentation":"The region in which the contact flow was last modified
" } }, "documentation":"Contains information about a flow.
" @@ -6781,6 +6842,28 @@ "member":{"shape":"ContactFlowType"}, "max":10 }, + "ContactFlowVersionSummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the view version.
" + }, + "VersionDescription":{ + "shape":"ContactFlowDescription", + "documentation":"The description of the flow version.
" + }, + "Version":{ + "shape":"ResourceVersion", + "documentation":"The identifier of the flow version.
" + } + }, + "documentation":"A summary of a contact flow version's metadata.
" + }, + "ContactFlowVersionSummaryList":{ + "type":"list", + "member":{"shape":"ContactFlowVersionSummary"} + }, "ContactId":{ "type":"string", "max":256, @@ -7169,6 +7252,60 @@ "ContactFlowArn":{ "shape":"ARN", "documentation":"The Amazon Resource Name (ARN) of the flow.
" + }, + "FlowContentSha256":{ + "shape":"FlowContentSha256", + "documentation":"Indicates the checksum value of the flow content.
" + } + } + }, + "CreateContactFlowVersionRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "ContactFlowId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"The identifier of the Amazon Connect instance.
", + "location":"uri", + "locationName":"InstanceId" + }, + "Description":{ + "shape":"ContactFlowDescription", + "documentation":"The description of the flow version.
" + }, + "ContactFlowId":{ + "shape":"ARN", + "documentation":"The identifier of the flow.
", + "location":"uri", + "locationName":"ContactFlowId" + }, + "FlowContentSha256":{ + "shape":"FlowContentSha256", + "documentation":"Indicates the checksum value of the flow content.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The Amazon Web Services Region where this resource was last modified.
" + }, + "LastModifiedRegion":{ + "shape":"RegionName", + "documentation":"The Amazon Web Services Region where this resource was last modified.
" + } + } + }, + "CreateContactFlowVersionResponse":{ + "type":"structure", + "members":{ + "ContactFlowArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the flow.
" + }, + "Version":{ + "shape":"ResourceVersion", + "documentation":"The identifier of the flow version.
" } } }, @@ -11553,6 +11690,12 @@ "type":"list", "member":{"shape":"FlowAssociationSummary"} }, + "FlowContentSha256":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9]{64}$" + }, "FunctionArn":{ "type":"string", "max":140, @@ -11952,15 +12095,15 @@ }, "Filters":{ "shape":"FiltersV2List", - "documentation":"The filters to apply to returned metrics. You can filter on the following resources:
Agents
Campaigns
Channels
Feature
Queues
Routing profiles
Routing step expression
User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | CAMPAIGN | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | FEATURE | FLOW_TYPE | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | INITIATION_METHOD | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | QUEUE | Q_CONNECT_ENABLED |
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.
ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
Q_CONNECT_ENABLED. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED filter key.
TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
This filter is available only for contact record-driven metrics.
Campaign ARNs are valid filterValues for the CAMPAIGN filter key.
The filters to apply to returned metrics. You can filter on the following resources:
Agents
Campaigns
Channels
Feature
Queues
Routing profiles
Routing step expression
User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE |CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | FEATURE | FLOW_TYPE | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | INITIATION_METHOD | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | QUEUE | Q_CONNECT_ENABLED |
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.
ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
Q_CONNECT_ENABLED. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED filter key.
TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
This filter is available only for contact record-driven metrics.
Campaign ARNs are valid filterValues for the CAMPAIGN filter key.
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | CAMPAIGN | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | INITIATION_METHOD | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | INITIATION_METHOD | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator 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 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 outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign, 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 outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Seconds
Valid groupings and filters: Campaign
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign
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 outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Percent
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
This metric is available only for outbound campaigns using the email delivery mode.
Unit: Count
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Valid groupings and filters: Campaign
UI name: Campaign interactions
This metric is available only for outbound campaigns.
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
UI name: Campaign send attempts
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 outbound campaigns.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempts
Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempt disposition rate
Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
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 outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Count
Valid groupings and filters: Agent, Campaign
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 identifier of the Amazon Connect instance.
", + "location":"uri", + "locationName":"InstanceId" + }, + "ContactFlowId":{ + "shape":"ARN", + "documentation":"The identifier of the flow.
", + "location":"uri", + "locationName":"ContactFlowId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"The maximum number of results to return per page. The default MaxResult size is 100.
", + "box":true, + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListContactFlowVersionsResponse":{ + "type":"structure", + "members":{ + "ContactFlowVersionSummaryList":{ + "shape":"ContactFlowVersionSummaryList", + "documentation":"A list of flow version summaries.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + } + } + }, "ListContactFlowsRequest":{ "type":"structure", "required":["InstanceId"], @@ -17971,6 +18162,10 @@ "type":"list", "member":{"shape":"String"} }, + "ResourceVersion":{ + "type":"long", + "min":1 + }, "ResumeContactRecordingRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/customer-profiles/2020-08-15/paginators-1.json b/botocore/data/customer-profiles/2020-08-15/paginators-1.json index 58e94da63d..f19bf61f60 100644 --- a/botocore/data/customer-profiles/2020-08-15/paginators-1.json +++ b/botocore/data/customer-profiles/2020-08-15/paginators-1.json @@ -5,6 +5,30 @@ "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Items" + }, + "GetSimilarProfiles": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ProfileIds" + }, + "ListObjectTypeAttributes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Items" + }, + "ListRuleBasedMatches": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "MatchIds" + }, + "ListSegmentDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Items" } } } diff --git a/botocore/data/customer-profiles/2020-08-15/paginators-1.sdk-extras.json b/botocore/data/customer-profiles/2020-08-15/paginators-1.sdk-extras.json new file mode 100644 index 0000000000..15e5e31825 --- /dev/null +++ b/botocore/data/customer-profiles/2020-08-15/paginators-1.sdk-extras.json @@ -0,0 +1,15 @@ +{ + "version": 1.0, + "merge": { + "pagination": { + "GetSimilarProfiles": { + "non_aggregate_keys": [ + "MatchType", + "MatchId", + "RuleLevel", + "ConfidenceScore" + ] + } + } + } +} diff --git a/botocore/data/customer-profiles/2020-08-15/service-2.json b/botocore/data/customer-profiles/2020-08-15/service-2.json index 147591d3e5..845d097810 100644 --- a/botocore/data/customer-profiles/2020-08-15/service-2.json +++ b/botocore/data/customer-profiles/2020-08-15/service-2.json @@ -32,6 +32,40 @@ ], "documentation":"Associates a new key value with a specific profile, such as a Contact Record ContactId.
A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.
" }, + "BatchGetCalculatedAttributeForProfile":{ + "name":"BatchGetCalculatedAttributeForProfile", + "http":{ + "method":"POST", + "requestUri":"/domains/{DomainName}/calculated-attributes/{CalculatedAttributeName}/batch-get-for-profiles" + }, + "input":{"shape":"BatchGetCalculatedAttributeForProfileRequest"}, + "output":{"shape":"BatchGetCalculatedAttributeForProfileResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Fetch the possible attribute values given the attribute name.
" + }, + "BatchGetProfile":{ + "name":"BatchGetProfile", + "http":{ + "method":"POST", + "requestUri":"/domains/{DomainName}/batch-get-profiles" + }, + "input":{"shape":"BatchGetProfileRequest"}, + "output":{"shape":"BatchGetProfileResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Get a batch of profiles.
" + }, "CreateCalculatedAttributeDefinition":{ "name":"CreateCalculatedAttributeDefinition", "http":{ @@ -117,6 +151,59 @@ ], "documentation":"Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
" }, + "CreateSegmentDefinition":{ + "name":"CreateSegmentDefinition", + "http":{ + "method":"POST", + "requestUri":"/domains/{DomainName}/segment-definitions/{SegmentDefinitionName}", + "responseCode":200 + }, + "input":{"shape":"CreateSegmentDefinitionRequest"}, + "output":{"shape":"CreateSegmentDefinitionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a segment definition associated to the given domain.
", + "idempotent":true + }, + "CreateSegmentEstimate":{ + "name":"CreateSegmentEstimate", + "http":{ + "method":"POST", + "requestUri":"/domains/{DomainName}/segment-estimates" + }, + "input":{"shape":"CreateSegmentEstimateRequest"}, + "output":{"shape":"CreateSegmentEstimateResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a segment estimate query.
" + }, + "CreateSegmentSnapshot":{ + "name":"CreateSegmentSnapshot", + "http":{ + "method":"POST", + "requestUri":"/domains/{DomainName}/segments/{SegmentDefinitionName}/snapshots" + }, + "input":{"shape":"CreateSegmentSnapshotRequest"}, + "output":{"shape":"CreateSegmentSnapshotResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Triggers a job to export a segment to a specified destination.
" + }, "DeleteCalculatedAttributeDefinition":{ "name":"DeleteCalculatedAttributeDefinition", "http":{ @@ -254,6 +341,25 @@ ], "documentation":"Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.
" }, + "DeleteSegmentDefinition":{ + "name":"DeleteSegmentDefinition", + "http":{ + "method":"DELETE", + "requestUri":"/domains/{DomainName}/segment-definitions/{SegmentDefinitionName}", + "responseCode":200 + }, + "input":{"shape":"DeleteSegmentDefinitionRequest"}, + "output":{"shape":"DeleteSegmentDefinitionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a segment definition from the domain.
", + "idempotent":true + }, "DeleteWorkflow":{ "name":"DeleteWorkflow", "http":{ @@ -458,6 +564,77 @@ ], "documentation":"Returns the template information for a specific object type.
A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.
" }, + "GetSegmentDefinition":{ + "name":"GetSegmentDefinition", + "http":{ + "method":"GET", + "requestUri":"/domains/{DomainName}/segment-definitions/{SegmentDefinitionName}", + "responseCode":200 + }, + "input":{"shape":"GetSegmentDefinitionRequest"}, + "output":{"shape":"GetSegmentDefinitionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets a segment definition from the domain.
" + }, + "GetSegmentEstimate":{ + "name":"GetSegmentEstimate", + "http":{ + "method":"GET", + "requestUri":"/domains/{DomainName}/segment-estimates/{EstimateId}" + }, + "input":{"shape":"GetSegmentEstimateRequest"}, + "output":{"shape":"GetSegmentEstimateResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets the result of a segment estimate query.
" + }, + "GetSegmentMembership":{ + "name":"GetSegmentMembership", + "http":{ + "method":"POST", + "requestUri":"/domains/{DomainName}/segments/{SegmentDefinitionName}/membership", + "responseCode":200 + }, + "input":{"shape":"GetSegmentMembershipRequest"}, + "output":{"shape":"GetSegmentMembershipResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Determines if the given profiles are within a segment.
", + "idempotent":true + }, + "GetSegmentSnapshot":{ + "name":"GetSegmentSnapshot", + "http":{ + "method":"GET", + "requestUri":"/domains/{DomainName}/segments/{SegmentDefinitionName}/snapshots/{SnapshotId}" + }, + "input":{"shape":"GetSegmentSnapshotRequest"}, + "output":{"shape":"GetSegmentSnapshotResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieve the latest status of a segment snapshot.
" + }, "GetSimilarProfiles":{ "name":"GetSimilarProfiles", "http":{ @@ -628,6 +805,40 @@ ], "documentation":"Lists all of the integrations in your domain.
" }, + "ListObjectTypeAttributes":{ + "name":"ListObjectTypeAttributes", + "http":{ + "method":"GET", + "requestUri":"/domains/{DomainName}/object-types/{ObjectTypeName}/attributes" + }, + "input":{"shape":"ListObjectTypeAttributesRequest"}, + "output":{"shape":"ListObjectTypeAttributesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Fetch the possible attribute values given the attribute name.
" + }, + "ListProfileAttributeValues":{ + "name":"ListProfileAttributeValues", + "http":{ + "method":"GET", + "requestUri":"/domains/{DomainName}/profile-attributes/{AttributeName}/values" + }, + "input":{"shape":"ProfileAttributeValuesRequest"}, + "output":{"shape":"ProfileAttributeValuesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Fetch the possible attribute values given the attribute name.
" + }, "ListProfileObjectTypeTemplates":{ "name":"ListProfileObjectTypeTemplates", "http":{ @@ -696,6 +907,24 @@ ], "documentation":"Returns a set of MatchIds that belong to the given domain.
Lists all segment definitions under a domain.
" + }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -1017,6 +1246,42 @@ "documentation":"A generic address associated with the customer that is not mailing, shipping, or billing.
", "sensitive":true }, + "AddressDimension":{ + "type":"structure", + "members":{ + "City":{ + "shape":"ProfileDimension", + "documentation":"The city belonging to the address.
", + "locationName":"City" + }, + "Country":{ + "shape":"ProfileDimension", + "documentation":"The country belonging to the address.
", + "locationName":"Country" + }, + "County":{ + "shape":"ProfileDimension", + "documentation":"The county belonging to the address.
", + "locationName":"County" + }, + "PostalCode":{ + "shape":"ProfileDimension", + "documentation":"The postal code belonging to the address.
", + "locationName":"PostalCode" + }, + "Province":{ + "shape":"ProfileDimension", + "documentation":"The province belonging to the address.
", + "locationName":"Province" + }, + "State":{ + "shape":"ProfileDimension", + "documentation":"The state belonging to the address.
", + "locationName":"State" + } + }, + "documentation":"Object that segments on Customer Profile's address object.
" + }, "AddressList":{ "type":"list", "member":{"shape":"string1To255"}, @@ -1147,6 +1412,46 @@ "documentation":"Mathematical expression and a list of attribute items specified in that expression.
", "sensitive":true }, + "AttributeDimension":{ + "type":"structure", + "required":[ + "DimensionType", + "Values" + ], + "members":{ + "DimensionType":{ + "shape":"AttributeDimensionType", + "documentation":"The action to segment with.
", + "locationName":"DimensionType" + }, + "Values":{ + "shape":"Values", + "documentation":"The values to apply the DimensionType on.
", + "locationName":"Values" + } + }, + "documentation":"Object that segments on various Customer Profile's fields.
" + }, + "AttributeDimensionType":{ + "type":"string", + "enum":[ + "INCLUSIVE", + "EXCLUSIVE", + "CONTAINS", + "BEGINS_WITH", + "ENDS_WITH", + "BEFORE", + "AFTER", + "BETWEEN", + "NOT_BETWEEN", + "ON", + "GREATER_THAN", + "LESS_THAN", + "GREATER_THAN_OR_EQUAL", + "LESS_THAN_OR_EQUAL", + "EQUAL" + ] + }, "AttributeItem":{ "type":"structure", "required":["Name"], @@ -1164,6 +1469,11 @@ "max":2, "min":1 }, + "AttributeMap":{ + "type":"map", + "key":{"shape":"attributeName"}, + "value":{"shape":"FilterAttributeDimension"} + }, "AttributeMatchingModel":{ "type":"string", "enum":[ @@ -1199,6 +1509,20 @@ }, "documentation":"Configuration information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles. You can choose how profiles are compared across attribute types and which attribute to use for matching from each type. There are three attribute types you can configure:
Email type
You can choose from Email, BusinessEmail, and PersonalEmail
Phone number type
You can choose from Phone, HomePhone, and MobilePhone
Address type
You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress
You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When choosing MANY_TO_MANY, the system can match attribute across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the two profiles are matched on the Email type.
An individual value belonging to the given attribute.
" + } + }, + "documentation":"List containing the values for the given attribute.
" + }, + "AttributeValueItemList":{ + "type":"list", + "member":{"shape":"AttributeValueItem"} + }, "Attributes":{ "type":"map", "key":{"shape":"string1To255"}, @@ -1255,6 +1579,151 @@ }, "documentation":"Batch defines the boundaries for ingestion for each step in APPFLOW_INTEGRATION workflow. APPFLOW_INTEGRATION workflow splits ingestion based on these boundaries.
Status code for why a specific profile and calculated attribute failed.
" + }, + "Message":{ + "shape":"string1To1000", + "documentation":"Message describing why a specific profile and calculated attribute failed.
" + }, + "ProfileId":{ + "shape":"uuid", + "documentation":"The profile id that failed.
" + } + }, + "documentation":"Error object describing why a specific profile and calculated attribute failed.
" + }, + "BatchGetCalculatedAttributeForProfileErrorList":{ + "type":"list", + "member":{"shape":"BatchGetCalculatedAttributeForProfileError"} + }, + "BatchGetCalculatedAttributeForProfileIdList":{ + "type":"list", + "member":{"shape":"uuid"}, + "max":100, + "min":1 + }, + "BatchGetCalculatedAttributeForProfileRequest":{ + "type":"structure", + "required":[ + "CalculatedAttributeName", + "DomainName", + "ProfileIds" + ], + "members":{ + "CalculatedAttributeName":{ + "shape":"typeName", + "documentation":"The unique name of the calculated attribute.
", + "location":"uri", + "locationName":"CalculatedAttributeName" + }, + "DomainName":{ + "shape":"name", + "documentation":"The unique name of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "ProfileIds":{ + "shape":"BatchGetCalculatedAttributeForProfileIdList", + "documentation":"List of unique identifiers for customer profiles to retrieve.
" + }, + "ConditionOverrides":{ + "shape":"ConditionOverrides", + "documentation":"Overrides the condition block within the original calculated attribute definition.
" + } + } + }, + "BatchGetCalculatedAttributeForProfileResponse":{ + "type":"structure", + "members":{ + "Errors":{ + "shape":"BatchGetCalculatedAttributeForProfileErrorList", + "documentation":"List of errors for calculated attribute values that could not be retrieved.
" + }, + "CalculatedAttributeValues":{ + "shape":"CalculatedAttributeValueList", + "documentation":"List of calculated attribute values retrieved.
" + }, + "ConditionOverrides":{ + "shape":"ConditionOverrides", + "documentation":"Overrides the condition block within the original calculated attribute definition.
" + } + } + }, + "BatchGetProfileError":{ + "type":"structure", + "required":[ + "Code", + "Message", + "ProfileId" + ], + "members":{ + "Code":{ + "shape":"string1To255", + "documentation":"Status code for why a specific profile failed.
" + }, + "Message":{ + "shape":"string1To1000", + "documentation":"Message describing why a specific profile failed.
" + }, + "ProfileId":{ + "shape":"uuid", + "documentation":"The profile id that failed.
" + } + }, + "documentation":"Error object describing why a specific profile failed.
" + }, + "BatchGetProfileErrorList":{ + "type":"list", + "member":{"shape":"BatchGetProfileError"} + }, + "BatchGetProfileIdList":{ + "type":"list", + "member":{"shape":"uuid"}, + "max":20, + "min":1 + }, + "BatchGetProfileRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ProfileIds" + ], + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique name of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "ProfileIds":{ + "shape":"BatchGetProfileIdList", + "documentation":"List of unique identifiers for customer profiles to retrieve.
" + } + } + }, + "BatchGetProfileResponse":{ + "type":"structure", + "members":{ + "Errors":{ + "shape":"BatchGetProfileErrorList", + "documentation":"For information about the errors that are common to all actions, see Common Errors.
" + }, + "Profiles":{ + "shape":"ProfileList", + "documentation":"Array of Profile Objects.
" + } + } + }, "Batches":{ "type":"list", "member":{"shape":"Batch"} @@ -1275,10 +1744,81 @@ "member":{"shape":"ListCalculatedAttributeDefinitionItem"}, "sensitive":true }, + "CalculatedAttributeDimension":{ + "type":"structure", + "required":[ + "DimensionType", + "Values" + ], + "members":{ + "DimensionType":{ + "shape":"AttributeDimensionType", + "documentation":"The action to segment with.
", + "locationName":"DimensionType" + }, + "Values":{ + "shape":"Values", + "documentation":"The values to apply the DimensionType with.
", + "locationName":"Values" + }, + "ConditionOverrides":{ + "shape":"ConditionOverrides", + "documentation":"Applies the given condition over the initial Calculated Attribute's definition.
", + "locationName":"ConditionOverrides" + } + }, + "documentation":"Object that segments on Customer Profile's Calculated Attributes.
" + }, + "CalculatedAttributeValue":{ + "type":"structure", + "members":{ + "CalculatedAttributeName":{ + "shape":"typeName", + "documentation":"The unique name of the calculated attribute.
" + }, + "DisplayName":{ + "shape":"displayName", + "documentation":"The display name of the calculated attribute.
" + }, + "IsDataPartial":{ + "shape":"string1To255", + "documentation":"Indicates whether the calculated attribute's value is based on partial data. If the data is partial, it is set to true.
" + }, + "ProfileId":{ + "shape":"uuid", + "documentation":"The profile id belonging to this calculated attribute value.
" + }, + "Value":{ + "shape":"string1To255", + "documentation":"The value of the calculated attribute.
" + } + }, + "documentation":"The object containing the values of a single calculated attribute value.
" + }, + "CalculatedAttributeValueList":{ + "type":"list", + "member":{"shape":"CalculatedAttributeValue"} + }, "CalculatedAttributesForProfileList":{ "type":"list", "member":{"shape":"ListCalculatedAttributeForProfileItem"} }, + "CalculatedCustomAttributes":{ + "type":"map", + "key":{"shape":"typeName"}, + "value":{"shape":"CalculatedAttributeDimension"} + }, + "ConditionOverrides":{ + "type":"structure", + "members":{ + "Range":{ + "shape":"RangeOverride", + "documentation":"The relative time period over which data is included in the aggregation for this override.
" + } + }, + "documentation":"An object to override the original condition block of a calculated attribute.
", + "sensitive":true + }, "Conditions":{ "type":"structure", "members":{ @@ -1399,6 +1939,10 @@ "shape":"Conditions", "documentation":"The conditions including range, object count, and threshold for the calculated attribute.
" }, + "Filter":{ + "shape":"Filter", + "documentation":"Defines how to filter incoming objects to include part of the Calculated Attribute.
" + }, "Statistic":{ "shape":"Statistic", "documentation":"The aggregation operation to perform for the calculated attribute.
" @@ -1432,6 +1976,10 @@ "shape":"Conditions", "documentation":"The conditions including range, object count, and threshold for the calculated attribute.
" }, + "Filter":{ + "shape":"Filter", + "documentation":"The filter that was used as part of the request.
" + }, "Statistic":{ "shape":"Statistic", "documentation":"The aggregation operation to perform for the calculated attribute.
" @@ -1749,6 +2297,179 @@ } } }, + "CreateSegmentDefinitionRequest":{ + "type":"structure", + "required":[ + "DomainName", + "SegmentDefinitionName", + "DisplayName", + "SegmentGroups" + ], + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique name of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "SegmentDefinitionName":{ + "shape":"name", + "documentation":"The unique name of the segment definition.
", + "location":"uri", + "locationName":"SegmentDefinitionName" + }, + "DisplayName":{ + "shape":"string1To255", + "documentation":"The display name of the segment definition.
" + }, + "Description":{ + "shape":"sensitiveText", + "documentation":"The description of the segment definition.
" + }, + "SegmentGroups":{ + "shape":"SegmentGroup", + "documentation":"Specifies the base segments and dimensions for a segment definition along with their respective relationship.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + } + }, + "CreateSegmentDefinitionResponse":{ + "type":"structure", + "required":["SegmentDefinitionName"], + "members":{ + "SegmentDefinitionName":{ + "shape":"name", + "documentation":"The name of the segment definition.
", + "locationName":"SegmentDefinitionName" + }, + "DisplayName":{ + "shape":"string1To255", + "documentation":"The display name of the segment definition.
", + "locationName":"DisplayName" + }, + "Description":{ + "shape":"sensitiveText", + "documentation":"The description of the segment definition.
", + "locationName":"Description" + }, + "CreatedAt":{ + "shape":"timestamp", + "documentation":"The timestamp of when the segment definition was created.
", + "locationName":"CreatedAt" + }, + "SegmentDefinitionArn":{ + "shape":"SegmentDefinitionArn", + "documentation":"The arn of the segment definition.
", + "locationName":"SegmentDefinitionArn" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags used to organize, track, or control access for this resource.
", + "locationName":"Tags" + } + } + }, + "CreateSegmentEstimateRequest":{ + "type":"structure", + "required":[ + "DomainName", + "SegmentQuery" + ], + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique name of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "SegmentQuery":{ + "shape":"SegmentGroupStructure", + "documentation":"The segment query for calculating a segment estimate.
" + } + } + }, + "CreateSegmentEstimateResponse":{ + "type":"structure", + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique name of the domain.
" + }, + "EstimateId":{ + "shape":"string1To255", + "documentation":"A unique identifier for the resource. The value can be passed to GetSegmentEstimate to retrieve the result of segment estimate status.
The status code for the response.
", + "location":"statusCode" + } + } + }, + "CreateSegmentSnapshotRequest":{ + "type":"structure", + "required":[ + "DomainName", + "SegmentDefinitionName", + "DataFormat" + ], + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique name of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "SegmentDefinitionName":{ + "shape":"name", + "documentation":"The name of the segment definition used in this snapshot request.
", + "location":"uri", + "locationName":"SegmentDefinitionName" + }, + "DataFormat":{ + "shape":"DataFormat", + "documentation":"The format in which the segment will be exported.
" + }, + "EncryptionKey":{ + "shape":"encryptionKey", + "documentation":"The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.
" + }, + "DestinationUri":{ + "shape":"string1To255", + "documentation":"The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.
" + } + } + }, + "CreateSegmentSnapshotResponse":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "SnapshotId":{ + "shape":"uuid", + "documentation":"The unique identifier of the segment snapshot.
" + } + } + }, + "CustomAttributes":{ + "type":"map", + "key":{"shape":"typeName"}, + "value":{"shape":"AttributeDimension"} + }, + "DataFormat":{ + "type":"string", + "enum":[ + "CSV", + "JSONL", + "ORC" + ] + }, "DataPullMode":{ "type":"string", "enum":[ @@ -1757,6 +2478,42 @@ ] }, "Date":{"type":"timestamp"}, + "DateDimension":{ + "type":"structure", + "required":[ + "DimensionType", + "Values" + ], + "members":{ + "DimensionType":{ + "shape":"DateDimensionType", + "documentation":"The action to segment with.
", + "locationName":"DimensionType" + }, + "Values":{ + "shape":"DateValues", + "documentation":"The values to apply the DimensionType on.
", + "locationName":"Values" + } + }, + "documentation":"Object that segments on various Customer Profile's date fields.
" + }, + "DateDimensionType":{ + "type":"string", + "enum":[ + "BEFORE", + "AFTER", + "BETWEEN", + "NOT_BETWEEN", + "ON" + ] + }, + "DateValues":{ + "type":"list", + "member":{"shape":"String"}, + "max":50, + "min":1 + }, "DatetimeTypeFieldName":{ "type":"string", "max":256, @@ -2000,6 +2757,37 @@ } } }, + "DeleteSegmentDefinitionRequest":{ + "type":"structure", + "required":[ + "DomainName", + "SegmentDefinitionName" + ], + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique name of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "SegmentDefinitionName":{ + "shape":"name", + "documentation":"The unique name of the segment definition.
", + "location":"uri", + "locationName":"SegmentDefinitionName" + } + } + }, + "DeleteSegmentDefinitionResponse":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"string1To1000", + "documentation":"A message that indicates the delete request is done.
", + "locationName":"Message" + } + } + }, "DeleteWorkflowRequest":{ "type":"structure", "required":[ @@ -2103,6 +2891,27 @@ "type":"list", "member":{"shape":"DetectedProfileObjectType"} }, + "Dimension":{ + "type":"structure", + "members":{ + "ProfileAttributes":{ + "shape":"ProfileAttributes", + "documentation":"Object that holds the profile attributes to segment on.
", + "locationName":"ProfileAttributes" + }, + "CalculatedAttributes":{ + "shape":"CalculatedCustomAttributes", + "documentation":"Object that holds the calculated attributes to segment on.
", + "locationName":"CalculatedAttributes" + } + }, + "documentation":"Object that holds what profile and calculated attributes to segment on.
", + "union":true + }, + "DimensionList":{ + "type":"list", + "member":{"shape":"Dimension"} + }, "DomainList":{ "type":"list", "member":{"shape":"ListDomainItem"} @@ -2141,6 +2950,19 @@ "max":3, "min":1 }, + "End":{ + "type":"integer", + "max":366, + "min":0 + }, + "EstimateStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "SUCCEEDED", + "FAILED" + ] + }, "EventStreamDestinationDetails":{ "type":"structure", "required":[ @@ -2245,6 +3067,36 @@ }, "documentation":"The S3 location where Identity Resolution Jobs write result files.
" }, + "ExtraLengthValueProfileDimension":{ + "type":"structure", + "required":[ + "DimensionType", + "Values" + ], + "members":{ + "DimensionType":{ + "shape":"StringDimensionType", + "documentation":"The action to segment with.
", + "locationName":"DimensionType" + }, + "Values":{ + "shape":"ExtraLengthValues", + "documentation":"The values to apply the DimensionType on.
", + "locationName":"Values" + } + }, + "documentation":"Object that segments on various Customer profile's fields that are larger than normal.
" + }, + "ExtraLengthValues":{ + "type":"list", + "member":{"shape":"string1To1000"}, + "max":50, + "min":1 + }, + "Failures":{ + "type":"list", + "member":{"shape":"ProfileQueryFailures"} + }, "FieldContentType":{ "type":"string", "enum":[ @@ -2355,6 +3207,97 @@ }, "documentation":"A duplicate customer profile that is to be merged into a main profile.
" }, + "Filter":{ + "type":"structure", + "required":[ + "Include", + "Groups" + ], + "members":{ + "Include":{ + "shape":"Include", + "documentation":"Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.
" + }, + "Groups":{ + "shape":"GroupList", + "documentation":"Holds the list of Filter groups within the Filter definition.
" + } + }, + "documentation":"Defines how to filter the objects coming in for calculated attributes.
" + }, + "FilterAttributeDimension":{ + "type":"structure", + "required":[ + "DimensionType", + "Values" + ], + "members":{ + "DimensionType":{ + "shape":"FilterDimensionType", + "documentation":"The action to filter with.
" + }, + "Values":{ + "shape":"ValueList", + "documentation":"The values to apply the DimensionType on.
" + } + }, + "documentation":"Object that defines how to filter the incoming objects for the calculated attribute.
" + }, + "FilterDimension":{ + "type":"structure", + "required":["Attributes"], + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "documentation":"Is the attribute within the FilterDimension map
" + } + }, + "documentation":"Contains the map of attribute names to attribute dimensions.
" + }, + "FilterDimensionList":{ + "type":"list", + "member":{"shape":"FilterDimension"}, + "max":10, + "min":1 + }, + "FilterDimensionType":{ + "type":"string", + "enum":[ + "INCLUSIVE", + "EXCLUSIVE", + "CONTAINS", + "BEGINS_WITH", + "ENDS_WITH", + "BEFORE", + "AFTER", + "BETWEEN", + "NOT_BETWEEN", + "ON", + "GREATER_THAN", + "LESS_THAN", + "GREATER_THAN_OR_EQUAL", + "LESS_THAN_OR_EQUAL", + "EQUAL" + ] + }, + "FilterGroup":{ + "type":"structure", + "required":[ + "Type", + "Dimensions" + ], + "members":{ + "Type":{ + "shape":"Type", + "documentation":"The type of logical relationship between the dimensions of the Filter group.
" + }, + "Dimensions":{ + "shape":"FilterDimensionList", + "documentation":"Object that holds the attributes to filter on.
" + } + }, + "documentation":"Object that holds the dimensions to filter on.
" + }, "FlowDefinition":{ "type":"structure", "required":[ @@ -2525,6 +3468,10 @@ "shape":"Statistic", "documentation":"The aggregation operation to perform for the calculated attribute.
" }, + "Filter":{ + "shape":"Filter", + "documentation":"The filter assigned to this calculated attribute definition.
" + }, "Conditions":{ "shape":"Conditions", "documentation":"The conditions including range, object count, and threshold for the calculated attribute.
" @@ -3027,6 +3974,237 @@ } } }, + "GetSegmentDefinitionRequest":{ + "type":"structure", + "required":[ + "DomainName", + "SegmentDefinitionName" + ], + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique name of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "SegmentDefinitionName":{ + "shape":"name", + "documentation":"The unique name of the segment definition.
", + "location":"uri", + "locationName":"SegmentDefinitionName" + } + } + }, + "GetSegmentDefinitionResponse":{ + "type":"structure", + "required":["SegmentDefinitionArn"], + "members":{ + "SegmentDefinitionName":{ + "shape":"name", + "documentation":"The name of the segment definition.
", + "locationName":"SegmentDefinitionName" + }, + "DisplayName":{ + "shape":"string1To255", + "documentation":"The display name of the segment definition.
", + "locationName":"DisplayName" + }, + "Description":{ + "shape":"sensitiveText", + "documentation":"The description of the segment definition.
", + "locationName":"Description" + }, + "SegmentGroups":{ + "shape":"SegmentGroup", + "documentation":"The segment criteria associated with this definition.
", + "locationName":"SegmentGroups" + }, + "SegmentDefinitionArn":{ + "shape":"SegmentDefinitionArn", + "documentation":"The arn of the segment definition.
", + "locationName":"SegmentDefinitionArn" + }, + "CreatedAt":{ + "shape":"timestamp", + "documentation":"The timestamp of when the segment definition was created.
", + "locationName":"CreatedAt" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags used to organize, track, or control access for this resource.
", + "locationName":"Tags" + } + } + }, + "GetSegmentEstimateRequest":{ + "type":"structure", + "required":[ + "DomainName", + "EstimateId" + ], + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique name of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "EstimateId":{ + "shape":"string1To255", + "documentation":"The query Id passed by a previous CreateSegmentEstimate operation.
The unique name of the domain.
" + }, + "EstimateId":{ + "shape":"string1To255", + "documentation":"The QueryId which is the same as the value passed in QueryId.
The current status of the query.
" + }, + "Estimate":{ + "shape":"string1To255", + "documentation":"The estimated number of profiles contained in the segment.
" + }, + "Message":{ + "shape":"string1To255", + "documentation":"The error message if there is any error.
" + }, + "StatusCode":{ + "shape":"StatusCode", + "documentation":"The status code of the segment estimate.
", + "location":"statusCode" + } + } + }, + "GetSegmentMembershipMessage":{"type":"string"}, + "GetSegmentMembershipRequest":{ + "type":"structure", + "required":[ + "DomainName", + "SegmentDefinitionName", + "ProfileIds" + ], + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique name of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "SegmentDefinitionName":{ + "shape":"name", + "documentation":"The Id of the wanted segment. Needs to be a valid, and existing segment Id.
", + "location":"uri", + "locationName":"SegmentDefinitionName" + }, + "ProfileIds":{ + "shape":"ProfileIds", + "documentation":"The list of profile IDs to query for.
", + "locationName":"ProfileIds" + } + } + }, + "GetSegmentMembershipResponse":{ + "type":"structure", + "members":{ + "SegmentDefinitionName":{ + "shape":"name", + "documentation":"The unique name of the segment definition.
", + "locationName":"SegmentDefinitionName" + }, + "Profiles":{ + "shape":"Profiles", + "documentation":"An array of maps where each contains a response per profile requested.
", + "locationName":"Profiles" + }, + "Failures":{ + "shape":"Failures", + "documentation":"An array of maps where each contains a response per profile failed for the request.
", + "locationName":"Failures" + } + } + }, + "GetSegmentMembershipStatus":{ + "type":"integer", + "box":true + }, + "GetSegmentSnapshotRequest":{ + "type":"structure", + "required":[ + "DomainName", + "SegmentDefinitionName", + "SnapshotId" + ], + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique identifier of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "SegmentDefinitionName":{ + "shape":"name", + "documentation":"The unique name of the segment definition.
", + "location":"uri", + "locationName":"SegmentDefinitionName" + }, + "SnapshotId":{ + "shape":"uuid", + "documentation":"The unique identifier of the segment snapshot.
", + "location":"uri", + "locationName":"SnapshotId" + } + } + }, + "GetSegmentSnapshotResponse":{ + "type":"structure", + "required":[ + "SnapshotId", + "Status", + "DataFormat" + ], + "members":{ + "SnapshotId":{ + "shape":"uuid", + "documentation":"The unique identifier of the segment snapshot.
" + }, + "Status":{ + "shape":"SegmentSnapshotStatus", + "documentation":"The status of the asynchronous job for exporting the segment snapshot.
" + }, + "StatusMessage":{ + "shape":"string1To1000", + "documentation":"The status message of the asynchronous job for exporting the segment snapshot.
" + }, + "DataFormat":{ + "shape":"DataFormat", + "documentation":"The format in which the segment will be exported.
" + }, + "EncryptionKey":{ + "shape":"encryptionKey", + "documentation":"The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.
" + }, + "DestinationUri":{ + "shape":"string1To255", + "documentation":"The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.
" + } + } + }, "GetSimilarProfilesRequest":{ "type":"structure", "required":[ @@ -3209,6 +4387,38 @@ } } }, + "Group":{ + "type":"structure", + "members":{ + "Dimensions":{ + "shape":"DimensionList", + "documentation":"Defines the attributes to segment on.
", + "locationName":"Dimensions" + }, + "SourceSegments":{ + "shape":"SourceSegmentList", + "documentation":"Defines the starting source of data.
", + "locationName":"SourceSegments" + }, + "SourceType":{ + "shape":"IncludeOptions", + "documentation":"Defines how to interact with the source data.
", + "locationName":"SourceType" + }, + "Type":{ + "shape":"IncludeOptions", + "documentation":"Defines how to interact with the profiles found in the current filtering.
", + "locationName":"Type" + } + }, + "documentation":"Contains dimensions that determine what to segment on.
" + }, + "GroupList":{ + "type":"list", + "member":{"shape":"FilterGroup"}, + "max":2, + "min":1 + }, "IdentityResolutionJob":{ "type":"structure", "members":{ @@ -3263,6 +4473,22 @@ "type":"list", "member":{"shape":"IdentityResolutionJob"} }, + "Include":{ + "type":"string", + "enum":[ + "ALL", + "ANY", + "NONE" + ] + }, + "IncludeOptions":{ + "type":"string", + "enum":[ + "ALL", + "ANY", + "NONE" + ] + }, "IncrementalPullConfig":{ "type":"structure", "members":{ @@ -3752,16 +4978,84 @@ } } }, - "ListIntegrationsResponse":{ + "ListIntegrationsResponse":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"IntegrationList", + "documentation":"The list of ListIntegrations instances.
" + }, + "NextToken":{ + "shape":"token", + "documentation":"The pagination token from the previous ListIntegrations API call.
" + } + } + }, + "ListObjectTypeAttributeItem":{ + "type":"structure", + "required":[ + "AttributeName", + "LastUpdatedAt" + ], + "members":{ + "AttributeName":{ + "shape":"name", + "documentation":"Name of the attribute.
" + }, + "LastUpdatedAt":{ + "shape":"timestamp", + "documentation":"When the attribute was last updated.
" + } + }, + "documentation":"Item that contains the attribute and when it was last updated.
" + }, + "ListObjectTypeAttributesList":{ + "type":"list", + "member":{"shape":"ListObjectTypeAttributeItem"} + }, + "ListObjectTypeAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ObjectTypeName" + ], + "members":{ + "NextToken":{ + "shape":"token", + "documentation":"The pagination token from the previous call.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"maxSize100", + "documentation":"The maximum number of objects returned per page.
", + "location":"querystring", + "locationName":"max-results" + }, + "DomainName":{ + "shape":"name", + "documentation":"The unique identifier of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "ObjectTypeName":{ + "shape":"typeName", + "documentation":"The name of the profile object type.
", + "location":"uri", + "locationName":"ObjectTypeName" + } + } + }, + "ListObjectTypeAttributesResponse":{ "type":"structure", "members":{ "Items":{ - "shape":"IntegrationList", - "documentation":"The list of ListIntegrations instances.
" + "shape":"ListObjectTypeAttributesList", + "documentation":"The items returned as part of the response.
" }, "NextToken":{ "shape":"token", - "documentation":"The pagination token from the previous ListIntegrations API call.
" + "documentation":"The pagination token from the previous call.
" } } }, @@ -3996,6 +5290,45 @@ } } }, + "ListSegmentDefinitionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique identifier of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "MaxResults":{ + "shape":"MaxSize500", + "documentation":"The maximum number of objects returned per page.
", + "location":"querystring", + "locationName":"max-results" + }, + "NextToken":{ + "shape":"token", + "documentation":"The pagination token from the previous call.
", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "ListSegmentDefinitionsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"token", + "documentation":"The pagination token from the previous call.
", + "locationName":"NextToken" + }, + "Items":{ + "shape":"SegmentDefinitionsList", + "documentation":"List of segment definitions.
", + "locationName":"Items" + } + } + }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], @@ -4263,6 +5596,12 @@ "max":15, "min":1 }, + "MaxSize500":{ + "type":"integer", + "box":true, + "max":500, + "min":1 + }, "MergeProfilesRequest":{ "type":"structure", "required":[ @@ -4526,6 +5865,182 @@ }, "documentation":"The standard profile of a customer.
" }, + "ProfileAttributeValuesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "AttributeName" + ], + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The unique identifier of the domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "AttributeName":{ + "shape":"string1To255", + "documentation":"The attribute name.
", + "location":"uri", + "locationName":"AttributeName" + } + } + }, + "ProfileAttributeValuesResponse":{ + "type":"structure", + "members":{ + "DomainName":{ + "shape":"name", + "documentation":"The name of the domain.
" + }, + "AttributeName":{ + "shape":"string1To255", + "documentation":"The attribute name.
" + }, + "Items":{ + "shape":"AttributeValueItemList", + "documentation":"The items returned as part of the response.
" + }, + "StatusCode":{ + "shape":"StatusCode", + "documentation":"The status code for the response.
", + "location":"statusCode" + } + } + }, + "ProfileAttributes":{ + "type":"structure", + "members":{ + "AccountNumber":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within account number.
", + "locationName":"AccountNumber" + }, + "AdditionalInformation":{ + "shape":"ExtraLengthValueProfileDimension", + "documentation":"A field to describe values to segment on within additional information.
", + "locationName":"AdditionalInformation" + }, + "FirstName":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within first name.
", + "locationName":"FirstName" + }, + "LastName":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within last name.
", + "locationName":"LastName" + }, + "MiddleName":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within middle name.
", + "locationName":"MiddleName" + }, + "GenderString":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within genderString.
", + "locationName":"GenderString" + }, + "PartyTypeString":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within partyTypeString.
", + "locationName":"PartyTypeString" + }, + "BirthDate":{ + "shape":"DateDimension", + "documentation":"A field to describe values to segment on within birthDate.
", + "locationName":"BirthDate" + }, + "PhoneNumber":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within phone number.
", + "locationName":"PhoneNumber" + }, + "BusinessName":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within business name.
", + "locationName":"BusinessName" + }, + "BusinessPhoneNumber":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within business phone number.
", + "locationName":"BusinessPhoneNumber" + }, + "HomePhoneNumber":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within home phone number.
", + "locationName":"HomePhoneNumber" + }, + "MobilePhoneNumber":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within mobile phone number.
", + "locationName":"MobilePhoneNumber" + }, + "EmailAddress":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within email address.
", + "locationName":"EmailAddress" + }, + "PersonalEmailAddress":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within personal email address.
", + "locationName":"PersonalEmailAddress" + }, + "BusinessEmailAddress":{ + "shape":"ProfileDimension", + "documentation":"A field to describe values to segment on within business email address.
", + "locationName":"BusinessEmailAddress" + }, + "Address":{ + "shape":"AddressDimension", + "documentation":"A field to describe values to segment on within address.
", + "locationName":"Address" + }, + "ShippingAddress":{ + "shape":"AddressDimension", + "documentation":"A field to describe values to segment on within shipping address.
", + "locationName":"ShippingAddress" + }, + "MailingAddress":{ + "shape":"AddressDimension", + "documentation":"A field to describe values to segment on within mailing address.
", + "locationName":"MailingAddress" + }, + "BillingAddress":{ + "shape":"AddressDimension", + "documentation":"A field to describe values to segment on within billing address.
", + "locationName":"BillingAddress" + }, + "Attributes":{ + "shape":"CustomAttributes", + "documentation":"A field to describe values to segment on within attributes.
", + "locationName":"Attributes" + } + }, + "documentation":"The object used to segment on attributes within the customer profile.
", + "sensitive":true + }, + "ProfileDimension":{ + "type":"structure", + "required":[ + "DimensionType", + "Values" + ], + "members":{ + "DimensionType":{ + "shape":"StringDimensionType", + "documentation":"The action to segment on.
", + "locationName":"DimensionType" + }, + "Values":{ + "shape":"Values", + "documentation":"The values to apply the DimensionType on.
", + "locationName":"Values" + } + }, + "documentation":"Object to hold the dimensions of a profile's fields to segment on.
" + }, + "ProfileId":{"type":"string"}, "ProfileIdList":{ "type":"list", "member":{"shape":"uuid"} @@ -4536,6 +6051,12 @@ "max":20, "min":1 }, + "ProfileIds":{ + "type":"list", + "member":{"shape":"uuid"}, + "max":100, + "min":1 + }, "ProfileList":{ "type":"list", "member":{"shape":"Profile"} @@ -4553,6 +6074,59 @@ "type":"list", "member":{"shape":"ListProfileObjectTypeTemplateItem"} }, + "ProfileQueryFailures":{ + "type":"structure", + "required":[ + "ProfileId", + "Message" + ], + "members":{ + "ProfileId":{ + "shape":"ProfileId", + "documentation":"The profile id the failure belongs to.
", + "locationName":"ProfileId" + }, + "Message":{ + "shape":"GetSegmentMembershipMessage", + "documentation":"A message describing the failure.
", + "locationName":"Message" + }, + "Status":{ + "shape":"GetSegmentMembershipStatus", + "documentation":"The status describing the failure.
", + "locationName":"Status" + } + }, + "documentation":"Object that holds failures for membership.
" + }, + "ProfileQueryResult":{ + "type":"structure", + "required":[ + "ProfileId", + "QueryResult" + ], + "members":{ + "ProfileId":{ + "shape":"ProfileId", + "documentation":"The profile id the result belongs to.
", + "locationName":"ProfileId" + }, + "QueryResult":{ + "shape":"QueryResult", + "documentation":"Describes whether the profile was absent or present in the segment.
", + "locationName":"QueryResult" + }, + "Profile":{ + "shape":"Profile", + "locationName":"Profile" + } + }, + "documentation":"Object that holds the results for membership.
" + }, + "Profiles":{ + "type":"list", + "member":{"shape":"ProfileQueryResult"} + }, "Property":{ "type":"string", "max":2048, @@ -4805,6 +6379,13 @@ } } }, + "QueryResult":{ + "type":"string", + "enum":[ + "PRESENT", + "ABSENT" + ] + }, "Range":{ "type":"structure", "required":[ @@ -4823,6 +6404,32 @@ }, "documentation":"The relative time period over which data is included in the aggregation.
" }, + "RangeOverride":{ + "type":"structure", + "required":[ + "Start", + "Unit" + ], + "members":{ + "Start":{ + "shape":"Start", + "documentation":"The start time of when to include objects.
" + }, + "End":{ + "shape":"End", + "documentation":"The end time of when to include objects.
" + }, + "Unit":{ + "shape":"RangeUnit", + "documentation":"The unit for start and end.
" + } + }, + "documentation":"Overrides the original range on a calculated attribute definition.
" + }, + "RangeUnit":{ + "type":"string", + "enum":["DAYS"] + }, "ResourceNotFoundException":{ "type":"structure", "members":{ @@ -5128,6 +6735,94 @@ } } }, + "SegmentDefinitionArn":{ + "type":"string", + "max":255, + "min":1 + }, + "SegmentDefinitionItem":{ + "type":"structure", + "members":{ + "SegmentDefinitionName":{ + "shape":"name", + "documentation":"Name of the segment definition.
", + "locationName":"SegmentDefinitionName" + }, + "DisplayName":{ + "shape":"string1To255", + "documentation":"Display name of the segment definition.
", + "locationName":"DisplayName" + }, + "Description":{ + "shape":"sensitiveText", + "documentation":"The description of the segment definition.
", + "locationName":"Description" + }, + "SegmentDefinitionArn":{ + "shape":"SegmentDefinitionArn", + "documentation":"The arn of the segment definition.
", + "locationName":"SegmentDefinitionArn" + }, + "CreatedAt":{ + "shape":"timestamp", + "documentation":"When the segment definition was created.
", + "locationName":"CreatedAt" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags belonging to the segment definition.
", + "locationName":"Tags" + } + }, + "documentation":"Object holding the segment definition fields.
" + }, + "SegmentDefinitionsList":{ + "type":"list", + "member":{"shape":"SegmentDefinitionItem"} + }, + "SegmentGroup":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"SegmentGroupList", + "documentation":"Holds the list of groups within the segment definition.
", + "locationName":"Groups" + }, + "Include":{ + "shape":"IncludeOptions", + "documentation":"Defines whether to include or exclude the profiles that fit the segment criteria.
", + "locationName":"Include" + } + }, + "documentation":"Contains all groups of the segment definition.
", + "sensitive":true + }, + "SegmentGroupList":{ + "type":"list", + "member":{"shape":"Group"} + }, + "SegmentGroupStructure":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"SegmentGroupList", + "documentation":"Holds the list of groups within the segment definition.
" + }, + "Include":{ + "shape":"IncludeOptions", + "documentation":"Define whether to include or exclude the profiles that fit the segment criteria.
" + } + }, + "documentation":"Contains all groups of the segment definition.
" + }, + "SegmentSnapshotStatus":{ + "type":"string", + "enum":[ + "COMPLETED", + "IN_PROGRESS", + "FAILED" + ] + }, "ServiceNowConnectorOperator":{ "type":"string", "enum":[ @@ -5231,23 +6926,44 @@ }, "documentation":"Contains information about the configuration of the source connector used in the flow.
" }, + "SourceSegment":{ + "type":"structure", + "members":{ + "SegmentDefinitionName":{ + "shape":"name", + "documentation":"The unique name of the segment definition.
", + "locationName":"SegmentDefinitionName" + } + }, + "documentation":"The source segments to build off of.
" + }, + "SourceSegmentList":{ + "type":"list", + "member":{"shape":"SourceSegment"} + }, "StandardIdentifier":{ "type":"string", "enum":[ "PROFILE", "ASSET", "CASE", + "ORDER", + "COMMUNICATION_RECORD", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", - "NEW_ONLY", - "ORDER" + "NEW_ONLY" ] }, "StandardIdentifierList":{ "type":"list", "member":{"shape":"StandardIdentifier"} }, + "Start":{ + "type":"integer", + "max":366, + "min":1 + }, "Statistic":{ "type":"string", "enum":[ @@ -5274,6 +6990,18 @@ "CANCELLED" ] }, + "StatusCode":{"type":"integer"}, + "String":{"type":"string"}, + "StringDimensionType":{ + "type":"string", + "enum":[ + "INCLUSIVE", + "EXCLUSIVE", + "CONTAINS", + "BEGINS_WITH", + "ENDS_WITH" + ] + }, "TagArn":{ "type":"string", "max":256, @@ -5442,6 +7170,14 @@ "OnDemand" ] }, + "Type":{ + "type":"string", + "enum":[ + "ALL", + "ANY", + "NONE" + ] + }, "Unit":{ "type":"string", "enum":["DAYS"] @@ -5807,6 +7543,18 @@ "max":366, "min":1 }, + "ValueList":{ + "type":"list", + "member":{"shape":"string1To255"}, + "max":10, + "min":1 + }, + "Values":{ + "type":"list", + "member":{"shape":"string1To255"}, + "max":50, + "min":1 + }, "WorkflowAttributes":{ "type":"structure", "members":{ diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 0918ac6fb0..f9bff6011b 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -13903,6 +13903,10 @@ "shape":"RequestLaunchTemplateData", "documentation":"The information for the launch template.
" }, + "Operator":{ + "shape":"OperatorRequest", + "documentation":"Reserved for internal use.
" + }, "TagSpecifications":{ "shape":"TagSpecificationList", "documentation":"The tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template.
To specify the tags for the resources that are created when an instance is launched, you must use the TagSpecifications parameter in the launch template data structure.
A connection tracking specification for the network interface.
" }, + "Operator":{ + "shape":"OperatorRequest", + "documentation":"Reserved for internal use.
" + }, "SubnetId":{ "shape":"SubnetId", "documentation":"The ID of the subnet to associate with the network interface.
", @@ -16395,6 +16403,10 @@ "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
", "idempotencyToken":true }, + "Operator":{ + "shape":"OperatorRequest", + "documentation":"Reserved for internal use.
" + }, "DryRun":{ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the Amazon Web Services account that owns the volume.
This parameter is returned only for volumes that are attached to Fargate tasks.
", "locationName":"volumeOwnerId" + }, + "Operator":{ + "shape":"OperatorResponse", + "documentation":"The entity that manages the EBS volume.
", + "locationName":"operator" } }, "documentation":"Describes a parameter used to set up an EBS volume in a block device mapping.
" @@ -35311,6 +35328,11 @@ "documentation":"The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.
", "locationName":"currentInstanceBootMode" }, + "Operator":{ + "shape":"OperatorResponse", + "documentation":"The entity that manages the instance.
", + "locationName":"operator" + }, "InstanceId":{ "shape":"String", "documentation":"The ID of the instance.
", @@ -36061,6 +36083,11 @@ "shape":"ImageMetadata", "documentation":"Information about the AMI used to launch the instance.
", "locationName":"imageMetadata" + }, + "Operator":{ + "shape":"OperatorResponse", + "documentation":"The entity that manages the instance.
", + "locationName":"operator" } }, "documentation":"Information about the instance and the AMI used to launch the instance.
" @@ -36456,6 +36483,11 @@ "shape":"ConnectionTrackingSpecificationResponse", "documentation":"A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
", "locationName":"connectionTrackingConfiguration" + }, + "Operator":{ + "shape":"OperatorResponse", + "documentation":"The entity that manages the network interface.
", + "locationName":"operator" } }, "documentation":"Describes a network interface.
" @@ -37044,6 +37076,11 @@ "documentation":"The Amazon Resource Name (ARN) of the Outpost.
", "locationName":"outpostArn" }, + "Operator":{ + "shape":"OperatorResponse", + "documentation":"The entity that manages the instance.
", + "locationName":"operator" + }, "Events":{ "shape":"InstanceStatusEventList", "documentation":"Any scheduled events associated with the instance.
", @@ -40604,6 +40641,11 @@ "shape":"TagList", "documentation":"The tags for the launch template.
", "locationName":"tagSet" + }, + "Operator":{ + "shape":"OperatorResponse", + "documentation":"The entity that manages the launch template.
", + "locationName":"operator" } }, "documentation":"Describes a launch template.
" @@ -41808,6 +41850,11 @@ "shape":"ResponseLaunchTemplateData", "documentation":"Information about the launch template.
", "locationName":"launchTemplateData" + }, + "Operator":{ + "shape":"OperatorResponse", + "documentation":"The entity that manages the launch template.
", + "locationName":"operator" } }, "documentation":"Describes a launch template version.
" @@ -47118,6 +47165,11 @@ "shape":"String", "documentation":"The IPv6 globally unique address associated with the network interface.
", "locationName":"ipv6Address" + }, + "Operator":{ + "shape":"OperatorResponse", + "documentation":"The entity that manages the network interface.
", + "locationName":"operator" } }, "documentation":"Describes a network interface.
" @@ -47763,6 +47815,32 @@ "remove" ] }, + "OperatorRequest":{ + "type":"structure", + "members":{ + "Principal":{ + "shape":"String", + "documentation":"The entity that manages the resource.
" + } + }, + "documentation":"The entity that manages the resource.
" + }, + "OperatorResponse":{ + "type":"structure", + "members":{ + "Managed":{ + "shape":"Boolean", + "documentation":"If true, the resource is managed by an entity.
If managed is true, then the principal is returned. The principal is the entity that manages the resource.
Describes whether the resource is managed by an entity and, if so, describes the entity that manages it.
" + }, "OrganizationArnStringList":{ "type":"list", "member":{ @@ -51047,6 +51125,10 @@ "DisableApiStop":{ "shape":"Boolean", "documentation":"Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.
" + }, + "Operator":{ + "shape":"OperatorRequest", + "documentation":"The entity that manages the launch template.
" } }, "documentation":"The information to include in the launch template.
You must specify at least one parameter for the launch template data.
Indicates whether the instance is enabled for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.
", "locationName":"disableApiStop" + }, + "Operator":{ + "shape":"OperatorResponse", + "documentation":"The entity that manages the launch template.
", + "locationName":"operator" } }, "documentation":"The information for a launch template.
" @@ -53305,6 +53392,10 @@ "shape":"Boolean", "documentation":"If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if an instance relies on its IPv6 address not changing. When you launch the instance, Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
" }, + "Operator":{ + "shape":"OperatorRequest", + "documentation":"Reserved for internal use.
" + }, "DryRun":{ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
This parameter is not returned by CreateVolume.
Reserved for future use.
", "locationName":"sseType" }, + "Operator":{ + "shape":"OperatorResponse", + "documentation":"The entity that manages the volume.
", + "locationName":"operator" + }, "VolumeId":{ "shape":"String", "documentation":"The ID of the volume.
", diff --git a/botocore/data/ecs/2014-11-13/service-2.json b/botocore/data/ecs/2014-11-13/service-2.json index 5653b3ee8c..411a7ee3f0 100644 --- a/botocore/data/ecs/2014-11-13/service-2.json +++ b/botocore/data/ecs/2014-11-13/service-2.json @@ -46,7 +46,7 @@ {"shape":"InvalidParameterException"}, {"shape":"NamespaceNotFoundException"} ], - "documentation":"Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name.
When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name.
When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
Amazon Elastic Inference (EI) is no longer available to customers.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide
" + "documentation":"Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, use UpdateService.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
Amazon Elastic Inference (EI) is no longer available to customers.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide
" }, "CreateTaskSet":{ "name":"CreateTaskSet", @@ -2172,7 +2172,7 @@ }, "deploymentConfiguration":{ "shape":"DeploymentConfiguration", - "documentation":"Optional deployment parameters that control how many tasks run during the deployment and the failure detection methods.
" + "documentation":"Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
" }, "placementConstraints":{ "shape":"PlacementConstraints", @@ -2188,7 +2188,7 @@ }, "healthCheckGracePeriodSeconds":{ "shape":"BoxedInteger", - "documentation":"The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.
If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in the task definition health check parameters. For more information, see Health check.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
" + "documentation":"The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of 0 is used. If you don't use any of the health checks, then healthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
" }, "schedulingStrategy":{ "shape":"SchedulingStrategy", @@ -2221,6 +2221,10 @@ "volumeConfigurations":{ "shape":"ServiceVolumeConfigurations", "documentation":"The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
" + }, + "vpcLatticeConfigurations":{ + "shape":"VpcLatticeConfigurations", + "documentation":"The VPC Lattice configuration for the service being created.
" } } }, @@ -2569,6 +2573,10 @@ "fargateEphemeralStorage":{ "shape":"DeploymentEphemeralStorage", "documentation":"The Fargate ephemeral storage settings for the deployment.
" + }, + "vpcLatticeConfigurations":{ + "shape":"VpcLatticeConfigurations", + "documentation":"The VPC Lattice configuration for the service deployment.
" } }, "documentation":"The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.
Information about the CloudWatch alarms.
" } }, - "documentation":"Optional deployment parameters that control how many tasks run during the deployment and the failure detection methods.
" + "documentation":"Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.
" }, "DeploymentController":{ "type":"structure", @@ -2660,7 +2668,7 @@ "members":{ "kmsKeyId":{ "shape":"String", - "documentation":"Specify an Amazon Web Services Key Management Service key ID to encrypt the ephemeral storage for deployment.
" + "documentation":"Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
" } }, "documentation":"The amount of ephemeral storage to allocate for the deployment.
" @@ -4119,7 +4127,7 @@ }, "loadBalancerName":{ "shape":"String", - "documentation":"The name of the load balancer to associate with the service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
" + "documentation":"The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
" }, "containerName":{ "shape":"String", @@ -4255,7 +4263,7 @@ }, "minimumScalingStepSize":{ "shape":"ManagedScalingStepSize", - "documentation":"The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default value of 1 is used.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
" + "documentation":"The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
" }, "maximumScalingStepSize":{ "shape":"ManagedScalingStepSize", @@ -4295,7 +4303,7 @@ "members":{ "kmsKeyId":{ "shape":"String", - "documentation":"Specify a Amazon Web Services Key Management Service key ID to encrypt the managed storage.
" + "documentation":"Specify a Key Management Service key ID to encrypt the managed storage.
" }, "fargateEphemeralStorageKmsKeyId":{ "shape":"String", @@ -4545,7 +4553,7 @@ "members":{ "containerPort":{ "shape":"BoxedInteger", - "documentation":"The port number on the container that's bound to the user-specified or automatically assigned host port.
For tasks that use the Fargate launch type or EC2 tasks that use the awsvpc network mode, you use containerPort to specify the exposed ports.
For Windows containers on Fargate, you can't use port 3150 for the containerPort. This is because it's reserved.
Suppose that you're using containers in a task with the EC2 launch type and you specify a container port and not a host port. Then, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way don't count toward the 100 reserved ports quota of a container instance.
The port number on the container that's bound to the user-specified or automatically assigned host port.
If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.
If you use containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the serviceConnectConfiguration of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + "documentation":"The name that's used for the port mapping. This parameter is the name that you use in the serviceConnectConfiguration and the vpcLatticeConfigurations of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a containerPortRange:
You must use either the bridge network mode or the awsvpc network mode.
This parameter is available for both the EC2 and Fargate launch types.
This parameter is available for both the Linux and Windows operating systems.
The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package
You can specify a maximum of 100 port ranges per container.
You do not specify a hostPortRange. The value of the hostPortRange is set as follows:
For containers in a task with the awsvpc network mode, the hostPortRange is set to the same value as the containerPortRange. This is a static mapping strategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange valid values are between 1 and 65535.
A port can only be included in one port mapping per container.
You cannot specify overlapping port ranges.
The first port in the range must be less than last port in the range.
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.
Port mappings expose your container's network ports to the outside world. this allows clients to access your application. It's also used for inter-container communication within the same task.
For task definitions (both the Fargate and EC2 launch type) that use the awsvpc network mode, only specify the containerPort. The hostPort is always ignored, and the container port is automatically mapped to a random high-numbered port on the host.
Most fields of this parameter (containerPort, hostPort, protocol) maps to PortBindings in the docker container create command and the --publish option to docker run. If the network mode of a task definition is set to host, host ports must either be undefined or match the container port in the port mapping.
You can't expose the same container port for multiple protocols. If you attempt this, an error is returned.
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.
Most fields of this parameter (containerPort, hostPort, protocol) maps to PortBindings in the docker container create command and the --publish option to docker run. If the network mode of a task definition is set to host, host ports must either be undefined or match the container port in the port mapping.
You can't expose the same container port for multiple protocols. If you attempt this, an error is returned.
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
" + "documentation":"The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.
If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.
If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
The CPU architecture.
You can run your Linux tasks on an ARM-based platform by setting the value to ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.
The default is X86_64.
The CPU architecture.
You can run your Linux tasks on an ARM-based platform by setting the value to ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.
The operating system.
The default is Linux.
The operating system.
" } }, "documentation":"Information about the platform for the Amazon ECS service or task.
For more information about RuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide.
The capacity provider strategy the service uses. When using DescribeServices, this field is omitted if the service was created using a launch type.
The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
" }, "platformVersion":{ "shape":"String", @@ -5290,7 +5298,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define both the key and value.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The time that the service revision was created. The format is yyyy-mm-dd HH:mm:ss.SSSSS.
" + }, + "vpcLatticeConfigurations":{ + "shape":"VpcLatticeConfigurations", + "documentation":"The VPC Lattice configuration for the service revision.
" } }, "documentation":"Information about the service revision.
A service revision contains a record of the workload configuration Amazon ECS is attempting to deploy. Whenever you create or deploy a service, Amazon ECS automatically creates and captures the configuration that you're trying to deploy in the service revision. For information about service revisions, see Amazon ECS service revisions in the Amazon Elastic Container Service Developer Guide .
" @@ -6436,7 +6448,7 @@ }, "networkMode":{ "shape":"NetworkMode", - "documentation":"The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
" + "documentation":"The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.
If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.
If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
Specify an Amazon Web Services Key Management Service key ID to encrypt the ephemeral storage for the task.
" + "documentation":"Specify an Key Management Service key ID to encrypt the ephemeral storage for the task.
" } }, "documentation":"The amount of ephemeral storage to allocate for the task.
" @@ -7177,7 +7189,7 @@ }, "deploymentConfiguration":{ "shape":"DeploymentConfiguration", - "documentation":"Optional deployment parameters that control how many tasks run during the deployment and the failure detection methods.
" + "documentation":"Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
" }, "networkConfiguration":{ "shape":"NetworkConfiguration", @@ -7201,7 +7213,7 @@ }, "healthCheckGracePeriodSeconds":{ "shape":"BoxedInteger", - "documentation":"The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
" + "documentation":"The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of 0 is used. If you don't use any of the health checks, then healthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
" }, "enableExecuteCommand":{ "shape":"BoxedBoolean", @@ -7230,6 +7242,10 @@ "volumeConfigurations":{ "shape":"ServiceVolumeConfigurations", "documentation":"The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition. If set to null, no new deployment is triggered. Otherwise, if this configuration differs from the existing one, it triggers a new deployment.
An object representing the VPC Lattice configuration for the service being updated.
" } } }, @@ -7386,6 +7402,33 @@ "VolumeList":{ "type":"list", "member":{"shape":"Volume"} + }, + "VpcLatticeConfiguration":{ + "type":"structure", + "required":[ + "roleArn", + "targetGroupArn", + "portName" + ], + "members":{ + "roleArn":{ + "shape":"IAMRoleArn", + "documentation":"The ARN of the IAM role to associate with this VPC Lattice configuration. This is the Amazon ECS infrastructure IAM role that is used to manage your VPC Lattice infrastructure.
" + }, + "targetGroupArn":{ + "shape":"String", + "documentation":"The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice configuration that the Amazon ECS tasks will be registered to.
" + }, + "portName":{ + "shape":"String", + "documentation":"The name of the port mapping to register in the VPC Lattice target group. This is the name of the portMapping you defined in your task definition.
The VPC Lattice configuration for your service that holds the information for the target group(s) Amazon ECS tasks will be registered to.
" + }, + "VpcLatticeConfigurations":{ + "type":"list", + "member":{"shape":"VpcLatticeConfiguration"} } }, "documentation":"Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.
Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure.
" diff --git a/botocore/data/iotsitewise/2019-12-02/paginators-1.json b/botocore/data/iotsitewise/2019-12-02/paginators-1.json index e89847599c..0237e4da5c 100644 --- a/botocore/data/iotsitewise/2019-12-02/paginators-1.json +++ b/botocore/data/iotsitewise/2019-12-02/paginators-1.json @@ -125,6 +125,12 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "compositionRelationshipSummaries" + }, + "ListDatasets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "datasetSummaries" } } } diff --git a/botocore/data/iotsitewise/2019-12-02/service-2.json b/botocore/data/iotsitewise/2019-12-02/service-2.json index 9b48828e91..721158573e 100644 --- a/botocore/data/iotsitewise/2019-12-02/service-2.json +++ b/botocore/data/iotsitewise/2019-12-02/service-2.json @@ -281,6 +281,27 @@ "documentation":"Creates a dashboard in an IoT SiteWise Monitor project.
", "endpoint":{"hostPrefix":"monitor."} }, + "CreateDataset":{ + "name":"CreateDataset", + "http":{ + "method":"POST", + "requestUri":"/datasets", + "responseCode":202 + }, + "input":{"shape":"CreateDatasetRequest"}, + "output":{"shape":"CreateDatasetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConflictingOperationException"} + ], + "documentation":"Creates a dataset to connect an external datasource.
", + "endpoint":{"hostPrefix":"api."} + }, "CreateGateway":{ "name":"CreateGateway", "http":{ @@ -433,6 +454,25 @@ "documentation":"Deletes a dashboard from IoT SiteWise Monitor.
", "endpoint":{"hostPrefix":"monitor."} }, + "DeleteDataset":{ + "name":"DeleteDataset", + "http":{ + "method":"DELETE", + "requestUri":"/datasets/{datasetId}", + "responseCode":202 + }, + "input":{"shape":"DeleteDatasetRequest"}, + "output":{"shape":"DeleteDatasetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictingOperationException"} + ], + "documentation":"Deletes a dataset. This cannot be undone.
", + "endpoint":{"hostPrefix":"api."} + }, "DeleteGateway":{ "name":"DeleteGateway", "http":{ @@ -659,6 +699,23 @@ "documentation":"Retrieves information about a dashboard.
", "endpoint":{"hostPrefix":"monitor."} }, + "DescribeDataset":{ + "name":"DescribeDataset", + "http":{ + "method":"GET", + "requestUri":"/datasets/{datasetId}" + }, + "input":{"shape":"DescribeDatasetRequest"}, + "output":{"shape":"DescribeDatasetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves information about a dataset.
", + "endpoint":{"hostPrefix":"api."} + }, "DescribeDefaultEncryptionConfiguration":{ "name":"DescribeDefaultEncryptionConfiguration", "http":{ @@ -944,6 +1001,27 @@ "documentation":"Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
Invokes SiteWise Assistant to start or continue a conversation.
", + "endpoint":{"hostPrefix":"data."} + }, "ListAccessPolicies":{ "name":"ListAccessPolicies", "http":{ @@ -1147,6 +1225,22 @@ "documentation":"Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
", "endpoint":{"hostPrefix":"monitor."} }, + "ListDatasets":{ + "name":"ListDatasets", + "http":{ + "method":"GET", + "requestUri":"/datasets" + }, + "input":{"shape":"ListDatasetsRequest"}, + "output":{"shape":"ListDatasetsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves a paginated list of datasets for a specific target resource.
", + "endpoint":{"hostPrefix":"api."} + }, "ListGateways":{ "name":"ListGateways", "http":{ @@ -1465,6 +1559,26 @@ "documentation":"Updates an IoT SiteWise Monitor dashboard.
", "endpoint":{"hostPrefix":"monitor."} }, + "UpdateDataset":{ + "name":"UpdateDataset", + "http":{ + "method":"PUT", + "requestUri":"/datasets/{datasetId}", + "responseCode":202 + }, + "input":{"shape":"UpdateDatasetRequest"}, + "output":{"shape":"UpdateDatasetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictingOperationException"} + ], + "documentation":"Updates a dataset.
", + "endpoint":{"hostPrefix":"api."} + }, "UpdateGateway":{ "name":"UpdateGateway", "http":{ @@ -1550,7 +1664,7 @@ "AccessDeniedException":{ "type":"structure", "members":{ - "message":{"shape":"errorMessage"} + "message":{"shape":"ErrorMessage"} }, "documentation":"Access is denied.
", "error":{"httpStatusCode":403}, @@ -1739,7 +1853,7 @@ "required":["alarmRoleArn"], "members":{ "alarmRoleArn":{ - "shape":"ARN", + "shape":"IamArn", "documentation":"The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.
" }, "notificationLambdaArn":{ @@ -2140,7 +2254,7 @@ }, "dataType":{ "shape":"PropertyDataType", - "documentation":"The data type of the asset model property.
" + "documentation":"The data type of the asset model property.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
Contains information about the data source.
" + }, + "content":{ + "shape":"Content", + "documentation":"Contains the cited text from the data source.
" + } + }, + "documentation":"Contains text content to which the SiteWise Assistant refers to, and generate the final response. It also contains information about the source.
" + }, + "Citations":{ + "type":"list", + "member":{"shape":"Citation"} + }, "ClientToken":{ "type":"string", "max":64, @@ -3711,6 +3843,22 @@ "error":{"httpStatusCode":409}, "exception":true }, + "Content":{ + "type":"structure", + "members":{ + "text":{ + "shape":"String", + "documentation":"The cited text from the data source.
" + } + }, + "documentation":"Contains the cited text from the data source.
" + }, + "ConversationId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, "CoreDeviceThingName":{ "type":"string", "max":128, @@ -4068,7 +4216,7 @@ }, "dashboardDefinition":{ "shape":"DashboardDefinition", - "documentation":"The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.
" + "documentation":"The dashboard definition specified in a JSON literal.
IoT SiteWise Monitor (Classic) see Create dashboards (CLI)
IoT SiteWise Monitor (AI-aware) see Create dashboards (CLI)
in the IoT SiteWise User Guide
" }, "clientToken":{ "shape":"ClientToken", @@ -4098,6 +4246,62 @@ } } }, + "CreateDatasetRequest":{ + "type":"structure", + "required":[ + "datasetName", + "datasetSource" + ], + "members":{ + "datasetId":{ + "shape":"ID", + "documentation":"The ID of the dataset.
" + }, + "datasetName":{ + "shape":"RestrictedName", + "documentation":"The name of the dataset.
" + }, + "datasetDescription":{ + "shape":"RestrictedDescription", + "documentation":"A description about the dataset, and its functionality.
" + }, + "datasetSource":{ + "shape":"DatasetSource", + "documentation":"The data source for the dataset.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", + "idempotencyToken":true + }, + "tags":{ + "shape":"TagMap", + "documentation":"A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
" + } + } + }, + "CreateDatasetResponse":{ + "type":"structure", + "required":[ + "datasetId", + "datasetArn", + "datasetStatus" + ], + "members":{ + "datasetId":{ + "shape":"ID", + "documentation":"The ID of the dataset.
" + }, + "datasetArn":{ + "shape":"ARN", + "documentation":"The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.
A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
" }, "roleArn":{ - "shape":"ARN", + "shape":"IamArn", "documentation":"The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
" }, "tags":{ @@ -4184,6 +4388,14 @@ "alarms":{ "shape":"Alarms", "documentation":"Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
" + }, + "portalType":{ + "shape":"PortalType", + "documentation":"Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
Contains a dashboard summary.
" }, + "DataSetReference":{ + "type":"structure", + "members":{ + "datasetArn":{ + "shape":"String", + "documentation":"The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
The data source for the dataset.
" + } + }, + "documentation":"Contains information about the dataset use and it's source.
" + }, + "DatasetSource":{ + "type":"structure", + "required":[ + "sourceType", + "sourceFormat" + ], + "members":{ + "sourceType":{ + "shape":"DatasetSourceType", + "documentation":"The type of data source for the dataset.
" + }, + "sourceFormat":{ + "shape":"DatasetSourceFormat", + "documentation":"The format of the dataset source associated with the dataset.
" + }, + "sourceDetail":{ + "shape":"SourceDetail", + "documentation":"The details of the dataset source associated with the dataset.
" + } + }, + "documentation":"The data source for the dataset.
" + }, + "DatasetSourceFormat":{ + "type":"string", + "enum":["KNOWLEDGE_BASE"] + }, + "DatasetSourceType":{ + "type":"string", + "enum":["KENDRA"] + }, + "DatasetState":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING", + "FAILED" + ] + }, + "DatasetStatus":{ + "type":"structure", + "required":["state"], + "members":{ + "state":{ + "shape":"DatasetState", + "documentation":"The current status of the dataset.
" + }, + "error":{"shape":"ErrorDetails"} + }, + "documentation":"The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.
The ID of the dataset.
" + }, + "arn":{ + "shape":"ARN", + "documentation":"The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
The name of the dataset.
" + }, + "description":{ + "shape":"RestrictedDescription", + "documentation":"A description about the dataset, and its functionality.
" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"The dataset creation date, in Unix epoch time.
" + }, + "lastUpdateDate":{ + "shape":"Timestamp", + "documentation":"The date the dataset was last updated, in Unix epoch time.
" + }, + "status":{ + "shape":"DatasetStatus", + "documentation":"The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.
The summary details for the dataset.
" + }, "Datum":{ "type":"structure", "members":{ @@ -4548,6 +4873,35 @@ "members":{ } }, + "DeleteDatasetRequest":{ + "type":"structure", + "required":["datasetId"], + "members":{ + "datasetId":{ + "shape":"CustomID", + "documentation":"The ID of the dataset.
", + "location":"uri", + "locationName":"datasetId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" + } + } + }, + "DeleteDatasetResponse":{ + "type":"structure", + "required":["datasetStatus"], + "members":{ + "datasetStatus":{ + "shape":"DatasetStatus", + "documentation":"The status of the dataset. This contains the state and any error messages. State is DELETING after a successfull call to this API, and any associated error message.
The ID of the dataset.
", + "location":"uri", + "locationName":"datasetId" + } + } + }, + "DescribeDatasetResponse":{ + "type":"structure", + "required":[ + "datasetId", + "datasetArn", + "datasetName", + "datasetDescription", + "datasetSource", + "datasetStatus", + "datasetCreationDate", + "datasetLastUpdateDate" + ], + "members":{ + "datasetId":{ + "shape":"ID", + "documentation":"The ID of the dataset.
" + }, + "datasetArn":{ + "shape":"ARN", + "documentation":"The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
The name of the dataset.
" + }, + "datasetDescription":{ + "shape":"RestrictedDescription", + "documentation":"A description about the dataset, and its functionality.
" + }, + "datasetSource":{ + "shape":"DatasetSource", + "documentation":"The data source for the dataset.
" + }, + "datasetStatus":{ + "shape":"DatasetStatus", + "documentation":"The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.
The dataset creation date, in Unix epoch time.
" + }, + "datasetLastUpdateDate":{ + "shape":"Timestamp", + "documentation":"The date the dataset was last updated, in Unix epoch time.
" + }, + "datasetVersion":{ + "shape":"Version", + "documentation":"The version of the dataset.
" + } + } + }, "DescribeDefaultEncryptionConfigurationRequest":{ "type":"structure", "members":{ @@ -5345,7 +5762,7 @@ }, "capabilitySyncStatus":{ "shape":"CapabilitySyncStatus", - "documentation":"The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.
NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.
The portal's logo image, which is available at a URL.
" }, "roleArn":{ - "shape":"ARN", + "shape":"IamArn", "documentation":"The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
" }, "portalAuthMode":{ @@ -5502,6 +5919,14 @@ "alarms":{ "shape":"Alarms", "documentation":"Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
" + }, + "portalType":{ + "shape":"PortalType", + "documentation":"Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
The maximum number of results to return at one time. The default is 25.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", + "idempotencyToken":true } } }, @@ -6038,7 +6469,7 @@ }, "capabilitySyncStatus":{ "shape":"CapabilitySyncStatus", - "documentation":"The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.
NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.
Contains a summary of a gateway capability configuration.
" @@ -6450,7 +6881,7 @@ "required":["arn"], "members":{ "arn":{ - "shape":"ARN", + "shape":"IamArn", "documentation":"The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide.
" } }, @@ -6461,7 +6892,7 @@ "required":["arn"], "members":{ "arn":{ - "shape":"ARN", + "shape":"IamArn", "documentation":"The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide.
If you delete the IAM user, access policies that contain this identity include an empty arn. You can delete the access policy for the IAM user that no longer exists.
The text message of the SiteWise Assistant's response.
" + }, + "citations":{ + "shape":"Citations", + "documentation":"A list of citations, and related information for the SiteWise Assistant's response.
" + } + }, + "documentation":"This contains the SiteWise Assistant's response and the corresponding citation.
", + "event":true + }, + "InvokeAssistantRequest":{ + "type":"structure", + "required":["message"], + "members":{ + "conversationId":{ + "shape":"ConversationId", + "documentation":"The ID assigned to a conversation. IoT SiteWise automatically generates a unique ID for you, and this parameter is never required. However, if you prefer to have your own ID, you must specify it here in UUID format. If you specify your own ID, it must be globally unique.
" + }, + "message":{ + "shape":"MessageInput", + "documentation":"A text message sent to the SiteWise Assistant by the user.
" + }, + "enableTrace":{ + "shape":"PrimitiveBoolean", + "documentation":"Specifies if to turn trace on or not. It is used to track the SiteWise Assistant's reasoning, and data access process.
" + } + } + }, + "InvokeAssistantResponse":{ + "type":"structure", + "required":[ + "body", + "conversationId" + ], + "members":{ + "body":{"shape":"ResponseStream"}, + "conversationId":{ + "shape":"ConversationId", + "documentation":"The ID of the conversation, in UUID format. This ID uniquely identifies the conversation within IoT SiteWise.
", + "location":"header", + "locationName":"x-amz-iotsitewise-assistant-conversation-id" + } + }, + "payload":"body" + }, "IotCoreThingName":{ "type":"string", "max":128, @@ -6683,6 +7170,24 @@ }, "documentation":"Contains the job summary information.
" }, + "KendraSourceDetail":{ + "type":"structure", + "required":[ + "knowledgeBaseArn", + "roleArn" + ], + "members":{ + "knowledgeBaseArn":{ + "shape":"ARN", + "documentation":"The knowledgeBaseArn details for the Kendra dataset source.
The roleARN details for the Kendra dataset source.
The source details for the Kendra dataset source.
" + }, "KmsKeyId":{ "type":"string", "max":2048, @@ -6726,7 +7231,7 @@ "locationName":"resourceId" }, "iamArn":{ - "shape":"ARN", + "shape":"IamArn", "documentation":"The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.
The type of data source for the dataset.
", + "location":"querystring", + "locationName":"sourceType" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results, or null if there are no additional results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return for each paginated request.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDatasetsResponse":{ + "type":"structure", + "required":["datasetSummaries"], + "members":{ + "datasetSummaries":{ + "shape":"DatasetSummaries", + "documentation":"A list that summarizes the dataset response.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results, or null if there are no additional results.
" + } + } + }, "ListGatewaysRequest":{ "type":"structure", "members":{ @@ -7494,6 +8037,16 @@ "DISASSOCIATED" ] }, + "Location":{ + "type":"structure", + "members":{ + "uri":{ + "shape":"String", + "documentation":"The URI of the location.
" + } + }, + "documentation":"Contains location information about the cited text and where it's stored.
" + }, "LoggingLevel":{ "type":"string", "enum":[ @@ -7549,6 +8102,12 @@ }, "documentation":"The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
" }, + "MessageInput":{ + "type":"string", + "max":10000, + "min":1, + "sensitive":true + }, "Metric":{ "type":"structure", "required":[ @@ -7695,6 +8254,7 @@ "type":"string", "enum":[ "CREATING", + "PENDING", "UPDATING", "DELETING", "ACTIVE", @@ -7754,13 +8314,48 @@ "documentation":"The date the portal was last updated, in Unix epoch time.
" }, "roleArn":{ - "shape":"ARN", + "shape":"IamArn", "documentation":"The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
" }, - "status":{"shape":"PortalStatus"} + "status":{"shape":"PortalStatus"}, + "portalType":{ + "shape":"PortalType", + "documentation":"Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
Contains a portal summary.
" }, + "PortalTools":{ + "type":"list", + "member":{"shape":"Name"} + }, + "PortalType":{ + "type":"string", + "enum":[ + "SITEWISE_PORTAL_V1", + "SITEWISE_PORTAL_V2" + ] + }, + "PortalTypeConfiguration":{ + "type":"map", + "key":{"shape":"PortalTypeKey"}, + "value":{"shape":"PortalTypeEntry"} + }, + "PortalTypeEntry":{ + "type":"structure", + "members":{ + "portalTools":{ + "shape":"PortalTools", + "documentation":"The array of tools associated with the specified portal type. The possible values are ASSISTANT and DASHBOARD.
The configuration entry associated with the specific portal type. The portalTypeConfiguration is a map of the portalTypeKey to the PortalTypeEntry.
The query timed out.
", "error":{"httpStatusCode":400}, "exception":true }, + "Reference":{ + "type":"structure", + "members":{ + "dataset":{ + "shape":"DataSetReference", + "documentation":"Contains the dataset reference information.
" + } + }, + "documentation":"Contains the reference information.
" + }, "Resolution":{ "type":"string", "max":3, @@ -8179,6 +8785,40 @@ "PROJECT" ] }, + "ResponseStream":{ + "type":"structure", + "members":{ + "trace":{ + "shape":"Trace", + "documentation":"Contains tracing information of the SiteWise Assistant's reasoning and data access.
" + }, + "output":{ + "shape":"InvocationOutput", + "documentation":"Contains the SiteWise Assistant's response.
" + }, + "accessDeniedException":{"shape":"AccessDeniedException"}, + "conflictingOperationException":{"shape":"ConflictingOperationException"}, + "internalFailureException":{"shape":"InternalFailureException"}, + "invalidRequestException":{"shape":"InvalidRequestException"}, + "limitExceededException":{"shape":"LimitExceededException"}, + "resourceNotFoundException":{"shape":"ResourceNotFoundException"}, + "throttlingException":{"shape":"ThrottlingException"} + }, + "documentation":"Contains the response, citation, and trace from the SiteWise Assistant.
", + "eventstream":true + }, + "RestrictedDescription":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^[a-zA-Z0-9 _\\-#$*!@]+$" + }, + "RestrictedName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9 _\\-#$*!@]+$" + }, "RetentionPeriod":{ "type":"structure", "members":{ @@ -8251,6 +8891,30 @@ }, "documentation":"Contains details for a SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.
" }, + "Source":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"String", + "documentation":"Contains the ARN of the dataset. If the source is Kendra, it's the ARN of the Kendra index.
" + }, + "location":{ + "shape":"Location", + "documentation":"Contains the location information where the cited text is originally stored. For example, if the data source is Kendra, and the text synchronized is from an S3 bucket, then the location refers to an S3 object.
" + } + }, + "documentation":"The data source for the dataset.
" + }, + "SourceDetail":{ + "type":"structure", + "members":{ + "kendra":{ + "shape":"KendraSourceDetail", + "documentation":"Contains details about the Kendra dataset source.
" + } + }, + "documentation":"The details of the dataset source associated with the dataset.
" + }, "StorageType":{ "type":"string", "enum":[ @@ -8434,6 +9098,17 @@ "error":{"httpStatusCode":400}, "exception":true }, + "Trace":{ + "type":"structure", + "members":{ + "text":{ + "shape":"String", + "documentation":"The cited text from the data source.
" + } + }, + "documentation":"Contains tracing information of the SiteWise Assistant's reasoning and data access.
", + "event":true + }, "Transform":{ "type":"structure", "required":[ @@ -8821,7 +9496,7 @@ }, "dashboardDefinition":{ "shape":"DashboardDefinition", - "documentation":"The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.
" + "documentation":"The new dashboard definition, as specified in a JSON literal.
IoT SiteWise Monitor (Classic) see Create dashboards (CLI)
IoT SiteWise Monitor (AI-aware) see Create dashboards (CLI)
in the IoT SiteWise User Guide
" }, "clientToken":{ "shape":"ClientToken", @@ -8835,6 +9510,56 @@ "members":{ } }, + "UpdateDatasetRequest":{ + "type":"structure", + "required":[ + "datasetId", + "datasetName", + "datasetSource" + ], + "members":{ + "datasetId":{ + "shape":"CustomID", + "documentation":"The ID of the dataset.
", + "location":"uri", + "locationName":"datasetId" + }, + "datasetName":{ + "shape":"RestrictedName", + "documentation":"The name of the dataset.
" + }, + "datasetDescription":{ + "shape":"RestrictedDescription", + "documentation":"A description about the dataset, and its functionality.
" + }, + "datasetSource":{ + "shape":"DatasetSource", + "documentation":"The data source for the dataset.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", + "idempotencyToken":true + } + } + }, + "UpdateDatasetResponse":{ + "type":"structure", + "members":{ + "datasetId":{ + "shape":"CustomID", + "documentation":"The ID of the dataset.
" + }, + "datasetArn":{ + "shape":"ARN", + "documentation":"The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
The status of the dataset. This contains the state and any error messages. State is UPDATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.
NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.
OUT_OF_SYNC – The gateway hasn't received the capability configuration.
SYNC_FAILED – The gateway rejected the capability configuration.
UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.
After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.
The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
" }, "clientToken":{ @@ -8939,6 +9664,14 @@ "alarms":{ "shape":"Alarms", "documentation":"Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
" + }, + "portalType":{ + "shape":"PortalType", + "documentation":"Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
The validation failed for this query.
", "error":{"httpStatusCode":400}, @@ -9083,8 +9816,7 @@ "ENABLED", "DISABLED" ] - }, - "errorMessage":{"type":"string"} + } }, "documentation":"Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.
" } diff --git a/botocore/data/polly/2016-06-10/examples-1.json b/botocore/data/polly/2016-06-10/examples-1.json index 38205dbea2..a0e354e0a2 100644 --- a/botocore/data/polly/2016-06-10/examples-1.json +++ b/botocore/data/polly/2016-06-10/examples-1.json @@ -123,7 +123,7 @@ "PutLexicon": [ { "input": { - "Content": "file://example.pls", + "Content": "Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.
Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.
For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
Call DeleteKnowledgeBase.
Call DeleteDataIntegration.
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.
Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.
Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.
Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
", "idempotent":true }, + "DeactivateMessageTemplate":{ + "name":"DeactivateMessageTemplate", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/messageTemplates/{messageTemplateId}/deactivate", + "responseCode":200 + }, + "input":{"shape":"DeactivateMessageTemplateRequest"}, + "output":{"shape":"DeactivateMessageTemplateResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.
Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.
Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.
Retrieves information about the knowledge base.
" }, + "GetMessageTemplate":{ + "name":"GetMessageTemplate", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/messageTemplates/{messageTemplateId}", + "responseCode":200 + }, + "input":{"shape":"GetMessageTemplateRequest"}, + "output":{"shape":"GetMessageTemplateResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.
Lists the knowledge bases.
" }, + "ListMessageTemplateVersions":{ + "name":"ListMessageTemplateVersions", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/messageTemplates/{messageTemplateId}/versions", + "responseCode":200 + }, + "input":{"shape":"ListMessageTemplateVersionsRequest"}, + "output":{"shape":"ListMessageTemplateVersionsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists all the available versions for the specified Amazon Q in Connect message template.
" + }, + "ListMessageTemplates":{ + "name":"ListMessageTemplates", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/messageTemplates", + "responseCode":200 + }, + "input":{"shape":"ListMessageTemplatesRequest"}, + "output":{"shape":"ListMessageTemplatesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
" + }, "ListQuickResponses":{ "name":"ListQuickResponses", "http":{ @@ -893,6 +1077,23 @@ ], "documentation":"Removes a URI template from a knowledge base.
" }, + "RenderMessageTemplate":{ + "name":"RenderMessageTemplate", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/messageTemplates/{messageTemplateId}/render", + "responseCode":200 + }, + "input":{"shape":"RenderMessageTemplateRequest"}, + "output":{"shape":"RenderMessageTemplateResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.
" + }, "SearchContent":{ "name":"SearchContent", "http":{ @@ -909,6 +1110,23 @@ ], "documentation":"Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
" }, + "SearchMessageTemplates":{ + "name":"SearchMessageTemplates", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/search/messageTemplates", + "responseCode":200 + }, + "input":{"shape":"SearchMessageTemplatesRequest"}, + "output":{"shape":"SearchMessageTemplatesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Searches for Amazon Q in Connect message templates in the specified knowledge base.
" + }, "SearchQuickResponses":{ "name":"SearchQuickResponses", "http":{ @@ -1096,6 +1314,42 @@ ], "documentation":"Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.
Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.
Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "messageTemplateId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", + "location":"uri", + "locationName":"messageTemplateId" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the message template version to activate.
" + } + } + }, + "ActivateMessageTemplateResponse":{ + "type":"structure", + "required":[ + "messageTemplateArn", + "messageTemplateId", + "versionNumber" + ], + "members":{ + "messageTemplateArn":{ + "shape":"ArnWithQualifier", + "documentation":"The Amazon Resource Name (ARN) of the message template.
" + }, + "messageTemplateId":{ + "shape":"Uuid", + "documentation":"The identifier of the message template.
" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the message template version that is activated.
" + } + } + }, + "AgentAttributes":{ + "type":"structure", + "members":{ + "firstName":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The agent’s first name as entered in their Amazon Connect user account.
" + }, + "lastName":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The agent’s last name as entered in their Amazon Connect user account.
" + } + }, + "documentation":"Information about an agent.
" + }, "AmazonConnectGuideAssociationData":{ "type":"structure", "members":{ @@ -1632,6 +1948,10 @@ "type":"string", "pattern":"^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$" }, + "ArnWithQualifier":{ + "type":"string", + "pattern":"^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$" + }, "AssistantAssociationData":{ "type":"structure", "required":[ @@ -1939,6 +2259,13 @@ "type":"string", "enum":["KNOWLEDGE_BASE"] }, + "AttachmentFileName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[\\p{L}\\p{M}\\p{N}_\\s&@()+,;=\\-]+\\.[A-Za-z0-9]+$", + "sensitive":true + }, "BedrockFoundationModelConfigurationForParsing":{ "type":"structure", "required":["modelArn"], @@ -1970,6 +2297,13 @@ "min":1, "sensitive":true }, + "ChannelSubtype":{ + "type":"string", + "enum":[ + "EMAIL", + "SMS" + ] + }, "Channels":{ "type":"list", "member":{"shape":"Channel"} @@ -2289,6 +2623,10 @@ }, "documentation":"Details about the content data.
" }, + "ContentDisposition":{ + "type":"string", + "enum":["ATTACHMENT"] + }, "ContentFeedbackData":{ "type":"structure", "members":{ @@ -2442,7 +2780,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"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.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
", "idempotencyToken":true }, "configuration":{ @@ -2501,7 +2839,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"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.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
", "idempotencyToken":true }, "modifiedTime":{ @@ -2548,7 +2886,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"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.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
", "idempotencyToken":true }, "description":{ @@ -2615,7 +2953,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"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.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
", "idempotencyToken":true }, "modifiedTime":{ @@ -2661,7 +2999,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken":true }, "tags":{ @@ -2688,7 +3026,7 @@ "members":{ "clientToken":{ "shape":"ClientToken", - "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken":true }, "description":{ @@ -2741,7 +3079,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken":true }, "contentId":{ @@ -2781,7 +3119,7 @@ "members":{ "clientToken":{ "shape":"NonEmptyString", - "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken":true }, "knowledgeBaseId":{ @@ -2834,7 +3172,7 @@ "members":{ "clientToken":{ "shape":"NonEmptyString", - "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken":true }, "description":{ @@ -2859,7 +3197,7 @@ }, "sourceConfiguration":{ "shape":"SourceConfiguration", - "documentation":"The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
" + "documentation":"The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
" }, "tags":{ "shape":"Tags", @@ -2880,42 +3218,27 @@ } } }, - "CreateQuickResponseRequest":{ + "CreateMessageTemplateAttachmentRequest":{ "type":"structure", "required":[ - "content", + "body", + "contentDisposition", "knowledgeBaseId", + "messageTemplateId", "name" ], "members":{ - "channels":{ - "shape":"Channels", - "documentation":"The Amazon Connect channels this quick response applies to.
" + "body":{ + "shape":"NonEmptyUnlimitedString", + "documentation":"The body of the attachment file being uploaded. It should be encoded using base64 encoding.
" }, "clientToken":{ - "shape":"NonEmptyString", - "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", - "idempotencyToken":true - }, - "content":{ - "shape":"QuickResponseDataProvider", - "documentation":"The content of the quick response.
" - }, - "contentType":{ - "shape":"QuickResponseType", - "documentation":"The media type of the quick response content.
Use application/x.quickresponse;format=plain for a quick response written in plain text.
Use application/x.quickresponse;format=markdown for a quick response written in richtext.
The description of the quick response.
" - }, - "groupingConfiguration":{ - "shape":"GroupingConfiguration", - "documentation":"The configuration information of the user groups that the quick response is accessible to.
" + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
" }, - "isActive":{ - "shape":"Boolean", - "documentation":"Whether the quick response is active.
" + "contentDisposition":{ + "shape":"ContentDisposition", + "documentation":"The presentation information for the attachment file.
" }, "knowledgeBaseId":{ "shape":"UuidOrArn", @@ -2923,13 +3246,171 @@ "location":"uri", "locationName":"knowledgeBaseId" }, - "language":{ - "shape":"LanguageCode", - "documentation":"The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", + "location":"uri", + "locationName":"messageTemplateId" }, "name":{ - "shape":"QuickResponseName", - "documentation":"The name of the quick response.
" + "shape":"AttachmentFileName", + "documentation":"The name of the attachment file being uploaded. The name should include the file extension.
" + } + } + }, + "CreateMessageTemplateAttachmentResponse":{ + "type":"structure", + "members":{ + "attachment":{ + "shape":"MessageTemplateAttachment", + "documentation":"The message template attachment.
" + } + } + }, + "CreateMessageTemplateRequest":{ + "type":"structure", + "required":[ + "channelSubtype", + "content", + "knowledgeBaseId", + "name" + ], + "members":{ + "channelSubtype":{ + "shape":"ChannelSubtype", + "documentation":"The channel subtype this message template applies to.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "content":{ + "shape":"MessageTemplateContentProvider", + "documentation":"The content of the message template.
" + }, + "defaultAttributes":{ + "shape":"MessageTemplateAttributes", + "documentation":"An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the message template.
" + }, + "groupingConfiguration":{"shape":"GroupingConfiguration"}, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
The name of the message template.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + } + }, + "CreateMessageTemplateResponse":{ + "type":"structure", + "members":{ + "messageTemplate":{ + "shape":"MessageTemplateData", + "documentation":"The message template.
" + } + } + }, + "CreateMessageTemplateVersionRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "messageTemplateId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "messageTemplateContentSha256":{ + "shape":"MessageTemplateContentSha256", + "documentation":"The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the $LATEST qualifier by default.
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", + "location":"uri", + "locationName":"messageTemplateId" + } + } + }, + "CreateMessageTemplateVersionResponse":{ + "type":"structure", + "members":{ + "messageTemplate":{ + "shape":"ExtendedMessageTemplateData", + "documentation":"The message template.
" + } + } + }, + "CreateQuickResponseRequest":{ + "type":"structure", + "required":[ + "content", + "knowledgeBaseId", + "name" + ], + "members":{ + "channels":{ + "shape":"Channels", + "documentation":"The Amazon Connect channels this quick response applies to.
" + }, + "clientToken":{ + "shape":"NonEmptyString", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "content":{ + "shape":"QuickResponseDataProvider", + "documentation":"The content of the quick response.
" + }, + "contentType":{ + "shape":"QuickResponseType", + "documentation":"The media type of the quick response content.
Use application/x.quickresponse;format=plain for a quick response written in plain text.
Use application/x.quickresponse;format=markdown for a quick response written in richtext.
The description of the quick response.
" + }, + "groupingConfiguration":{ + "shape":"GroupingConfiguration", + "documentation":"The configuration information of the user groups that the quick response is accessible to.
" + }, + "isActive":{ + "shape":"Boolean", + "documentation":"Whether the quick response is active.
" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
The name of the quick response.
" }, "shortcutKey":{ "shape":"ShortCutKey", @@ -2969,7 +3450,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken":true }, "description":{ @@ -2999,6 +3480,250 @@ } } }, + "CustomAttributes":{ + "type":"map", + "key":{"shape":"MessageTemplateAttributeKey"}, + "value":{"shape":"MessageTemplateAttributeValue"}, + "sensitive":true + }, + "CustomerProfileAttributes":{ + "type":"structure", + "members":{ + "accountNumber":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"A unique account number that you have given to the customer.
" + }, + "additionalInformation":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"Any additional information relevant to the customer's profile.
" + }, + "address1":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The first line of a customer address.
" + }, + "address2":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The second line of a customer address.
" + }, + "address3":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The third line of a customer address.
" + }, + "address4":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The fourth line of a customer address.
" + }, + "billingAddress1":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The first line of a customer’s billing address.
" + }, + "billingAddress2":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The second line of a customer’s billing address.
" + }, + "billingAddress3":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The third line of a customer’s billing address.
" + }, + "billingAddress4":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The fourth line of a customer’s billing address.
" + }, + "billingCity":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The city of a customer’s billing address.
" + }, + "billingCountry":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The country of a customer’s billing address.
" + }, + "billingCounty":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The county of a customer’s billing address.
" + }, + "billingPostalCode":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The postal code of a customer’s billing address.
" + }, + "billingProvince":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The province of a customer’s billing address.
" + }, + "billingState":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The state of a customer’s billing address.
" + }, + "birthDate":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's birth date.
" + }, + "businessEmailAddress":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's business email address.
" + }, + "businessName":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The name of the customer's business.
" + }, + "businessPhoneNumber":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's business phone number.
" + }, + "city":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The city in which a customer lives.
" + }, + "country":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The country in which a customer lives.
" + }, + "county":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The county in which a customer lives.
" + }, + "custom":{ + "shape":"CustomAttributes", + "documentation":"The custom attributes in customer profile attributes.
" + }, + "emailAddress":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's email address, which has not been specified as a personal or business address.
" + }, + "firstName":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's first name.
" + }, + "gender":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's gender.
" + }, + "homePhoneNumber":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's mobile phone number.
" + }, + "lastName":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's last name.
" + }, + "mailingAddress1":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The first line of a customer’s mailing address.
" + }, + "mailingAddress2":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The second line of a customer’s mailing address.
" + }, + "mailingAddress3":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The third line of a customer’s mailing address.
" + }, + "mailingAddress4":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The fourth line of a customer’s mailing address.
" + }, + "mailingCity":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The city of a customer’s mailing address.
" + }, + "mailingCountry":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The country of a customer’s mailing address.
" + }, + "mailingCounty":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The county of a customer’s mailing address.
" + }, + "mailingPostalCode":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The postal code of a customer’s mailing address.
" + }, + "mailingProvince":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The province of a customer’s mailing address.
" + }, + "mailingState":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The state of a customer’s mailing address.
" + }, + "middleName":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's middle name.
" + }, + "mobilePhoneNumber":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's mobile phone number.
" + }, + "partyType":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's party type.
" + }, + "phoneNumber":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's phone number, which has not been specified as a mobile, home, or business number.
" + }, + "postalCode":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The postal code of a customer address.
" + }, + "profileARN":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The ARN of a customer profile.
" + }, + "profileId":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The unique identifier of a customer profile.
" + }, + "province":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The province in which a customer lives.
" + }, + "shippingAddress1":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The first line of a customer’s shipping address.
" + }, + "shippingAddress2":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The second line of a customer’s shipping address.
" + }, + "shippingAddress3":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The third line of a customer’s shipping address.
" + }, + "shippingAddress4":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The fourth line of a customer’s shipping address.
" + }, + "shippingCity":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The city of a customer’s shipping address.
" + }, + "shippingCountry":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The country of a customer’s shipping address.
" + }, + "shippingCounty":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The county of a customer’s shipping address.
" + }, + "shippingPostalCode":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The postal code of a customer’s shipping address.
" + }, + "shippingProvince":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The province of a customer’s shipping address.
" + }, + "shippingState":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The state of a customer’s shipping address.
" + }, + "state":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The state in which a customer lives.
" + } + }, + "documentation":"The customer profile attributes that are used with the message template.
" + }, "DataDetails":{ "type":"structure", "members":{ @@ -3056,6 +3781,54 @@ "type":"list", "member":{"shape":"DataSummary"} }, + "DeactivateMessageTemplateRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "messageTemplateId", + "versionNumber" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "messageTemplateId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", + "location":"uri", + "locationName":"messageTemplateId" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the message template version to deactivate.
" + } + } + }, + "DeactivateMessageTemplateResponse":{ + "type":"structure", + "required":[ + "messageTemplateArn", + "messageTemplateId", + "versionNumber" + ], + "members":{ + "messageTemplateArn":{ + "shape":"ArnWithQualifier", + "documentation":"The Amazon Resource Name (ARN) of the message template.
" + }, + "messageTemplateId":{ + "shape":"Uuid", + "documentation":"The identifier of the message template.
" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the message template version that has been deactivated.
" + } + } + }, "DeleteAIAgentRequest":{ "type":"structure", "required":[ @@ -3319,51 +4092,110 @@ "members":{ } }, - "DeleteQuickResponseRequest":{ + "DeleteMessageTemplateAttachmentRequest":{ "type":"structure", "required":[ + "attachmentId", "knowledgeBaseId", - "quickResponseId" + "messageTemplateId" ], "members":{ + "attachmentId":{ + "shape":"Uuid", + "documentation":"The identifier of the attachment file.
", + "location":"uri", + "locationName":"attachmentId" + }, "knowledgeBaseId":{ "shape":"UuidOrArn", - "documentation":"The knowledge base from which the quick response is deleted. The identifier of the knowledge base.
", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, - "quickResponseId":{ - "shape":"UuidOrArn", - "documentation":"The identifier of the quick response to delete.
", + "messageTemplateId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "location":"uri", - "locationName":"quickResponseId" + "locationName":"messageTemplateId" } } }, - "DeleteQuickResponseResponse":{ + "DeleteMessageTemplateAttachmentResponse":{ "type":"structure", "members":{ } }, - "Description":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[a-zA-Z0-9\\s_.,-]+" - }, - "Document":{ + "DeleteMessageTemplateRequest":{ "type":"structure", - "required":["contentReference"], + "required":[ + "knowledgeBaseId", + "messageTemplateId" + ], "members":{ - "contentReference":{ - "shape":"ContentReference", - "documentation":"A reference to the content resource.
" - }, - "excerpt":{ - "shape":"DocumentText", - "documentation":"The excerpt from the document.
" + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" }, - "title":{ + "messageTemplateId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the message template. Can be either the ID or the ARN.
", + "location":"uri", + "locationName":"messageTemplateId" + } + } + }, + "DeleteMessageTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteQuickResponseRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "quickResponseId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The knowledge base from which the quick response is deleted. The identifier of the knowledge base.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "quickResponseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the quick response to delete.
", + "location":"uri", + "locationName":"quickResponseId" + } + } + }, + "DeleteQuickResponseResponse":{ + "type":"structure", + "members":{ + } + }, + "Description":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\s_.,-]+" + }, + "Document":{ + "type":"structure", + "required":["contentReference"], + "members":{ + "contentReference":{ + "shape":"ContentReference", + "documentation":"A reference to the content resource.
" + }, + "excerpt":{ + "shape":"DocumentText", + "documentation":"The excerpt from the document.
" + }, + "title":{ "shape":"DocumentText", "documentation":"The title of the document.
" } @@ -3384,6 +4216,167 @@ }, "documentation":"The text of the document.
" }, + "EmailHeader":{ + "type":"structure", + "members":{ + "name":{ + "shape":"EmailHeaderKey", + "documentation":"The name of the email header.
" + }, + "value":{ + "shape":"EmailHeaderValue", + "documentation":"The value of the email header.
" + } + }, + "documentation":"The email header to include in email messages.
" + }, + "EmailHeaderKey":{ + "type":"string", + "max":126, + "min":1, + "pattern":"^[!-9;-@A-~]+$" + }, + "EmailHeaderValue":{ + "type":"string", + "max":870, + "min":1, + "pattern":"[ -~]*", + "sensitive":true + }, + "EmailHeaders":{ + "type":"list", + "member":{"shape":"EmailHeader"}, + "max":15, + "min":0 + }, + "EmailMessageTemplateContent":{ + "type":"structure", + "members":{ + "body":{ + "shape":"EmailMessageTemplateContentBody", + "documentation":"The body to use in email messages.
" + }, + "headers":{ + "shape":"EmailHeaders", + "documentation":"The email headers to include in email messages.
" + }, + "subject":{ + "shape":"NonEmptyUnlimitedString", + "documentation":"The subject line, or title, to use in email messages.
" + } + }, + "documentation":"The content of the message template that applies to the email channel subtype.
" + }, + "EmailMessageTemplateContentBody":{ + "type":"structure", + "members":{ + "html":{ + "shape":"MessageTemplateBodyContentProvider", + "documentation":"The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
" + }, + "plainText":{ + "shape":"MessageTemplateBodyContentProvider", + "documentation":"The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
" + } + }, + "documentation":"The body to use in email messages.
" + }, + "ExtendedMessageTemplateData":{ + "type":"structure", + "required":[ + "channelSubtype", + "content", + "createdTime", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedBy", + "lastModifiedTime", + "messageTemplateArn", + "messageTemplateContentSha256", + "messageTemplateId", + "name" + ], + "members":{ + "attachments":{ + "shape":"MessageTemplateAttachmentList", + "documentation":"The message template attachments.
" + }, + "attributeTypes":{ + "shape":"MessageTemplateAttributeTypeList", + "documentation":"The types of attributes contain the message template.
" + }, + "channelSubtype":{ + "shape":"ChannelSubtype", + "documentation":"The channel subtype this message template applies to.
" + }, + "content":{ + "shape":"MessageTemplateContentProvider", + "documentation":"The content of the message template.
" + }, + "createdTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp when the message template was created.
" + }, + "defaultAttributes":{ + "shape":"MessageTemplateAttributes", + "documentation":"An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the message template.
" + }, + "groupingConfiguration":{"shape":"GroupingConfiguration"}, + "isActive":{ + "shape":"Boolean", + "documentation":"Whether the version of the message template is activated.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base.
" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
The Amazon Resource Name (ARN) of the user who last updated the message template data.
" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp when the message template data was last modified.
" + }, + "messageTemplateArn":{ + "shape":"ArnWithQualifier", + "documentation":"The Amazon Resource Name (ARN) of the message template.
" + }, + "messageTemplateContentSha256":{ + "shape":"MessageTemplateContentSha256", + "documentation":"The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.
The identifier of the message template.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the message template.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the message template version.
" + } + }, + "documentation":"The extended data of a message template.
" + }, "ExternalSource":{ "type":"string", "enum":["AMAZON_CONNECT"] @@ -3795,6 +4788,36 @@ } } }, + "GetMessageTemplateRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "messageTemplateId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "messageTemplateId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the message template. Can be either the ID or the ARN.
", + "location":"uri", + "locationName":"messageTemplateId" + } + } + }, + "GetMessageTemplateResponse":{ + "type":"structure", + "members":{ + "messageTemplate":{ + "shape":"ExtendedMessageTemplateData", + "documentation":"The message template.
" + } + } + }, "GetQuickResponseRequest":{ "type":"structure", "required":[ @@ -4782,6 +5805,91 @@ } } }, + "ListMessageTemplateVersionsRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "messageTemplateId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "messageTemplateId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", + "location":"uri", + "locationName":"messageTemplateId" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListMessageTemplateVersionsResponse":{ + "type":"structure", + "required":["messageTemplateVersionSummaries"], + "members":{ + "messageTemplateVersionSummaries":{ + "shape":"MessageTemplateVersionSummaryList", + "documentation":"Summary information about the versions of a message template.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + } + } + }, + "ListMessageTemplatesRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListMessageTemplatesResponse":{ + "type":"structure", + "required":["messageTemplateSummaries"], + "members":{ + "messageTemplateSummaries":{ + "shape":"MessageTemplateSummaryList", + "documentation":"Summary information about the message template.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + } + } + }, "ListQuickResponsesRequest":{ "type":"structure", "required":["knowledgeBaseId"], @@ -4839,43 +5947,589 @@ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } - } + } + }, + "LlmModelId":{ + "type":"string", + "max":128, + "min":1 + }, + "ManagedSourceConfiguration":{ + "type":"structure", + "members":{ + "webCrawlerConfiguration":{ + "shape":"WebCrawlerConfiguration", + "documentation":"Configuration data for web crawler data source.
" + } + }, + "documentation":"Source configuration for managed resources.
", + "union":true + }, + "ManualSearchAIAgentConfiguration":{ + "type":"structure", + "members":{ + "answerGenerationAIPromptId":{ + "shape":"UuidWithQualifier", + "documentation":"The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
" + }, + "associationConfigurations":{ + "shape":"AssociationConfigurationList", + "documentation":"The association configurations for overriding behavior on this AI Agent.
" + } + }, + "documentation":"The configuration for the MANUAL_SEARCH AI Agent type.
The identifier of the attachment file.
" + }, + "contentDisposition":{ + "shape":"ContentDisposition", + "documentation":"The presentation information for the attachment file.
" + }, + "name":{ + "shape":"AttachmentFileName", + "documentation":"The name of the attachment file being uploaded. The name should include the file extension.
" + }, + "uploadedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp when the attachment file was uploaded.
" + }, + "url":{ + "shape":"Url", + "documentation":"A pre-signed Amazon S3 URL that can be used to download the attachment file.
" + }, + "urlExpiry":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The expiration time of the pre-signed Amazon S3 URL.
" + } + }, + "documentation":"Information about the message template attachment.
" + }, + "MessageTemplateAttachmentList":{ + "type":"list", + "member":{"shape":"MessageTemplateAttachment"} + }, + "MessageTemplateAttributeKey":{ + "type":"string", + "max":32767, + "min":1 + }, + "MessageTemplateAttributeKeyList":{ + "type":"list", + "member":{"shape":"MessageTemplateAttributeKey"}, + "sensitive":true + }, + "MessageTemplateAttributeType":{ + "type":"string", + "enum":[ + "SYSTEM", + "AGENT", + "CUSTOMER_PROFILE", + "CUSTOM" + ] + }, + "MessageTemplateAttributeTypeList":{ + "type":"list", + "member":{"shape":"MessageTemplateAttributeType"} + }, + "MessageTemplateAttributeValue":{ + "type":"string", + "max":32767, + "min":1, + "sensitive":true + }, + "MessageTemplateAttributes":{ + "type":"structure", + "members":{ + "agentAttributes":{ + "shape":"AgentAttributes", + "documentation":"The agent attributes that are used with the message template.
" + }, + "customAttributes":{ + "shape":"CustomAttributes", + "documentation":"The custom attributes that are used with the message template.
" + }, + "customerProfileAttributes":{ + "shape":"CustomerProfileAttributes", + "documentation":"The customer profile attributes that are used with the message template.
" + }, + "systemAttributes":{ + "shape":"SystemAttributes", + "documentation":"The system attributes that are used with the message template.
" + } + }, + "documentation":"The attributes that are used with the message template.
" + }, + "MessageTemplateBodyContentProvider":{ + "type":"structure", + "members":{ + "content":{ + "shape":"NonEmptyUnlimitedString", + "documentation":"The content of the message template.
" + } + }, + "documentation":"The container of the message template body.
", + "union":true + }, + "MessageTemplateContentProvider":{ + "type":"structure", + "members":{ + "email":{ + "shape":"EmailMessageTemplateContent", + "documentation":"The content of the message template that applies to the email channel subtype.
" + }, + "sms":{ + "shape":"SMSMessageTemplateContent", + "documentation":"The content of the message template that applies to the SMS channel subtype.
" + } + }, + "documentation":"The container of message template content.
", + "union":true + }, + "MessageTemplateContentSha256":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9]+$" + }, + "MessageTemplateData":{ + "type":"structure", + "required":[ + "channelSubtype", + "content", + "createdTime", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedBy", + "lastModifiedTime", + "messageTemplateArn", + "messageTemplateContentSha256", + "messageTemplateId", + "name" + ], + "members":{ + "attributeTypes":{ + "shape":"MessageTemplateAttributeTypeList", + "documentation":"The types of attributes that the message template contains.
" + }, + "channelSubtype":{ + "shape":"ChannelSubtype", + "documentation":"The channel subtype this message template applies to.
" + }, + "content":{ + "shape":"MessageTemplateContentProvider", + "documentation":"The content of the message template.
" + }, + "createdTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp when the message template was created.
" + }, + "defaultAttributes":{ + "shape":"MessageTemplateAttributes", + "documentation":"An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the message template.
" + }, + "groupingConfiguration":{"shape":"GroupingConfiguration"}, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base.
" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
The Amazon Resource Name (ARN) of the user who last updated the message template data.
" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp when the message template data was last modified.
" + }, + "messageTemplateArn":{ + "shape":"ArnWithQualifier", + "documentation":"The Amazon Resource Name (ARN) of the message template.
" + }, + "messageTemplateContentSha256":{ + "shape":"MessageTemplateContentSha256", + "documentation":"The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.
The identifier of the message template.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the message template.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + }, + "documentation":"The data of a message template.
" + }, + "MessageTemplateFilterField":{ + "type":"structure", + "required":[ + "name", + "operator" + ], + "members":{ + "includeNoExistence":{ + "shape":"Boolean", + "documentation":"Whether to treat null value as a match for the attribute field.
" + }, + "name":{ + "shape":"NonEmptyString", + "documentation":"The name of the attribute field to filter the message templates by.
" + }, + "operator":{ + "shape":"MessageTemplateFilterOperator", + "documentation":"The operator to use for filtering.
" + }, + "values":{ + "shape":"MessageTemplateFilterValueList", + "documentation":"The values of attribute field to filter the message template by.
" + } + }, + "documentation":"The message template fields to filter the message template query results by. The following is the list of supported field names:
name
description
channel
channelSubtype
language
qualifier
createdTime
lastModifiedTime
lastModifiedBy
groupingConfiguration.criteria
groupingConfiguration.values
The name of the message template.
" + }, + "order":{ + "shape":"Order", + "documentation":"The order at which the message templates are sorted by.
" + } + }, + "documentation":"The message template fields to order the message template query results by. The following is the list of supported field names:
name
description
channel
channelSubtype
language
qualifier
createdTime
lastModifiedTime
lastModifiedBy
groupingConfiguration.criteria
groupingConfiguration.values
Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
" + }, + "name":{ + "shape":"NonEmptyString", + "documentation":"The name of the attribute to query the message templates by.
" + }, + "operator":{ + "shape":"MessageTemplateQueryOperator", + "documentation":"The operator to use for matching attribute field values in the query.
" + }, + "priority":{ + "shape":"Priority", + "documentation":"The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
" + }, + "values":{ + "shape":"MessageTemplateQueryValueList", + "documentation":"The values of the attribute to query the message templates by.
" + } + }, + "documentation":"The message template fields to query message templates by. The following is the list of supported field names:
name
description
The configuration of filtering rules applied to message template query results.
" + }, + "orderOnField":{ + "shape":"MessageTemplateOrderField", + "documentation":"The message template attribute fields on which the query results are ordered.
" + }, + "queries":{ + "shape":"MessageTemplateQueryFieldList", + "documentation":"The message template query expressions.
" + } + }, + "documentation":"The search expression of the message template.
" + }, + "MessageTemplateSearchResultData":{ + "type":"structure", + "required":[ + "channelSubtype", + "createdTime", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedBy", + "lastModifiedTime", + "messageTemplateArn", + "messageTemplateId", + "name" + ], + "members":{ + "channelSubtype":{ + "shape":"ChannelSubtype", + "documentation":"The channel subtype this message template applies to.
" + }, + "createdTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp when the message template was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the message template.
" + }, + "groupingConfiguration":{"shape":"GroupingConfiguration"}, + "isActive":{ + "shape":"Boolean", + "documentation":"Whether the version of the message template is activated.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base.
" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
The Amazon Resource Name (ARN) of the user who last updated the message template data.
" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp when the message template data was last modified.
" + }, + "messageTemplateArn":{ + "shape":"ArnWithQualifier", + "documentation":"The Amazon Resource Name (ARN) of the message template.
" + }, + "messageTemplateId":{ + "shape":"Uuid", + "documentation":"The identifier of the message template.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the message template.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the message template version.
" + } + }, + "documentation":"The result of message template search.
" }, - "LlmModelId":{ - "type":"string", - "max":128, - "min":1 + "MessageTemplateSearchResultsList":{ + "type":"list", + "member":{"shape":"MessageTemplateSearchResultData"} }, - "ManagedSourceConfiguration":{ + "MessageTemplateSummary":{ "type":"structure", + "required":[ + "channelSubtype", + "createdTime", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedBy", + "lastModifiedTime", + "messageTemplateArn", + "messageTemplateId", + "name" + ], "members":{ - "webCrawlerConfiguration":{ - "shape":"WebCrawlerConfiguration", - "documentation":"Configuration data for web crawler data source.
" + "activeVersionNumber":{ + "shape":"Version", + "documentation":"The version number of the message template version that is activated.
" + }, + "channelSubtype":{ + "shape":"ChannelSubtype", + "documentation":"The channel subtype this message template applies to.
" + }, + "createdTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp when the message template was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the message template.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base.
" + }, + "lastModifiedBy":{ + "shape":"GenericArn", + "documentation":"The Amazon Resource Name (ARN) of the user who last updated the message template data.
" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp when the message template data was last modified.
" + }, + "messageTemplateArn":{ + "shape":"ArnWithQualifier", + "documentation":"The Amazon Resource Name (ARN) of the message template.
" + }, + "messageTemplateId":{ + "shape":"Uuid", + "documentation":"The identifier of the message template.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the message template.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" } }, - "documentation":"Source configuration for managed resources.
", - "union":true + "documentation":"The summary of the message template.
" }, - "ManualSearchAIAgentConfiguration":{ + "MessageTemplateSummaryList":{ + "type":"list", + "member":{"shape":"MessageTemplateSummary"} + }, + "MessageTemplateVersionSummary":{ "type":"structure", + "required":[ + "channelSubtype", + "isActive", + "knowledgeBaseArn", + "knowledgeBaseId", + "messageTemplateArn", + "messageTemplateId", + "name", + "versionNumber" + ], "members":{ - "answerGenerationAIPromptId":{ - "shape":"UuidWithQualifier", - "documentation":"The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
" + "channelSubtype":{ + "shape":"ChannelSubtype", + "documentation":"The channel subtype this message template applies to.
" }, - "associationConfigurations":{ - "shape":"AssociationConfigurationList", - "documentation":"The association configurations for overriding behavior on this AI Agent.
" + "isActive":{ + "shape":"Boolean", + "documentation":"Whether the version of the message template is activated.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base.
" + }, + "messageTemplateArn":{ + "shape":"ArnWithQualifier", + "documentation":"The Amazon Resource Name (ARN) of the message template.
" + }, + "messageTemplateId":{ + "shape":"Uuid", + "documentation":"The identifier of the message template.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the message template.
" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the message template version.
" } }, - "documentation":"The configuration for the MANUAL_SEARCH AI Agent type.
The summary of the message template version.
" }, - "MaxResults":{ - "type":"integer", - "box":true, - "max":100, - "min":1 + "MessageTemplateVersionSummaryList":{ + "type":"list", + "member":{"shape":"MessageTemplateVersionSummary"} }, "Name":{ "type":"string", @@ -4899,6 +6553,11 @@ "max":4096, "min":1 }, + "NonEmptyUnlimitedString":{ + "type":"string", + "min":1, + "sensitive":true + }, "NotifyRecommendationsReceivedError":{ "type":"structure", "members":{ @@ -5345,7 +7004,7 @@ }, "language":{ "shape":"LanguageCode", - "documentation":"The language code value for the language in which the quick response is written.
" + "documentation":"The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
An object that specifies the values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the value for that variable.
" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "messageTemplateId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the message template. Can be either the ID or the ARN.
", + "location":"uri", + "locationName":"messageTemplateId" + } + } + }, + "RenderMessageTemplateResponse":{ + "type":"structure", + "required":["content"], + "members":{ + "attachments":{ + "shape":"MessageTemplateAttachmentList", + "documentation":"The message template attachments.
" + }, + "attributesNotInterpolated":{ + "shape":"MessageTemplateAttributeKeyList", + "documentation":"The attribute keys that are not resolved.
" + }, + "content":{ + "shape":"MessageTemplateContentProvider", + "documentation":"The content of the message template.
" + } + } + }, "RenderingConfiguration":{ "type":"structure", "members":{ @@ -6040,6 +7743,26 @@ "documentation":"A union type that specifies the data stored on the session.
", "union":true }, + "SMSMessageTemplateContent":{ + "type":"structure", + "members":{ + "body":{ + "shape":"SMSMessageTemplateContentBody", + "documentation":"The body to use in SMS messages.
" + } + }, + "documentation":"The content of the message template that applies to the SMS channel subtype.
" + }, + "SMSMessageTemplateContentBody":{ + "type":"structure", + "members":{ + "plainText":{ + "shape":"MessageTemplateBodyContentProvider", + "documentation":"The message body to use in SMS messages.
" + } + }, + "documentation":"The body to use in SMS messages.
" + }, "SearchContentRequest":{ "type":"structure", "required":[ @@ -6096,6 +7819,51 @@ }, "documentation":"The search expression.
" }, + "SearchMessageTemplatesRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "searchExpression" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "searchExpression":{ + "shape":"MessageTemplateSearchExpression", + "documentation":"The search expression for querying the message template.
" + } + } + }, + "SearchMessageTemplatesResponse":{ + "type":"structure", + "required":["results"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + }, + "results":{ + "shape":"MessageTemplateSearchResultsList", + "documentation":"The results of the message template search.
" + } + } + }, "SearchQuickResponsesRequest":{ "type":"structure", "required":[ @@ -6534,10 +8302,42 @@ "CREATE_IN_PROGRESS" ] }, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, "SyntheticTimestamp_epoch_seconds":{ "type":"timestamp", "timestampFormat":"unixTimestamp" }, + "SystemAttributes":{ + "type":"structure", + "members":{ + "customerEndpoint":{ + "shape":"SystemEndpointAttributes", + "documentation":"The CustomerEndpoint attribute.
" + }, + "name":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The name of the task.
" + }, + "systemEndpoint":{ + "shape":"SystemEndpointAttributes", + "documentation":"The SystemEndpoint attribute.
" + } + }, + "documentation":"The system attributes that are used with the message template.
" + }, + "SystemEndpointAttributes":{ + "type":"structure", + "members":{ + "address":{ + "shape":"MessageTemplateAttributeValue", + "documentation":"The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
The system endpoint attributes that are used with the message template.
" + }, "TagCondition":{ "type":"structure", "required":["key"], @@ -6735,7 +8535,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"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.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
", "idempotencyToken":true }, "configuration":{ @@ -6783,7 +8583,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"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.
", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
", "idempotencyToken":true }, "description":{ @@ -6921,6 +8721,87 @@ } } }, + "UpdateMessageTemplateMetadataRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "messageTemplateId" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"The description of the message template.
" + }, + "groupingConfiguration":{"shape":"GroupingConfiguration"}, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "messageTemplateId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", + "location":"uri", + "locationName":"messageTemplateId" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the message template.
" + } + } + }, + "UpdateMessageTemplateMetadataResponse":{ + "type":"structure", + "members":{ + "messageTemplate":{ + "shape":"MessageTemplateData", + "documentation":"The message template.
" + } + } + }, + "UpdateMessageTemplateRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "messageTemplateId" + ], + "members":{ + "content":{ + "shape":"MessageTemplateContentProvider", + "documentation":"The content of the message template.
" + }, + "defaultAttributes":{ + "shape":"MessageTemplateAttributes", + "documentation":"An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", + "location":"uri", + "locationName":"messageTemplateId" + } + } + }, + "UpdateMessageTemplateResponse":{ + "type":"structure", + "members":{ + "messageTemplate":{ + "shape":"MessageTemplateData", + "documentation":"The message template.
" + } + } + }, "UpdateQuickResponseRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/rds-data/2018-08-01/service-2.json b/botocore/data/rds-data/2018-08-01/service-2.json index 4d05b202a7..6422aa2c5a 100644 --- a/botocore/data/rds-data/2018-08-01/service-2.json +++ b/botocore/data/rds-data/2018-08-01/service-2.json @@ -26,6 +26,7 @@ {"shape":"SecretsErrorException"}, {"shape":"HttpEndpointNotEnabledException"}, {"shape":"DatabaseErrorException"}, + {"shape":"DatabaseResumingException"}, {"shape":"DatabaseUnavailableException"}, {"shape":"TransactionNotFoundException"}, {"shape":"InvalidSecretException"}, @@ -52,6 +53,7 @@ {"shape":"SecretsErrorException"}, {"shape":"HttpEndpointNotEnabledException"}, {"shape":"DatabaseErrorException"}, + {"shape":"DatabaseResumingException"}, {"shape":"DatabaseUnavailableException"}, {"shape":"TransactionNotFoundException"}, {"shape":"InvalidSecretException"}, @@ -110,7 +112,8 @@ ], "documentation":"Runs one or more SQL statements.
This operation isn't supported for Aurora Serverless v2 and provisioned DB clusters. For Aurora Serverless v1 DB clusters, the operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.
A request was canceled because the Aurora Serverless v2 DB instance was in a paused state. The Data API request automatically causes the DB instance to begin resuming. Wait a few seconds and try again.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "DatabaseUnavailableException":{ "type":"structure", "members":{ diff --git a/botocore/data/rds/2014-10-31/service-2.json b/botocore/data/rds/2014-10-31/service-2.json index 3e1dd2b93c..95d2f7a55a 100644 --- a/botocore/data/rds/2014-10-31/service-2.json +++ b/botocore/data/rds/2014-10-31/service-2.json @@ -1296,7 +1296,8 @@ "resultWrapper":"DescribeDBLogFilesResult" }, "errors":[ - {"shape":"DBInstanceNotFoundFault"} + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBInstanceNotReadyFault"} ], "documentation":"Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
" }, @@ -1794,6 +1795,7 @@ }, "errors":[ {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBInstanceNotReadyFault"}, {"shape":"DBLogFileNotFoundFault"} ], "documentation":"Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
" @@ -4418,7 +4420,7 @@ "members":{ "DBName":{ "shape":"String", - "documentation":"The meaning of this parameter differs according to the database engine you use.
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
Must contain 1 to 64 alphanumeric characters.
Can't be a word reserved by the database engine.
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.
Constraints:
It must contain 1 to 63 alphanumeric characters.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
Can't be a word reserved by the database engine.
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL for non-CDBs and RDSCDB for CDBs.
Default: ORCL
Constraints:
Must contain 1 to 8 alphanumeric characters.
Must contain a letter.
Can't be a word reserved by the database engine.
Not applicable. Must be null.
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. In some cases, we recommend that you don't add a database name. For more information, see Additional considerations in the Amazon RDS User Guide.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine.
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine.
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine.
The Oracle System ID (SID) of the created DB instance. If you don't specify a value, the default value is ORCL. You can't specify the string null, or any other reserved word, for DBName.
Default: ORCL
Constraints:
Can't be longer than 8 characters.
The name of the database to create when the DB instance is created. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine.
Not applicable. Must be null.
The meaning of this parameter differs according to the database engine you use.
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
Must contain 1 to 64 alphanumeric characters.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the database engine.
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.
Constraints:
It must contain 1 to 63 alphanumeric characters.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
Can't be a word reserved by the database engine.
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL for non-CDBs and RDSCDB for CDBs.
Default: ORCL
Constraints:
Must contain 1 to 8 alphanumeric characters.
Must contain a letter.
Can't be a word reserved by the database engine.
Not applicable. Must be null.
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. In some cases, we recommend that you don't add a database name. For more information, see Additional considerations in the Amazon RDS User Guide.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine.
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine.
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine.
The Oracle System ID (SID) of the created DB instance. If you don't specify a value, the default value is ORCL. You can't specify the string null, or any other reserved word, for DBName.
Default: ORCL
Constraints:
Can't be longer than 8 characters.
The name of the database to create when the DB instance is created. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine.
Not applicable. Must be null.
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
" + }, + "ServerlessV2FeaturesSupport":{ + "shape":"ServerlessV2FeaturesSupport", + "documentation":"Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
" } }, "documentation":"This data type is used as a response element in the action DescribeDBEngineVersions.
An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.
", + "error":{ + "code":"DBInstanceNotReady", + "httpStatusCode":503 + }, + "exception":true + }, "DBInstanceRole":{ "type":"structure", "members":{ @@ -8156,7 +8173,8 @@ "documentation":"The Amazon Resource Name (ARN) for the DB shard group.
" }, "TagList":{"shape":"TagList"} - } + }, + "documentation":"Contains the details for an Amazon RDS DB shard group.
" }, "DBShardGroupAlreadyExistsFault":{ "type":"structure", @@ -12229,7 +12247,7 @@ }, "ApplyImmediately":{ "shape":"Boolean", - "documentation":"Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" + "documentation":"Specifies whether the modifications in this request are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", @@ -16002,16 +16020,34 @@ "type":"string", "sensitive":true }, + "ServerlessV2FeaturesSupport":{ + "type":"structure", + "members":{ + "MinCapacity":{ + "shape":"DoubleOptional", + "documentation":"If the minimum capacity is 0 ACUs, the engine version supports the automatic pause/resume feature of Aurora Serverless v2.
" + }, + "MaxCapacity":{ + "shape":"DoubleOptional", + "documentation":" Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version. Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be 256 or 128.
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
" + }, "ServerlessV2ScalingConfiguration":{ "type":"structure", "members":{ "MinCapacity":{ "shape":"DoubleOptional", - "documentation":"The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
" + "documentation":"The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
" }, "MaxCapacity":{ "shape":"DoubleOptional", - "documentation":"The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
" + "documentation":"The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions.
" + }, + "SecondsUntilAutoPause":{ + "shape":"IntegerOptional", + "documentation":"Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it.
Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.
" } }, "documentation":"Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
" @@ -16021,11 +16057,15 @@ "members":{ "MinCapacity":{ "shape":"DoubleOptional", - "documentation":"The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
" + "documentation":"The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
" }, "MaxCapacity":{ "shape":"DoubleOptional", - "documentation":"The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
" + "documentation":"The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions.
" + }, + "SecondsUntilAutoPause":{ + "shape":"IntegerOptional", + "documentation":"The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again.
This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.
" } }, "documentation":"The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
" diff --git a/docs/source/conf.py b/docs/source/conf.py index db4353a35f..f47d8e38bf 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.63' +release = '1.35.64' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.