Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

DescribeCampaign - Amazon Connect

DescribeCampaign

Describes an outbound campaign.

Request Syntax

GET /v2/campaigns/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

The identifier of the outbound campaign.

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [a-zA-Z0-9\-:/]*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "campaign": { "arn": "string", "channelSubtypeConfig": { "email": { "capacity": number, "defaultOutboundConfig": { "connectSourceEmailAddress": "string", "sourceEmailAddressDisplayName": "string", "wisdomTemplateArn": "string" }, "outboundMode": { ... } }, "sms": { "capacity": number, "defaultOutboundConfig": { "connectSourcePhoneNumberArn": "string", "wisdomTemplateArn": "string" }, "outboundMode": { ... } }, "telephony": { "capacity": number, "connectQueueId": "string", "defaultOutboundConfig": { "answerMachineDetectionConfig": { "awaitAnswerMachinePrompt": boolean, "enableAnswerMachineDetection": boolean }, "connectContactFlowId": "string", "connectSourcePhoneNumber": "string" }, "outboundMode": { ... } } }, "communicationLimitsOverride": { "allChannelSubtypes": { ... } }, "communicationTimeConfig": { "email": { "openHours": { ... }, "restrictedPeriods": { ... } }, "localTimeZoneConfig": { "defaultTimeZone": "string", "localTimeZoneDetection": [ "string" ] }, "sms": { "openHours": { ... }, "restrictedPeriods": { ... } }, "telephony": { "openHours": { ... }, "restrictedPeriods": { ... } } }, "connectCampaignFlowArn": "string", "connectInstanceId": "string", "id": "string", "name": "string", "schedule": { "endTime": "string", "refreshFrequency": "string", "startTime": "string" }, "source": { ... }, "tags": { "string" : "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

campaign

The configuration for an outbound campaign.

Type: Campaign object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the outbound campaigns.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.