{ "smithy": "2.0", "shapes": { "com.amazonaws.connectcampaignsv2#AbandonmentRatePacingConfig": { "type": "structure", "members": { "targetRate": { "target": "com.amazonaws.connectcampaignsv2#TargetRate", "traits": { "smithy.api#required": {} } }, "connectionStartPoint": { "target": "com.amazonaws.connectcampaignsv2#ConnectionStartPoint", "traits": { "smithy.api#documentation": "Event from which connectionThresholdSeconds is measured.", "smithy.api#required": {} } }, "connectionThresholdSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Seconds after connectionStartPoint before a contact counts as abandoned.", "smithy.api#range": { "min": 1 }, "smithy.api#required": {} } }, "evaluationWindow": { "target": "com.amazonaws.connectcampaignsv2#EvaluationWindow", "traits": { "smithy.api#documentation": "Rolling window over which abandonmentRate is computed.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration for abandonment-rate-based dialer throttling." } }, "com.amazonaws.connectcampaignsv2#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "xAmzErrorType": { "target": "com.amazonaws.connectcampaignsv2#XAmazonErrorType", "traits": { "smithy.api#httpHeader": "x-amzn-ErrorType" } } }, "traits": { "smithy.api#documentation": "You do not have sufficient access to perform this action.", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.connectcampaignsv2#AgentAction": { "type": "string", "traits": { "smithy.api#documentation": "Actions that can performed on a contact by an agent", "smithy.api#enum": [ { "value": "DISCARD", "name": "DISCARD" } ] } }, "com.amazonaws.connectcampaignsv2#AgentActions": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#AgentAction" }, "traits": { "smithy.api#documentation": "Actions that can be performed by agent during preview phase.", "smithy.api#uniqueItems": {} } }, "com.amazonaws.connectcampaignsv2#AgentlessConfig": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Agentless config" } }, "com.amazonaws.connectcampaignsv2#AmazonConnectCampaignServiceV2": { "type": "service", "version": "2024-04-23", "operations": [ { "target": "com.amazonaws.connectcampaignsv2#CreateCampaign" }, { "target": "com.amazonaws.connectcampaignsv2#DeleteCampaign" }, { "target": "com.amazonaws.connectcampaignsv2#DeleteCampaignChannelSubtypeConfig" }, { "target": "com.amazonaws.connectcampaignsv2#DeleteCampaignCommunicationLimits" }, { "target": "com.amazonaws.connectcampaignsv2#DeleteCampaignCommunicationTime" }, { "target": "com.amazonaws.connectcampaignsv2#DeleteCampaignEntryLimits" }, { "target": "com.amazonaws.connectcampaignsv2#DeleteConnectInstanceConfig" }, { "target": "com.amazonaws.connectcampaignsv2#DeleteConnectInstanceIntegration" }, { "target": "com.amazonaws.connectcampaignsv2#DeleteInstanceOnboardingJob" }, { "target": "com.amazonaws.connectcampaignsv2#DescribeCampaign" }, { "target": "com.amazonaws.connectcampaignsv2#GetCampaignState" }, { "target": "com.amazonaws.connectcampaignsv2#GetCampaignStateBatch" }, { "target": "com.amazonaws.connectcampaignsv2#GetConnectInstanceConfig" }, { "target": "com.amazonaws.connectcampaignsv2#GetInstanceCommunicationLimits" }, { "target": "com.amazonaws.connectcampaignsv2#GetInstanceOnboardingJobStatus" }, { "target": "com.amazonaws.connectcampaignsv2#ListCampaigns" }, { "target": "com.amazonaws.connectcampaignsv2#ListConnectInstanceIntegrations" }, { "target": "com.amazonaws.connectcampaignsv2#ListTagsForResource" }, { "target": "com.amazonaws.connectcampaignsv2#PauseCampaign" }, { "target": "com.amazonaws.connectcampaignsv2#PutConnectInstanceIntegration" }, { "target": "com.amazonaws.connectcampaignsv2#PutInstanceCommunicationLimits" }, { "target": "com.amazonaws.connectcampaignsv2#PutOutboundRequestBatch" }, { "target": "com.amazonaws.connectcampaignsv2#PutProfileOutboundRequestBatch" }, { "target": "com.amazonaws.connectcampaignsv2#ResumeCampaign" }, { "target": "com.amazonaws.connectcampaignsv2#StartCampaign" }, { "target": "com.amazonaws.connectcampaignsv2#StartInstanceOnboardingJob" }, { "target": "com.amazonaws.connectcampaignsv2#StopCampaign" }, { "target": "com.amazonaws.connectcampaignsv2#TagResource" }, { "target": "com.amazonaws.connectcampaignsv2#UntagResource" }, { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignChannelSubtypeConfig" }, { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignCommunicationLimits" }, { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignCommunicationTime" }, { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignEntryLimits" }, { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignFlowAssociation" }, { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignName" }, { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignSchedule" }, { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignSource" } ], "traits": { "aws.api#service": { "sdkId": "ConnectCampaignsV2", "arnNamespace": "connect-campaigns", "cloudTrailEventSource": "connect-campaigns.amazonaws.com" }, "aws.auth#sigv4": { "name": "connect-campaigns" }, "aws.protocols#restJson1": {}, "smithy.api#cors": { "origin": "*", "additionalAllowedHeaders": [ "*", "Authorization", "Date", "X-Amz-Date", "X-Amz-Security-Token", "X-Amz-Target", "content-type", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id", "x-amzn-trace-id" ], "additionalExposedHeaders": [ "x-amzn-errortype", "x-amzn-requestid", "x-amzn-errormessage", "x-amzn-trace-id", "x-amz-apigw-id", "date" ], "maxAge": 86400 }, "smithy.api#documentation": "Provide APIs to create and manage Amazon Connect Campaigns.", "smithy.api#title": "AmazonConnectCampaignServiceV2", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://connect-campaigns-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://connect-campaigns-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://connect-campaigns.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://connect-campaigns.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://connect-campaigns-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://connect-campaigns-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://connect-campaigns.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://connect-campaigns.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect-campaigns-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-campaigns-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect-campaigns.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-campaigns.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect-campaigns-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-campaigns-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect-campaigns.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-campaigns.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect-campaigns-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-campaigns-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect-campaigns.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-campaigns.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-campaigns-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-campaigns.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-campaigns-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-campaigns.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.connectcampaignsv2#AnswerMachineDetectionConfig": { "type": "structure", "members": { "enableAnswerMachineDetection": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Enable or disable answering machine detection", "smithy.api#required": {} } }, "awaitAnswerMachinePrompt": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": null, "smithy.api#documentation": "Enable or disable await answer machine prompt" } } }, "traits": { "smithy.api#documentation": "Answering Machine Detection config" } }, "com.amazonaws.connectcampaignsv2#Arn": { "type": "string", "traits": { "smithy.api#documentation": "Amazon Resource Names(ARN)", "smithy.api#length": { "min": 20, "max": 500 }, "smithy.api#pattern": "^arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?:\\:[^:]+)?$" } }, "com.amazonaws.connectcampaignsv2#AttributeName": { "type": "string", "traits": { "smithy.api#documentation": "The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.", "smithy.api#length": { "min": 0, "max": 32767 }, "smithy.api#pattern": "^[a-zA-Z0-9\\-_]+$" } }, "com.amazonaws.connectcampaignsv2#AttributeValue": { "type": "string", "traits": { "smithy.api#documentation": "The value of the attribute.", "smithy.api#length": { "min": 0, "max": 32767 }, "smithy.api#pattern": "^.*$" } }, "com.amazonaws.connectcampaignsv2#Attributes": { "type": "map", "key": { "target": "com.amazonaws.connectcampaignsv2#AttributeName" }, "value": { "target": "com.amazonaws.connectcampaignsv2#AttributeValue" }, "traits": { "smithy.api#documentation": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.", "smithy.api#sensitive": {} } }, "com.amazonaws.connectcampaignsv2#BandwidthAllocation": { "type": "double", "traits": { "smithy.api#documentation": "The bandwidth allocation of a queue resource.", "smithy.api#range": { "min": 0, "max": 2 } } }, "com.amazonaws.connectcampaignsv2#BrowserId": { "type": "string", "traits": { "smithy.api#documentation": "Browser Id for web notification event trigger", "smithy.api#length": { "min": 1, "max": 36 } } }, "com.amazonaws.connectcampaignsv2#Campaign": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.connectcampaignsv2#CampaignArn", "traits": { "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcampaignsv2#CampaignName", "traits": { "smithy.api#required": {} } }, "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#required": {} } }, "channelSubtypeConfig": { "target": "com.amazonaws.connectcampaignsv2#ChannelSubtypeConfig" }, "type": { "target": "com.amazonaws.connectcampaignsv2#ExternalCampaignType" }, "source": { "target": "com.amazonaws.connectcampaignsv2#Source" }, "connectCampaignFlowArn": { "target": "com.amazonaws.connectcampaignsv2#Arn" }, "schedule": { "target": "com.amazonaws.connectcampaignsv2#Schedule" }, "entryLimitsConfig": { "target": "com.amazonaws.connectcampaignsv2#EntryLimitsConfig" }, "communicationTimeConfig": { "target": "com.amazonaws.connectcampaignsv2#CommunicationTimeConfig" }, "communicationLimitsOverride": { "target": "com.amazonaws.connectcampaignsv2#CommunicationLimitsConfig" }, "lastModifiedTime": { "target": "com.amazonaws.connectcampaignsv2#TimeStamp", "traits": { "smithy.api#documentation": "The timestamp of the most recent modification to the campaign or its configuration. Null for campaigns created before this field was introduced." } }, "tags": { "target": "com.amazonaws.connectcampaignsv2#TagMap" } }, "traits": { "smithy.api#documentation": "An Amazon Connect campaign." } }, "com.amazonaws.connectcampaignsv2#CampaignArn": { "type": "string", "traits": { "smithy.api#documentation": "The resource name of an Amazon Connect campaign.", "smithy.api#length": { "min": 20, "max": 500 } } }, "com.amazonaws.connectcampaignsv2#CampaignDeletionPolicy": { "type": "string", "traits": { "smithy.api#documentation": "Enumeration of the policies to enact on existing campaigns during instance config deletion", "smithy.api#enum": [ { "value": "RETAIN_ALL", "name": "RETAIN_ALL" }, { "value": "DELETE_ALL", "name": "DELETE_ALL" } ] } }, "com.amazonaws.connectcampaignsv2#CampaignFilters": { "type": "structure", "members": { "instanceIdFilter": { "target": "com.amazonaws.connectcampaignsv2#InstanceIdFilter" } }, "traits": { "smithy.api#documentation": "Filter model by type" } }, "com.amazonaws.connectcampaignsv2#CampaignId": { "type": "string", "traits": { "smithy.api#documentation": "Identifier representing a Campaign", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[-:/a-zA-Z0-9]+$" } }, "com.amazonaws.connectcampaignsv2#CampaignIdList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#CampaignId" }, "traits": { "smithy.api#documentation": "List of CampaignId" } }, "com.amazonaws.connectcampaignsv2#CampaignName": { "type": "string", "traits": { "smithy.api#documentation": "The name of an Amazon Connect Campaign name.", "smithy.api#length": { "min": 1, "max": 127 } } }, "com.amazonaws.connectcampaignsv2#CampaignState": { "type": "string", "traits": { "smithy.api#documentation": "State of a campaign", "smithy.api#enum": [ { "value": "Initialized", "name": "INITIALIZED", "documentation": "Campaign is in initialized state" }, { "value": "Running", "name": "RUNNING", "documentation": "Campaign is in running state" }, { "value": "Paused", "name": "PAUSED", "documentation": "Campaign is in paused state" }, { "value": "Stopped", "name": "STOPPED", "documentation": "Campaign is in stopped state" }, { "value": "Failed", "name": "FAILED", "documentation": "Campaign is in failed state" }, { "value": "Completed", "name": "COMPLETED", "documentation": "Campaign is in completed state" } ] } }, "com.amazonaws.connectcampaignsv2#CampaignSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.connectcampaignsv2#CampaignArn", "traits": { "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcampaignsv2#CampaignName", "traits": { "smithy.api#required": {} } }, "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#required": {} } }, "channelSubtypes": { "target": "com.amazonaws.connectcampaignsv2#ChannelSubtypeList", "traits": { "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connectcampaignsv2#ExternalCampaignType" }, "schedule": { "target": "com.amazonaws.connectcampaignsv2#Schedule" }, "entryLimitsConfig": { "target": "com.amazonaws.connectcampaignsv2#EntryLimitsConfig" }, "connectCampaignFlowArn": { "target": "com.amazonaws.connectcampaignsv2#Arn" }, "lastModifiedTime": { "target": "com.amazonaws.connectcampaignsv2#TimeStamp", "traits": { "smithy.api#documentation": "The timestamp of the most recent modification to the campaign or its configuration. Null for campaigns created before this field was introduced." } } }, "traits": { "smithy.api#documentation": "An Amazon Connect campaign summary." } }, "com.amazonaws.connectcampaignsv2#CampaignSummaryList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#CampaignSummary" }, "traits": { "smithy.api#documentation": "A list of Amazon Connect campaigns." } }, "com.amazonaws.connectcampaignsv2#Capacity": { "type": "double", "traits": { "smithy.api#documentation": "Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns", "smithy.api#range": { "min": 0.01, "max": 1 } } }, "com.amazonaws.connectcampaignsv2#ChannelContext": { "type": "structure", "members": { "webNotificationContext": { "target": "com.amazonaws.connectcampaignsv2#WebNotificationContext" } }, "traits": { "smithy.api#documentation": "Additional metadata related to the event trigger context" } }, "com.amazonaws.connectcampaignsv2#ChannelSubtype": { "type": "string", "traits": { "smithy.api#documentation": "The type of campaign channel subtype.", "smithy.api#enum": [ { "value": "TELEPHONY", "name": "TELEPHONY" }, { "value": "SMS", "name": "SMS" }, { "value": "EMAIL", "name": "EMAIL" }, { "value": "WHATSAPP", "name": "WHATSAPP" } ] } }, "com.amazonaws.connectcampaignsv2#ChannelSubtypeConfig": { "type": "structure", "members": { "telephony": { "target": "com.amazonaws.connectcampaignsv2#TelephonyChannelSubtypeConfig" }, "sms": { "target": "com.amazonaws.connectcampaignsv2#SmsChannelSubtypeConfig" }, "email": { "target": "com.amazonaws.connectcampaignsv2#EmailChannelSubtypeConfig" }, "whatsApp": { "target": "com.amazonaws.connectcampaignsv2#WhatsAppChannelSubtypeConfig" } }, "traits": { "smithy.api#documentation": "Campaign Channel Subtype config" } }, "com.amazonaws.connectcampaignsv2#ChannelSubtypeList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#ChannelSubtype" }, "traits": { "smithy.api#documentation": "Channel subtype list", "smithy.api#uniqueItems": {} } }, "com.amazonaws.connectcampaignsv2#ChannelSubtypeParameters": { "type": "union", "members": { "telephony": { "target": "com.amazonaws.connectcampaignsv2#TelephonyChannelSubtypeParameters" }, "sms": { "target": "com.amazonaws.connectcampaignsv2#SmsChannelSubtypeParameters" }, "email": { "target": "com.amazonaws.connectcampaignsv2#EmailChannelSubtypeParameters" }, "whatsApp": { "target": "com.amazonaws.connectcampaignsv2#WhatsAppChannelSubtypeParameters" } }, "traits": { "smithy.api#documentation": "ChannelSubtypeParameters for an outbound request" } }, "com.amazonaws.connectcampaignsv2#ClientToken": { "type": "string", "traits": { "smithy.api#documentation": "Client provided parameter used for idempotency. Its value must be unique for each request.", "smithy.api#length": { "min": 0, "max": 200 }, "smithy.api#pattern": "^[a-zA-Z0-9_\\-.]*$" } }, "com.amazonaws.connectcampaignsv2#CommunicationLimit": { "type": "structure", "members": { "maxCountPerRecipient": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Maximum number of contacts allowed for a given target within the given frequency.", "smithy.api#range": { "min": 1 }, "smithy.api#required": {} } }, "frequency": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of days to consider with regards to this limit.", "smithy.api#range": { "min": 1, "max": 30 }, "smithy.api#required": {} } }, "unit": { "target": "com.amazonaws.connectcampaignsv2#CommunicationLimitTimeUnit", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Communication Limit" } }, "com.amazonaws.connectcampaignsv2#CommunicationLimitList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#CommunicationLimit" }, "traits": { "smithy.api#documentation": "List of communication limit", "smithy.api#length": { "max": 2 } } }, "com.amazonaws.connectcampaignsv2#CommunicationLimitTimeUnit": { "type": "string", "traits": { "smithy.api#documentation": "The communication limit time unit.", "smithy.api#enum": [ { "value": "DAY", "name": "DAY" } ] } }, "com.amazonaws.connectcampaignsv2#CommunicationLimits": { "type": "union", "members": { "communicationLimitsList": { "target": "com.amazonaws.connectcampaignsv2#CommunicationLimitList" } }, "traits": { "smithy.api#documentation": "Communication limits" } }, "com.amazonaws.connectcampaignsv2#CommunicationLimitsConfig": { "type": "structure", "members": { "allChannelSubtypes": { "target": "com.amazonaws.connectcampaignsv2#CommunicationLimits" }, "instanceLimitsHandling": { "target": "com.amazonaws.connectcampaignsv2#InstanceLimitsHandling" } }, "traits": { "smithy.api#documentation": "Communication limits config" } }, "com.amazonaws.connectcampaignsv2#CommunicationLimitsConfigType": { "type": "string", "traits": { "smithy.api#documentation": "The type of campaign communication limits config.", "smithy.api#enum": [ { "value": "ALL_CHANNEL_SUBTYPES", "name": "ALL_CHANNEL_SUBTYPES" } ] } }, "com.amazonaws.connectcampaignsv2#CommunicationTimeConfig": { "type": "structure", "members": { "localTimeZoneConfig": { "target": "com.amazonaws.connectcampaignsv2#LocalTimeZoneConfig", "traits": { "smithy.api#required": {} } }, "telephony": { "target": "com.amazonaws.connectcampaignsv2#TimeWindow" }, "sms": { "target": "com.amazonaws.connectcampaignsv2#TimeWindow" }, "email": { "target": "com.amazonaws.connectcampaignsv2#TimeWindow" }, "whatsApp": { "target": "com.amazonaws.connectcampaignsv2#TimeWindow" } }, "traits": { "smithy.api#documentation": "Campaign communication time config" } }, "com.amazonaws.connectcampaignsv2#CommunicationTimeConfigType": { "type": "string", "traits": { "smithy.api#documentation": "The type of campaign communication time config", "smithy.api#enum": [ { "value": "TELEPHONY", "name": "TELEPHONY" }, { "value": "SMS", "name": "SMS" }, { "value": "EMAIL", "name": "EMAIL" }, { "value": "WHATSAPP", "name": "WHATSAPP" } ] } }, "com.amazonaws.connectcampaignsv2#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "xAmzErrorType": { "target": "com.amazonaws.connectcampaignsv2#XAmazonErrorType", "traits": { "smithy.api#httpHeader": "x-amzn-ErrorType" } } }, "traits": { "smithy.api#documentation": "The request could not be processed because of conflict in the current state of the resource.", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.connectcampaignsv2#ConnectionStartPoint": { "type": "string", "traits": { "smithy.api#documentation": "Reference point against which the connection threshold is measured.", "smithy.api#enum": [ { "value": "CONNECTED_TO_SYSTEM", "name": "CONNECTED_TO_SYSTEM", "documentation": "Threshold measured from when the contact connects to the telephony system." }, { "value": "GREETING_START", "name": "GREETING_START", "documentation": "Threshold measured from when the customer-side greeting begins." }, { "value": "GREETING_END", "name": "GREETING_END", "documentation": "Threshold measured from when the customer-side greeting ends." } ] } }, "com.amazonaws.connectcampaignsv2#ContactFlowId": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of the contact flow for the outbound call.", "smithy.api#length": { "max": 500 } } }, "com.amazonaws.connectcampaignsv2#CreateCampaign": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#CreateCampaignRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#CreateCampaignResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a campaign for the specified Amazon Connect account. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#CreateCampaignRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.connectcampaignsv2#CampaignName", "traits": { "smithy.api#required": {} } }, "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#required": {} } }, "channelSubtypeConfig": { "target": "com.amazonaws.connectcampaignsv2#ChannelSubtypeConfig" }, "type": { "target": "com.amazonaws.connectcampaignsv2#ExternalCampaignType" }, "source": { "target": "com.amazonaws.connectcampaignsv2#Source" }, "connectCampaignFlowArn": { "target": "com.amazonaws.connectcampaignsv2#Arn" }, "schedule": { "target": "com.amazonaws.connectcampaignsv2#Schedule" }, "entryLimitsConfig": { "target": "com.amazonaws.connectcampaignsv2#EntryLimitsConfig" }, "communicationTimeConfig": { "target": "com.amazonaws.connectcampaignsv2#CommunicationTimeConfig" }, "communicationLimitsOverride": { "target": "com.amazonaws.connectcampaignsv2#CommunicationLimitsConfig" }, "tags": { "target": "com.amazonaws.connectcampaignsv2#TagMap" } }, "traits": { "smithy.api#documentation": "The request for CreateCampaign API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#CreateCampaignResponse": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId" }, "arn": { "target": "com.amazonaws.connectcampaignsv2#CampaignArn" }, "tags": { "target": "com.amazonaws.connectcampaignsv2#TagMap" } }, "traits": { "smithy.api#documentation": "The response for Create Campaign API", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#CustomerProfilesIntegrationConfig": { "type": "structure", "members": { "domainArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } }, "objectTypeNames": { "target": "com.amazonaws.connectcampaignsv2#ObjectTypeNamesMap", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Customer Profiles integration config" } }, "com.amazonaws.connectcampaignsv2#CustomerProfilesIntegrationIdentifier": { "type": "structure", "members": { "domainArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Customer Profiles integration identifier" } }, "com.amazonaws.connectcampaignsv2#CustomerProfilesIntegrationSummary": { "type": "structure", "members": { "domainArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } }, "objectTypeNames": { "target": "com.amazonaws.connectcampaignsv2#ObjectTypeNamesMap", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Customer Profiles integration summary" } }, "com.amazonaws.connectcampaignsv2#DailyHours": { "type": "map", "key": { "target": "com.amazonaws.connectcampaignsv2#DayOfWeek" }, "value": { "target": "com.amazonaws.connectcampaignsv2#TimeRangeList" }, "traits": { "smithy.api#documentation": "Daily Hours map" } }, "com.amazonaws.connectcampaignsv2#DayOfWeek": { "type": "string", "traits": { "smithy.api#documentation": "Day of week enum", "smithy.api#enum": [ { "value": "MONDAY", "name": "MONDAY" }, { "value": "TUESDAY", "name": "TUESDAY" }, { "value": "WEDNESDAY", "name": "WEDNESDAY" }, { "value": "THURSDAY", "name": "THURSDAY" }, { "value": "FRIDAY", "name": "FRIDAY" }, { "value": "SATURDAY", "name": "SATURDAY" }, { "value": "SUNDAY", "name": "SUNDAY" } ] } }, "com.amazonaws.connectcampaignsv2#DeleteCampaign": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#DeleteCampaignRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a campaign from the specified Amazon Connect account.", "smithy.api#http": { "uri": "/v2/campaigns/{id}", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#DeleteCampaignChannelSubtypeConfig": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#DeleteCampaignChannelSubtypeConfigRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the channel subtype config of a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/channel-subtype-config", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#DeleteCampaignChannelSubtypeConfigRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "channelSubtype": { "target": "com.amazonaws.connectcampaignsv2#ChannelSubtype", "traits": { "smithy.api#httpQuery": "channelSubtype", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for DeleteCampaignChannelSubtypeConfig API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#DeleteCampaignCommunicationLimits": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#DeleteCampaignCommunicationLimitsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the communication limits config for a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/communication-limits", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#DeleteCampaignCommunicationLimitsRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "config": { "target": "com.amazonaws.connectcampaignsv2#CommunicationLimitsConfigType", "traits": { "smithy.api#httpQuery": "config", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for DeleteCampaignCommunicationLimits API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#DeleteCampaignCommunicationTime": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#DeleteCampaignCommunicationTimeRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the communication time config for a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/communication-time", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#DeleteCampaignCommunicationTimeRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "config": { "target": "com.amazonaws.connectcampaignsv2#CommunicationTimeConfigType", "traits": { "smithy.api#httpQuery": "config", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for DeleteCampaignCommunicationTime API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#DeleteCampaignEntryLimits": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#DeleteCampaignEntryLimitsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the entry limits config for a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/entry-limits", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#DeleteCampaignEntryLimitsRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for DeleteCampaignEntryLimits API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#DeleteCampaignRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for DeleteCampaign API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#DeleteConnectInstanceConfig": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#DeleteConnectInstanceConfigRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a connect instance config from the specified AWS account.", "smithy.api#http": { "uri": "/v2/connect-instance/{connectInstanceId}/config", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#DeleteConnectInstanceConfigRequest": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "campaignDeletionPolicy": { "target": "com.amazonaws.connectcampaignsv2#CampaignDeletionPolicy", "traits": { "smithy.api#httpQuery": "campaignDeletionPolicy" } } }, "traits": { "smithy.api#documentation": "The request for DeleteConnectInstanceConfig API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#DeleteConnectInstanceIntegration": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#DeleteConnectInstanceIntegrationRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Delete the integration for the specified Amazon Connect instance.", "smithy.api#http": { "uri": "/v2/connect-instance/{connectInstanceId}/integrations/delete", "method": "POST" } } }, "com.amazonaws.connectcampaignsv2#DeleteConnectInstanceIntegrationRequest": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "integrationIdentifier": { "target": "com.amazonaws.connectcampaignsv2#IntegrationIdentifier", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for DeleteConnectInstanceIntegration API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#DeleteInstanceOnboardingJob": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#DeleteInstanceOnboardingJobRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.", "smithy.api#http": { "uri": "/v2/connect-instance/{connectInstanceId}/onboarding", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#DeleteInstanceOnboardingJobRequest": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for DeleteInstanceOnboardingJob API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#DescribeCampaign": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#DescribeCampaignRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#DescribeCampaignResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Describes the specific campaign.", "smithy.api#http": { "uri": "/v2/campaigns/{id}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcampaignsv2#DescribeCampaignRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for DescribeCampaign API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#DescribeCampaignResponse": { "type": "structure", "members": { "campaign": { "target": "com.amazonaws.connectcampaignsv2#Campaign" } }, "traits": { "smithy.api#documentation": "The response for DescribeCampaign API.", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#DestinationPhoneNumber": { "type": "string", "traits": { "smithy.api#documentation": "The phone number of the customer, in E.164 format.", "smithy.api#length": { "min": 0, "max": 20 }, "smithy.api#pattern": "^[\\d\\-+]*$", "smithy.api#sensitive": {} } }, "com.amazonaws.connectcampaignsv2#DialRequestId": { "type": "string", "traits": { "smithy.api#documentation": "Identifier representing a Dial request", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[-_.a-zA-Z0-9]+$" } }, "com.amazonaws.connectcampaignsv2#EmailAddress": { "type": "string", "traits": { "smithy.api#documentation": "Source/Destination Email address used for Email messages", "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "[^\\s@]+@[^\\s@]+\\.[^\\s@]+", "smithy.api#sensitive": {} } }, "com.amazonaws.connectcampaignsv2#EmailChannelSubtypeConfig": { "type": "structure", "members": { "capacity": { "target": "com.amazonaws.connectcampaignsv2#Capacity" }, "outboundMode": { "target": "com.amazonaws.connectcampaignsv2#EmailOutboundMode", "traits": { "smithy.api#required": {} } }, "defaultOutboundConfig": { "target": "com.amazonaws.connectcampaignsv2#EmailOutboundConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Email Channel Subtype config" } }, "com.amazonaws.connectcampaignsv2#EmailChannelSubtypeParameters": { "type": "structure", "members": { "destinationEmailAddress": { "target": "com.amazonaws.connectcampaignsv2#EmailAddress", "traits": { "smithy.api#required": {} } }, "connectSourceEmailAddress": { "target": "com.amazonaws.connectcampaignsv2#EmailAddress" }, "templateArn": { "target": "com.amazonaws.connectcampaignsv2#Arn" }, "templateParameters": { "target": "com.amazonaws.connectcampaignsv2#Attributes", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Parameters for the Email Channel Subtype" } }, "com.amazonaws.connectcampaignsv2#EmailDisplayName": { "type": "string", "traits": { "smithy.api#documentation": "Display name for Email Address", "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#sensitive": {} } }, "com.amazonaws.connectcampaignsv2#EmailOutboundConfig": { "type": "structure", "members": { "connectSourceEmailAddress": { "target": "com.amazonaws.connectcampaignsv2#EmailAddress", "traits": { "smithy.api#required": {} } }, "sourceEmailAddressDisplayName": { "target": "com.amazonaws.connectcampaignsv2#EmailDisplayName" }, "wisdomTemplateArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Default Email Outbound config" } }, "com.amazonaws.connectcampaignsv2#EmailOutboundMode": { "type": "union", "members": { "agentless": { "target": "com.amazonaws.connectcampaignsv2#AgentlessConfig" } }, "traits": { "smithy.api#documentation": "Email Outbound Mode" } }, "com.amazonaws.connectcampaignsv2#Enabled": { "type": "boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Boolean to indicate if custom encryption has been enabled." } }, "com.amazonaws.connectcampaignsv2#EncryptionConfig": { "type": "structure", "members": { "enabled": { "target": "com.amazonaws.connectcampaignsv2#Enabled", "traits": { "smithy.api#default": false, "smithy.api#required": {} } }, "encryptionType": { "target": "com.amazonaws.connectcampaignsv2#EncryptionType" }, "keyArn": { "target": "com.amazonaws.connectcampaignsv2#EncryptionKey" } }, "traits": { "smithy.api#documentation": "Encryption config for Connect Instance. Note that sensitive data will always be encrypted.\nIf disabled, service will perform encryption with its own key.\nIf enabled, a KMS key id needs to be provided and KMS charges will apply.\nKMS is only type supported" } }, "com.amazonaws.connectcampaignsv2#EncryptionKey": { "type": "string", "traits": { "smithy.api#documentation": "KMS key id/arn for encryption config.", "smithy.api#length": { "max": 500 } } }, "com.amazonaws.connectcampaignsv2#EncryptionType": { "type": "string", "traits": { "smithy.api#documentation": "Server-side encryption type.", "smithy.api#enum": [ { "name": "KMS", "value": "KMS" } ] } }, "com.amazonaws.connectcampaignsv2#EntryLimitsConfig": { "type": "structure", "members": { "maxEntryCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Maximum number of times a participant can enter the campaign. A value of 0 indicates unlimited entries. Values of 1 or greater specify the exact number of entries allowed.", "smithy.api#range": { "min": 0 }, "smithy.api#required": {} } }, "minEntryInterval": { "target": "com.amazonaws.connectcampaignsv2#Iso8601Duration", "traits": { "smithy.api#documentation": "Minimum time interval that must pass before a participant can enter the campaign again.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Campaign entry limits config" } }, "com.amazonaws.connectcampaignsv2#EvaluationWindow": { "type": "string", "traits": { "smithy.api#documentation": "Rolling window over which abandonmentRate is computed. Range PT1H to PT24H.", "smithy.api#length": { "max": 5 }, "smithy.api#pattern": "^PT([1-9]|1[0-9]|2[0-4])H$" } }, "com.amazonaws.connectcampaignsv2#EventTrigger": { "type": "structure", "members": { "customerProfilesDomainArn": { "target": "com.amazonaws.connectcampaignsv2#Arn" } }, "traits": { "smithy.api#documentation": "Event trigger of the campaign" } }, "com.amazonaws.connectcampaignsv2#EventTriggerContext": { "type": "structure", "members": { "sourceEvent": { "target": "com.amazonaws.connectcampaignsv2#SourceEvent" }, "channelContext": { "target": "com.amazonaws.connectcampaignsv2#ChannelContext" } }, "traits": { "smithy.api#documentation": "Event trigger context data" } }, "com.amazonaws.connectcampaignsv2#EventType": { "type": "string", "traits": { "smithy.api#documentation": "Enumeration of Customer Profiles event type", "smithy.api#enum": [ { "value": "Campaign-Email", "name": "CAMPAIGN_EMAIL" }, { "value": "Campaign-SMS", "name": "CAMPAIGN_SMS" }, { "value": "Campaign-Telephony", "name": "CAMPAIGN_TELEPHONY" }, { "value": "Campaign-Orchestration", "name": "CAMPAIGN_ORCHESTRATION" }, { "value": "Campaign-WhatsApp", "name": "CAMPAIGN_WHATS_APP" }, { "value": "Campaign-WebNotification", "name": "CAMPAIGN_WEB_NOTIFICATION" } ] } }, "com.amazonaws.connectcampaignsv2#ExternalCampaignType": { "type": "string", "traits": { "smithy.api#documentation": "The type of campaign externally exposed in APIs.", "smithy.api#enum": [ { "value": "MANAGED", "name": "MANAGED" }, { "value": "JOURNEY", "name": "JOURNEY" } ] } }, "com.amazonaws.connectcampaignsv2#FailedCampaignStateResponse": { "type": "structure", "members": { "campaignId": { "target": "com.amazonaws.connectcampaignsv2#CampaignId" }, "failureCode": { "target": "com.amazonaws.connectcampaignsv2#GetCampaignStateBatchFailureCode" } }, "traits": { "smithy.api#documentation": "Failed response of campaign state" } }, "com.amazonaws.connectcampaignsv2#FailedCampaignStateResponseList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#FailedCampaignStateResponse" }, "traits": { "smithy.api#documentation": "List of failed requests of campaign state", "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.connectcampaignsv2#FailedProfileOutboundRequest": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.connectcampaignsv2#ClientToken" }, "id": { "target": "com.amazonaws.connectcampaignsv2#ProfileOutboundRequestId" }, "failureCode": { "target": "com.amazonaws.connectcampaignsv2#ProfileOutboundRequestFailureCode" } }, "traits": { "smithy.api#documentation": "Failure details for a profile outbound request" } }, "com.amazonaws.connectcampaignsv2#FailedProfileOutboundRequestList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#FailedProfileOutboundRequest" }, "traits": { "smithy.api#documentation": "List of failed profile outbound requests", "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.connectcampaignsv2#FailedRequest": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.connectcampaignsv2#ClientToken" }, "id": { "target": "com.amazonaws.connectcampaignsv2#DialRequestId" }, "failureCode": { "target": "com.amazonaws.connectcampaignsv2#FailureCode" } }, "traits": { "smithy.api#documentation": "A failed request identified by the unique client token." } }, "com.amazonaws.connectcampaignsv2#FailedRequestList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#FailedRequest" }, "traits": { "smithy.api#documentation": "A list of failed requests.", "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.connectcampaignsv2#FailureCode": { "type": "string", "traits": { "smithy.api#documentation": "A predefined code indicating the error that caused the failure.", "smithy.api#enum": [ { "value": "InvalidInput", "name": "INVALID_INPUT", "documentation": "The request failed to satisfy the constraints specified by the service" }, { "value": "RequestThrottled", "name": "REQUEST_THROTTLED", "documentation": "The request was throttled due to excessive usage" }, { "value": "UnknownError", "name": "UNKNOWN_ERROR", "documentation": "Unexpected error during processing of request" }, { "value": "BufferLimitExceeded", "name": "BUFFER_LIMIT_EXCEEDED", "documentation": "Request throttled due to large number of pending dial requests" } ] } }, "com.amazonaws.connectcampaignsv2#GetCampaignState": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#GetCampaignStateRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#GetCampaignStateResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Get state of a campaign for the specified Amazon Connect account.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/state", "method": "GET" } } }, "com.amazonaws.connectcampaignsv2#GetCampaignStateBatch": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#GetCampaignStateBatchRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#GetCampaignStateBatchResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Get state of campaigns for the specified Amazon Connect account.", "smithy.api#http": { "uri": "/v2/campaigns-state", "method": "POST" } } }, "com.amazonaws.connectcampaignsv2#GetCampaignStateBatchFailureCode": { "type": "string", "traits": { "smithy.api#documentation": "A predefined code indicating the error that caused the failure in getting state of campaigns", "smithy.api#enum": [ { "value": "ResourceNotFound", "name": "RESOURCE_NOT_FOUND", "documentation": "The specified resource was not found" }, { "value": "UnknownError", "name": "UNKNOWN_ERROR", "documentation": "Unexpected error during processing of request" } ] } }, "com.amazonaws.connectcampaignsv2#GetCampaignStateBatchRequest": { "type": "structure", "members": { "campaignIds": { "target": "com.amazonaws.connectcampaignsv2#CampaignIdList", "traits": { "smithy.api#length": { "min": 1, "max": 25 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for GetCampaignStateBatch API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#GetCampaignStateBatchResponse": { "type": "structure", "members": { "successfulRequests": { "target": "com.amazonaws.connectcampaignsv2#SuccessfulCampaignStateResponseList" }, "failedRequests": { "target": "com.amazonaws.connectcampaignsv2#FailedCampaignStateResponseList" } }, "traits": { "smithy.api#documentation": "The response for GetCampaignStateBatch API.", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#GetCampaignStateRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for GetCampaignState API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#GetCampaignStateResponse": { "type": "structure", "members": { "state": { "target": "com.amazonaws.connectcampaignsv2#CampaignState" } }, "traits": { "smithy.api#documentation": "The response for GetCampaignState API.", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#GetConnectInstanceConfig": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#GetConnectInstanceConfigRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#GetConnectInstanceConfigResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Get the specific Connect instance config.", "smithy.api#http": { "uri": "/v2/connect-instance/{connectInstanceId}/config", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcampaignsv2#GetConnectInstanceConfigRequest": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for GetConnectInstanceConfig API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#GetConnectInstanceConfigResponse": { "type": "structure", "members": { "connectInstanceConfig": { "target": "com.amazonaws.connectcampaignsv2#InstanceConfig" } }, "traits": { "smithy.api#documentation": "The response for GetConnectInstanceConfig API.", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#GetInstanceCommunicationLimits": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#GetInstanceCommunicationLimitsRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#GetInstanceCommunicationLimitsResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Get the instance communication limits.", "smithy.api#http": { "uri": "/v2/connect-instance/{connectInstanceId}/communication-limits", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcampaignsv2#GetInstanceCommunicationLimitsRequest": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for GetInstanceCommunicationLimits API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#GetInstanceCommunicationLimitsResponse": { "type": "structure", "members": { "communicationLimitsConfig": { "target": "com.amazonaws.connectcampaignsv2#InstanceCommunicationLimitsConfig" } }, "traits": { "smithy.api#documentation": "The response for GetInstanceCommunicationLimits API.", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#GetInstanceOnboardingJobStatus": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#GetInstanceOnboardingJobStatusRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#GetInstanceOnboardingJobStatusResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Get the specific instance onboarding job status.", "smithy.api#http": { "uri": "/v2/connect-instance/{connectInstanceId}/onboarding", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcampaignsv2#GetInstanceOnboardingJobStatusRequest": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for GetInstanceOnboardingJobStatus API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#GetInstanceOnboardingJobStatusResponse": { "type": "structure", "members": { "connectInstanceOnboardingJobStatus": { "target": "com.amazonaws.connectcampaignsv2#InstanceOnboardingJobStatus" } }, "traits": { "smithy.api#documentation": "The response for GetInstanceOnboardingJobStatus API.", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#InstanceCommunicationLimitsConfig": { "type": "structure", "members": { "allChannelSubtypes": { "target": "com.amazonaws.connectcampaignsv2#CommunicationLimits" } }, "traits": { "smithy.api#documentation": "Instance Communication limits config" } }, "com.amazonaws.connectcampaignsv2#InstanceConfig": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#required": {} } }, "serviceLinkedRoleArn": { "target": "com.amazonaws.connectcampaignsv2#ServiceLinkedRoleArn", "traits": { "smithy.api#required": {} } }, "encryptionConfig": { "target": "com.amazonaws.connectcampaignsv2#EncryptionConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Instance config object" } }, "com.amazonaws.connectcampaignsv2#InstanceId": { "type": "string", "traits": { "smithy.api#documentation": "Amazon Connect Instance Id", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[-_.a-zA-Z0-9]+$" } }, "com.amazonaws.connectcampaignsv2#InstanceIdFilter": { "type": "structure", "members": { "value": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#required": {} } }, "operator": { "target": "com.amazonaws.connectcampaignsv2#InstanceIdFilterOperator", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Connect instance identifier filter" } }, "com.amazonaws.connectcampaignsv2#InstanceIdFilterOperator": { "type": "string", "traits": { "smithy.api#documentation": "Operators for Connect instance identifier filter", "smithy.api#enum": [ { "name": "EQ", "value": "Eq", "documentation": "Equals operator" } ] } }, "com.amazonaws.connectcampaignsv2#InstanceLimitsHandling": { "type": "string", "traits": { "smithy.api#documentation": "Instance limits handling", "smithy.api#enum": [ { "value": "OPT_IN", "name": "OPT_IN" }, { "value": "OPT_OUT", "name": "OPT_OUT" } ] } }, "com.amazonaws.connectcampaignsv2#InstanceOnboardingJobFailureCode": { "type": "string", "traits": { "smithy.api#documentation": "Enumeration of the possible failure codes for instance onboarding job", "smithy.api#enum": [ { "value": "EVENT_BRIDGE_ACCESS_DENIED", "name": "EVENT_BRIDGE_ACCESS_DENIED" }, { "value": "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED", "name": "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED" }, { "value": "IAM_ACCESS_DENIED", "name": "IAM_ACCESS_DENIED" }, { "value": "KMS_ACCESS_DENIED", "name": "KMS_ACCESS_DENIED" }, { "value": "KMS_KEY_NOT_FOUND", "name": "KMS_KEY_NOT_FOUND" }, { "value": "INTERNAL_FAILURE", "name": "INTERNAL_FAILURE" } ] } }, "com.amazonaws.connectcampaignsv2#InstanceOnboardingJobStatus": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connectcampaignsv2#InstanceOnboardingJobStatusCode", "traits": { "smithy.api#required": {} } }, "failureCode": { "target": "com.amazonaws.connectcampaignsv2#InstanceOnboardingJobFailureCode" } }, "traits": { "smithy.api#documentation": "Instance onboarding job status object" } }, "com.amazonaws.connectcampaignsv2#InstanceOnboardingJobStatusCode": { "type": "string", "traits": { "smithy.api#documentation": "Enumeration of the possible states for instance onboarding job", "smithy.api#enum": [ { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "SUCCEEDED", "name": "SUCCEEDED" }, { "value": "FAILED", "name": "FAILED" } ] } }, "com.amazonaws.connectcampaignsv2#IntegrationConfig": { "type": "union", "members": { "customerProfiles": { "target": "com.amazonaws.connectcampaignsv2#CustomerProfilesIntegrationConfig" }, "qConnect": { "target": "com.amazonaws.connectcampaignsv2#QConnectIntegrationConfig" }, "lambda": { "target": "com.amazonaws.connectcampaignsv2#LambdaIntegrationConfig" } }, "traits": { "smithy.api#documentation": "Integration config for Connect Instance" } }, "com.amazonaws.connectcampaignsv2#IntegrationIdentifier": { "type": "union", "members": { "customerProfiles": { "target": "com.amazonaws.connectcampaignsv2#CustomerProfilesIntegrationIdentifier" }, "qConnect": { "target": "com.amazonaws.connectcampaignsv2#QConnectIntegrationIdentifier" }, "lambda": { "target": "com.amazonaws.connectcampaignsv2#LambdaIntegrationIdentifier" } }, "traits": { "smithy.api#documentation": "Integration identifier for Connect instance" } }, "com.amazonaws.connectcampaignsv2#IntegrationSummary": { "type": "union", "members": { "customerProfiles": { "target": "com.amazonaws.connectcampaignsv2#CustomerProfilesIntegrationSummary" }, "qConnect": { "target": "com.amazonaws.connectcampaignsv2#QConnectIntegrationSummary" }, "lambda": { "target": "com.amazonaws.connectcampaignsv2#LambdaIntegrationSummary" } }, "traits": { "smithy.api#documentation": "Integration summary for Connect instance." } }, "com.amazonaws.connectcampaignsv2#IntegrationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#IntegrationSummary" }, "traits": { "smithy.api#documentation": "A list of Amazon Connect Instance Integrations." } }, "com.amazonaws.connectcampaignsv2#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "xAmzErrorType": { "target": "com.amazonaws.connectcampaignsv2#XAmazonErrorType", "traits": { "smithy.api#httpHeader": "x-amzn-ErrorType" } } }, "traits": { "smithy.api#documentation": "Request processing failed because of an error or failure with the service.", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException": { "type": "structure", "members": { "state": { "target": "com.amazonaws.connectcampaignsv2#CampaignState", "traits": { "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "xAmzErrorType": { "target": "com.amazonaws.connectcampaignsv2#XAmazonErrorType", "traits": { "smithy.api#httpHeader": "x-amzn-ErrorType" } } }, "traits": { "smithy.api#documentation": "The request could not be processed because of conflict in the current state of the campaign.", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.connectcampaignsv2#InvalidStateException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "xAmzErrorType": { "target": "com.amazonaws.connectcampaignsv2#XAmazonErrorType", "traits": { "smithy.api#httpHeader": "x-amzn-ErrorType" } } }, "traits": { "smithy.api#documentation": "The request could not be processed because of conflict in the current state.", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.connectcampaignsv2#Iso8601Date": { "type": "string", "traits": { "smithy.api#documentation": "Date in ISO 8601 format, e.g. 2024-01-01", "smithy.api#pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "com.amazonaws.connectcampaignsv2#Iso8601Duration": { "type": "string", "traits": { "smithy.api#documentation": "Time duration in ISO 8601 format", "smithy.api#length": { "min": 0, "max": 50 }, "smithy.api#pattern": "^P(?:([-+]?[0-9]+)D)?(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?$" } }, "com.amazonaws.connectcampaignsv2#Iso8601Time": { "type": "string", "traits": { "smithy.api#documentation": "Time in ISO 8601 format, e.g. T23:11", "smithy.api#pattern": "^T\\d{2}:\\d{2}$" } }, "com.amazonaws.connectcampaignsv2#LambdaArn": { "type": "string", "traits": { "smithy.api#documentation": "Lambda ARN for integration with Connect instances", "smithy.api#length": { "min": 1, "max": 140 }, "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:function:([a-zA-Z0-9-_]+)(:([a-zA-Z0-9-_]+))?$" } }, "com.amazonaws.connectcampaignsv2#LambdaIntegrationConfig": { "type": "structure", "members": { "functionArn": { "target": "com.amazonaws.connectcampaignsv2#LambdaArn", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Lambda integration config" } }, "com.amazonaws.connectcampaignsv2#LambdaIntegrationIdentifier": { "type": "structure", "members": { "functionArn": { "target": "com.amazonaws.connectcampaignsv2#LambdaArn", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Lambda integration identifier" } }, "com.amazonaws.connectcampaignsv2#LambdaIntegrationSummary": { "type": "structure", "members": { "functionArn": { "target": "com.amazonaws.connectcampaignsv2#LambdaArn", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Lambda integration summary" } }, "com.amazonaws.connectcampaignsv2#ListCampaigns": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#ListCampaignsRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#ListCampaignsResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Provides summary information about the campaigns under the specified Amazon Connect account.", "smithy.api#http": { "uri": "/v2/campaigns-summary", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "campaignSummaryList" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcampaignsv2#ListCampaignsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.connectcampaignsv2#MaxResults" }, "nextToken": { "target": "com.amazonaws.connectcampaignsv2#NextToken" }, "filters": { "target": "com.amazonaws.connectcampaignsv2#CampaignFilters" } }, "traits": { "smithy.api#documentation": "The request for ListCampaigns API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#ListCampaignsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.connectcampaignsv2#NextToken" }, "campaignSummaryList": { "target": "com.amazonaws.connectcampaignsv2#CampaignSummaryList" } }, "traits": { "smithy.api#documentation": "The response for ListCampaigns API.", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#ListConnectInstanceIntegrations": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#ListConnectInstanceIntegrationsRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#ListConnectInstanceIntegrationsResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Provides summary information about the integration under the specified Connect instance.", "smithy.api#http": { "uri": "/v2/connect-instance/{connectInstanceId}/integrations", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "integrationSummaryList" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcampaignsv2#ListConnectInstanceIntegrationsRequest": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.connectcampaignsv2#MaxResults", "traits": { "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.connectcampaignsv2#NextToken", "traits": { "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "The request for ListConnectInstanceIntegrations API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#ListConnectInstanceIntegrationsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.connectcampaignsv2#NextToken" }, "integrationSummaryList": { "target": "com.amazonaws.connectcampaignsv2#IntegrationSummaryList" } }, "traits": { "smithy.api#documentation": "The response for ListConnectInstanceIntegrations API.", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "List tags for a resource.", "smithy.api#http": { "uri": "/v2/tags/{arn}", "method": "GET" } } }, "com.amazonaws.connectcampaignsv2#ListTagsForResourceRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for ListTagsForResource API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.connectcampaignsv2#TagMap" } }, "traits": { "smithy.api#documentation": "The request for ListTagsForResource API.", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#LocalTimeZoneConfig": { "type": "structure", "members": { "defaultTimeZone": { "target": "com.amazonaws.connectcampaignsv2#TimeZone" }, "localTimeZoneDetection": { "target": "com.amazonaws.connectcampaignsv2#LocalTimeZoneDetection" }, "localTimeZoneDetectionScope": { "target": "com.amazonaws.connectcampaignsv2#LocalTimeZoneDetectionScope" } }, "traits": { "smithy.api#documentation": "Local time zone config" } }, "com.amazonaws.connectcampaignsv2#LocalTimeZoneDetection": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#LocalTimeZoneDetectionType" }, "traits": { "smithy.api#documentation": "Local TimeZone Detection method list", "smithy.api#uniqueItems": {} } }, "com.amazonaws.connectcampaignsv2#LocalTimeZoneDetectionScope": { "type": "string", "traits": { "smithy.api#documentation": "Local TimeZone Detection scope.", "smithy.api#enum": [ { "value": "PRIMARY_ONLY", "name": "PRIMARY_ONLY" }, { "value": "ALL_AVAILABLE", "name": "ALL_AVAILABLE" } ] } }, "com.amazonaws.connectcampaignsv2#LocalTimeZoneDetectionType": { "type": "string", "traits": { "smithy.api#documentation": "Local TimeZone Detection method.", "smithy.api#enum": [ { "value": "ZIP_CODE", "name": "ZIP_CODE" }, { "value": "AREA_CODE", "name": "AREA_CODE" } ] } }, "com.amazonaws.connectcampaignsv2#MaxResults": { "type": "integer", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.", "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.connectcampaignsv2#NextToken": { "type": "string", "traits": { "smithy.api#documentation": "The token for the next set of results.", "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.connectcampaignsv2#ObjectTypeName": { "type": "string", "traits": { "smithy.api#documentation": "Object type name", "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.connectcampaignsv2#ObjectTypeNamesMap": { "type": "map", "key": { "target": "com.amazonaws.connectcampaignsv2#EventType" }, "value": { "target": "com.amazonaws.connectcampaignsv2#ObjectTypeName" }, "traits": { "smithy.api#documentation": "Object type names map." } }, "com.amazonaws.connectcampaignsv2#OpenHours": { "type": "union", "members": { "dailyHours": { "target": "com.amazonaws.connectcampaignsv2#DailyHours" } }, "traits": { "smithy.api#documentation": "Open Hours config" } }, "com.amazonaws.connectcampaignsv2#OutboundRequest": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.connectcampaignsv2#ClientToken", "traits": { "smithy.api#required": {} } }, "expirationTime": { "target": "com.amazonaws.connectcampaignsv2#TimeStamp", "traits": { "smithy.api#required": {} } }, "channelSubtypeParameters": { "target": "com.amazonaws.connectcampaignsv2#ChannelSubtypeParameters", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An outbound request for a campaign." } }, "com.amazonaws.connectcampaignsv2#OutboundRequestList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#OutboundRequest" }, "traits": { "smithy.api#documentation": "A list of outbound requests.", "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.connectcampaignsv2#PacingStrategy": { "type": "union", "members": { "abandonmentRate": { "target": "com.amazonaws.connectcampaignsv2#AbandonmentRatePacingConfig" } }, "traits": { "smithy.api#documentation": "Pacing constraint the dialer may enforce." } }, "com.amazonaws.connectcampaignsv2#PacingStrategyList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#PacingStrategy" }, "traits": { "smithy.api#documentation": "List of pacing strategies the dialer enforces simultaneously.", "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.connectcampaignsv2#PauseCampaign": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#PauseCampaignRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Pauses a campaign for the specified Amazon Connect account.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/pause", "method": "POST" } } }, "com.amazonaws.connectcampaignsv2#PauseCampaignRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for PauseCampaign API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#PredictiveConfig": { "type": "structure", "members": { "bandwidthAllocation": { "target": "com.amazonaws.connectcampaignsv2#BandwidthAllocation", "traits": { "smithy.api#required": {} } }, "pacingStrategies": { "target": "com.amazonaws.connectcampaignsv2#PacingStrategyList", "traits": { "smithy.api#documentation": "Pacing strategies the dialer enforces simultaneously." } } }, "traits": { "smithy.api#documentation": "Predictive config" } }, "com.amazonaws.connectcampaignsv2#PreviewConfig": { "type": "structure", "members": { "bandwidthAllocation": { "target": "com.amazonaws.connectcampaignsv2#BandwidthAllocation", "traits": { "smithy.api#required": {} } }, "timeoutConfig": { "target": "com.amazonaws.connectcampaignsv2#TimeoutConfig", "traits": { "smithy.api#required": {} } }, "agentActions": { "target": "com.amazonaws.connectcampaignsv2#AgentActions" } }, "traits": { "smithy.api#documentation": "Preview config" } }, "com.amazonaws.connectcampaignsv2#ProfileId": { "type": "string", "traits": { "smithy.api#documentation": "Identifier of the customer profile", "smithy.api#pattern": "^[a-f0-9]{32}$" } }, "com.amazonaws.connectcampaignsv2#ProfileOutboundRequest": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.connectcampaignsv2#ClientToken", "traits": { "smithy.api#required": {} } }, "profileId": { "target": "com.amazonaws.connectcampaignsv2#ProfileId", "traits": { "smithy.api#required": {} } }, "expirationTime": { "target": "com.amazonaws.connectcampaignsv2#TimeStamp" }, "eventTriggerContext": { "target": "com.amazonaws.connectcampaignsv2#EventTriggerContext" } }, "traits": { "smithy.api#documentation": "Information about a profile outbound request" } }, "com.amazonaws.connectcampaignsv2#ProfileOutboundRequestFailureCode": { "type": "string", "traits": { "smithy.api#documentation": "Predefined code indicating the error that caused the failure", "smithy.api#enum": [ { "value": "UnknownError", "name": "UNKNOWN_ERROR", "documentation": "Unexpected error during processing of request" }, { "value": "ResourceNotFound", "name": "RESOURCE_NOT_FOUND", "documentation": "The specified resource was not found" }, { "value": "Conflict", "name": "CONFLICT", "documentation": "The specified resource conflicts with another resource" }, { "value": "RequestThrottled", "name": "REQUEST_THROTTLED", "documentation": "Request throttled due to large number of requests" }, { "value": "InvalidInput", "name": "INVALID_INPUT", "documentation": "The request failed to satisfy the constraints specified by the service" } ] } }, "com.amazonaws.connectcampaignsv2#ProfileOutboundRequestId": { "type": "string", "traits": { "smithy.api#documentation": "Identifier of the profile outbound request", "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9_\\-.]*$" } }, "com.amazonaws.connectcampaignsv2#ProfileOutboundRequestList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#ProfileOutboundRequest" }, "traits": { "smithy.api#documentation": "List of profile outbound requests", "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.connectcampaignsv2#ProgressiveConfig": { "type": "structure", "members": { "bandwidthAllocation": { "target": "com.amazonaws.connectcampaignsv2#BandwidthAllocation", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Progressive config" } }, "com.amazonaws.connectcampaignsv2#PutConnectInstanceIntegration": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#PutConnectInstanceIntegrationRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Put or update the integration for the specified Amazon Connect instance.", "smithy.api#http": { "uri": "/v2/connect-instance/{connectInstanceId}/integrations", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#PutConnectInstanceIntegrationRequest": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "integrationConfig": { "target": "com.amazonaws.connectcampaignsv2#IntegrationConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for PutConnectInstanceIntegration API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#PutInstanceCommunicationLimits": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#PutInstanceCommunicationLimitsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Put the instance communication limits. This API is idempotent.", "smithy.api#http": { "uri": "/v2/connect-instance/{connectInstanceId}/communication-limits", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#PutInstanceCommunicationLimitsRequest": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "communicationLimitsConfig": { "target": "com.amazonaws.connectcampaignsv2#InstanceCommunicationLimitsConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for PutInstanceCommunicationLimits API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#PutOutboundRequestBatch": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#PutOutboundRequestBatchRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#PutOutboundRequestBatchResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates outbound requests for the specified campaign Amazon Connect account. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/outbound-requests", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#PutOutboundRequestBatchRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "outboundRequests": { "target": "com.amazonaws.connectcampaignsv2#OutboundRequestList", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for PutOutboundRequestBatch API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#PutOutboundRequestBatchResponse": { "type": "structure", "members": { "successfulRequests": { "target": "com.amazonaws.connectcampaignsv2#SuccessfulRequestList" }, "failedRequests": { "target": "com.amazonaws.connectcampaignsv2#FailedRequestList" } }, "traits": { "smithy.api#documentation": "The response for PutOutboundRequestBatch API.", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#PutProfileOutboundRequestBatch": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#PutProfileOutboundRequestBatchRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#PutProfileOutboundRequestBatchResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Takes in a list of profile outbound requests to be placed as part of an outbound campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/profile-outbound-requests", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#PutProfileOutboundRequestBatchRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "profileOutboundRequests": { "target": "com.amazonaws.connectcampaignsv2#ProfileOutboundRequestList", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for PutProfileOutboundRequestBatch API", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#PutProfileOutboundRequestBatchResponse": { "type": "structure", "members": { "successfulRequests": { "target": "com.amazonaws.connectcampaignsv2#SuccessfulProfileOutboundRequestList" }, "failedRequests": { "target": "com.amazonaws.connectcampaignsv2#FailedProfileOutboundRequestList" } }, "traits": { "smithy.api#documentation": "The response for PutProfileOutboundRequestBatch API", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#QConnectIntegrationConfig": { "type": "structure", "members": { "knowledgeBaseArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Q Connect integration config" } }, "com.amazonaws.connectcampaignsv2#QConnectIntegrationIdentifier": { "type": "structure", "members": { "knowledgeBaseArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Q Connect integration identifier" } }, "com.amazonaws.connectcampaignsv2#QConnectIntegrationSummary": { "type": "structure", "members": { "knowledgeBaseArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Q Connect integration summary" } }, "com.amazonaws.connectcampaignsv2#QueueId": { "type": "string", "traits": { "smithy.api#documentation": "The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.", "smithy.api#length": { "max": 500 } } }, "com.amazonaws.connectcampaignsv2#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "xAmzErrorType": { "target": "com.amazonaws.connectcampaignsv2#XAmazonErrorType", "traits": { "smithy.api#httpHeader": "x-amzn-ErrorType" } } }, "traits": { "smithy.api#documentation": "The specified resource was not found.", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.connectcampaignsv2#RestrictedPeriod": { "type": "structure", "members": { "name": { "target": "com.amazonaws.connectcampaignsv2#RestrictedPeriodName" }, "startDate": { "target": "com.amazonaws.connectcampaignsv2#Iso8601Date", "traits": { "smithy.api#required": {} } }, "endDate": { "target": "com.amazonaws.connectcampaignsv2#Iso8601Date", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Restricted period" } }, "com.amazonaws.connectcampaignsv2#RestrictedPeriodList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#RestrictedPeriod" }, "traits": { "smithy.api#documentation": "List of restricted period" } }, "com.amazonaws.connectcampaignsv2#RestrictedPeriodName": { "type": "string", "traits": { "smithy.api#documentation": "The name of a restricted period.", "smithy.api#length": { "min": 1, "max": 127 } } }, "com.amazonaws.connectcampaignsv2#RestrictedPeriods": { "type": "union", "members": { "restrictedPeriodList": { "target": "com.amazonaws.connectcampaignsv2#RestrictedPeriodList" } }, "traits": { "smithy.api#documentation": "Restricted period config" } }, "com.amazonaws.connectcampaignsv2#ResumeCampaign": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#ResumeCampaignRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Stops a campaign for the specified Amazon Connect account.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/resume", "method": "POST" } } }, "com.amazonaws.connectcampaignsv2#ResumeCampaignRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for ResumeCampaign API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#RingTimeout": { "type": "integer", "traits": { "smithy.api#documentation": "Ring timeout for outbound calls", "smithy.api#range": { "min": 15, "max": 60 } } }, "com.amazonaws.connectcampaignsv2#Schedule": { "type": "structure", "members": { "startTime": { "target": "com.amazonaws.connectcampaignsv2#TimeStamp", "traits": { "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.connectcampaignsv2#TimeStamp", "traits": { "smithy.api#required": {} } }, "refreshFrequency": { "target": "com.amazonaws.connectcampaignsv2#Iso8601Duration" } }, "traits": { "smithy.api#documentation": "Campaign schedule" } }, "com.amazonaws.connectcampaignsv2#ServiceLinkedRoleArn": { "type": "string", "traits": { "smithy.api#documentation": "Service linked role arn", "smithy.api#length": { "max": 256 } } }, "com.amazonaws.connectcampaignsv2#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "xAmzErrorType": { "target": "com.amazonaws.connectcampaignsv2#XAmazonErrorType", "traits": { "smithy.api#httpHeader": "x-amzn-ErrorType" } } }, "traits": { "smithy.api#documentation": "Request would cause a service quota to be exceeded.", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.connectcampaignsv2#SessionId": { "type": "string", "traits": { "smithy.api#documentation": "Session Id for web notification event trigger", "smithy.api#length": { "min": 1, "max": 36 } } }, "com.amazonaws.connectcampaignsv2#SmsChannelSubtypeConfig": { "type": "structure", "members": { "capacity": { "target": "com.amazonaws.connectcampaignsv2#Capacity" }, "outboundMode": { "target": "com.amazonaws.connectcampaignsv2#SmsOutboundMode", "traits": { "smithy.api#required": {} } }, "defaultOutboundConfig": { "target": "com.amazonaws.connectcampaignsv2#SmsOutboundConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "SMS Channel Subtype config" } }, "com.amazonaws.connectcampaignsv2#SmsChannelSubtypeParameters": { "type": "structure", "members": { "destinationPhoneNumber": { "target": "com.amazonaws.connectcampaignsv2#DestinationPhoneNumber", "traits": { "smithy.api#required": {} } }, "connectSourcePhoneNumberArn": { "target": "com.amazonaws.connectcampaignsv2#Arn" }, "templateArn": { "target": "com.amazonaws.connectcampaignsv2#Arn" }, "templateParameters": { "target": "com.amazonaws.connectcampaignsv2#Attributes", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Parameters for the SMS Channel Subtype" } }, "com.amazonaws.connectcampaignsv2#SmsOutboundConfig": { "type": "structure", "members": { "connectSourcePhoneNumberArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } }, "wisdomTemplateArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Default SMS Outbound config" } }, "com.amazonaws.connectcampaignsv2#SmsOutboundMode": { "type": "union", "members": { "agentless": { "target": "com.amazonaws.connectcampaignsv2#AgentlessConfig" } }, "traits": { "smithy.api#documentation": "SMS Outbound Mode" } }, "com.amazonaws.connectcampaignsv2#Source": { "type": "union", "members": { "customerProfilesSegmentArn": { "target": "com.amazonaws.connectcampaignsv2#Arn" }, "eventTrigger": { "target": "com.amazonaws.connectcampaignsv2#EventTrigger" } }, "traits": { "smithy.api#documentation": "Source of the campaign" } }, "com.amazonaws.connectcampaignsv2#SourceEvent": { "type": "string", "traits": { "smithy.api#documentation": "Source event object for event triggers", "smithy.api#length": { "min": 1 } } }, "com.amazonaws.connectcampaignsv2#SourcePhoneNumber": { "type": "string", "traits": { "smithy.api#documentation": "The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.connectcampaignsv2#StartCampaign": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#StartCampaignRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Starts a campaign for the specified Amazon Connect account.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/start", "method": "POST" } } }, "com.amazonaws.connectcampaignsv2#StartCampaignRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for StartCampaign API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#StartInstanceOnboardingJob": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#StartInstanceOnboardingJobRequest" }, "output": { "target": "com.amazonaws.connectcampaignsv2#StartInstanceOnboardingJobResponse" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Onboard the specific Amazon Connect instance to Connect Campaigns.", "smithy.api#http": { "uri": "/v2/connect-instance/{connectInstanceId}/onboarding", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#StartInstanceOnboardingJobRequest": { "type": "structure", "members": { "connectInstanceId": { "target": "com.amazonaws.connectcampaignsv2#InstanceId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "encryptionConfig": { "target": "com.amazonaws.connectcampaignsv2#EncryptionConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for StartInstanceOnboardingJob API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#StartInstanceOnboardingJobResponse": { "type": "structure", "members": { "connectInstanceOnboardingJobStatus": { "target": "com.amazonaws.connectcampaignsv2#InstanceOnboardingJobStatus" } }, "traits": { "smithy.api#documentation": "The response for StartInstanceOnboardingJob API.", "smithy.api#output": {} } }, "com.amazonaws.connectcampaignsv2#StopCampaign": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#StopCampaignRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Stops a campaign for the specified Amazon Connect account.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/stop", "method": "POST" } } }, "com.amazonaws.connectcampaignsv2#StopCampaignRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for StopCampaign API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#SuccessfulCampaignStateResponse": { "type": "structure", "members": { "campaignId": { "target": "com.amazonaws.connectcampaignsv2#CampaignId" }, "state": { "target": "com.amazonaws.connectcampaignsv2#CampaignState" } }, "traits": { "smithy.api#documentation": "Successful response of campaign state" } }, "com.amazonaws.connectcampaignsv2#SuccessfulCampaignStateResponseList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#SuccessfulCampaignStateResponse" }, "traits": { "smithy.api#documentation": "List of successful response of campaign state", "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.connectcampaignsv2#SuccessfulProfileOutboundRequest": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.connectcampaignsv2#ClientToken" }, "id": { "target": "com.amazonaws.connectcampaignsv2#ProfileOutboundRequestId" } }, "traits": { "smithy.api#documentation": "Success details for a profile outbound request" } }, "com.amazonaws.connectcampaignsv2#SuccessfulProfileOutboundRequestList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#SuccessfulProfileOutboundRequest" }, "traits": { "smithy.api#documentation": "List of successful profile outbound requests", "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.connectcampaignsv2#SuccessfulRequest": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.connectcampaignsv2#ClientToken" }, "id": { "target": "com.amazonaws.connectcampaignsv2#DialRequestId" } }, "traits": { "smithy.api#documentation": "A successful request identified by the unique client token." } }, "com.amazonaws.connectcampaignsv2#SuccessfulRequestList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#SuccessfulRequest" }, "traits": { "smithy.api#documentation": "A list of successful requests identified by the unique client token.", "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.connectcampaignsv2#TagKey": { "type": "string", "traits": { "smithy.api#documentation": "The key of tag.", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, "com.amazonaws.connectcampaignsv2#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#TagKey" }, "traits": { "smithy.api#documentation": "List of tag keys.", "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.connectcampaignsv2#TagMap": { "type": "map", "key": { "target": "com.amazonaws.connectcampaignsv2#TagKey" }, "value": { "target": "com.amazonaws.connectcampaignsv2#TagValue" }, "traits": { "smithy.api#documentation": "Tag map with key and value." } }, "com.amazonaws.connectcampaignsv2#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#TagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Tag a resource.", "smithy.api#http": { "uri": "/v2/tags/{arn}", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#TagResourceRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.connectcampaignsv2#TagMap", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for TagResource API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#TagValue": { "type": "string", "traits": { "smithy.api#documentation": "The value of tag.", "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.connectcampaignsv2#TargetRate": { "type": "double", "traits": { "smithy.api#documentation": "Target abandonment rate.", "smithy.api#range": { "min": 0.0, "max": 1.0 } } }, "com.amazonaws.connectcampaignsv2#TelephonyChannelSubtypeConfig": { "type": "structure", "members": { "capacity": { "target": "com.amazonaws.connectcampaignsv2#Capacity" }, "connectQueueId": { "target": "com.amazonaws.connectcampaignsv2#QueueId" }, "outboundMode": { "target": "com.amazonaws.connectcampaignsv2#TelephonyOutboundMode", "traits": { "smithy.api#required": {} } }, "defaultOutboundConfig": { "target": "com.amazonaws.connectcampaignsv2#TelephonyOutboundConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Telephony Channel Subtype config" } }, "com.amazonaws.connectcampaignsv2#TelephonyChannelSubtypeParameters": { "type": "structure", "members": { "destinationPhoneNumber": { "target": "com.amazonaws.connectcampaignsv2#DestinationPhoneNumber", "traits": { "smithy.api#required": {} } }, "attributes": { "target": "com.amazonaws.connectcampaignsv2#Attributes", "traits": { "smithy.api#required": {} } }, "connectSourcePhoneNumber": { "target": "com.amazonaws.connectcampaignsv2#SourcePhoneNumber" }, "answerMachineDetectionConfig": { "target": "com.amazonaws.connectcampaignsv2#AnswerMachineDetectionConfig" }, "ringTimeout": { "target": "com.amazonaws.connectcampaignsv2#RingTimeout" } }, "traits": { "smithy.api#documentation": "Parameters for the Telephony Channel Subtype" } }, "com.amazonaws.connectcampaignsv2#TelephonyOutboundConfig": { "type": "structure", "members": { "connectContactFlowId": { "target": "com.amazonaws.connectcampaignsv2#ContactFlowId", "traits": { "smithy.api#required": {} } }, "connectSourcePhoneNumber": { "target": "com.amazonaws.connectcampaignsv2#SourcePhoneNumber" }, "answerMachineDetectionConfig": { "target": "com.amazonaws.connectcampaignsv2#AnswerMachineDetectionConfig" }, "ringTimeout": { "target": "com.amazonaws.connectcampaignsv2#RingTimeout" } }, "traits": { "smithy.api#documentation": "Default Telephony Outbound config" } }, "com.amazonaws.connectcampaignsv2#TelephonyOutboundMode": { "type": "union", "members": { "progressive": { "target": "com.amazonaws.connectcampaignsv2#ProgressiveConfig" }, "predictive": { "target": "com.amazonaws.connectcampaignsv2#PredictiveConfig" }, "agentless": { "target": "com.amazonaws.connectcampaignsv2#AgentlessConfig" }, "preview": { "target": "com.amazonaws.connectcampaignsv2#PreviewConfig" } }, "traits": { "smithy.api#documentation": "Telephony Outbound Mode" } }, "com.amazonaws.connectcampaignsv2#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "xAmzErrorType": { "target": "com.amazonaws.connectcampaignsv2#XAmazonErrorType", "traits": { "smithy.api#httpHeader": "x-amzn-ErrorType" } } }, "traits": { "smithy.api#documentation": "The request was denied due to request throttling.", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": {} } }, "com.amazonaws.connectcampaignsv2#TimeRange": { "type": "structure", "members": { "startTime": { "target": "com.amazonaws.connectcampaignsv2#Iso8601Time", "traits": { "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.connectcampaignsv2#Iso8601Time", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Time range in 24 hour format" } }, "com.amazonaws.connectcampaignsv2#TimeRangeList": { "type": "list", "member": { "target": "com.amazonaws.connectcampaignsv2#TimeRange" }, "traits": { "smithy.api#documentation": "List of time range" } }, "com.amazonaws.connectcampaignsv2#TimeStamp": { "type": "timestamp", "traits": { "smithy.api#documentation": "Timestamp with no UTC offset or timezone", "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.connectcampaignsv2#TimeWindow": { "type": "structure", "members": { "openHours": { "target": "com.amazonaws.connectcampaignsv2#OpenHours", "traits": { "smithy.api#required": {} } }, "restrictedPeriods": { "target": "com.amazonaws.connectcampaignsv2#RestrictedPeriods" } }, "traits": { "smithy.api#documentation": "Time window config" } }, "com.amazonaws.connectcampaignsv2#TimeZone": { "type": "string", "traits": { "smithy.api#documentation": "Time Zone Id in the IANA format", "smithy.api#length": { "min": 0, "max": 50 }, "smithy.api#pattern": "^[a-zA-Z0-9_\\-/]*$" } }, "com.amazonaws.connectcampaignsv2#TimeoutConfig": { "type": "structure", "members": { "durationInSeconds": { "target": "com.amazonaws.connectcampaignsv2#TimeoutDuration", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Timeout Config for preview contacts." } }, "com.amazonaws.connectcampaignsv2#TimeoutDuration": { "type": "integer", "traits": { "smithy.api#documentation": "Timeout duration for a preview contact in seconds.", "smithy.api#range": { "min": 1, "max": 300 } } }, "com.amazonaws.connectcampaignsv2#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#UntagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ThrottlingException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Untag a resource.", "smithy.api#http": { "uri": "/v2/tags/{arn}", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#UntagResourceRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.connectcampaignsv2#TagKeyList", "traits": { "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for UntagResource API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignChannelSubtypeConfig": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignChannelSubtypeConfigRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the channel subtype config of a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/channel-subtype-config", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignChannelSubtypeConfigRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "channelSubtypeConfig": { "target": "com.amazonaws.connectcampaignsv2#ChannelSubtypeConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for UpdateCampaignChannelSubtypeConfig API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignCommunicationLimits": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignCommunicationLimitsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the communication limits config for a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/communication-limits", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignCommunicationLimitsRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "communicationLimitsOverride": { "target": "com.amazonaws.connectcampaignsv2#CommunicationLimitsConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for UpdateCampaignCommunicationLimits API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignCommunicationTime": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignCommunicationTimeRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the communication time config for a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/communication-time", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignCommunicationTimeRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "communicationTimeConfig": { "target": "com.amazonaws.connectcampaignsv2#CommunicationTimeConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for UpdateCampaignCommunicationTime API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignEntryLimits": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignEntryLimitsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the entry limits config for a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/entry-limits", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignEntryLimitsRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "entryLimitsConfig": { "target": "com.amazonaws.connectcampaignsv2#EntryLimitsConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for UpdateCampaignEntryLimits API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignFlowAssociation": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignFlowAssociationRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the campaign flow associated with a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/flow", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignFlowAssociationRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "connectCampaignFlowArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for UpdateCampaignFlowAssociation API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignName": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignNameRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the name of a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/name", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignNameRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcampaignsv2#CampaignName", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for UpdateCampaignName API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignSchedule": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignScheduleRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the schedule for a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/schedule", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignScheduleRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "schedule": { "target": "com.amazonaws.connectcampaignsv2#Schedule", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for UpdateCampaignSchedule API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignSource": { "type": "operation", "input": { "target": "com.amazonaws.connectcampaignsv2#UpdateCampaignSourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcampaignsv2#AccessDeniedException" }, { "target": "com.amazonaws.connectcampaignsv2#ConflictException" }, { "target": "com.amazonaws.connectcampaignsv2#InternalServerException" }, { "target": "com.amazonaws.connectcampaignsv2#InvalidCampaignStateException" }, { "target": "com.amazonaws.connectcampaignsv2#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcampaignsv2#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the campaign source with a campaign. This API is idempotent.", "smithy.api#http": { "uri": "/v2/campaigns/{id}/source", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcampaignsv2#UpdateCampaignSourceRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcampaignsv2#CampaignId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.connectcampaignsv2#Source", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for UpdateCampaignSource API.", "smithy.api#input": {} } }, "com.amazonaws.connectcampaignsv2#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "xAmzErrorType": { "target": "com.amazonaws.connectcampaignsv2#XAmazonErrorType", "traits": { "smithy.api#httpHeader": "x-amzn-ErrorType" } } }, "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.connectcampaignsv2#WebNotificationContext": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.connectcampaignsv2#SessionId" }, "browserId": { "target": "com.amazonaws.connectcampaignsv2#BrowserId" } }, "traits": { "smithy.api#documentation": "Context metadata for the web notification type channel" } }, "com.amazonaws.connectcampaignsv2#WhatsAppChannelSubtypeConfig": { "type": "structure", "members": { "capacity": { "target": "com.amazonaws.connectcampaignsv2#Capacity" }, "outboundMode": { "target": "com.amazonaws.connectcampaignsv2#WhatsAppOutboundMode", "traits": { "smithy.api#required": {} } }, "defaultOutboundConfig": { "target": "com.amazonaws.connectcampaignsv2#WhatsAppOutboundConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "WhatsApp Channel Subtype config" } }, "com.amazonaws.connectcampaignsv2#WhatsAppChannelSubtypeParameters": { "type": "structure", "members": { "destinationPhoneNumber": { "target": "com.amazonaws.connectcampaignsv2#DestinationPhoneNumber", "traits": { "smithy.api#required": {} } }, "connectSourcePhoneNumberArn": { "target": "com.amazonaws.connectcampaignsv2#Arn" }, "templateArn": { "target": "com.amazonaws.connectcampaignsv2#Arn" }, "templateParameters": { "target": "com.amazonaws.connectcampaignsv2#Attributes", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Parameters for the WhatsApp Channel Subtype" } }, "com.amazonaws.connectcampaignsv2#WhatsAppOutboundConfig": { "type": "structure", "members": { "connectSourcePhoneNumberArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } }, "wisdomTemplateArn": { "target": "com.amazonaws.connectcampaignsv2#Arn", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Default WhatsApp Outbound config" } }, "com.amazonaws.connectcampaignsv2#WhatsAppOutboundMode": { "type": "union", "members": { "agentless": { "target": "com.amazonaws.connectcampaignsv2#AgentlessConfig" } }, "traits": { "smithy.api#documentation": "WhatsApp Outbound Mode" } }, "com.amazonaws.connectcampaignsv2#XAmazonErrorType": { "type": "string", "traits": { "smithy.api#documentation": "A header that defines the error encountered while processing the request." } } } }