ConnectCampaignService / Client / list_campaigns
list_campaigns#
- ConnectCampaignService.Client.list_campaigns(**kwargs)#
Provides summary information about the campaigns under the specified Amazon Connect account.
See also: AWS API Documentation
Request Syntax
response = client.list_campaigns( maxResults=123, nextToken='string', filters={ 'instanceIdFilter': { 'value': 'string', 'operator': 'Eq' } } )
- Parameters:
maxResults (integer) – The maximum number of results to return per page.
nextToken (string) – The token for the next set of results.
filters (dict) –
Filter model by type
instanceIdFilter (dict) –
Connect instance identifier filter
value (string) – [REQUIRED]
Amazon Connect Instance Id
operator (string) – [REQUIRED]
Operators for Connect instance identifier filter
- Return type:
dict
- Returns:
Response Syntax
{ 'nextToken': 'string', 'campaignSummaryList': [ { 'id': 'string', 'arn': 'string', 'name': 'string', 'connectInstanceId': 'string' }, ] }
Response Structure
(dict) –
ListCampaignsResponse
nextToken (string) –
The token for the next set of results.
campaignSummaryList (list) –
A list of Amazon Connect campaigns.
(dict) –
An Amazon Connect campaign summary.
id (string) –
Identifier representing a Campaign
arn (string) –
The resource name of an Amazon Connect campaign.
name (string) –
The name of an Amazon Connect Campaign name.
connectInstanceId (string) –
Amazon Connect Instance Id
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException