GetGlobalSettingsCommand

Suggest an Edit

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ChimeClient, GetGlobalSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import
// const { ChimeClient, GetGlobalSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import
const client = new ChimeClient(config);
const input = {};
const command = new GetGlobalSettingsCommand(input);
const response = await client.send(command);
// { // GetGlobalSettingsResponse
//   BusinessCalling: { // BusinessCallingSettings
//     CdrBucket: "STRING_VALUE",
//   },
//   VoiceConnector: { // VoiceConnectorSettings
//     CdrBucket: "STRING_VALUE",
//   },
// };

GetGlobalSettingsCommand Input

See GetGlobalSettingsCommandInput for more details
GetGlobalSettingsCommandInput

GetGlobalSettingsCommand Output

See GetGlobalSettingsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
BusinessCalling
BusinessCallingSettings | undefined

The Amazon Chime Business Calling settings.

VoiceConnector
VoiceConnectorSettings | undefined

The Amazon Chime Voice Connector settings.

Throws

Name
Fault
Details
BadRequestException
client

The input parameters don't match the service's restrictions.

ForbiddenException
client

The client is permanently forbidden from making the request.

ServiceFailureException
server

The service encountered an unexpected error.

ServiceUnavailableException
server

The service is currently unavailable.

ThrottledClientException
client

The client exceeded its request rate limit.

UnauthorizedClientException
client

The client is not currently authorized to make the request.

ChimeServiceException
Base exception class for all service exceptions from Chime service.