QuickSight / Paginator / SearchActionConnectors
SearchActionConnectors¶
- class QuickSight.Paginator.SearchActionConnectors¶
paginator = client.get_paginator('search_action_connectors')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
QuickSight.Client.search_action_connectors()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( AwsAccountId='string', Filters=[ { 'Name': 'ACTION_CONNECTOR_NAME'|'ACTION_CONNECTOR_TYPE'|'QUICKSIGHT_OWNER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER', 'Operator': 'StringEquals'|'StringLike', 'Value': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
AwsAccountId (string) –
[REQUIRED]
The Amazon Web Services account ID in which to search for action connectors.
Filters (list) –
[REQUIRED]
The search filters to apply. You can filter by connector name, type, or user permissions. Maximum of one filter is supported.
(dict) –
A filter used to search for action connectors based on specific criteria.
Name (string) – [REQUIRED]
The name of the filter attribute (e.g., ACTION_CONNECTOR_NAME, ACTION_CONNECTOR_TYPE, QUICKSIGHT_VIEWER_OR_OWNER).
Operator (string) – [REQUIRED]
The comparison operator to use for the filter (e.g., StringEquals, StringLike).
Value (string) – [REQUIRED]
The value to compare against using the specified operator.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'RequestId': 'string', 'Status': 123, 'ActionConnectorSummaries': [ { 'Arn': 'string', 'ActionConnectorId': 'string', 'Type': 'GENERIC_HTTP'|'SERVICENOW_NOW_PLATFORM'|'SALESFORCE_CRM'|'MICROSOFT_OUTLOOK'|'PAGERDUTY_ADVANCE'|'JIRA_CLOUD'|'ATLASSIAN_CONFLUENCE'|'AMAZON_S3'|'AMAZON_BEDROCK_AGENT_RUNTIME'|'AMAZON_BEDROCK_RUNTIME'|'AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME'|'AMAZON_TEXTRACT'|'AMAZON_COMPREHEND'|'AMAZON_COMPREHEND_MEDICAL'|'MICROSOFT_ONEDRIVE'|'MICROSOFT_SHAREPOINT'|'MICROSOFT_TEAMS'|'SAP_BUSINESSPARTNER'|'SAP_PRODUCTMASTERDATA'|'SAP_PHYSICALINVENTORY'|'SAP_BILLOFMATERIALS'|'SAP_MATERIALSTOCK'|'ZENDESK_SUITE'|'SMARTSHEET'|'SLACK'|'ASANA'|'BAMBOO_HR', 'Name': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED', 'Error': { 'Message': 'string', 'Type': 'INTERNAL_FAILURE' } }, ] }
Response Structure
(dict) –
RequestId (string) –
The Amazon Web Services request ID for this operation.
Status (integer) –
The HTTP status code of the request.
ActionConnectorSummaries (list) –
A list of action connector summaries that match the search criteria.
(dict) –
Contains summary information about an action connector, used in list and search operations.
Arn (string) –
The Amazon Resource Name (ARN) of the action connector.
ActionConnectorId (string) –
The unique identifier of the action connector.
Type (string) –
The type of action connector (e.g., SALESFORCE, JIRA, CUSTOM, BEDROCK).
Name (string) –
The name of the action connector.
CreatedTime (datetime) –
The date and time when the action connector was created.
LastUpdatedTime (datetime) –
The date and time when the action connector was last updated.
Status (string) –
The current status of the action connector.
Error (dict) –
Error information if the action connector is in an error state.
Message (string) –
The error message describing what went wrong with the action connector.
Type (string) –
The type or category of the error.