UNPKG

@aws-sdk/client-iot

Version:

AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native

97 lines (96 loc) 4.39 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { UpdateDomainConfigurationRequest, UpdateDomainConfigurationResponse } from "../models/models_2"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateDomainConfigurationCommand}. */ export interface UpdateDomainConfigurationCommandInput extends UpdateDomainConfigurationRequest { } /** * @public * * The output of {@link UpdateDomainConfigurationCommand}. */ export interface UpdateDomainConfigurationCommandOutput extends UpdateDomainConfigurationResponse, __MetadataBearer { } declare const UpdateDomainConfigurationCommand_base: { new (input: UpdateDomainConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDomainConfigurationCommandInput, UpdateDomainConfigurationCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: UpdateDomainConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDomainConfigurationCommandInput, UpdateDomainConfigurationCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Updates values stored in the domain configuration. Domain configurations for default * endpoints can't be updated.</p> * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateDomainConfiguration</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, UpdateDomainConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, UpdateDomainConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // UpdateDomainConfigurationRequest * domainConfigurationName: "STRING_VALUE", // required * authorizerConfig: { // AuthorizerConfig * defaultAuthorizerName: "STRING_VALUE", * allowAuthorizerOverride: true || false, * }, * domainConfigurationStatus: "ENABLED" || "DISABLED", * removeAuthorizerConfig: true || false, * tlsConfig: { // TlsConfig * securityPolicy: "STRING_VALUE", * }, * serverCertificateConfig: { // ServerCertificateConfig * enableOCSPCheck: true || false, * }, * }; * const command = new UpdateDomainConfigurationCommand(input); * const response = await client.send(command); * // { // UpdateDomainConfigurationResponse * // domainConfigurationName: "STRING_VALUE", * // domainConfigurationArn: "STRING_VALUE", * // }; * * ``` * * @param UpdateDomainConfigurationCommandInput - {@link UpdateDomainConfigurationCommandInput} * @returns {@link UpdateDomainConfigurationCommandOutput} * @see {@link UpdateDomainConfigurationCommandInput} for command's `input` shape. * @see {@link UpdateDomainConfigurationCommandOutput} for command's `response` shape. * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape. * * @throws {@link CertificateValidationException} (client fault) * <p>The certificate is invalid.</p> * * @throws {@link InternalFailureException} (server fault) * <p>An unexpected error has occurred.</p> * * @throws {@link InvalidRequestException} (client fault) * <p>The request is not valid.</p> * * @throws {@link ResourceNotFoundException} (client fault) * <p>The specified resource does not exist.</p> * * @throws {@link ServiceUnavailableException} (server fault) * <p>The service is temporarily unavailable.</p> * * @throws {@link ThrottlingException} (client fault) * <p>The rate exceeds the limit.</p> * * @throws {@link UnauthorizedException} (client fault) * <p>You are not authorized to perform this operation.</p> * * @throws {@link IoTServiceException} * <p>Base exception class for all service exceptions from IoT service.</p> * * @public */ export declare class UpdateDomainConfigurationCommand extends UpdateDomainConfigurationCommand_base { }