2025/12/11 - Amazon QuickSight - 1 new12 updated api methods
Changes This release adds new GetIdentityContext API, Dashboard customization options for tables and pivot tables, Visual styling options- borders and decals, map GeocodingPreferences, KeyPairCredentials for DataSourceCredentials. Snapshot APIs now support registered users. Parameters limit increased to 400
Retrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs.
Currently, you can call the following APIs with identity-enhanced Credentials
Supported Authentication Methods
This API supports Quick Sight native users, IAM federated users, and Active Directory users. For Quick Sight users authenticated by Amazon Web Services Identity Center, see Identity Center documentation on identity-enhanced IAM role sessions.
Getting Identity-Enhanced Credentials
To obtain identity-enhanced credentials, follow these steps:
Call the GetIdentityContext API to retrieve an identity token for the specified user.
Use the identity token with the STS AssumeRole API to obtain identity-enhanced IAM role session credentials.
Usage with STS AssumeRole
The identity token returned by this API should be used with the STS AssumeRole API to obtain credentials for an identity-enhanced IAM role session. When calling AssumeRole, include the identity token in the ProvidedContexts parameter with ProviderArn set to arn:aws:iam::aws:contextProvider/QuickSight and ContextAssertion set to the identity token received from this API.
The assumed role must allow the sts:SetContext action in addition to sts:AssumeRole in its trust relationship policy. The trust policy should include both actions for the principal that will be assuming the role.
See also: AWS API Documentation
Request Syntax
client.get_identity_context(
AwsAccountId='string',
UserIdentifier={
'UserName': 'string',
'Email': 'string',
'UserArn': 'string'
},
Namespace='string',
SessionExpiresAt=datetime(2015, 1, 1)
)
string
[REQUIRED]
The ID for the Amazon Web Services account that the user whose identity context you want to retrieve is in. Currently, you use the ID for the Amazon Web Services account that contains your Quick Sight account.
dict
[REQUIRED]
The identifier for the user whose identity context you want to retrieve.
UserName (string) --
The name of the user that you want to get identity context for.
Email (string) --
The email address of the user that you want to get identity context for.
UserArn (string) --
The Amazon Resource Name (ARN) of the user that you want to get identity context for.
string
The namespace of the user that you want to get identity context for. This parameter is required when the UserIdentifier is specified using Email or UserName.
datetime
The timestamp at which the session will expire.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'Context': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Context (string) --
The identity context information for the user. This is an identity token that should be used as the ContextAssertion parameter in the STS AssumeRole API call to obtain identity enhanced AWS credentials.
{'Definition': {'ColumnConfigurations': {'DecalSettingsConfiguration': {'CustomDecalSettings': [{'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}]}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': [{'DataFieldBarSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldBarSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}]}},
'ComboChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}},
'Series': [{'DataFieldComboSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'FieldComboSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}]}},
'FilledMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'GeospatialMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'LineChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': {'DataFieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}},
'TableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}}}}}}
Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the analysis.
AnalysisId (string) --
The ID of the analysis.
CreationStatus (string) --
The status of the creation of the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'ColumnConfigurations': {'DecalSettingsConfiguration': {'CustomDecalSettings': [{'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}]}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': [{'DataFieldBarSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldBarSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}]}},
'ComboChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}},
'Series': [{'DataFieldComboSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'FieldComboSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}]}},
'FilledMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'GeospatialMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'LineChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': {'DataFieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}},
'TableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}}}}}}
Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the dashboard.
VersionArn (string) --
The ARN of the dashboard, including the version number of the first version that is created.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The status of the dashboard creation request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Credentials': {'KeyPairCredentials': {'KeyPairUsername': 'string',
'PrivateKey': 'string',
'PrivateKeyPassphrase': 'string'}}}
Creates a data source.
See also: AWS API Documentation
Request Syntax
client.create_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
Type='ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string',
'KeyPairCredentials': {
'KeyPairUsername': 'string',
'PrivateKey': 'string',
'PrivateKeyPassphrase': 'string'
},
'WebProxyCredentials': {
'WebProxyUsername': 'string',
'WebProxyPassword': 'string'
}
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
FolderArns=[
'string',
]
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
string
[REQUIRED]
The type of the data source. To return a list of all data sources, use ListDataSources.
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
dict
The parameters that Amazon Quick Sight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
dict
The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see ``CredentialPair ``.
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Quick Sight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
KeyPairCredentials (dict) --
The credentials for connecting using key-pair.
KeyPairUsername (string) -- [REQUIRED]
Username
PrivateKey (string) -- [REQUIRED]
PrivateKey
PrivateKeyPassphrase (string) --
PrivateKeyPassphrase
WebProxyCredentials (dict) --
The credentials for connecting through a web proxy server.
WebProxyUsername (string) -- [REQUIRED]
The username for authenticating with the web proxy server.
WebProxyPassword (string) -- [REQUIRED]
The password for authenticating with the web proxy server.
list
A list of resource permissions on the data source.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
list
When you create the data source, Amazon Quick Sight adds the data source to these folders.
(string) --
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
CreationStatus (string) --
The status of creating the data source.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'ColumnConfigurations': {'DecalSettingsConfiguration': {'CustomDecalSettings': [{'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}]}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': [{'DataFieldBarSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldBarSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}]}},
'ComboChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}},
'Series': [{'DataFieldComboSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'FieldComboSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}]}},
'FilledMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'GeospatialMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'LineChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': {'DataFieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}},
'TableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}}}}}}
Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Quick Sight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'TemplateId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
TemplateId (string) --
The ID of the template.
CreationStatus (string) --
The template creation status.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'ColumnConfigurations': {'DecalSettingsConfiguration': {'CustomDecalSettings': [{'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}]}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': [{'DataFieldBarSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldBarSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}]}},
'ComboChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}},
'Series': [{'DataFieldComboSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'FieldComboSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}]}},
'FilledMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'GeospatialMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'LineChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': {'DataFieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}},
'TableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}}}}}}
Provides a detailed description of the definition of an analysis.
See also: AWS API Documentation
Request Syntax
client.describe_analysis_definition(
AwsAccountId='string',
AnalysisId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
string
[REQUIRED]
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Definition': {'ColumnConfigurations': {'DecalSettingsConfiguration': {'CustomDecalSettings': [{'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}]}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': [{'DataFieldBarSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldBarSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}]}},
'ComboChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}},
'Series': [{'DataFieldComboSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'FieldComboSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}]}},
'FilledMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'GeospatialMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'LineChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': {'DataFieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}},
'TableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}}}}}}
Provides a detailed description of the definition of a dashboard.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard_definition(
AwsAccountId='string',
DashboardId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
string
[REQUIRED]
The ID for the dashboard.
integer
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
string
The alias name.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Result': {'RegisteredUsers': [{'FileGroups': [{'Files': [{'FormatType': 'CSV '
'| '
'PDF '
'| '
'EXCEL',
'SheetSelections': [{'SelectionScope': 'ALL_VISUALS '
'| '
'SELECTED_VISUALS',
'SheetId': 'string',
'VisualIds': ['string']}]}],
'S3Results': [{'ErrorInfo': [{'ErrorMessage': 'string',
'ErrorType': 'string'}],
'S3DestinationConfiguration': {'BucketConfiguration': {'BucketName': 'string',
'BucketPrefix': 'string',
'BucketRegion': 'string'}},
'S3Uri': 'string'}]}]}]}}
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.
If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state..
Registered user support
This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the user will be returned in RegisteredUsers response attribute. The attribute will contain a list with at most one object in it.
Possible error scenarios
The request fails with an Access Denied error in the following scenarios:
The credentials have expired.
The job was started by a different user.
The registered user doesn't have access to the specified dashboard.
The request succeeds but the job fails in the following scenarios:
DASHBOARD_ACCESS_DENIED - The registered user lost access to the dashboard.
CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in all selected formats.
The request succeeds but the response contains an error code in the following scenarios:
CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in some selected formats.
RLS_CHANGED - Row-level security settings have changed. Re-run the job with current settings.
CLS_CHANGED - Column-level security settings have changed. Re-run the job with current settings.
DATASET_DELETED - The dataset has been deleted. Verify the dataset exists before re-running the job.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard_snapshot_job_result(
AwsAccountId='string',
DashboardId='string',
SnapshotJobId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
string
[REQUIRED]
The ID of the dashboard that you have started a snapshot job for.
string
[REQUIRED]
The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
dict
Response Syntax
{
'Arn': 'string',
'JobStatus': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'Result': {
'AnonymousUsers': [
{
'FileGroups': [
{
'Files': [
{
'SheetSelections': [
{
'SheetId': 'string',
'SelectionScope': 'ALL_VISUALS'|'SELECTED_VISUALS',
'VisualIds': [
'string',
]
},
],
'FormatType': 'CSV'|'PDF'|'EXCEL'
},
],
'S3Results': [
{
'S3DestinationConfiguration': {
'BucketConfiguration': {
'BucketName': 'string',
'BucketPrefix': 'string',
'BucketRegion': 'string'
}
},
'S3Uri': 'string',
'ErrorInfo': [
{
'ErrorMessage': 'string',
'ErrorType': 'string'
},
]
},
]
},
]
},
],
'RegisteredUsers': [
{
'FileGroups': [
{
'Files': [
{
'SheetSelections': [
{
'SheetId': 'string',
'SelectionScope': 'ALL_VISUALS'|'SELECTED_VISUALS',
'VisualIds': [
'string',
]
},
],
'FormatType': 'CSV'|'PDF'|'EXCEL'
},
],
'S3Results': [
{
'S3DestinationConfiguration': {
'BucketConfiguration': {
'BucketName': 'string',
'BucketPrefix': 'string',
'BucketRegion': 'string'
}
},
'S3Uri': 'string',
'ErrorInfo': [
{
'ErrorMessage': 'string',
'ErrorType': 'string'
},
]
},
]
},
]
},
]
},
'ErrorInfo': {
'ErrorMessage': 'string',
'ErrorType': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.
JobStatus (string) --
Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.
CreatedTime (datetime) --
The time that a snapshot job was created.
LastUpdatedTime (datetime) --
The time that a snapshot job status was last updated.
Result (dict) --
The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.
AnonymousUsers (list) --
A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.
(dict) --
A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.
FileGroups (list) --
A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.
(dict) --
A structure that contains information on the generated snapshot file groups.
Files (list) --
A list of SnapshotFile objects.
(dict) --
A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.
SheetSelections (list) --
A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.
(dict) --
A structure that contains information that identifies the snapshot that needs to be generated.
SheetId (string) --
The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.
SelectionScope (string) --
The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.
ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.
SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.
VisualIds (list) --
A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.
(string) --
FormatType (string) --
The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.
S3Results (list) --
A list of SnapshotJobS3Result objects.
(dict) --
The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.
S3DestinationConfiguration (dict) --
A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.
BucketConfiguration (dict) --
A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.
BucketName (string) --
The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
BucketPrefix (string) --
The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
BucketRegion (string) --
The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.
S3Uri (string) --
The Amazon S3 Uri.
ErrorInfo (list) --
An array of error records that describe any failures that occur while the dashboard snapshot job runs.
(dict) --
Information on the error that caused the snapshot job to fail.
ErrorMessage (string) --
The error message.
ErrorType (string) --
The error type.
RegisteredUsers (list) --
A list of RegisteredUserSnapshotJobResult objects that contain information about files that are requested for registered user during a StartDashboardSnapshotJob API call.
(dict) --
A structure that contains information about files that are requested for registered user during a StartDashboardSnapshotJob API call.
FileGroups (list) --
A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested for registered user during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.
(dict) --
A structure that contains information on the generated snapshot file groups.
Files (list) --
A list of SnapshotFile objects.
(dict) --
A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.
SheetSelections (list) --
A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.
(dict) --
A structure that contains information that identifies the snapshot that needs to be generated.
SheetId (string) --
The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.
SelectionScope (string) --
The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.
ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.
SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.
VisualIds (list) --
A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.
(string) --
FormatType (string) --
The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.
S3Results (list) --
A list of SnapshotJobS3Result objects.
(dict) --
The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.
S3DestinationConfiguration (dict) --
A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.
BucketConfiguration (dict) --
A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.
BucketName (string) --
The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
BucketPrefix (string) --
The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
BucketRegion (string) --
The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.
S3Uri (string) --
The Amazon S3 Uri.
ErrorInfo (list) --
An array of error records that describe any failures that occur while the dashboard snapshot job runs.
(dict) --
Information on the error that caused the snapshot job to fail.
ErrorMessage (string) --
The error message.
ErrorType (string) --
The error type.
ErrorInfo (dict) --
Displays information for the error that caused a job to fail.
ErrorMessage (string) --
The error message.
ErrorType (string) --
The error type.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request
{'Definition': {'ColumnConfigurations': {'DecalSettingsConfiguration': {'CustomDecalSettings': [{'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}]}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': [{'DataFieldBarSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldBarSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}]}},
'ComboChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}},
'Series': [{'DataFieldComboSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'FieldComboSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}]}},
'FilledMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'GeospatialMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'LineChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': {'DataFieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}},
'TableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}}}}}}
Provides a detailed description of the definition of a template.
See also: AWS API Documentation
Request Syntax
client.describe_template_definition(
AwsAccountId='string',
TemplateId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
string
[REQUIRED]
The ID of the template that you're describing.
integer
The version number of the template.
string
The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Definition': {'ColumnConfigurations': {'DecalSettingsConfiguration': {'CustomDecalSettings': [{'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}]}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': [{'DataFieldBarSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldBarSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}]}},
'ComboChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}},
'Series': [{'DataFieldComboSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'FieldComboSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}]}},
'FilledMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'GeospatialMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'LineChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': {'DataFieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}},
'TableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}}}}}}
Updates an analysis in Amazon Quick Sight
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the analysis that you're updating.
AnalysisId (string) --
The ID of the analysis.
UpdateStatus (string) --
The update status of the last update that was made to the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'ColumnConfigurations': {'DecalSettingsConfiguration': {'CustomDecalSettings': [{'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}]}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': [{'DataFieldBarSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldBarSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}]}},
'ComboChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}},
'Series': [{'DataFieldComboSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'FieldComboSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}]}},
'FilledMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'GeospatialMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'LineChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': {'DataFieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}},
'TableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}}}}}}
Updates a dashboard in an Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
VersionArn (string) --
The ARN of the dashboard, including the version number.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The creation status of the request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Credentials': {'KeyPairCredentials': {'KeyPairUsername': 'string',
'PrivateKey': 'string',
'PrivateKeyPassphrase': 'string'}}}
Updates a data source.
See also: AWS API Documentation
Request Syntax
client.update_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string',
'KeyPairCredentials': {
'KeyPairUsername': 'string',
'PrivateKey': 'string',
'PrivateKeyPassphrase': 'string'
},
'WebProxyCredentials': {
'WebProxyUsername': 'string',
'WebProxyPassword': 'string'
}
},
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
}
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
dict
The parameters that Amazon Quick Sight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
dict
The credentials that Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see ``CredentialPair ``.
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Quick Sight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
KeyPairCredentials (dict) --
The credentials for connecting using key-pair.
KeyPairUsername (string) -- [REQUIRED]
Username
PrivateKey (string) -- [REQUIRED]
PrivateKey
PrivateKeyPassphrase (string) --
PrivateKeyPassphrase
WebProxyCredentials (dict) --
The credentials for connecting through a web proxy server.
WebProxyUsername (string) -- [REQUIRED]
The username for authenticating with the web proxy server.
WebProxyPassword (string) -- [REQUIRED]
The password for authenticating with the web proxy server.
dict
Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
UpdateStatus (string) --
The update status of the data source's last update.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'ColumnConfigurations': {'DecalSettingsConfiguration': {'CustomDecalSettings': [{'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}]}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': [{'DataFieldBarSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldBarSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}]}},
'ComboChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}},
'Series': [{'DataFieldComboSeriesItem': {'FieldId': 'string',
'FieldValue': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'FieldComboSeriesItem': {'FieldId': 'string',
'Settings': {'BorderSettings': {'BorderColor': 'string',
'BorderVisibility': 'HIDDEN '
'| '
'VISIBLE',
'BorderWidth': 'string'},
'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'},
'LineStyleSettings': {'LineInterpolation': 'LINEAR '
'| '
'SMOOTH '
'| '
'STEPPED',
'LineStyle': 'SOLID '
'| '
'DOTTED '
'| '
'DASHED',
'LineVisibility': 'HIDDEN '
'| '
'VISIBLE',
'LineWidth': 'string'},
'MarkerStyleSettings': {'MarkerColor': 'string',
'MarkerShape': 'CIRCLE '
'| '
'TRIANGLE '
'| '
'SQUARE '
'| '
'DIAMOND '
'| '
'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}]}},
'FilledMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'GeospatialMapVisual': {'GeocodingPreferences': [{'Preference': {'Coordinate': {'Latitude': 'double',
'Longitude': 'double'},
'GeocoderHierarchy': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}},
'RequestKey': {'City': 'string',
'Country': 'string',
'County': 'string',
'PostCode': 'string',
'State': 'string'}}]},
'LineChartVisual': {'ChartConfiguration': {'DefaultSeriesSettings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}},
'Series': {'DataFieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}},
'FieldSeriesItem': {'Settings': {'DecalSettings': {'DecalColor': 'string',
'DecalPatternType': 'SOLID '
'| '
'DIAGONAL_MEDIUM '
'| '
'CIRCLE_MEDIUM '
'| '
'DIAMOND_GRID_MEDIUM '
'| '
'CHECKERBOARD_MEDIUM '
'| '
'TRIANGLE_MEDIUM '
'| '
'DIAGONAL_OPPOSITE_MEDIUM '
'| '
'DIAMOND_MEDIUM '
'| '
'DIAGONAL_LARGE '
'| '
'CIRCLE_LARGE '
'| '
'DIAMOND_GRID_LARGE '
'| '
'CHECKERBOARD_LARGE '
'| '
'TRIANGLE_LARGE '
'| '
'DIAGONAL_OPPOSITE_LARGE '
'| '
'DIAMOND_LARGE '
'| '
'DIAGONAL_SMALL '
'| '
'CIRCLE_SMALL '
'| '
'DIAMOND_GRID_SMALL '
'| '
'CHECKERBOARD_SMALL '
'| '
'TRIANGLE_SMALL '
'| '
'DIAGONAL_OPPOSITE_SMALL '
'| '
'DIAMOND_SMALL',
'DecalStyleType': 'Manual '
'| '
'Auto',
'DecalVisibility': 'HIDDEN '
'| '
'VISIBLE',
'ElementValue': 'string'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}},
'TableVisual': {'ChartConfiguration': {'DashboardCustomizationVisualOptions': {'FieldsConfiguration': {'AdditionalFields': [{'ColumnName': 'string',
'DataSetIdentifier': 'string'}],
'Status': 'ENABLED '
'| '
'DISABLED'}}}}}}}}
Updates a template from an existing Amazon Quick Sight analysis or another template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'TemplateId': 'string',
'Arn': 'string',
'VersionArn': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
TemplateId (string) --
The ID for the template.
Arn (string) --
The Amazon Resource Name (ARN) for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
CreationStatus (string) --
The creation status of the template.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.