Skip to content

Commit

Permalink
docs(client-quicksight): A series of documentation updates to the Qui…
Browse files Browse the repository at this point in the history 
…ckSight API reference.
  • Loading branch information
awstools committed Aug 8, 2022
1 parent ded8662 commit 3425087
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 23 deletions.
11 changes: 7 additions & 4 deletions clients/client-quicksight/src/QuickSight.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -902,7 +902,7 @@ export class QuickSight extends QuickSightClient {
}

/**
* <p>Creates an Amazon QuickSight group.</p>
* <p>Use the <code>CreateGroup</code> operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.</p>
* <p>The permissions resource is
* <code>arn:aws:quicksight:<your-region>:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i>
* </code>.</p>
Expand Down Expand Up @@ -2774,7 +2774,7 @@ export class QuickSight extends QuickSightClient {
}

/**
* <p>Generates a temporary session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. </p>
* <p>Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. </p>
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user's browser. The following rules apply to the generated URL:</p>
* <ul>
* <li>
Expand All @@ -2787,7 +2787,10 @@ export class QuickSight extends QuickSightClient {
* <p>They are valid for 5 minutes after you run this command.</p>
* </li>
* <li>
* <p>The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional <code>SessionLifetimeInMinutes</code> parameter to customi session duration.</p>
* <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p>
* </li>
* <li>
* <p>The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional <code>SessionLifetimeInMinutes</code> parameter to customize session duration.</p>
* </li>
* </ul>
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html">Embedding Analytics Using GetDashboardEmbedUrl</a> in the <i>Amazon QuickSight User
Expand Down Expand Up @@ -3250,7 +3253,7 @@ export class QuickSight extends QuickSightClient {
}

/**
* <p>Lists the namespaces for the specified Amazon Web Services account.</p>
* <p>Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.</p>
*/
public listNamespaces(
args: ListNamespacesCommandInput,
Expand Down
2 changes: 1 addition & 1 deletion clients/client-quicksight/src/commands/CreateGroupCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface CreateGroupCommandInput extends CreateGroupRequest {}
export interface CreateGroupCommandOutput extends CreateGroupResponse, __MetadataBearer {}

/**
* <p>Creates an Amazon QuickSight group.</p>
* <p>Use the <code>CreateGroup</code> operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.</p>
* <p>The permissions resource is
* <code>arn:aws:quicksight:<your-region>:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i>
* </code>.</p>
Expand Down
7 changes: 5 additions & 2 deletions clients/client-quicksight/src/commands/GetDashboardEmbedUrlCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface GetDashboardEmbedUrlCommandInput extends GetDashboardEmbedUrlRe
export interface GetDashboardEmbedUrlCommandOutput extends GetDashboardEmbedUrlResponse, __MetadataBearer {}

/**
* <p>Generates a temporary session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. </p>
* <p>Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. </p>
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user's browser. The following rules apply to the generated URL:</p>
* <ul>
* <li>
Expand All @@ -41,7 +41,10 @@ export interface GetDashboardEmbedUrlCommandOutput extends GetDashboardEmbedUrlR
* <p>They are valid for 5 minutes after you run this command.</p>
* </li>
* <li>
* <p>The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional <code>SessionLifetimeInMinutes</code> parameter to customi session duration.</p>
* <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p>
* </li>
* <li>
* <p>The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional <code>SessionLifetimeInMinutes</code> parameter to customize session duration.</p>
* </li>
* </ul>
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html">Embedding Analytics Using GetDashboardEmbedUrl</a> in the <i>Amazon QuickSight User
Expand Down
2 changes: 1 addition & 1 deletion clients/client-quicksight/src/commands/ListNamespacesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface ListNamespacesCommandInput extends ListNamespacesRequest {}
export interface ListNamespacesCommandOutput extends ListNamespacesResponse, __MetadataBearer {}

/**
* <p>Lists the namespaces for the specified Amazon Web Services account.</p>
* <p>Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
30 changes: 23 additions & 7 deletions clients/client-quicksight/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,11 @@ export interface GenerateEmbedUrlForAnonymousUserRequest {
SessionTags?: SessionTag[];

/**
* <p>The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose <code>Dashboard</code> embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.</p>
* <p>The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user
* is authorized to access during the lifetime of the session. If you choose
* <code>Dashboard</code> embedding experience, pass the list of dashboard ARNs in the
* account that you want the user to be able to view. Currently, you can pass up to 25
* dashboard ARNs in each API call.</p>
*/
AuthorizedResourceArns: string[] | undefined;

Expand All @@ -537,8 +541,14 @@ export interface GenerateEmbedUrlForAnonymousUserRequest {
ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration | undefined;

/**
* <p>The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console and instead allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.</p>
* <p>To include a subdomain, use <code>*</code> to include all subdomains under a specific domain to the allow list. For example, <code>https://*.sapp.amazon.com,</code> includes all subdomains under <code>https://sapp.amazon.com</code>.</p>
* <p>The domains that you want to add to the allow list for access to the generated URL that
* is then embedded. This optional parameter overrides the static domains that are
* configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it
* allows only the domains that you include in this parameter. You can list up to three
* domains or subdomains in each API call.</p>
* <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>.
* For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under
* <code>https://sapp.amazon.com</code>.</p>
*/
AllowedDomains?: string[];
}
Expand Down Expand Up @@ -766,8 +776,14 @@ export interface GenerateEmbedUrlForRegisteredUserRequest {
ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined;

/**
* <p>The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console and instead allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.</p>
* <p>To include a subdomain, use <code>*</code> to include all subdomains under a specific domain to the allow list. For example, <code>https://*.sapp.amazon.com,</code> includes all subdomains under <code>https://sapp.amazon.com</code>.</p>
* <p>The domains that you want to add to the allow list for access to the generated URL that
* is then embedded. This optional parameter overrides the static domains that are
* configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it
* allows only the domains that you include in this parameter. You can list up to three
* domains or subdomains in each API call.</p>
* <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>.
* For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under
* <code>https://sapp.amazon.com</code>.</p>
*/
AllowedDomains?: string[];
}
Expand Down Expand Up @@ -1614,7 +1630,7 @@ export interface ListNamespacesRequest {
AwsAccountId: string | undefined;

/**
* <p>A pagination token that can be used in a subsequent request.</p>
* <p>A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous <code>ListNameSpaces</code> API call if there is more data that can be returned. To receive the data, make another <code>ListNamespaces</code> API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a <code>ListNamespaces</code> API call with an expired token, you will receive a <code>HTTP 400 InvalidNextTokenException</code> error.</p>
*/
NextToken?: string;

Expand All @@ -1633,7 +1649,7 @@ export interface ListNamespacesResponse {
Namespaces?: NamespaceInfoV2[];

/**
* <p>A pagination token that can be used in a subsequent request.</p>
* <p>A unique pagination token that can be used in a subsequent request. Receiving <code>NextToken</code> in your response inticates that there is more data that can be returned. To receive the data, make another <code>ListNamespaces</code> API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a <code>ListNamespaces</code> API call with an expired token, you will receive a <code>HTTP 400 InvalidNextTokenException</code> error.</p>
*/
NextToken?: string;

Expand Down

0 comments on commit 3425087

Please sign in to comment.