aws-sdk-quicksight 1.183.0 → 1.185.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +1636 -55
- data/lib/aws-sdk-quicksight/client_api.rb +1078 -0
- data/lib/aws-sdk-quicksight/types.rb +2385 -0
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/sig/client.rbs +500 -0
- data/sig/params.rbs +15 -0
- data/sig/types.rbs +654 -0
- metadata +1 -1
|
@@ -1875,6 +1875,99 @@ module Aws::QuickSight
|
|
|
1875
1875
|
req.send_request(options)
|
|
1876
1876
|
end
|
|
1877
1877
|
|
|
1878
|
+
# Creates an agent in Amazon QuickSight.
|
|
1879
|
+
#
|
|
1880
|
+
# @option params [Array<String>] :spaces
|
|
1881
|
+
# The Amazon Resource Names (ARNs) of the spaces to attach to the agent.
|
|
1882
|
+
#
|
|
1883
|
+
# @option params [Array<String>] :action_connectors
|
|
1884
|
+
# The Amazon Resource Names (ARNs) of the action connectors to attach to
|
|
1885
|
+
# the agent.
|
|
1886
|
+
#
|
|
1887
|
+
# @option params [required, String] :aws_account_id
|
|
1888
|
+
# The ID of the Amazon Web Services account that contains the agent.
|
|
1889
|
+
#
|
|
1890
|
+
# @option params [required, String] :agent_id
|
|
1891
|
+
# A unique identifier for the agent.
|
|
1892
|
+
#
|
|
1893
|
+
# @option params [required, String] :name
|
|
1894
|
+
# The name of the agent.
|
|
1895
|
+
#
|
|
1896
|
+
# @option params [String] :description
|
|
1897
|
+
# A description of the agent.
|
|
1898
|
+
#
|
|
1899
|
+
# @option params [String] :icon_id
|
|
1900
|
+
# The icon identifier for the agent.
|
|
1901
|
+
#
|
|
1902
|
+
# @option params [Array<String>] :starter_prompts
|
|
1903
|
+
# A list of starter prompts that are displayed to users when they begin
|
|
1904
|
+
# interacting with the agent.
|
|
1905
|
+
#
|
|
1906
|
+
# @option params [String] :welcome_message
|
|
1907
|
+
# The welcome message that is displayed when a user starts a
|
|
1908
|
+
# conversation with the agent.
|
|
1909
|
+
#
|
|
1910
|
+
# @option params [String] :agent_lifecycle
|
|
1911
|
+
# The lifecycle state of the agent. Valid values are `PREVIEW` and
|
|
1912
|
+
# `PUBLISHED`.
|
|
1913
|
+
#
|
|
1914
|
+
# @option params [Types::CustomPromptInput] :custom_prompt_input
|
|
1915
|
+
# The custom prompt configuration for the agent.
|
|
1916
|
+
#
|
|
1917
|
+
# @return [Types::CreateAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1918
|
+
#
|
|
1919
|
+
# * {Types::CreateAgentResponse#arn #arn} => String
|
|
1920
|
+
# * {Types::CreateAgentResponse#agent_id #agent_id} => String
|
|
1921
|
+
# * {Types::CreateAgentResponse#agent_status #agent_status} => String
|
|
1922
|
+
# * {Types::CreateAgentResponse#agent_name #agent_name} => String
|
|
1923
|
+
# * {Types::CreateAgentResponse#request_id #request_id} => String
|
|
1924
|
+
#
|
|
1925
|
+
# @example Request syntax with placeholder values
|
|
1926
|
+
#
|
|
1927
|
+
# resp = client.create_agent({
|
|
1928
|
+
# spaces: ["Arn"],
|
|
1929
|
+
# action_connectors: ["Arn"],
|
|
1930
|
+
# aws_account_id: "AwsAccountId", # required
|
|
1931
|
+
# agent_id: "AgentId", # required
|
|
1932
|
+
# name: "AgentName", # required
|
|
1933
|
+
# description: "AgentDescription",
|
|
1934
|
+
# icon_id: "IconId",
|
|
1935
|
+
# starter_prompts: ["StarterPrompt"],
|
|
1936
|
+
# welcome_message: "WelcomeMessage",
|
|
1937
|
+
# agent_lifecycle: "PREVIEW", # accepts PREVIEW, PUBLISHED
|
|
1938
|
+
# custom_prompt_input: {
|
|
1939
|
+
# existing_prompt: {
|
|
1940
|
+
# model_profile_id: "ModelProfileId", # required
|
|
1941
|
+
# subscription_id: "SubscriptionId", # required
|
|
1942
|
+
# qbs_aws_account_id: "QbsAwsAccountId", # required
|
|
1943
|
+
# },
|
|
1944
|
+
# new_prompt: {
|
|
1945
|
+
# response_length: "StyleDescription",
|
|
1946
|
+
# output_style: "StyleDescription",
|
|
1947
|
+
# identity: "StyleDescription",
|
|
1948
|
+
# tone: "StyleDescription",
|
|
1949
|
+
# custom_instructions: "StyleDescription",
|
|
1950
|
+
# },
|
|
1951
|
+
# },
|
|
1952
|
+
# })
|
|
1953
|
+
#
|
|
1954
|
+
# @example Response structure
|
|
1955
|
+
#
|
|
1956
|
+
# resp.arn #=> String
|
|
1957
|
+
# resp.agent_id #=> String
|
|
1958
|
+
# resp.agent_status #=> String, one of "ACTIVE", "UPDATING", "FAILED", "CREATING"
|
|
1959
|
+
# resp.agent_name #=> String
|
|
1960
|
+
# resp.request_id #=> String
|
|
1961
|
+
#
|
|
1962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAgent AWS API Documentation
|
|
1963
|
+
#
|
|
1964
|
+
# @overload create_agent(params = {})
|
|
1965
|
+
# @param [Hash] params ({})
|
|
1966
|
+
def create_agent(params = {}, options = {})
|
|
1967
|
+
req = build_request(:create_agent, params)
|
|
1968
|
+
req.send_request(options)
|
|
1969
|
+
end
|
|
1970
|
+
|
|
1878
1971
|
# Creates an analysis in Amazon Quick Sight. Analyses can be created
|
|
1879
1972
|
# either from a template or from an `AnalysisDefinition`.
|
|
1880
1973
|
#
|
|
@@ -3944,6 +4037,88 @@ module Aws::QuickSight
|
|
|
3944
4037
|
req.send_request(options)
|
|
3945
4038
|
end
|
|
3946
4039
|
|
|
4040
|
+
# Creates a new flow in the specified Amazon Web Services account.
|
|
4041
|
+
# Creates both a DRAFT and PUBLISHED (auto-published) version.
|
|
4042
|
+
#
|
|
4043
|
+
# This operation is idempotent. Supply a `ClientToken` to safely retry
|
|
4044
|
+
# without creating duplicate resources.
|
|
4045
|
+
#
|
|
4046
|
+
# @option params [required, String] :aws_account_id
|
|
4047
|
+
# The ID of the Amazon Web Services account where you want to create the
|
|
4048
|
+
# flow.
|
|
4049
|
+
#
|
|
4050
|
+
# @option params [required, String] :name
|
|
4051
|
+
# The display name for the flow.
|
|
4052
|
+
#
|
|
4053
|
+
# @option params [String] :description
|
|
4054
|
+
# The description for the flow.
|
|
4055
|
+
#
|
|
4056
|
+
# @option params [required, Hash,Array,String,Numeric,Boolean] :flow_definition
|
|
4057
|
+
# The definition of the flow, specifying the steps and configurations.
|
|
4058
|
+
# This is the flow definition in Quick Flow's internal format. The
|
|
4059
|
+
# format is subject to change.
|
|
4060
|
+
#
|
|
4061
|
+
# <note markdown="1"> Always derive or depend on the flow definition from the `DescribeFlow`
|
|
4062
|
+
# operation to ensure you are working with the latest format.
|
|
4063
|
+
#
|
|
4064
|
+
# </note>
|
|
4065
|
+
#
|
|
4066
|
+
# Document type used to carry open content
|
|
4067
|
+
# (Hash,Array,String,Numeric,Boolean). A document type value is
|
|
4068
|
+
# serialized using the same format as its surroundings and requires no
|
|
4069
|
+
# additional encoding or escaping.
|
|
4070
|
+
#
|
|
4071
|
+
# @option params [Array<Types::Permission>] :permissions
|
|
4072
|
+
# Initial permissions for the flow. If omitted, the flow is created
|
|
4073
|
+
# without any permissions.
|
|
4074
|
+
#
|
|
4075
|
+
# @option params [String] :client_token
|
|
4076
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
4077
|
+
# idempotency of the request.
|
|
4078
|
+
#
|
|
4079
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
4080
|
+
# not need to pass this option.**
|
|
4081
|
+
#
|
|
4082
|
+
# @return [Types::CreateFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4083
|
+
#
|
|
4084
|
+
# * {Types::CreateFlowResponse#arn #arn} => String
|
|
4085
|
+
# * {Types::CreateFlowResponse#flow_id #flow_id} => String
|
|
4086
|
+
# * {Types::CreateFlowResponse#request_id #request_id} => String
|
|
4087
|
+
# * {Types::CreateFlowResponse#status #status} => Integer
|
|
4088
|
+
#
|
|
4089
|
+
# @example Request syntax with placeholder values
|
|
4090
|
+
#
|
|
4091
|
+
# resp = client.create_flow({
|
|
4092
|
+
# aws_account_id: "AccountId", # required
|
|
4093
|
+
# name: "TitleInput", # required
|
|
4094
|
+
# description: "FlowDescriptionInput",
|
|
4095
|
+
# flow_definition: { # required
|
|
4096
|
+
# },
|
|
4097
|
+
# permissions: [
|
|
4098
|
+
# {
|
|
4099
|
+
# actions: ["ActionsListMemberString"], # required
|
|
4100
|
+
# principal: "PermissionPrincipalString", # required
|
|
4101
|
+
# },
|
|
4102
|
+
# ],
|
|
4103
|
+
# client_token: "CreateFlowRequestClientTokenString",
|
|
4104
|
+
# })
|
|
4105
|
+
#
|
|
4106
|
+
# @example Response structure
|
|
4107
|
+
#
|
|
4108
|
+
# resp.arn #=> String
|
|
4109
|
+
# resp.flow_id #=> String
|
|
4110
|
+
# resp.request_id #=> String
|
|
4111
|
+
# resp.status #=> Integer
|
|
4112
|
+
#
|
|
4113
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFlow AWS API Documentation
|
|
4114
|
+
#
|
|
4115
|
+
# @overload create_flow(params = {})
|
|
4116
|
+
# @param [Hash] params ({})
|
|
4117
|
+
def create_flow(params = {}, options = {})
|
|
4118
|
+
req = build_request(:create_flow, params)
|
|
4119
|
+
req.send_request(options)
|
|
4120
|
+
end
|
|
4121
|
+
|
|
3947
4122
|
# Creates an empty shared folder.
|
|
3948
4123
|
#
|
|
3949
4124
|
# @option params [required, String] :aws_account_id
|
|
@@ -4389,6 +4564,104 @@ module Aws::QuickSight
|
|
|
4389
4564
|
req.send_request(options)
|
|
4390
4565
|
end
|
|
4391
4566
|
|
|
4567
|
+
# Creates an OAuthClientApplication.
|
|
4568
|
+
#
|
|
4569
|
+
# @option params [required, String] :aws_account_id
|
|
4570
|
+
# The Amazon Web Services account ID.
|
|
4571
|
+
#
|
|
4572
|
+
# @option params [required, String] :o_auth_client_application_id
|
|
4573
|
+
# An ID for the OAuthClientApplication that you want to create. This ID
|
|
4574
|
+
# is unique per Amazon Web Services Region for each Amazon Web Services
|
|
4575
|
+
# account.
|
|
4576
|
+
#
|
|
4577
|
+
# @option params [required, String] :name
|
|
4578
|
+
# The display name for the OAuthClientApplication.
|
|
4579
|
+
#
|
|
4580
|
+
# @option params [required, String] :o_auth_client_authentication_type
|
|
4581
|
+
# The authentication type to use for the OAuthClientApplication. This
|
|
4582
|
+
# determines the OAuth 2.0 grant flow that is used when the data source
|
|
4583
|
+
# connects to the identity provider. Valid values are `TOKEN`.
|
|
4584
|
+
#
|
|
4585
|
+
# @option params [required, String] :client_id
|
|
4586
|
+
# The client ID of the OAuth application that is registered with the
|
|
4587
|
+
# identity provider.
|
|
4588
|
+
#
|
|
4589
|
+
# @option params [required, String] :client_secret
|
|
4590
|
+
# The client secret of the OAuth application that is registered with the
|
|
4591
|
+
# identity provider.
|
|
4592
|
+
#
|
|
4593
|
+
# @option params [required, String] :o_auth_token_endpoint_url
|
|
4594
|
+
# The token endpoint URL of the identity provider that is used to obtain
|
|
4595
|
+
# access tokens.
|
|
4596
|
+
#
|
|
4597
|
+
# @option params [String] :o_auth_authorization_endpoint_url
|
|
4598
|
+
# The authorization endpoint URL of the identity provider that is used
|
|
4599
|
+
# to obtain authorization codes.
|
|
4600
|
+
#
|
|
4601
|
+
# @option params [String] :o_auth_scopes
|
|
4602
|
+
# The OAuth scopes that are requested when the OAuthClientApplication
|
|
4603
|
+
# obtains an access token from the identity provider.
|
|
4604
|
+
#
|
|
4605
|
+
# @option params [String] :data_source_type
|
|
4606
|
+
# The type of data source that the OAuthClientApplication is used with.
|
|
4607
|
+
# Valid values are `SNOWFLAKE`.
|
|
4608
|
+
#
|
|
4609
|
+
# @option params [Types::VpcConnectionProperties] :identity_provider_vpc_connection_properties
|
|
4610
|
+
# VPC connection properties.
|
|
4611
|
+
#
|
|
4612
|
+
# @option params [Array<Types::Tag>] :tags
|
|
4613
|
+
# Contains a map of the key-value pairs for the resource tag or tags
|
|
4614
|
+
# assigned to the OAuthClientApplication.
|
|
4615
|
+
#
|
|
4616
|
+
# @return [Types::CreateOAuthClientApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4617
|
+
#
|
|
4618
|
+
# * {Types::CreateOAuthClientApplicationResponse#arn #arn} => String
|
|
4619
|
+
# * {Types::CreateOAuthClientApplicationResponse#o_auth_client_application_id #o_auth_client_application_id} => String
|
|
4620
|
+
# * {Types::CreateOAuthClientApplicationResponse#creation_status #creation_status} => String
|
|
4621
|
+
# * {Types::CreateOAuthClientApplicationResponse#request_id #request_id} => String
|
|
4622
|
+
# * {Types::CreateOAuthClientApplicationResponse#status #status} => Integer
|
|
4623
|
+
#
|
|
4624
|
+
# @example Request syntax with placeholder values
|
|
4625
|
+
#
|
|
4626
|
+
# resp = client.create_o_auth_client_application({
|
|
4627
|
+
# aws_account_id: "AwsAccountId", # required
|
|
4628
|
+
# o_auth_client_application_id: "OAuthClientApplicationId", # required
|
|
4629
|
+
# name: "ResourceName", # required
|
|
4630
|
+
# o_auth_client_authentication_type: "TOKEN", # required, accepts TOKEN
|
|
4631
|
+
# client_id: "OAuthClientId", # required
|
|
4632
|
+
# client_secret: "OAuthClientSecret", # required
|
|
4633
|
+
# o_auth_token_endpoint_url: "OAuthTokenEndpointUrl", # required
|
|
4634
|
+
# o_auth_authorization_endpoint_url: "OAuthAuthorizationEndpointUrl",
|
|
4635
|
+
# o_auth_scopes: "OAuthScopesString",
|
|
4636
|
+
# data_source_type: "ADOBE_ANALYTICS", # accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, S3_TABLES, 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
|
|
4637
|
+
# identity_provider_vpc_connection_properties: {
|
|
4638
|
+
# vpc_connection_arn: "Arn", # required
|
|
4639
|
+
# },
|
|
4640
|
+
# tags: [
|
|
4641
|
+
# {
|
|
4642
|
+
# key: "TagKey", # required
|
|
4643
|
+
# value: "TagValue", # required
|
|
4644
|
+
# },
|
|
4645
|
+
# ],
|
|
4646
|
+
# })
|
|
4647
|
+
#
|
|
4648
|
+
# @example Response structure
|
|
4649
|
+
#
|
|
4650
|
+
# resp.arn #=> String
|
|
4651
|
+
# resp.o_auth_client_application_id #=> String
|
|
4652
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
|
4653
|
+
# resp.request_id #=> String
|
|
4654
|
+
# resp.status #=> Integer
|
|
4655
|
+
#
|
|
4656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateOAuthClientApplication AWS API Documentation
|
|
4657
|
+
#
|
|
4658
|
+
# @overload create_o_auth_client_application(params = {})
|
|
4659
|
+
# @param [Hash] params ({})
|
|
4660
|
+
def create_o_auth_client_application(params = {}, options = {})
|
|
4661
|
+
req = build_request(:create_o_auth_client_application, params)
|
|
4662
|
+
req.send_request(options)
|
|
4663
|
+
end
|
|
4664
|
+
|
|
4392
4665
|
# Creates a refresh schedule for a dataset. You can create up to 5
|
|
4393
4666
|
# different schedules for a single dataset.
|
|
4394
4667
|
#
|
|
@@ -4492,6 +4765,52 @@ module Aws::QuickSight
|
|
|
4492
4765
|
req.send_request(options)
|
|
4493
4766
|
end
|
|
4494
4767
|
|
|
4768
|
+
# Creates a new Amazon QuickSight space. A space is a collection of
|
|
4769
|
+
# resources that can be used to organize and manage QuickSight assets.
|
|
4770
|
+
#
|
|
4771
|
+
# @option params [required, String] :aws_account_id
|
|
4772
|
+
# The ID of the Amazon Web Services account that contains the space.
|
|
4773
|
+
#
|
|
4774
|
+
# @option params [required, String] :space_id
|
|
4775
|
+
# The ID of the space. This ID is unique per Amazon Web Services Region
|
|
4776
|
+
# for each Amazon Web Services account.
|
|
4777
|
+
#
|
|
4778
|
+
# @option params [required, String] :name
|
|
4779
|
+
# A display name for the space.
|
|
4780
|
+
#
|
|
4781
|
+
# @option params [String] :description
|
|
4782
|
+
# A description of the space.
|
|
4783
|
+
#
|
|
4784
|
+
# @return [Types::CreateSpaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4785
|
+
#
|
|
4786
|
+
# * {Types::CreateSpaceResponse#space_id #space_id} => String
|
|
4787
|
+
# * {Types::CreateSpaceResponse#space_arn #space_arn} => String
|
|
4788
|
+
# * {Types::CreateSpaceResponse#request_id #request_id} => String
|
|
4789
|
+
#
|
|
4790
|
+
# @example Request syntax with placeholder values
|
|
4791
|
+
#
|
|
4792
|
+
# resp = client.create_space({
|
|
4793
|
+
# aws_account_id: "AwsAccountId", # required
|
|
4794
|
+
# space_id: "PublicSpaceId", # required
|
|
4795
|
+
# name: "SpaceName", # required
|
|
4796
|
+
# description: "SpaceDescription",
|
|
4797
|
+
# })
|
|
4798
|
+
#
|
|
4799
|
+
# @example Response structure
|
|
4800
|
+
#
|
|
4801
|
+
# resp.space_id #=> String
|
|
4802
|
+
# resp.space_arn #=> String
|
|
4803
|
+
# resp.request_id #=> String
|
|
4804
|
+
#
|
|
4805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateSpace AWS API Documentation
|
|
4806
|
+
#
|
|
4807
|
+
# @overload create_space(params = {})
|
|
4808
|
+
# @param [Hash] params ({})
|
|
4809
|
+
def create_space(params = {}, options = {})
|
|
4810
|
+
req = build_request(:create_space, params)
|
|
4811
|
+
req.send_request(options)
|
|
4812
|
+
end
|
|
4813
|
+
|
|
4495
4814
|
# Creates a template either from a `TemplateDefinition` or from an
|
|
4496
4815
|
# existing Quick Sight analysis or template. You can use the resulting
|
|
4497
4816
|
# template to create additional dashboards, templates, or analyses.
|
|
@@ -5579,6 +5898,38 @@ module Aws::QuickSight
|
|
|
5579
5898
|
req.send_request(options)
|
|
5580
5899
|
end
|
|
5581
5900
|
|
|
5901
|
+
# Deletes an agent.
|
|
5902
|
+
#
|
|
5903
|
+
# @option params [required, String] :agent_id
|
|
5904
|
+
# The unique identifier for the agent to delete.
|
|
5905
|
+
#
|
|
5906
|
+
# @option params [required, String] :aws_account_id
|
|
5907
|
+
# The ID of the Amazon Web Services account that contains the agent.
|
|
5908
|
+
#
|
|
5909
|
+
# @return [Types::DeleteAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5910
|
+
#
|
|
5911
|
+
# * {Types::DeleteAgentResponse#request_id #request_id} => String
|
|
5912
|
+
#
|
|
5913
|
+
# @example Request syntax with placeholder values
|
|
5914
|
+
#
|
|
5915
|
+
# resp = client.delete_agent({
|
|
5916
|
+
# agent_id: "String", # required
|
|
5917
|
+
# aws_account_id: "String", # required
|
|
5918
|
+
# })
|
|
5919
|
+
#
|
|
5920
|
+
# @example Response structure
|
|
5921
|
+
#
|
|
5922
|
+
# resp.request_id #=> String
|
|
5923
|
+
#
|
|
5924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAgent AWS API Documentation
|
|
5925
|
+
#
|
|
5926
|
+
# @overload delete_agent(params = {})
|
|
5927
|
+
# @param [Hash] params ({})
|
|
5928
|
+
def delete_agent(params = {}, options = {})
|
|
5929
|
+
req = build_request(:delete_agent, params)
|
|
5930
|
+
req.send_request(options)
|
|
5931
|
+
end
|
|
5932
|
+
|
|
5582
5933
|
# Deletes an analysis from Amazon Quick Sight. You can optionally
|
|
5583
5934
|
# include a recovery window during which you can restore the analysis.
|
|
5584
5935
|
# If you don't specify a recovery window value, the operation defaults
|
|
@@ -5958,6 +6309,42 @@ module Aws::QuickSight
|
|
|
5958
6309
|
req.send_request(options)
|
|
5959
6310
|
end
|
|
5960
6311
|
|
|
6312
|
+
# Permanently deletes a flow from the specified Amazon Web Services
|
|
6313
|
+
# account. This operation cannot be undone.
|
|
6314
|
+
#
|
|
6315
|
+
# @option params [required, String] :aws_account_id
|
|
6316
|
+
# The ID of the Amazon Web Services account that contains the flow that
|
|
6317
|
+
# you are deleting.
|
|
6318
|
+
#
|
|
6319
|
+
# @option params [required, String] :flow_id
|
|
6320
|
+
# The unique identifier of the flow to delete.
|
|
6321
|
+
#
|
|
6322
|
+
# @return [Types::DeleteFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6323
|
+
#
|
|
6324
|
+
# * {Types::DeleteFlowResponse#request_id #request_id} => String
|
|
6325
|
+
# * {Types::DeleteFlowResponse#status #status} => Integer
|
|
6326
|
+
#
|
|
6327
|
+
# @example Request syntax with placeholder values
|
|
6328
|
+
#
|
|
6329
|
+
# resp = client.delete_flow({
|
|
6330
|
+
# aws_account_id: "AccountId", # required
|
|
6331
|
+
# flow_id: "FlowId", # required
|
|
6332
|
+
# })
|
|
6333
|
+
#
|
|
6334
|
+
# @example Response structure
|
|
6335
|
+
#
|
|
6336
|
+
# resp.request_id #=> String
|
|
6337
|
+
# resp.status #=> Integer
|
|
6338
|
+
#
|
|
6339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFlow AWS API Documentation
|
|
6340
|
+
#
|
|
6341
|
+
# @overload delete_flow(params = {})
|
|
6342
|
+
# @param [Hash] params ({})
|
|
6343
|
+
def delete_flow(params = {}, options = {})
|
|
6344
|
+
req = build_request(:delete_flow, params)
|
|
6345
|
+
req.send_request(options)
|
|
6346
|
+
end
|
|
6347
|
+
|
|
5961
6348
|
# Deletes an empty folder.
|
|
5962
6349
|
#
|
|
5963
6350
|
# @option params [required, String] :aws_account_id
|
|
@@ -6245,6 +6632,44 @@ module Aws::QuickSight
|
|
|
6245
6632
|
req.send_request(options)
|
|
6246
6633
|
end
|
|
6247
6634
|
|
|
6635
|
+
# Deletes an OAuthClientApplication.
|
|
6636
|
+
#
|
|
6637
|
+
# @option params [required, String] :aws_account_id
|
|
6638
|
+
# The Amazon Web Services account ID.
|
|
6639
|
+
#
|
|
6640
|
+
# @option params [required, String] :o_auth_client_application_id
|
|
6641
|
+
# The ID of the OAuthClientApplication that you want to delete.
|
|
6642
|
+
#
|
|
6643
|
+
# @return [Types::DeleteOAuthClientApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6644
|
+
#
|
|
6645
|
+
# * {Types::DeleteOAuthClientApplicationResponse#arn #arn} => String
|
|
6646
|
+
# * {Types::DeleteOAuthClientApplicationResponse#o_auth_client_application_id #o_auth_client_application_id} => String
|
|
6647
|
+
# * {Types::DeleteOAuthClientApplicationResponse#request_id #request_id} => String
|
|
6648
|
+
# * {Types::DeleteOAuthClientApplicationResponse#status #status} => Integer
|
|
6649
|
+
#
|
|
6650
|
+
# @example Request syntax with placeholder values
|
|
6651
|
+
#
|
|
6652
|
+
# resp = client.delete_o_auth_client_application({
|
|
6653
|
+
# aws_account_id: "AwsAccountId", # required
|
|
6654
|
+
# o_auth_client_application_id: "OAuthClientApplicationId", # required
|
|
6655
|
+
# })
|
|
6656
|
+
#
|
|
6657
|
+
# @example Response structure
|
|
6658
|
+
#
|
|
6659
|
+
# resp.arn #=> String
|
|
6660
|
+
# resp.o_auth_client_application_id #=> String
|
|
6661
|
+
# resp.request_id #=> String
|
|
6662
|
+
# resp.status #=> Integer
|
|
6663
|
+
#
|
|
6664
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteOAuthClientApplication AWS API Documentation
|
|
6665
|
+
#
|
|
6666
|
+
# @overload delete_o_auth_client_application(params = {})
|
|
6667
|
+
# @param [Hash] params ({})
|
|
6668
|
+
def delete_o_auth_client_application(params = {}, options = {})
|
|
6669
|
+
req = build_request(:delete_o_auth_client_application, params)
|
|
6670
|
+
req.send_request(options)
|
|
6671
|
+
end
|
|
6672
|
+
|
|
6248
6673
|
# Deletes a refresh schedule from a dataset.
|
|
6249
6674
|
#
|
|
6250
6675
|
# @option params [required, String] :data_set_id
|
|
@@ -6372,6 +6797,42 @@ module Aws::QuickSight
|
|
|
6372
6797
|
req.send_request(options)
|
|
6373
6798
|
end
|
|
6374
6799
|
|
|
6800
|
+
# Deletes an Amazon QuickSight space.
|
|
6801
|
+
#
|
|
6802
|
+
# @option params [required, String] :aws_account_id
|
|
6803
|
+
# The ID of the Amazon Web Services account that contains the space.
|
|
6804
|
+
#
|
|
6805
|
+
# @option params [required, String] :space_id
|
|
6806
|
+
# The ID of the space that you want to delete.
|
|
6807
|
+
#
|
|
6808
|
+
# @return [Types::DeleteSpaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6809
|
+
#
|
|
6810
|
+
# * {Types::DeleteSpaceResponse#space_id #space_id} => String
|
|
6811
|
+
# * {Types::DeleteSpaceResponse#space_arn #space_arn} => String
|
|
6812
|
+
# * {Types::DeleteSpaceResponse#request_id #request_id} => String
|
|
6813
|
+
#
|
|
6814
|
+
# @example Request syntax with placeholder values
|
|
6815
|
+
#
|
|
6816
|
+
# resp = client.delete_space({
|
|
6817
|
+
# aws_account_id: "AwsAccountId", # required
|
|
6818
|
+
# space_id: "PublicSpaceId", # required
|
|
6819
|
+
# })
|
|
6820
|
+
#
|
|
6821
|
+
# @example Response structure
|
|
6822
|
+
#
|
|
6823
|
+
# resp.space_id #=> String
|
|
6824
|
+
# resp.space_arn #=> String
|
|
6825
|
+
# resp.request_id #=> String
|
|
6826
|
+
#
|
|
6827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteSpace AWS API Documentation
|
|
6828
|
+
#
|
|
6829
|
+
# @overload delete_space(params = {})
|
|
6830
|
+
# @param [Hash] params ({})
|
|
6831
|
+
def delete_space(params = {}, options = {})
|
|
6832
|
+
req = build_request(:delete_space, params)
|
|
6833
|
+
req.send_request(options)
|
|
6834
|
+
end
|
|
6835
|
+
|
|
6375
6836
|
# Deletes a template.
|
|
6376
6837
|
#
|
|
6377
6838
|
# @option params [required, String] :aws_account_id
|
|
@@ -7145,37 +7606,138 @@ module Aws::QuickSight
|
|
|
7145
7606
|
req.send_request(options)
|
|
7146
7607
|
end
|
|
7147
7608
|
|
|
7148
|
-
#
|
|
7609
|
+
# Describes an agent.
|
|
7149
7610
|
#
|
|
7150
|
-
# @option params [required, String] :
|
|
7151
|
-
# The
|
|
7152
|
-
# You must be using the Amazon Web Services account that the analysis is
|
|
7153
|
-
# in.
|
|
7611
|
+
# @option params [required, String] :agent_id
|
|
7612
|
+
# The unique identifier for the agent.
|
|
7154
7613
|
#
|
|
7155
|
-
# @option params [required, String] :
|
|
7156
|
-
# The ID of the
|
|
7157
|
-
# URL of the analysis.
|
|
7614
|
+
# @option params [required, String] :aws_account_id
|
|
7615
|
+
# The ID of the Amazon Web Services account that contains the agent.
|
|
7158
7616
|
#
|
|
7159
|
-
# @return [Types::
|
|
7617
|
+
# @return [Types::DescribeAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7160
7618
|
#
|
|
7161
|
-
# * {Types::
|
|
7162
|
-
# * {Types::
|
|
7163
|
-
# * {Types::DescribeAnalysisResponse#request_id #request_id} => String
|
|
7619
|
+
# * {Types::DescribeAgentResponse#agent #agent} => Types::Agent
|
|
7620
|
+
# * {Types::DescribeAgentResponse#request_id #request_id} => String
|
|
7164
7621
|
#
|
|
7165
7622
|
# @example Request syntax with placeholder values
|
|
7166
7623
|
#
|
|
7167
|
-
# resp = client.
|
|
7624
|
+
# resp = client.describe_agent({
|
|
7625
|
+
# agent_id: "AgentId", # required
|
|
7168
7626
|
# aws_account_id: "AwsAccountId", # required
|
|
7169
|
-
# analysis_id: "ShortRestrictiveResourceId", # required
|
|
7170
7627
|
# })
|
|
7171
7628
|
#
|
|
7172
7629
|
# @example Response structure
|
|
7173
7630
|
#
|
|
7174
|
-
# resp.
|
|
7175
|
-
# resp.
|
|
7176
|
-
# resp.
|
|
7177
|
-
# resp.
|
|
7178
|
-
# resp.
|
|
7631
|
+
# resp.agent.spaces #=> Array
|
|
7632
|
+
# resp.agent.spaces[0] #=> String
|
|
7633
|
+
# resp.agent.action_connectors #=> Array
|
|
7634
|
+
# resp.agent.action_connectors[0] #=> String
|
|
7635
|
+
# resp.agent.description #=> String
|
|
7636
|
+
# resp.agent.icon_id #=> String
|
|
7637
|
+
# resp.agent.name #=> String
|
|
7638
|
+
# resp.agent.starter_prompts #=> Array
|
|
7639
|
+
# resp.agent.starter_prompts[0] #=> String
|
|
7640
|
+
# resp.agent.welcome_message #=> String
|
|
7641
|
+
# resp.agent.arn #=> String
|
|
7642
|
+
# resp.agent.agent_id #=> String
|
|
7643
|
+
# resp.agent.agent_lifecycle #=> String, one of "PREVIEW", "PUBLISHED"
|
|
7644
|
+
# resp.agent.agent_status #=> String, one of "ACTIVE", "UPDATING", "FAILED", "CREATING"
|
|
7645
|
+
# resp.agent.created_at #=> Time
|
|
7646
|
+
# resp.agent.creator #=> String
|
|
7647
|
+
# resp.agent.custom_prompt_interface.model_profile_id #=> String
|
|
7648
|
+
# resp.agent.custom_prompt_interface.subscription_id #=> String
|
|
7649
|
+
# resp.agent.custom_prompt_interface.qbs_aws_account_id #=> String
|
|
7650
|
+
# resp.agent.custom_prompt_interface.response_length #=> String
|
|
7651
|
+
# resp.agent.custom_prompt_interface.output_style #=> String
|
|
7652
|
+
# resp.agent.custom_prompt_interface.identity #=> String
|
|
7653
|
+
# resp.agent.custom_prompt_interface.tone #=> String
|
|
7654
|
+
# resp.agent.custom_prompt_interface.custom_instructions #=> String
|
|
7655
|
+
# resp.agent.custom_prompt_interface.prompt_summary #=> String
|
|
7656
|
+
# resp.agent.error_message #=> String
|
|
7657
|
+
# resp.agent.updated_at #=> Time
|
|
7658
|
+
# resp.request_id #=> String
|
|
7659
|
+
#
|
|
7660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAgent AWS API Documentation
|
|
7661
|
+
#
|
|
7662
|
+
# @overload describe_agent(params = {})
|
|
7663
|
+
# @param [Hash] params ({})
|
|
7664
|
+
def describe_agent(params = {}, options = {})
|
|
7665
|
+
req = build_request(:describe_agent, params)
|
|
7666
|
+
req.send_request(options)
|
|
7667
|
+
end
|
|
7668
|
+
|
|
7669
|
+
# Describes the resource permissions for an agent.
|
|
7670
|
+
#
|
|
7671
|
+
# @option params [required, String] :agent_id
|
|
7672
|
+
# The unique identifier for the agent.
|
|
7673
|
+
#
|
|
7674
|
+
# @option params [required, String] :aws_account_id
|
|
7675
|
+
# The ID of the Amazon Web Services account that contains the agent.
|
|
7676
|
+
#
|
|
7677
|
+
# @return [Types::DescribeAgentPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7678
|
+
#
|
|
7679
|
+
# * {Types::DescribeAgentPermissionsResponse#arn #arn} => String
|
|
7680
|
+
# * {Types::DescribeAgentPermissionsResponse#agent_id #agent_id} => String
|
|
7681
|
+
# * {Types::DescribeAgentPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
|
7682
|
+
# * {Types::DescribeAgentPermissionsResponse#request_id #request_id} => String
|
|
7683
|
+
#
|
|
7684
|
+
# @example Request syntax with placeholder values
|
|
7685
|
+
#
|
|
7686
|
+
# resp = client.describe_agent_permissions({
|
|
7687
|
+
# agent_id: "AgentId", # required
|
|
7688
|
+
# aws_account_id: "AwsAccountId", # required
|
|
7689
|
+
# })
|
|
7690
|
+
#
|
|
7691
|
+
# @example Response structure
|
|
7692
|
+
#
|
|
7693
|
+
# resp.arn #=> String
|
|
7694
|
+
# resp.agent_id #=> String
|
|
7695
|
+
# resp.permissions #=> Array
|
|
7696
|
+
# resp.permissions[0].principal #=> String
|
|
7697
|
+
# resp.permissions[0].actions #=> Array
|
|
7698
|
+
# resp.permissions[0].actions[0] #=> String
|
|
7699
|
+
# resp.request_id #=> String
|
|
7700
|
+
#
|
|
7701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAgentPermissions AWS API Documentation
|
|
7702
|
+
#
|
|
7703
|
+
# @overload describe_agent_permissions(params = {})
|
|
7704
|
+
# @param [Hash] params ({})
|
|
7705
|
+
def describe_agent_permissions(params = {}, options = {})
|
|
7706
|
+
req = build_request(:describe_agent_permissions, params)
|
|
7707
|
+
req.send_request(options)
|
|
7708
|
+
end
|
|
7709
|
+
|
|
7710
|
+
# Provides a summary of the metadata for an analysis.
|
|
7711
|
+
#
|
|
7712
|
+
# @option params [required, String] :aws_account_id
|
|
7713
|
+
# The ID of the Amazon Web Services account that contains the analysis.
|
|
7714
|
+
# You must be using the Amazon Web Services account that the analysis is
|
|
7715
|
+
# in.
|
|
7716
|
+
#
|
|
7717
|
+
# @option params [required, String] :analysis_id
|
|
7718
|
+
# The ID of the analysis that you're describing. The ID is part of the
|
|
7719
|
+
# URL of the analysis.
|
|
7720
|
+
#
|
|
7721
|
+
# @return [Types::DescribeAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7722
|
+
#
|
|
7723
|
+
# * {Types::DescribeAnalysisResponse#analysis #analysis} => Types::Analysis
|
|
7724
|
+
# * {Types::DescribeAnalysisResponse#status #status} => Integer
|
|
7725
|
+
# * {Types::DescribeAnalysisResponse#request_id #request_id} => String
|
|
7726
|
+
#
|
|
7727
|
+
# @example Request syntax with placeholder values
|
|
7728
|
+
#
|
|
7729
|
+
# resp = client.describe_analysis({
|
|
7730
|
+
# aws_account_id: "AwsAccountId", # required
|
|
7731
|
+
# analysis_id: "ShortRestrictiveResourceId", # required
|
|
7732
|
+
# })
|
|
7733
|
+
#
|
|
7734
|
+
# @example Response structure
|
|
7735
|
+
#
|
|
7736
|
+
# resp.analysis.analysis_id #=> String
|
|
7737
|
+
# resp.analysis.arn #=> String
|
|
7738
|
+
# resp.analysis.name #=> String
|
|
7739
|
+
# resp.analysis.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
|
7740
|
+
# resp.analysis.errors #=> Array
|
|
7179
7741
|
# resp.analysis.errors[0].type #=> String, one of "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
|
|
7180
7742
|
# resp.analysis.errors[0].message #=> String
|
|
7181
7743
|
# resp.analysis.errors[0].violated_entities #=> Array
|
|
@@ -9636,6 +10198,60 @@ module Aws::QuickSight
|
|
|
9636
10198
|
req.send_request(options)
|
|
9637
10199
|
end
|
|
9638
10200
|
|
|
10201
|
+
# Returns the full details of a flow for the latest version of the
|
|
10202
|
+
# requested publish state.
|
|
10203
|
+
#
|
|
10204
|
+
# @option params [required, String] :aws_account_id
|
|
10205
|
+
# The ID of the Amazon Web Services account that contains the flow that
|
|
10206
|
+
# you are describing.
|
|
10207
|
+
#
|
|
10208
|
+
# @option params [required, String] :flow_id
|
|
10209
|
+
# The unique identifier of the flow.
|
|
10210
|
+
#
|
|
10211
|
+
# @option params [required, String] :publish_state
|
|
10212
|
+
# The publish state of the flow version to describe. Valid values are
|
|
10213
|
+
# `DRAFT`, `PUBLISHED`, or `PENDING_APPROVAL`.
|
|
10214
|
+
#
|
|
10215
|
+
# @return [Types::DescribeFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10216
|
+
#
|
|
10217
|
+
# * {Types::DescribeFlowResponse#flow #flow} => Types::FlowDetail
|
|
10218
|
+
# * {Types::DescribeFlowResponse#request_id #request_id} => String
|
|
10219
|
+
# * {Types::DescribeFlowResponse#status #status} => Integer
|
|
10220
|
+
#
|
|
10221
|
+
# @example Request syntax with placeholder values
|
|
10222
|
+
#
|
|
10223
|
+
# resp = client.describe_flow({
|
|
10224
|
+
# aws_account_id: "AccountId", # required
|
|
10225
|
+
# flow_id: "FlowId", # required
|
|
10226
|
+
# publish_state: "PUBLISHED", # required, accepts PUBLISHED, DRAFT, PENDING_APPROVAL
|
|
10227
|
+
# })
|
|
10228
|
+
#
|
|
10229
|
+
# @example Response structure
|
|
10230
|
+
#
|
|
10231
|
+
# resp.flow.arn #=> String
|
|
10232
|
+
# resp.flow.flow_id #=> String
|
|
10233
|
+
# resp.flow.name #=> String
|
|
10234
|
+
# resp.flow.description #=> String
|
|
10235
|
+
# resp.flow.publish_state #=> String, one of "PUBLISHED", "DRAFT", "PENDING_APPROVAL"
|
|
10236
|
+
# resp.flow.created_time #=> Time
|
|
10237
|
+
# resp.flow.created_by #=> String
|
|
10238
|
+
# resp.flow.last_updated_time #=> Time
|
|
10239
|
+
# resp.flow.last_updated_by #=> String
|
|
10240
|
+
# resp.flow.step_aliases #=> Array
|
|
10241
|
+
# resp.flow.step_aliases[0].step_id #=> String
|
|
10242
|
+
# resp.flow.step_aliases[0].step_alias #=> String
|
|
10243
|
+
# resp.request_id #=> String
|
|
10244
|
+
# resp.status #=> Integer
|
|
10245
|
+
#
|
|
10246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFlow AWS API Documentation
|
|
10247
|
+
#
|
|
10248
|
+
# @overload describe_flow(params = {})
|
|
10249
|
+
# @param [Hash] params ({})
|
|
10250
|
+
def describe_flow(params = {}, options = {})
|
|
10251
|
+
req = build_request(:describe_flow, params)
|
|
10252
|
+
req.send_request(options)
|
|
10253
|
+
end
|
|
10254
|
+
|
|
9639
10255
|
# Describes a folder.
|
|
9640
10256
|
#
|
|
9641
10257
|
# @option params [required, String] :aws_account_id
|
|
@@ -10131,6 +10747,52 @@ module Aws::QuickSight
|
|
|
10131
10747
|
req.send_request(options)
|
|
10132
10748
|
end
|
|
10133
10749
|
|
|
10750
|
+
# Describes an OAuthClientApplication.
|
|
10751
|
+
#
|
|
10752
|
+
# @option params [required, String] :aws_account_id
|
|
10753
|
+
# The Amazon Web Services account ID.
|
|
10754
|
+
#
|
|
10755
|
+
# @option params [required, String] :o_auth_client_application_id
|
|
10756
|
+
# The ID of the OAuthClientApplication that you want to describe.
|
|
10757
|
+
#
|
|
10758
|
+
# @return [Types::DescribeOAuthClientApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10759
|
+
#
|
|
10760
|
+
# * {Types::DescribeOAuthClientApplicationResponse#o_auth_client_application #o_auth_client_application} => Types::OAuthClientApplication
|
|
10761
|
+
# * {Types::DescribeOAuthClientApplicationResponse#request_id #request_id} => String
|
|
10762
|
+
# * {Types::DescribeOAuthClientApplicationResponse#status #status} => Integer
|
|
10763
|
+
#
|
|
10764
|
+
# @example Request syntax with placeholder values
|
|
10765
|
+
#
|
|
10766
|
+
# resp = client.describe_o_auth_client_application({
|
|
10767
|
+
# aws_account_id: "AwsAccountId", # required
|
|
10768
|
+
# o_auth_client_application_id: "OAuthClientApplicationId", # required
|
|
10769
|
+
# })
|
|
10770
|
+
#
|
|
10771
|
+
# @example Response structure
|
|
10772
|
+
#
|
|
10773
|
+
# resp.o_auth_client_application.o_auth_client_application_id #=> String
|
|
10774
|
+
# resp.o_auth_client_application.name #=> String
|
|
10775
|
+
# resp.o_auth_client_application.o_auth_client_authentication_type #=> String, one of "TOKEN"
|
|
10776
|
+
# resp.o_auth_client_application.o_auth_token_endpoint_url #=> String
|
|
10777
|
+
# resp.o_auth_client_application.o_auth_authorization_endpoint_url #=> String
|
|
10778
|
+
# resp.o_auth_client_application.o_auth_scopes #=> String
|
|
10779
|
+
# resp.o_auth_client_application.data_source_type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "S3_TABLES", "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"
|
|
10780
|
+
# resp.o_auth_client_application.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
|
|
10781
|
+
# resp.o_auth_client_application.created_time #=> Time
|
|
10782
|
+
# resp.o_auth_client_application.last_updated_time #=> Time
|
|
10783
|
+
# resp.o_auth_client_application.arn #=> String
|
|
10784
|
+
# resp.request_id #=> String
|
|
10785
|
+
# resp.status #=> Integer
|
|
10786
|
+
#
|
|
10787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeOAuthClientApplication AWS API Documentation
|
|
10788
|
+
#
|
|
10789
|
+
# @overload describe_o_auth_client_application(params = {})
|
|
10790
|
+
# @param [Hash] params ({})
|
|
10791
|
+
def describe_o_auth_client_application(params = {}, options = {})
|
|
10792
|
+
req = build_request(:describe_o_auth_client_application, params)
|
|
10793
|
+
req.send_request(options)
|
|
10794
|
+
end
|
|
10795
|
+
|
|
10134
10796
|
# Describes a personalization configuration.
|
|
10135
10797
|
#
|
|
10136
10798
|
# @option params [required, String] :aws_account_id
|
|
@@ -10328,6 +10990,104 @@ module Aws::QuickSight
|
|
|
10328
10990
|
req.send_request(options)
|
|
10329
10991
|
end
|
|
10330
10992
|
|
|
10993
|
+
# Describes an Amazon QuickSight space.
|
|
10994
|
+
#
|
|
10995
|
+
# @option params [required, String] :aws_account_id
|
|
10996
|
+
# The ID of the Amazon Web Services account that contains the space.
|
|
10997
|
+
#
|
|
10998
|
+
# @option params [required, String] :space_id
|
|
10999
|
+
# The ID of the space that you want to describe.
|
|
11000
|
+
#
|
|
11001
|
+
# @option params [Integer] :max_contributors
|
|
11002
|
+
# The maximum number of contributors to include in the response.
|
|
11003
|
+
#
|
|
11004
|
+
# @return [Types::DescribeSpaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
11005
|
+
#
|
|
11006
|
+
# * {Types::DescribeSpaceResponse#space_id #space_id} => String
|
|
11007
|
+
# * {Types::DescribeSpaceResponse#space_arn #space_arn} => String
|
|
11008
|
+
# * {Types::DescribeSpaceResponse#space #space} => Types::SpaceDetails
|
|
11009
|
+
# * {Types::DescribeSpaceResponse#contributors #contributors} => Array<Types::SpaceContributor>
|
|
11010
|
+
# * {Types::DescribeSpaceResponse#request_id #request_id} => String
|
|
11011
|
+
#
|
|
11012
|
+
# @example Request syntax with placeholder values
|
|
11013
|
+
#
|
|
11014
|
+
# resp = client.describe_space({
|
|
11015
|
+
# aws_account_id: "AwsAccountId", # required
|
|
11016
|
+
# space_id: "PublicSpaceId", # required
|
|
11017
|
+
# max_contributors: 1,
|
|
11018
|
+
# })
|
|
11019
|
+
#
|
|
11020
|
+
# @example Response structure
|
|
11021
|
+
#
|
|
11022
|
+
# resp.space_id #=> String
|
|
11023
|
+
# resp.space_arn #=> String
|
|
11024
|
+
# resp.space.name #=> String
|
|
11025
|
+
# resp.space.description #=> String
|
|
11026
|
+
# resp.space.resources #=> Array
|
|
11027
|
+
# resp.space.resources[0].resource_type #=> String, one of "TOPIC", "DASHBOARD", "KNOWLEDGE_BASE", "SPACE", "ACTION_CONNECTOR", "DATA_SET", "ARTIFACT"
|
|
11028
|
+
# resp.space.resources[0].resource_details.resource_arn #=> String
|
|
11029
|
+
# resp.space.created_at #=> Time
|
|
11030
|
+
# resp.space.updated_at #=> Time
|
|
11031
|
+
# resp.space.consumed_source_size #=> Integer
|
|
11032
|
+
# resp.space.consumed_source_doc_count #=> Integer
|
|
11033
|
+
# resp.space.created_by #=> String
|
|
11034
|
+
# resp.space.created_by_arn #=> String
|
|
11035
|
+
# resp.contributors #=> Array
|
|
11036
|
+
# resp.contributors[0].user_name #=> String
|
|
11037
|
+
# resp.contributors[0].raw_file_size_bytes #=> Integer
|
|
11038
|
+
# resp.contributors[0].percentage #=> Float
|
|
11039
|
+
# resp.request_id #=> String
|
|
11040
|
+
#
|
|
11041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeSpace AWS API Documentation
|
|
11042
|
+
#
|
|
11043
|
+
# @overload describe_space(params = {})
|
|
11044
|
+
# @param [Hash] params ({})
|
|
11045
|
+
def describe_space(params = {}, options = {})
|
|
11046
|
+
req = build_request(:describe_space, params)
|
|
11047
|
+
req.send_request(options)
|
|
11048
|
+
end
|
|
11049
|
+
|
|
11050
|
+
# Describes the permissions for an Amazon QuickSight space.
|
|
11051
|
+
#
|
|
11052
|
+
# @option params [required, String] :aws_account_id
|
|
11053
|
+
# The ID of the Amazon Web Services account that contains the space.
|
|
11054
|
+
#
|
|
11055
|
+
# @option params [required, String] :space_id
|
|
11056
|
+
# The ID of the space that you want to describe permissions for.
|
|
11057
|
+
#
|
|
11058
|
+
# @return [Types::DescribeSpacePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
11059
|
+
#
|
|
11060
|
+
# * {Types::DescribeSpacePermissionsResponse#space_id #space_id} => String
|
|
11061
|
+
# * {Types::DescribeSpacePermissionsResponse#space_arn #space_arn} => String
|
|
11062
|
+
# * {Types::DescribeSpacePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
|
11063
|
+
# * {Types::DescribeSpacePermissionsResponse#request_id #request_id} => String
|
|
11064
|
+
#
|
|
11065
|
+
# @example Request syntax with placeholder values
|
|
11066
|
+
#
|
|
11067
|
+
# resp = client.describe_space_permissions({
|
|
11068
|
+
# aws_account_id: "AwsAccountId", # required
|
|
11069
|
+
# space_id: "PublicSpaceId", # required
|
|
11070
|
+
# })
|
|
11071
|
+
#
|
|
11072
|
+
# @example Response structure
|
|
11073
|
+
#
|
|
11074
|
+
# resp.space_id #=> String
|
|
11075
|
+
# resp.space_arn #=> String
|
|
11076
|
+
# resp.permissions #=> Array
|
|
11077
|
+
# resp.permissions[0].principal #=> String
|
|
11078
|
+
# resp.permissions[0].actions #=> Array
|
|
11079
|
+
# resp.permissions[0].actions[0] #=> String
|
|
11080
|
+
# resp.request_id #=> String
|
|
11081
|
+
#
|
|
11082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeSpacePermissions AWS API Documentation
|
|
11083
|
+
#
|
|
11084
|
+
# @overload describe_space_permissions(params = {})
|
|
11085
|
+
# @param [Hash] params ({})
|
|
11086
|
+
def describe_space_permissions(params = {}, options = {})
|
|
11087
|
+
req = build_request(:describe_space_permissions, params)
|
|
11088
|
+
req.send_request(options)
|
|
11089
|
+
end
|
|
11090
|
+
|
|
10331
11091
|
# Describes a template's metadata.
|
|
10332
11092
|
#
|
|
10333
11093
|
# @option params [required, String] :aws_account_id
|
|
@@ -12319,6 +13079,54 @@ module Aws::QuickSight
|
|
|
12319
13079
|
req.send_request(options)
|
|
12320
13080
|
end
|
|
12321
13081
|
|
|
13082
|
+
# Lists all agents in an Amazon QuickSight account.
|
|
13083
|
+
#
|
|
13084
|
+
# @option params [required, String] :aws_account_id
|
|
13085
|
+
# The ID of the Amazon Web Services account that contains the agents.
|
|
13086
|
+
#
|
|
13087
|
+
# @option params [Integer] :max_results
|
|
13088
|
+
# The maximum number of results to return.
|
|
13089
|
+
#
|
|
13090
|
+
# @option params [String] :next_token
|
|
13091
|
+
# The token for the next set of results, or null if there are no more
|
|
13092
|
+
# results.
|
|
13093
|
+
#
|
|
13094
|
+
# @return [Types::ListAgentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
13095
|
+
#
|
|
13096
|
+
# * {Types::ListAgentsResponse#request_id #request_id} => String
|
|
13097
|
+
# * {Types::ListAgentsResponse#agent_summaries #agent_summaries} => Array<Types::AgentSummary>
|
|
13098
|
+
# * {Types::ListAgentsResponse#next_token #next_token} => String
|
|
13099
|
+
#
|
|
13100
|
+
# @example Request syntax with placeholder values
|
|
13101
|
+
#
|
|
13102
|
+
# resp = client.list_agents({
|
|
13103
|
+
# aws_account_id: "AwsAccountId", # required
|
|
13104
|
+
# max_results: 1,
|
|
13105
|
+
# next_token: "String",
|
|
13106
|
+
# })
|
|
13107
|
+
#
|
|
13108
|
+
# @example Response structure
|
|
13109
|
+
#
|
|
13110
|
+
# resp.request_id #=> String
|
|
13111
|
+
# resp.agent_summaries #=> Array
|
|
13112
|
+
# resp.agent_summaries[0].arn #=> String
|
|
13113
|
+
# resp.agent_summaries[0].agent_id #=> String
|
|
13114
|
+
# resp.agent_summaries[0].name #=> String
|
|
13115
|
+
# resp.agent_summaries[0].description #=> String
|
|
13116
|
+
# resp.agent_summaries[0].created_at #=> Time
|
|
13117
|
+
# resp.agent_summaries[0].updated_at #=> Time
|
|
13118
|
+
# resp.agent_summaries[0].icon_id #=> String
|
|
13119
|
+
# resp.next_token #=> String
|
|
13120
|
+
#
|
|
13121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAgents AWS API Documentation
|
|
13122
|
+
#
|
|
13123
|
+
# @overload list_agents(params = {})
|
|
13124
|
+
# @param [Hash] params ({})
|
|
13125
|
+
def list_agents(params = {}, options = {})
|
|
13126
|
+
req = build_request(:list_agents, params)
|
|
13127
|
+
req.send_request(options)
|
|
13128
|
+
end
|
|
13129
|
+
|
|
12322
13130
|
# Lists Amazon Quick Sight analyses that exist in the specified Amazon
|
|
12323
13131
|
# Web Services account.
|
|
12324
13132
|
#
|
|
@@ -13874,6 +14682,59 @@ module Aws::QuickSight
|
|
|
13874
14682
|
req.send_request(options)
|
|
13875
14683
|
end
|
|
13876
14684
|
|
|
14685
|
+
# Lists all OAuthClientApplications in the current Amazon Web Services
|
|
14686
|
+
# Region that belong to this Amazon Web Services account.
|
|
14687
|
+
#
|
|
14688
|
+
# @option params [required, String] :aws_account_id
|
|
14689
|
+
# The Amazon Web Services account ID.
|
|
14690
|
+
#
|
|
14691
|
+
# @option params [String] :next_token
|
|
14692
|
+
# A pagination token that can be used in a subsequent request.
|
|
14693
|
+
#
|
|
14694
|
+
# @option params [Integer] :max_results
|
|
14695
|
+
# The maximum number of results to return.
|
|
14696
|
+
#
|
|
14697
|
+
# @return [Types::ListOAuthClientApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14698
|
+
#
|
|
14699
|
+
# * {Types::ListOAuthClientApplicationsResponse#o_auth_client_applications #o_auth_client_applications} => Array<Types::OAuthClientApplicationSummary>
|
|
14700
|
+
# * {Types::ListOAuthClientApplicationsResponse#next_token #next_token} => String
|
|
14701
|
+
# * {Types::ListOAuthClientApplicationsResponse#request_id #request_id} => String
|
|
14702
|
+
# * {Types::ListOAuthClientApplicationsResponse#status #status} => Integer
|
|
14703
|
+
#
|
|
14704
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
14705
|
+
#
|
|
14706
|
+
# @example Request syntax with placeholder values
|
|
14707
|
+
#
|
|
14708
|
+
# resp = client.list_o_auth_client_applications({
|
|
14709
|
+
# aws_account_id: "AwsAccountId", # required
|
|
14710
|
+
# next_token: "String",
|
|
14711
|
+
# max_results: 1,
|
|
14712
|
+
# })
|
|
14713
|
+
#
|
|
14714
|
+
# @example Response structure
|
|
14715
|
+
#
|
|
14716
|
+
# resp.o_auth_client_applications #=> Array
|
|
14717
|
+
# resp.o_auth_client_applications[0].o_auth_client_application_id #=> String
|
|
14718
|
+
# resp.o_auth_client_applications[0].name #=> String
|
|
14719
|
+
# resp.o_auth_client_applications[0].o_auth_client_authentication_type #=> String, one of "TOKEN"
|
|
14720
|
+
# resp.o_auth_client_applications[0].data_source_type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "S3_TABLES", "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"
|
|
14721
|
+
# resp.o_auth_client_applications[0].identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
|
|
14722
|
+
# resp.o_auth_client_applications[0].created_time #=> Time
|
|
14723
|
+
# resp.o_auth_client_applications[0].last_updated_time #=> Time
|
|
14724
|
+
# resp.o_auth_client_applications[0].arn #=> String
|
|
14725
|
+
# resp.next_token #=> String
|
|
14726
|
+
# resp.request_id #=> String
|
|
14727
|
+
# resp.status #=> Integer
|
|
14728
|
+
#
|
|
14729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListOAuthClientApplications AWS API Documentation
|
|
14730
|
+
#
|
|
14731
|
+
# @overload list_o_auth_client_applications(params = {})
|
|
14732
|
+
# @param [Hash] params ({})
|
|
14733
|
+
def list_o_auth_client_applications(params = {}, options = {})
|
|
14734
|
+
req = build_request(:list_o_auth_client_applications, params)
|
|
14735
|
+
req.send_request(options)
|
|
14736
|
+
end
|
|
14737
|
+
|
|
13877
14738
|
# Lists the refresh schedules of a dataset. Each dataset can have up to
|
|
13878
14739
|
# 5 schedules.
|
|
13879
14740
|
#
|
|
@@ -14033,72 +14894,170 @@ module Aws::QuickSight
|
|
|
14033
14894
|
req.send_request(options)
|
|
14034
14895
|
end
|
|
14035
14896
|
|
|
14036
|
-
# Lists the
|
|
14897
|
+
# Lists the resources in an Amazon QuickSight space.
|
|
14037
14898
|
#
|
|
14038
|
-
# @option params [required, String] :
|
|
14039
|
-
# The
|
|
14040
|
-
# tags for.
|
|
14899
|
+
# @option params [required, String] :aws_account_id
|
|
14900
|
+
# The ID of the Amazon Web Services account that contains the space.
|
|
14041
14901
|
#
|
|
14042
|
-
# @
|
|
14902
|
+
# @option params [required, String] :space_id
|
|
14903
|
+
# The ID of the space that you want to list resources for.
|
|
14043
14904
|
#
|
|
14044
|
-
#
|
|
14045
|
-
#
|
|
14046
|
-
# * {Types::
|
|
14905
|
+
# @return [Types::ListSpaceResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14906
|
+
#
|
|
14907
|
+
# * {Types::ListSpaceResourcesResponse#space_id #space_id} => String
|
|
14908
|
+
# * {Types::ListSpaceResourcesResponse#space_arn #space_arn} => String
|
|
14909
|
+
# * {Types::ListSpaceResourcesResponse#space_resources #space_resources} => Array<Types::SpaceResourceSummary>
|
|
14910
|
+
# * {Types::ListSpaceResourcesResponse#request_id #request_id} => String
|
|
14047
14911
|
#
|
|
14048
14912
|
# @example Request syntax with placeholder values
|
|
14049
14913
|
#
|
|
14050
|
-
# resp = client.
|
|
14051
|
-
#
|
|
14914
|
+
# resp = client.list_space_resources({
|
|
14915
|
+
# aws_account_id: "AwsAccountId", # required
|
|
14916
|
+
# space_id: "PublicSpaceId", # required
|
|
14052
14917
|
# })
|
|
14053
14918
|
#
|
|
14054
14919
|
# @example Response structure
|
|
14055
14920
|
#
|
|
14056
|
-
# resp.
|
|
14057
|
-
# resp.
|
|
14058
|
-
# resp.
|
|
14921
|
+
# resp.space_id #=> String
|
|
14922
|
+
# resp.space_arn #=> String
|
|
14923
|
+
# resp.space_resources #=> Array
|
|
14924
|
+
# resp.space_resources[0].resource_type #=> String, one of "TOPIC", "DASHBOARD", "KNOWLEDGE_BASE", "SPACE", "ACTION_CONNECTOR", "DATA_SET", "ARTIFACT"
|
|
14925
|
+
# resp.space_resources[0].resource_details.resource_arn #=> String
|
|
14926
|
+
# resp.space_resources[0].resource_name #=> String
|
|
14927
|
+
# resp.space_resources[0].updated_at #=> Time
|
|
14059
14928
|
# resp.request_id #=> String
|
|
14060
|
-
# resp.status #=> Integer
|
|
14061
14929
|
#
|
|
14062
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
|
14930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListSpaceResources AWS API Documentation
|
|
14063
14931
|
#
|
|
14064
|
-
# @overload
|
|
14932
|
+
# @overload list_space_resources(params = {})
|
|
14065
14933
|
# @param [Hash] params ({})
|
|
14066
|
-
def
|
|
14067
|
-
req = build_request(:
|
|
14934
|
+
def list_space_resources(params = {}, options = {})
|
|
14935
|
+
req = build_request(:list_space_resources, params)
|
|
14068
14936
|
req.send_request(options)
|
|
14069
14937
|
end
|
|
14070
14938
|
|
|
14071
|
-
# Lists all
|
|
14939
|
+
# Lists all Amazon QuickSight spaces in an Amazon Web Services account.
|
|
14072
14940
|
#
|
|
14073
14941
|
# @option params [required, String] :aws_account_id
|
|
14074
|
-
# The ID of the Amazon Web Services account that contains the
|
|
14075
|
-
# aliases that you're listing.
|
|
14076
|
-
#
|
|
14077
|
-
# @option params [required, String] :template_id
|
|
14078
|
-
# The ID for the template.
|
|
14942
|
+
# The ID of the Amazon Web Services account that contains the spaces.
|
|
14079
14943
|
#
|
|
14080
14944
|
# @option params [String] :next_token
|
|
14081
14945
|
# The token for the next set of results, or null if there are no more
|
|
14082
14946
|
# results.
|
|
14083
14947
|
#
|
|
14084
14948
|
# @option params [Integer] :max_results
|
|
14085
|
-
# The maximum number of results to
|
|
14086
|
-
#
|
|
14087
|
-
# @return [Types::ListTemplateAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14949
|
+
# The maximum number of results to return.
|
|
14088
14950
|
#
|
|
14089
|
-
#
|
|
14090
|
-
# * {Types::ListTemplateAliasesResponse#status #status} => Integer
|
|
14091
|
-
# * {Types::ListTemplateAliasesResponse#request_id #request_id} => String
|
|
14092
|
-
# * {Types::ListTemplateAliasesResponse#next_token #next_token} => String
|
|
14951
|
+
# @return [Types::ListSpacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14093
14952
|
#
|
|
14094
|
-
#
|
|
14953
|
+
# * {Types::ListSpacesResponse#space_id #space_id} => String
|
|
14954
|
+
# * {Types::ListSpacesResponse#space_arn #space_arn} => String
|
|
14955
|
+
# * {Types::ListSpacesResponse#space_summaries #space_summaries} => Array<Types::SpaceSummary>
|
|
14956
|
+
# * {Types::ListSpacesResponse#next_token #next_token} => String
|
|
14957
|
+
# * {Types::ListSpacesResponse#request_id #request_id} => String
|
|
14095
14958
|
#
|
|
14096
14959
|
# @example Request syntax with placeholder values
|
|
14097
14960
|
#
|
|
14098
|
-
# resp = client.
|
|
14961
|
+
# resp = client.list_spaces({
|
|
14099
14962
|
# aws_account_id: "AwsAccountId", # required
|
|
14100
|
-
#
|
|
14101
|
-
#
|
|
14963
|
+
# next_token: "NextToken",
|
|
14964
|
+
# max_results: 1,
|
|
14965
|
+
# })
|
|
14966
|
+
#
|
|
14967
|
+
# @example Response structure
|
|
14968
|
+
#
|
|
14969
|
+
# resp.space_id #=> String
|
|
14970
|
+
# resp.space_arn #=> String
|
|
14971
|
+
# resp.space_summaries #=> Array
|
|
14972
|
+
# resp.space_summaries[0].space_id #=> String
|
|
14973
|
+
# resp.space_summaries[0].space_arn #=> String
|
|
14974
|
+
# resp.space_summaries[0].name #=> String
|
|
14975
|
+
# resp.space_summaries[0].description #=> String
|
|
14976
|
+
# resp.space_summaries[0].updated_at #=> Time
|
|
14977
|
+
# resp.space_summaries[0].consumed_source_size #=> Integer
|
|
14978
|
+
# resp.space_summaries[0].consumed_source_doc_count #=> Integer
|
|
14979
|
+
# resp.space_summaries[0].created_at #=> Time
|
|
14980
|
+
# resp.space_summaries[0].created_by #=> String
|
|
14981
|
+
# resp.space_summaries[0].created_by_arn #=> String
|
|
14982
|
+
# resp.space_summaries[0].resources_count #=> Integer
|
|
14983
|
+
# resp.next_token #=> String
|
|
14984
|
+
# resp.request_id #=> String
|
|
14985
|
+
#
|
|
14986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListSpaces AWS API Documentation
|
|
14987
|
+
#
|
|
14988
|
+
# @overload list_spaces(params = {})
|
|
14989
|
+
# @param [Hash] params ({})
|
|
14990
|
+
def list_spaces(params = {}, options = {})
|
|
14991
|
+
req = build_request(:list_spaces, params)
|
|
14992
|
+
req.send_request(options)
|
|
14993
|
+
end
|
|
14994
|
+
|
|
14995
|
+
# Lists the tags assigned to a resource.
|
|
14996
|
+
#
|
|
14997
|
+
# @option params [required, String] :resource_arn
|
|
14998
|
+
# The Amazon Resource Name (ARN) of the resource that you want a list of
|
|
14999
|
+
# tags for.
|
|
15000
|
+
#
|
|
15001
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
15002
|
+
#
|
|
15003
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
|
15004
|
+
# * {Types::ListTagsForResourceResponse#request_id #request_id} => String
|
|
15005
|
+
# * {Types::ListTagsForResourceResponse#status #status} => Integer
|
|
15006
|
+
#
|
|
15007
|
+
# @example Request syntax with placeholder values
|
|
15008
|
+
#
|
|
15009
|
+
# resp = client.list_tags_for_resource({
|
|
15010
|
+
# resource_arn: "Arn", # required
|
|
15011
|
+
# })
|
|
15012
|
+
#
|
|
15013
|
+
# @example Response structure
|
|
15014
|
+
#
|
|
15015
|
+
# resp.tags #=> Array
|
|
15016
|
+
# resp.tags[0].key #=> String
|
|
15017
|
+
# resp.tags[0].value #=> String
|
|
15018
|
+
# resp.request_id #=> String
|
|
15019
|
+
# resp.status #=> Integer
|
|
15020
|
+
#
|
|
15021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTagsForResource AWS API Documentation
|
|
15022
|
+
#
|
|
15023
|
+
# @overload list_tags_for_resource(params = {})
|
|
15024
|
+
# @param [Hash] params ({})
|
|
15025
|
+
def list_tags_for_resource(params = {}, options = {})
|
|
15026
|
+
req = build_request(:list_tags_for_resource, params)
|
|
15027
|
+
req.send_request(options)
|
|
15028
|
+
end
|
|
15029
|
+
|
|
15030
|
+
# Lists all the aliases of a template.
|
|
15031
|
+
#
|
|
15032
|
+
# @option params [required, String] :aws_account_id
|
|
15033
|
+
# The ID of the Amazon Web Services account that contains the template
|
|
15034
|
+
# aliases that you're listing.
|
|
15035
|
+
#
|
|
15036
|
+
# @option params [required, String] :template_id
|
|
15037
|
+
# The ID for the template.
|
|
15038
|
+
#
|
|
15039
|
+
# @option params [String] :next_token
|
|
15040
|
+
# The token for the next set of results, or null if there are no more
|
|
15041
|
+
# results.
|
|
15042
|
+
#
|
|
15043
|
+
# @option params [Integer] :max_results
|
|
15044
|
+
# The maximum number of results to be returned per request.
|
|
15045
|
+
#
|
|
15046
|
+
# @return [Types::ListTemplateAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
15047
|
+
#
|
|
15048
|
+
# * {Types::ListTemplateAliasesResponse#template_alias_list #template_alias_list} => Array<Types::TemplateAlias>
|
|
15049
|
+
# * {Types::ListTemplateAliasesResponse#status #status} => Integer
|
|
15050
|
+
# * {Types::ListTemplateAliasesResponse#request_id #request_id} => String
|
|
15051
|
+
# * {Types::ListTemplateAliasesResponse#next_token #next_token} => String
|
|
15052
|
+
#
|
|
15053
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
15054
|
+
#
|
|
15055
|
+
# @example Request syntax with placeholder values
|
|
15056
|
+
#
|
|
15057
|
+
# resp = client.list_template_aliases({
|
|
15058
|
+
# aws_account_id: "AwsAccountId", # required
|
|
15059
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
|
15060
|
+
# next_token: "String",
|
|
14102
15061
|
# max_results: 1,
|
|
14103
15062
|
# })
|
|
14104
15063
|
#
|
|
@@ -15638,6 +16597,64 @@ module Aws::QuickSight
|
|
|
15638
16597
|
req.send_request(options)
|
|
15639
16598
|
end
|
|
15640
16599
|
|
|
16600
|
+
# Searches for agents based on specified filters.
|
|
16601
|
+
#
|
|
16602
|
+
# @option params [required, String] :aws_account_id
|
|
16603
|
+
# The ID of the Amazon Web Services account that contains the agents.
|
|
16604
|
+
#
|
|
16605
|
+
# @option params [required, Array<Types::AgentSearchFilter>] :filters
|
|
16606
|
+
# The filters to apply when searching agents.
|
|
16607
|
+
#
|
|
16608
|
+
# @option params [Integer] :max_results
|
|
16609
|
+
# The maximum number of results to return.
|
|
16610
|
+
#
|
|
16611
|
+
# @option params [String] :next_token
|
|
16612
|
+
# The token for the next set of results, or null if there are no more
|
|
16613
|
+
# results.
|
|
16614
|
+
#
|
|
16615
|
+
# @return [Types::SearchAgentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
16616
|
+
#
|
|
16617
|
+
# * {Types::SearchAgentsResponse#agent_summaries #agent_summaries} => Array<Types::AgentSummary>
|
|
16618
|
+
# * {Types::SearchAgentsResponse#next_token #next_token} => String
|
|
16619
|
+
# * {Types::SearchAgentsResponse#request_id #request_id} => String
|
|
16620
|
+
#
|
|
16621
|
+
# @example Request syntax with placeholder values
|
|
16622
|
+
#
|
|
16623
|
+
# resp = client.search_agents({
|
|
16624
|
+
# aws_account_id: "AwsAccountId", # required
|
|
16625
|
+
# filters: [ # required
|
|
16626
|
+
# {
|
|
16627
|
+
# name: "DIRECT_QUICKSIGHT_OWNER", # accepts DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, AGENT_NAME
|
|
16628
|
+
# operator: "StringEquals", # accepts StringEquals, StringLike
|
|
16629
|
+
# value: "String",
|
|
16630
|
+
# },
|
|
16631
|
+
# ],
|
|
16632
|
+
# max_results: 1,
|
|
16633
|
+
# next_token: "String",
|
|
16634
|
+
# })
|
|
16635
|
+
#
|
|
16636
|
+
# @example Response structure
|
|
16637
|
+
#
|
|
16638
|
+
# resp.agent_summaries #=> Array
|
|
16639
|
+
# resp.agent_summaries[0].arn #=> String
|
|
16640
|
+
# resp.agent_summaries[0].agent_id #=> String
|
|
16641
|
+
# resp.agent_summaries[0].name #=> String
|
|
16642
|
+
# resp.agent_summaries[0].description #=> String
|
|
16643
|
+
# resp.agent_summaries[0].created_at #=> Time
|
|
16644
|
+
# resp.agent_summaries[0].updated_at #=> Time
|
|
16645
|
+
# resp.agent_summaries[0].icon_id #=> String
|
|
16646
|
+
# resp.next_token #=> String
|
|
16647
|
+
# resp.request_id #=> String
|
|
16648
|
+
#
|
|
16649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAgents AWS API Documentation
|
|
16650
|
+
#
|
|
16651
|
+
# @overload search_agents(params = {})
|
|
16652
|
+
# @param [Hash] params ({})
|
|
16653
|
+
def search_agents(params = {}, options = {})
|
|
16654
|
+
req = build_request(:search_agents, params)
|
|
16655
|
+
req.send_request(options)
|
|
16656
|
+
end
|
|
16657
|
+
|
|
15641
16658
|
# Searches for analyses that belong to the user specified in the filter.
|
|
15642
16659
|
#
|
|
15643
16660
|
# <note markdown="1"> This operation is eventually consistent. The results are best effort
|
|
@@ -16113,6 +17130,73 @@ module Aws::QuickSight
|
|
|
16113
17130
|
req.send_request(options)
|
|
16114
17131
|
end
|
|
16115
17132
|
|
|
17133
|
+
# Searches for Amazon QuickSight spaces that match the specified
|
|
17134
|
+
# filters.
|
|
17135
|
+
#
|
|
17136
|
+
# @option params [required, String] :aws_account_id
|
|
17137
|
+
# The ID of the Amazon Web Services account that contains the spaces.
|
|
17138
|
+
#
|
|
17139
|
+
# @option params [String] :next_token
|
|
17140
|
+
# The token for the next set of results, or null if there are no more
|
|
17141
|
+
# results.
|
|
17142
|
+
#
|
|
17143
|
+
# @option params [Integer] :max_results
|
|
17144
|
+
# The maximum number of results to return.
|
|
17145
|
+
#
|
|
17146
|
+
# @option params [required, Array<Types::SpaceQuicksightSearchFilter>] :filters
|
|
17147
|
+
# The filters to apply to the search.
|
|
17148
|
+
#
|
|
17149
|
+
# @return [Types::SearchSpacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17150
|
+
#
|
|
17151
|
+
# * {Types::SearchSpacesResponse#space_id #space_id} => String
|
|
17152
|
+
# * {Types::SearchSpacesResponse#space_arn #space_arn} => String
|
|
17153
|
+
# * {Types::SearchSpacesResponse#space_summaries #space_summaries} => Array<Types::SpaceSummary>
|
|
17154
|
+
# * {Types::SearchSpacesResponse#next_token #next_token} => String
|
|
17155
|
+
# * {Types::SearchSpacesResponse#request_id #request_id} => String
|
|
17156
|
+
#
|
|
17157
|
+
# @example Request syntax with placeholder values
|
|
17158
|
+
#
|
|
17159
|
+
# resp = client.search_spaces({
|
|
17160
|
+
# aws_account_id: "AwsAccountId", # required
|
|
17161
|
+
# next_token: "NextToken",
|
|
17162
|
+
# max_results: 1,
|
|
17163
|
+
# filters: [ # required
|
|
17164
|
+
# {
|
|
17165
|
+
# name: "SPACE_ID", # required, accepts SPACE_ID, SPACE_NAME, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, CONTRIBUTED_BY, CONSUMED_SOURCE_SIZE, CREATED_BY
|
|
17166
|
+
# operator: "STRING_EQUALS", # required, accepts STRING_EQUALS, STRING_LIKE, NUMBER_RANGE
|
|
17167
|
+
# value: "String", # required
|
|
17168
|
+
# },
|
|
17169
|
+
# ],
|
|
17170
|
+
# })
|
|
17171
|
+
#
|
|
17172
|
+
# @example Response structure
|
|
17173
|
+
#
|
|
17174
|
+
# resp.space_id #=> String
|
|
17175
|
+
# resp.space_arn #=> String
|
|
17176
|
+
# resp.space_summaries #=> Array
|
|
17177
|
+
# resp.space_summaries[0].space_id #=> String
|
|
17178
|
+
# resp.space_summaries[0].space_arn #=> String
|
|
17179
|
+
# resp.space_summaries[0].name #=> String
|
|
17180
|
+
# resp.space_summaries[0].description #=> String
|
|
17181
|
+
# resp.space_summaries[0].updated_at #=> Time
|
|
17182
|
+
# resp.space_summaries[0].consumed_source_size #=> Integer
|
|
17183
|
+
# resp.space_summaries[0].consumed_source_doc_count #=> Integer
|
|
17184
|
+
# resp.space_summaries[0].created_at #=> Time
|
|
17185
|
+
# resp.space_summaries[0].created_by #=> String
|
|
17186
|
+
# resp.space_summaries[0].created_by_arn #=> String
|
|
17187
|
+
# resp.space_summaries[0].resources_count #=> Integer
|
|
17188
|
+
# resp.next_token #=> String
|
|
17189
|
+
# resp.request_id #=> String
|
|
17190
|
+
#
|
|
17191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchSpaces AWS API Documentation
|
|
17192
|
+
#
|
|
17193
|
+
# @overload search_spaces(params = {})
|
|
17194
|
+
# @param [Hash] params ({})
|
|
17195
|
+
def search_spaces(params = {}, options = {})
|
|
17196
|
+
req = build_request(:search_spaces, params)
|
|
17197
|
+
req.send_request(options)
|
|
17198
|
+
end
|
|
17199
|
+
|
|
16116
17200
|
# Searches for any Q topic that exists in an Quick account.
|
|
16117
17201
|
#
|
|
16118
17202
|
# @option params [required, String] :aws_account_id
|
|
@@ -17697,6 +18781,181 @@ module Aws::QuickSight
|
|
|
17697
18781
|
req.send_request(options)
|
|
17698
18782
|
end
|
|
17699
18783
|
|
|
18784
|
+
# Updates an existing agent.
|
|
18785
|
+
#
|
|
18786
|
+
# @option params [required, String] :agent_id
|
|
18787
|
+
# The unique identifier for the agent to update.
|
|
18788
|
+
#
|
|
18789
|
+
# @option params [required, String] :aws_account_id
|
|
18790
|
+
# The ID of the Amazon Web Services account that contains the agent.
|
|
18791
|
+
#
|
|
18792
|
+
# @option params [required, String] :name
|
|
18793
|
+
# The name of the agent.
|
|
18794
|
+
#
|
|
18795
|
+
# @option params [String] :description
|
|
18796
|
+
# A description of the agent.
|
|
18797
|
+
#
|
|
18798
|
+
# @option params [String] :icon_id
|
|
18799
|
+
# The icon identifier for the agent.
|
|
18800
|
+
#
|
|
18801
|
+
# @option params [Array<String>] :starter_prompts
|
|
18802
|
+
# A list of starter prompts that are displayed to users when they begin
|
|
18803
|
+
# interacting with the agent.
|
|
18804
|
+
#
|
|
18805
|
+
# @option params [String] :welcome_message
|
|
18806
|
+
# The welcome message that is displayed when a user starts a
|
|
18807
|
+
# conversation with the agent.
|
|
18808
|
+
#
|
|
18809
|
+
# @option params [Types::CustomPromptInput] :custom_prompt_input
|
|
18810
|
+
# The custom prompt configuration for the agent.
|
|
18811
|
+
#
|
|
18812
|
+
# @option params [Array<String>] :spaces_to_add
|
|
18813
|
+
# The Amazon Resource Names (ARNs) of the spaces to attach to the agent.
|
|
18814
|
+
#
|
|
18815
|
+
# @option params [Array<String>] :spaces_to_remove
|
|
18816
|
+
# The Amazon Resource Names (ARNs) of the spaces to detach from the
|
|
18817
|
+
# agent.
|
|
18818
|
+
#
|
|
18819
|
+
# @option params [Array<String>] :action_connectors_to_add
|
|
18820
|
+
# The Amazon Resource Names (ARNs) of the action connectors to attach to
|
|
18821
|
+
# the agent.
|
|
18822
|
+
#
|
|
18823
|
+
# @option params [Array<String>] :action_connectors_to_remove
|
|
18824
|
+
# The Amazon Resource Names (ARNs) of the action connectors to detach
|
|
18825
|
+
# from the agent.
|
|
18826
|
+
#
|
|
18827
|
+
# @return [Types::UpdateAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
18828
|
+
#
|
|
18829
|
+
# * {Types::UpdateAgentResponse#arn #arn} => String
|
|
18830
|
+
# * {Types::UpdateAgentResponse#agent_id #agent_id} => String
|
|
18831
|
+
# * {Types::UpdateAgentResponse#agent_status #agent_status} => String
|
|
18832
|
+
# * {Types::UpdateAgentResponse#failed_to_add_spaces #failed_to_add_spaces} => Array<Types::FailedToUpdateAssociation>
|
|
18833
|
+
# * {Types::UpdateAgentResponse#failed_to_remove_spaces #failed_to_remove_spaces} => Array<Types::FailedToUpdateAssociation>
|
|
18834
|
+
# * {Types::UpdateAgentResponse#failed_to_add_action_connectors #failed_to_add_action_connectors} => Array<Types::FailedToUpdateAssociation>
|
|
18835
|
+
# * {Types::UpdateAgentResponse#failed_to_remove_action_connectors #failed_to_remove_action_connectors} => Array<Types::FailedToUpdateAssociation>
|
|
18836
|
+
# * {Types::UpdateAgentResponse#request_id #request_id} => String
|
|
18837
|
+
#
|
|
18838
|
+
# @example Request syntax with placeholder values
|
|
18839
|
+
#
|
|
18840
|
+
# resp = client.update_agent({
|
|
18841
|
+
# agent_id: "AgentId", # required
|
|
18842
|
+
# aws_account_id: "AwsAccountId", # required
|
|
18843
|
+
# name: "AgentName", # required
|
|
18844
|
+
# description: "AgentDescription",
|
|
18845
|
+
# icon_id: "IconId",
|
|
18846
|
+
# starter_prompts: ["StarterPrompt"],
|
|
18847
|
+
# welcome_message: "WelcomeMessage",
|
|
18848
|
+
# custom_prompt_input: {
|
|
18849
|
+
# existing_prompt: {
|
|
18850
|
+
# model_profile_id: "ModelProfileId", # required
|
|
18851
|
+
# subscription_id: "SubscriptionId", # required
|
|
18852
|
+
# qbs_aws_account_id: "QbsAwsAccountId", # required
|
|
18853
|
+
# },
|
|
18854
|
+
# new_prompt: {
|
|
18855
|
+
# response_length: "StyleDescription",
|
|
18856
|
+
# output_style: "StyleDescription",
|
|
18857
|
+
# identity: "StyleDescription",
|
|
18858
|
+
# tone: "StyleDescription",
|
|
18859
|
+
# custom_instructions: "StyleDescription",
|
|
18860
|
+
# },
|
|
18861
|
+
# },
|
|
18862
|
+
# spaces_to_add: ["Arn"],
|
|
18863
|
+
# spaces_to_remove: ["Arn"],
|
|
18864
|
+
# action_connectors_to_add: ["Arn"],
|
|
18865
|
+
# action_connectors_to_remove: ["Arn"],
|
|
18866
|
+
# })
|
|
18867
|
+
#
|
|
18868
|
+
# @example Response structure
|
|
18869
|
+
#
|
|
18870
|
+
# resp.arn #=> String
|
|
18871
|
+
# resp.agent_id #=> String
|
|
18872
|
+
# resp.agent_status #=> String, one of "ACTIVE", "UPDATING", "FAILED", "CREATING"
|
|
18873
|
+
# resp.failed_to_add_spaces #=> Array
|
|
18874
|
+
# resp.failed_to_add_spaces[0].arn #=> String
|
|
18875
|
+
# resp.failed_to_add_spaces[0].error_message #=> String
|
|
18876
|
+
# resp.failed_to_add_spaces[0].error_code #=> String
|
|
18877
|
+
# resp.failed_to_remove_spaces #=> Array
|
|
18878
|
+
# resp.failed_to_remove_spaces[0].arn #=> String
|
|
18879
|
+
# resp.failed_to_remove_spaces[0].error_message #=> String
|
|
18880
|
+
# resp.failed_to_remove_spaces[0].error_code #=> String
|
|
18881
|
+
# resp.failed_to_add_action_connectors #=> Array
|
|
18882
|
+
# resp.failed_to_add_action_connectors[0].arn #=> String
|
|
18883
|
+
# resp.failed_to_add_action_connectors[0].error_message #=> String
|
|
18884
|
+
# resp.failed_to_add_action_connectors[0].error_code #=> String
|
|
18885
|
+
# resp.failed_to_remove_action_connectors #=> Array
|
|
18886
|
+
# resp.failed_to_remove_action_connectors[0].arn #=> String
|
|
18887
|
+
# resp.failed_to_remove_action_connectors[0].error_message #=> String
|
|
18888
|
+
# resp.failed_to_remove_action_connectors[0].error_code #=> String
|
|
18889
|
+
# resp.request_id #=> String
|
|
18890
|
+
#
|
|
18891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAgent AWS API Documentation
|
|
18892
|
+
#
|
|
18893
|
+
# @overload update_agent(params = {})
|
|
18894
|
+
# @param [Hash] params ({})
|
|
18895
|
+
def update_agent(params = {}, options = {})
|
|
18896
|
+
req = build_request(:update_agent, params)
|
|
18897
|
+
req.send_request(options)
|
|
18898
|
+
end
|
|
18899
|
+
|
|
18900
|
+
# Updates the resource permissions for an agent.
|
|
18901
|
+
#
|
|
18902
|
+
# @option params [required, String] :agent_id
|
|
18903
|
+
# The unique identifier for the agent.
|
|
18904
|
+
#
|
|
18905
|
+
# @option params [required, String] :aws_account_id
|
|
18906
|
+
# The ID of the Amazon Web Services account that contains the agent.
|
|
18907
|
+
#
|
|
18908
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
|
18909
|
+
# The resource permissions that you want to grant on the agent.
|
|
18910
|
+
#
|
|
18911
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
|
18912
|
+
# The resource permissions that you want to revoke from the agent.
|
|
18913
|
+
#
|
|
18914
|
+
# @return [Types::UpdateAgentPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
18915
|
+
#
|
|
18916
|
+
# * {Types::UpdateAgentPermissionsResponse#arn #arn} => String
|
|
18917
|
+
# * {Types::UpdateAgentPermissionsResponse#agent_id #agent_id} => String
|
|
18918
|
+
# * {Types::UpdateAgentPermissionsResponse#request_id #request_id} => String
|
|
18919
|
+
# * {Types::UpdateAgentPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
|
18920
|
+
#
|
|
18921
|
+
# @example Request syntax with placeholder values
|
|
18922
|
+
#
|
|
18923
|
+
# resp = client.update_agent_permissions({
|
|
18924
|
+
# agent_id: "AgentId", # required
|
|
18925
|
+
# aws_account_id: "AwsAccountId", # required
|
|
18926
|
+
# grant_permissions: [
|
|
18927
|
+
# {
|
|
18928
|
+
# principal: "Principal", # required
|
|
18929
|
+
# actions: ["String"], # required
|
|
18930
|
+
# },
|
|
18931
|
+
# ],
|
|
18932
|
+
# revoke_permissions: [
|
|
18933
|
+
# {
|
|
18934
|
+
# principal: "Principal", # required
|
|
18935
|
+
# actions: ["String"], # required
|
|
18936
|
+
# },
|
|
18937
|
+
# ],
|
|
18938
|
+
# })
|
|
18939
|
+
#
|
|
18940
|
+
# @example Response structure
|
|
18941
|
+
#
|
|
18942
|
+
# resp.arn #=> String
|
|
18943
|
+
# resp.agent_id #=> String
|
|
18944
|
+
# resp.request_id #=> String
|
|
18945
|
+
# resp.permissions #=> Array
|
|
18946
|
+
# resp.permissions[0].principal #=> String
|
|
18947
|
+
# resp.permissions[0].actions #=> Array
|
|
18948
|
+
# resp.permissions[0].actions[0] #=> String
|
|
18949
|
+
#
|
|
18950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAgentPermissions AWS API Documentation
|
|
18951
|
+
#
|
|
18952
|
+
# @overload update_agent_permissions(params = {})
|
|
18953
|
+
# @param [Hash] params ({})
|
|
18954
|
+
def update_agent_permissions(params = {}, options = {})
|
|
18955
|
+
req = build_request(:update_agent_permissions, params)
|
|
18956
|
+
req.send_request(options)
|
|
18957
|
+
end
|
|
18958
|
+
|
|
17700
18959
|
# Updates an analysis in Amazon Quick Sight
|
|
17701
18960
|
#
|
|
17702
18961
|
# @option params [required, String] :aws_account_id
|
|
@@ -20183,6 +21442,82 @@ module Aws::QuickSight
|
|
|
20183
21442
|
req.send_request(options)
|
|
20184
21443
|
end
|
|
20185
21444
|
|
|
21445
|
+
# Updates an existing flow. Supply only the fields you want to change.
|
|
21446
|
+
# Updates both DRAFT and PUBLISHED versions. When `FlowDefinition` is
|
|
21447
|
+
# provided, all existing steps are replaced with the new definition.
|
|
21448
|
+
#
|
|
21449
|
+
# @option params [required, String] :aws_account_id
|
|
21450
|
+
# The ID of the Amazon Web Services account that contains the flow that
|
|
21451
|
+
# you are updating.
|
|
21452
|
+
#
|
|
21453
|
+
# @option params [required, String] :flow_id
|
|
21454
|
+
# The unique identifier of the flow to update.
|
|
21455
|
+
#
|
|
21456
|
+
# @option params [String] :name
|
|
21457
|
+
# Updated display name for the flow. Omit to preserve the existing name.
|
|
21458
|
+
#
|
|
21459
|
+
# @option params [String] :description
|
|
21460
|
+
# Updated description for the flow. Omit to preserve the existing
|
|
21461
|
+
# description.
|
|
21462
|
+
#
|
|
21463
|
+
# @option params [Hash,Array,String,Numeric,Boolean] :flow_definition
|
|
21464
|
+
# The definition of the flow, specifying the steps and configurations.
|
|
21465
|
+
# This is the flow definition in Quick Flow's internal format. The
|
|
21466
|
+
# format is subject to change. When provided, all existing steps are
|
|
21467
|
+
# replaced. Omit to preserve the existing definition.
|
|
21468
|
+
#
|
|
21469
|
+
# <note markdown="1"> Always derive or depend on the flow definition from the `DescribeFlow`
|
|
21470
|
+
# operation to ensure you are working with the latest format.
|
|
21471
|
+
#
|
|
21472
|
+
# </note>
|
|
21473
|
+
#
|
|
21474
|
+
# Document type used to carry open content
|
|
21475
|
+
# (Hash,Array,String,Numeric,Boolean). A document type value is
|
|
21476
|
+
# serialized using the same format as its surroundings and requires no
|
|
21477
|
+
# additional encoding or escaping.
|
|
21478
|
+
#
|
|
21479
|
+
# @option params [String] :client_token
|
|
21480
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
21481
|
+
# idempotency of the request.
|
|
21482
|
+
#
|
|
21483
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
21484
|
+
# not need to pass this option.**
|
|
21485
|
+
#
|
|
21486
|
+
# @return [Types::UpdateFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
21487
|
+
#
|
|
21488
|
+
# * {Types::UpdateFlowResponse#arn #arn} => String
|
|
21489
|
+
# * {Types::UpdateFlowResponse#flow_id #flow_id} => String
|
|
21490
|
+
# * {Types::UpdateFlowResponse#request_id #request_id} => String
|
|
21491
|
+
# * {Types::UpdateFlowResponse#status #status} => Integer
|
|
21492
|
+
#
|
|
21493
|
+
# @example Request syntax with placeholder values
|
|
21494
|
+
#
|
|
21495
|
+
# resp = client.update_flow({
|
|
21496
|
+
# aws_account_id: "AccountId", # required
|
|
21497
|
+
# flow_id: "FlowId", # required
|
|
21498
|
+
# name: "TitleInput",
|
|
21499
|
+
# description: "FlowDescriptionInput",
|
|
21500
|
+
# flow_definition: {
|
|
21501
|
+
# },
|
|
21502
|
+
# client_token: "UpdateFlowRequestClientTokenString",
|
|
21503
|
+
# })
|
|
21504
|
+
#
|
|
21505
|
+
# @example Response structure
|
|
21506
|
+
#
|
|
21507
|
+
# resp.arn #=> String
|
|
21508
|
+
# resp.flow_id #=> String
|
|
21509
|
+
# resp.request_id #=> String
|
|
21510
|
+
# resp.status #=> Integer
|
|
21511
|
+
#
|
|
21512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFlow AWS API Documentation
|
|
21513
|
+
#
|
|
21514
|
+
# @overload update_flow(params = {})
|
|
21515
|
+
# @param [Hash] params ({})
|
|
21516
|
+
def update_flow(params = {}, options = {})
|
|
21517
|
+
req = build_request(:update_flow, params)
|
|
21518
|
+
req.send_request(options)
|
|
21519
|
+
end
|
|
21520
|
+
|
|
20186
21521
|
# Updates permissions against principals on a flow.
|
|
20187
21522
|
#
|
|
20188
21523
|
# @option params [required, String] :aws_account_id
|
|
@@ -20636,6 +21971,86 @@ module Aws::QuickSight
|
|
|
20636
21971
|
req.send_request(options)
|
|
20637
21972
|
end
|
|
20638
21973
|
|
|
21974
|
+
# Updates an OAuthClientApplication.
|
|
21975
|
+
#
|
|
21976
|
+
# @option params [required, String] :aws_account_id
|
|
21977
|
+
# The Amazon Web Services account ID.
|
|
21978
|
+
#
|
|
21979
|
+
# @option params [required, String] :o_auth_client_application_id
|
|
21980
|
+
# The ID of the OAuthClientApplication that you want to update.
|
|
21981
|
+
#
|
|
21982
|
+
# @option params [required, String] :name
|
|
21983
|
+
# The display name for the OAuthClientApplication.
|
|
21984
|
+
#
|
|
21985
|
+
# @option params [String] :client_id
|
|
21986
|
+
# The client ID of the OAuth application that is registered with the
|
|
21987
|
+
# identity provider.
|
|
21988
|
+
#
|
|
21989
|
+
# @option params [String] :client_secret
|
|
21990
|
+
# The client secret of the OAuth application that is registered with the
|
|
21991
|
+
# identity provider.
|
|
21992
|
+
#
|
|
21993
|
+
# @option params [String] :o_auth_token_endpoint_url
|
|
21994
|
+
# The token endpoint URL of the identity provider that is used to obtain
|
|
21995
|
+
# access tokens.
|
|
21996
|
+
#
|
|
21997
|
+
# @option params [String] :o_auth_authorization_endpoint_url
|
|
21998
|
+
# The authorization endpoint URL of the identity provider that is used
|
|
21999
|
+
# to obtain authorization codes.
|
|
22000
|
+
#
|
|
22001
|
+
# @option params [String] :o_auth_scopes
|
|
22002
|
+
# The OAuth scopes that are requested when the OAuthClientApplication
|
|
22003
|
+
# obtains an access token from the identity provider.
|
|
22004
|
+
#
|
|
22005
|
+
# @option params [String] :data_source_type
|
|
22006
|
+
# The type of data source that the OAuthClientApplication is used with.
|
|
22007
|
+
# Valid values are `SNOWFLAKE`.
|
|
22008
|
+
#
|
|
22009
|
+
# @option params [Types::VpcConnectionProperties] :identity_provider_vpc_connection_properties
|
|
22010
|
+
# VPC connection properties.
|
|
22011
|
+
#
|
|
22012
|
+
# @return [Types::UpdateOAuthClientApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
22013
|
+
#
|
|
22014
|
+
# * {Types::UpdateOAuthClientApplicationResponse#arn #arn} => String
|
|
22015
|
+
# * {Types::UpdateOAuthClientApplicationResponse#o_auth_client_application_id #o_auth_client_application_id} => String
|
|
22016
|
+
# * {Types::UpdateOAuthClientApplicationResponse#update_status #update_status} => String
|
|
22017
|
+
# * {Types::UpdateOAuthClientApplicationResponse#request_id #request_id} => String
|
|
22018
|
+
# * {Types::UpdateOAuthClientApplicationResponse#status #status} => Integer
|
|
22019
|
+
#
|
|
22020
|
+
# @example Request syntax with placeholder values
|
|
22021
|
+
#
|
|
22022
|
+
# resp = client.update_o_auth_client_application({
|
|
22023
|
+
# aws_account_id: "AwsAccountId", # required
|
|
22024
|
+
# o_auth_client_application_id: "OAuthClientApplicationId", # required
|
|
22025
|
+
# name: "ResourceName", # required
|
|
22026
|
+
# client_id: "OAuthClientId",
|
|
22027
|
+
# client_secret: "OAuthClientSecret",
|
|
22028
|
+
# o_auth_token_endpoint_url: "OAuthTokenEndpointUrl",
|
|
22029
|
+
# o_auth_authorization_endpoint_url: "OAuthAuthorizationEndpointUrl",
|
|
22030
|
+
# o_auth_scopes: "OAuthScopesString",
|
|
22031
|
+
# data_source_type: "ADOBE_ANALYTICS", # accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, S3_TABLES, 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
|
|
22032
|
+
# identity_provider_vpc_connection_properties: {
|
|
22033
|
+
# vpc_connection_arn: "Arn", # required
|
|
22034
|
+
# },
|
|
22035
|
+
# })
|
|
22036
|
+
#
|
|
22037
|
+
# @example Response structure
|
|
22038
|
+
#
|
|
22039
|
+
# resp.arn #=> String
|
|
22040
|
+
# resp.o_auth_client_application_id #=> String
|
|
22041
|
+
# resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
|
22042
|
+
# resp.request_id #=> String
|
|
22043
|
+
# resp.status #=> Integer
|
|
22044
|
+
#
|
|
22045
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateOAuthClientApplication AWS API Documentation
|
|
22046
|
+
#
|
|
22047
|
+
# @overload update_o_auth_client_application(params = {})
|
|
22048
|
+
# @param [Hash] params ({})
|
|
22049
|
+
def update_o_auth_client_application(params = {}, options = {})
|
|
22050
|
+
req = build_request(:update_o_auth_client_application, params)
|
|
22051
|
+
req.send_request(options)
|
|
22052
|
+
end
|
|
22053
|
+
|
|
20639
22054
|
# This API controls public sharing settings for your entire Quick Sight
|
|
20640
22055
|
# account, affecting data security and access. When you enable public
|
|
20641
22056
|
# sharing:
|
|
@@ -21015,6 +22430,172 @@ module Aws::QuickSight
|
|
|
21015
22430
|
req.send_request(options)
|
|
21016
22431
|
end
|
|
21017
22432
|
|
|
22433
|
+
# Updates the metadata of an Amazon QuickSight space.
|
|
22434
|
+
#
|
|
22435
|
+
# @option params [required, String] :aws_account_id
|
|
22436
|
+
# The ID of the Amazon Web Services account that contains the space.
|
|
22437
|
+
#
|
|
22438
|
+
# @option params [required, String] :space_id
|
|
22439
|
+
# The ID of the space that you want to update.
|
|
22440
|
+
#
|
|
22441
|
+
# @option params [String] :name
|
|
22442
|
+
# A new display name for the space.
|
|
22443
|
+
#
|
|
22444
|
+
# @option params [String] :description
|
|
22445
|
+
# A new description for the space.
|
|
22446
|
+
#
|
|
22447
|
+
# @return [Types::UpdateSpaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
22448
|
+
#
|
|
22449
|
+
# * {Types::UpdateSpaceResponse#space_id #space_id} => String
|
|
22450
|
+
# * {Types::UpdateSpaceResponse#space_arn #space_arn} => String
|
|
22451
|
+
# * {Types::UpdateSpaceResponse#request_id #request_id} => String
|
|
22452
|
+
#
|
|
22453
|
+
# @example Request syntax with placeholder values
|
|
22454
|
+
#
|
|
22455
|
+
# resp = client.update_space({
|
|
22456
|
+
# aws_account_id: "AwsAccountId", # required
|
|
22457
|
+
# space_id: "PublicSpaceId", # required
|
|
22458
|
+
# name: "SpaceName",
|
|
22459
|
+
# description: "SpaceDescription",
|
|
22460
|
+
# })
|
|
22461
|
+
#
|
|
22462
|
+
# @example Response structure
|
|
22463
|
+
#
|
|
22464
|
+
# resp.space_id #=> String
|
|
22465
|
+
# resp.space_arn #=> String
|
|
22466
|
+
# resp.request_id #=> String
|
|
22467
|
+
#
|
|
22468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateSpace AWS API Documentation
|
|
22469
|
+
#
|
|
22470
|
+
# @overload update_space(params = {})
|
|
22471
|
+
# @param [Hash] params ({})
|
|
22472
|
+
def update_space(params = {}, options = {})
|
|
22473
|
+
req = build_request(:update_space, params)
|
|
22474
|
+
req.send_request(options)
|
|
22475
|
+
end
|
|
22476
|
+
|
|
22477
|
+
# Updates the permissions for an Amazon QuickSight space.
|
|
22478
|
+
#
|
|
22479
|
+
# @option params [required, String] :aws_account_id
|
|
22480
|
+
# The ID of the Amazon Web Services account that contains the space.
|
|
22481
|
+
#
|
|
22482
|
+
# @option params [required, String] :space_id
|
|
22483
|
+
# The ID of the space that you want to update permissions for.
|
|
22484
|
+
#
|
|
22485
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
|
22486
|
+
# The permissions that you want to grant on the space.
|
|
22487
|
+
#
|
|
22488
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
|
22489
|
+
# The permissions that you want to revoke from the space.
|
|
22490
|
+
#
|
|
22491
|
+
# @return [Types::UpdateSpacePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
22492
|
+
#
|
|
22493
|
+
# * {Types::UpdateSpacePermissionsResponse#space_id #space_id} => String
|
|
22494
|
+
# * {Types::UpdateSpacePermissionsResponse#space_arn #space_arn} => String
|
|
22495
|
+
# * {Types::UpdateSpacePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
|
22496
|
+
# * {Types::UpdateSpacePermissionsResponse#request_id #request_id} => String
|
|
22497
|
+
#
|
|
22498
|
+
# @example Request syntax with placeholder values
|
|
22499
|
+
#
|
|
22500
|
+
# resp = client.update_space_permissions({
|
|
22501
|
+
# aws_account_id: "AwsAccountId", # required
|
|
22502
|
+
# space_id: "PublicSpaceId", # required
|
|
22503
|
+
# grant_permissions: [
|
|
22504
|
+
# {
|
|
22505
|
+
# principal: "Principal", # required
|
|
22506
|
+
# actions: ["String"], # required
|
|
22507
|
+
# },
|
|
22508
|
+
# ],
|
|
22509
|
+
# revoke_permissions: [
|
|
22510
|
+
# {
|
|
22511
|
+
# principal: "Principal", # required
|
|
22512
|
+
# actions: ["String"], # required
|
|
22513
|
+
# },
|
|
22514
|
+
# ],
|
|
22515
|
+
# })
|
|
22516
|
+
#
|
|
22517
|
+
# @example Response structure
|
|
22518
|
+
#
|
|
22519
|
+
# resp.space_id #=> String
|
|
22520
|
+
# resp.space_arn #=> String
|
|
22521
|
+
# resp.permissions #=> Array
|
|
22522
|
+
# resp.permissions[0].principal #=> String
|
|
22523
|
+
# resp.permissions[0].actions #=> Array
|
|
22524
|
+
# resp.permissions[0].actions[0] #=> String
|
|
22525
|
+
# resp.request_id #=> String
|
|
22526
|
+
#
|
|
22527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateSpacePermissions AWS API Documentation
|
|
22528
|
+
#
|
|
22529
|
+
# @overload update_space_permissions(params = {})
|
|
22530
|
+
# @param [Hash] params ({})
|
|
22531
|
+
def update_space_permissions(params = {}, options = {})
|
|
22532
|
+
req = build_request(:update_space_permissions, params)
|
|
22533
|
+
req.send_request(options)
|
|
22534
|
+
end
|
|
22535
|
+
|
|
22536
|
+
# Adds or removes resources from an Amazon QuickSight space.
|
|
22537
|
+
#
|
|
22538
|
+
# @option params [required, String] :aws_account_id
|
|
22539
|
+
# The ID of the Amazon Web Services account that contains the space.
|
|
22540
|
+
#
|
|
22541
|
+
# @option params [required, String] :space_id
|
|
22542
|
+
# The ID of the space that you want to update resources for.
|
|
22543
|
+
#
|
|
22544
|
+
# @option params [Array<Types::SpaceResourceOperation>] :add_resources
|
|
22545
|
+
# A list of resources to add to the space.
|
|
22546
|
+
#
|
|
22547
|
+
# @option params [Array<Types::SpaceResourceOperation>] :remove_resources
|
|
22548
|
+
# A list of resources to remove from the space.
|
|
22549
|
+
#
|
|
22550
|
+
# @return [Types::UpdateSpaceResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
22551
|
+
#
|
|
22552
|
+
# * {Types::UpdateSpaceResourcesResponse#space_id #space_id} => String
|
|
22553
|
+
# * {Types::UpdateSpaceResourcesResponse#space_arn #space_arn} => String
|
|
22554
|
+
# * {Types::UpdateSpaceResourcesResponse#failed_resource_operations #failed_resource_operations} => Array<Types::FailedSpaceResourceOperation>
|
|
22555
|
+
# * {Types::UpdateSpaceResourcesResponse#request_id #request_id} => String
|
|
22556
|
+
#
|
|
22557
|
+
# @example Request syntax with placeholder values
|
|
22558
|
+
#
|
|
22559
|
+
# resp = client.update_space_resources({
|
|
22560
|
+
# aws_account_id: "AwsAccountId", # required
|
|
22561
|
+
# space_id: "PublicSpaceId", # required
|
|
22562
|
+
# add_resources: [
|
|
22563
|
+
# {
|
|
22564
|
+
# resource_type: "TOPIC", # required, accepts TOPIC, DASHBOARD, KNOWLEDGE_BASE, SPACE, ACTION_CONNECTOR, DATA_SET, ARTIFACT
|
|
22565
|
+
# resource_details: { # required
|
|
22566
|
+
# resource_arn: "Arn",
|
|
22567
|
+
# },
|
|
22568
|
+
# },
|
|
22569
|
+
# ],
|
|
22570
|
+
# remove_resources: [
|
|
22571
|
+
# {
|
|
22572
|
+
# resource_type: "TOPIC", # required, accepts TOPIC, DASHBOARD, KNOWLEDGE_BASE, SPACE, ACTION_CONNECTOR, DATA_SET, ARTIFACT
|
|
22573
|
+
# resource_details: { # required
|
|
22574
|
+
# resource_arn: "Arn",
|
|
22575
|
+
# },
|
|
22576
|
+
# },
|
|
22577
|
+
# ],
|
|
22578
|
+
# })
|
|
22579
|
+
#
|
|
22580
|
+
# @example Response structure
|
|
22581
|
+
#
|
|
22582
|
+
# resp.space_id #=> String
|
|
22583
|
+
# resp.space_arn #=> String
|
|
22584
|
+
# resp.failed_resource_operations #=> Array
|
|
22585
|
+
# resp.failed_resource_operations[0].resource_type #=> String, one of "TOPIC", "DASHBOARD", "KNOWLEDGE_BASE", "SPACE", "ACTION_CONNECTOR", "DATA_SET", "ARTIFACT"
|
|
22586
|
+
# resp.failed_resource_operations[0].resource_details.resource_arn #=> String
|
|
22587
|
+
# resp.failed_resource_operations[0].error_message #=> String
|
|
22588
|
+
# resp.request_id #=> String
|
|
22589
|
+
#
|
|
22590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateSpaceResources AWS API Documentation
|
|
22591
|
+
#
|
|
22592
|
+
# @overload update_space_resources(params = {})
|
|
22593
|
+
# @param [Hash] params ({})
|
|
22594
|
+
def update_space_resources(params = {}, options = {})
|
|
22595
|
+
req = build_request(:update_space_resources, params)
|
|
22596
|
+
req.send_request(options)
|
|
22597
|
+
end
|
|
22598
|
+
|
|
21018
22599
|
# Updates a template from an existing Amazon Quick Sight analysis or
|
|
21019
22600
|
# another template.
|
|
21020
22601
|
#
|
|
@@ -22266,7 +23847,7 @@ module Aws::QuickSight
|
|
|
22266
23847
|
tracer: tracer
|
|
22267
23848
|
)
|
|
22268
23849
|
context[:gem_name] = 'aws-sdk-quicksight'
|
|
22269
|
-
context[:gem_version] = '1.
|
|
23850
|
+
context[:gem_version] = '1.185.0'
|
|
22270
23851
|
Seahorse::Client::Request.new(handlers, context)
|
|
22271
23852
|
end
|
|
22272
23853
|
|