Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { M2Client, GetSignedBluinsightsUrlCommand } from "@aws-sdk/client-m2"; // ES Modules import + * // const { M2Client, GetSignedBluinsightsUrlCommand } = require("@aws-sdk/client-m2"); // CommonJS import + * const client = new M2Client(config); + * const input = {}; + * const command = new GetSignedBluinsightsUrlCommand(input); + * const response = await client.send(command); + * // { // GetSignedBluinsightsUrlResponse + * // signedBiUrl: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param GetSignedBluinsightsUrlCommandInput - {@link GetSignedBluinsightsUrlCommandInput} + * @returns {@link GetSignedBluinsightsUrlCommandOutput} + * @see {@link GetSignedBluinsightsUrlCommandInput} for command's `input` shape. + * @see {@link GetSignedBluinsightsUrlCommandOutput} for command's `response` shape. + * @see {@link M2ClientResolvedConfig | config} for M2Client's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The account or role doesn't have the right permissions to make the request.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred during the processing of the request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The number of requests made exceeds the limit.
+ * + * @throws {@link M2ServiceException} + *Base exception class for all service exceptions from M2 service.
+ * + */ +export class GetSignedBluinsightsUrlCommand extends $Command< + GetSignedBluinsightsUrlCommandInput, + GetSignedBluinsightsUrlCommandOutput, + M2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetSignedBluinsightsUrlCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe Amazon Resource Name (ARN) of the role associated with the application.
+ *The Amazon Resource Name (ARN) that identifies a role that the application uses to access Amazon Web Services resources + * that are not part of the application or are in a different Amazon Web Services account.
*/ roleArn?: string; } @@ -481,7 +482,8 @@ export interface PoAttributes { encoding?: string; /** - *An array containing one or more filename extensions, allowing you to specify which files to be included as PDS member.
+ *An array containing one or more filename extensions, allowing you to specify which files + * to be included as PDS member.
*/ memberFileExtensions: string[] | undefined; } @@ -2519,7 +2521,7 @@ export interface UpdateApplicationResponse { */ export interface HighAvailabilityConfig { /** - *The number of instances in a high availability configuration.
+ *The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.
*/ desiredCapacity: number | undefined; } @@ -2992,7 +2994,7 @@ export interface UpdateEnvironmentRequest { environmentId: string | undefined; /** - *The desired capacity for the runtime environment to update.
+ *The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.
*/ desiredCapacity?: number; @@ -3032,6 +3034,16 @@ export interface UpdateEnvironmentResponse { environmentId: string | undefined; } +/** + * @public + */ +export interface GetSignedBluinsightsUrlResponse { + /** + *Single sign-on AWS Blu Insights URL.
+ */ + signedBiUrl: string | undefined; +} + /** * @public */ diff --git a/clients/client-m2/src/protocols/Aws_restJson1.ts b/clients/client-m2/src/protocols/Aws_restJson1.ts index cddfcf2efe87..214da544052d 100644 --- a/clients/client-m2/src/protocols/Aws_restJson1.ts +++ b/clients/client-m2/src/protocols/Aws_restJson1.ts @@ -59,6 +59,10 @@ import { } from "../commands/GetDataSetImportTaskCommand"; import { GetDeploymentCommandInput, GetDeploymentCommandOutput } from "../commands/GetDeploymentCommand"; import { GetEnvironmentCommandInput, GetEnvironmentCommandOutput } from "../commands/GetEnvironmentCommand"; +import { + GetSignedBluinsightsUrlCommandInput, + GetSignedBluinsightsUrlCommandOutput, +} from "../commands/GetSignedBluinsightsUrlCommand"; import { ListApplicationsCommandInput, ListApplicationsCommandOutput } from "../commands/ListApplicationsCommand"; import { ListApplicationVersionsCommandInput, @@ -664,6 +668,31 @@ export const se_GetEnvironmentCommand = async ( }); }; +/** + * serializeAws_restJson1GetSignedBluinsightsUrlCommand + */ +export const se_GetSignedBluinsightsUrlCommand = async ( + input: GetSignedBluinsightsUrlCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/signed-bi-url"; + let body: any; + body = ""; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1ListApplicationsCommand */ @@ -2225,6 +2254,59 @@ const de_GetEnvironmentCommandError = async ( } }; +/** + * deserializeAws_restJson1GetSignedBluinsightsUrlCommand + */ +export const de_GetSignedBluinsightsUrlCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseThe Amazon Resource Name (ARN) of the role associated with the application.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies a role that the application uses to access Amazon Web Services resources\n that are not part of the application or are in a different Amazon Web Services account.
" } } } @@ -2730,6 +2727,10 @@ "value": "Available", "name": "AVAILABLE" }, + { + "value": "Updating", + "name": "UPDATING" + }, { "value": "Deleting", "name": "DELETING" @@ -2737,10 +2738,6 @@ { "value": "Failed", "name": "FAILED" - }, - { - "value": "Updating", - "name": "UPDATING" } ] } @@ -3874,13 +3871,59 @@ } } }, + "com.amazonaws.m2#GetSignedBluinsightsUrl": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.m2#GetSignedBluinsightsUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#actionPermissionDescription": "Grants permission to create a signed Bluinsights url", + "smithy.api#documentation": "Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
", + "smithy.api#http": { + "method": "GET", + "uri": "/signed-bi-url", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#GetSignedBluinsightsUrlResponse": { + "type": "structure", + "members": { + "signedBiUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Single sign-on AWS Blu Insights URL.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.m2#HighAvailabilityConfig": { "type": "structure", "members": { "desiredCapacity": { "target": "com.amazonaws.m2#CapacityValue", "traits": { - "smithy.api#documentation": "The number of instances in a high availability configuration.
", + "smithy.api#documentation": "The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.
", "smithy.api#required": {} } } @@ -4950,7 +4993,7 @@ "traits": { "smithy.api#range": { "min": 1, - "max": 100 + "max": 2000 } } }, @@ -4999,7 +5042,7 @@ "memberFileExtensions": { "target": "com.amazonaws.m2#String20List", "traits": { - "smithy.api#documentation": "An array containing one or more filename extensions, allowing you to specify which files to be included as PDS member.
", + "smithy.api#documentation": "An array containing one or more filename extensions, allowing you to specify which files\n to be included as PDS member.
", "smithy.api#required": {} } } @@ -5857,7 +5900,7 @@ "target": "com.amazonaws.m2#CapacityValue", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "The desired capacity for the runtime environment to update.
" + "smithy.api#documentation": "The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.
" } }, "instanceType": {