[ aws . alexaforbusiness ]

create-conference-provider

Description

Adds a new conference provider under the user’s AWS account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-conference-provider
--conference-provider-name <value>
--conference-provider-type <value>
[--ip-dial-in <value>]
[--pstn-dial-in <value>]
--meeting-setting <value>
[--client-request-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--conference-provider-name (string)

The name of the conference provider.

--conference-provider-type (string)

Represents a type within a list of predefined types.

Possible values:

  • CHIME

  • BLUEJEANS

  • FUZE

  • GOOGLE_HANGOUTS

  • POLYCOM

  • RINGCENTRAL

  • SKYPE_FOR_BUSINESS

  • WEBEX

  • ZOOM

  • CUSTOM

--ip-dial-in (structure)

The IP endpoint and protocol for calling.

Endpoint -> (string)

The IP address.

CommsProtocol -> (string)

The protocol, including SIP, SIPS, and H323.

Shorthand Syntax:

Endpoint=string,CommsProtocol=string

JSON Syntax:

{
  "Endpoint": "string",
  "CommsProtocol": "SIP"|"SIPS"|"H323"
}

--pstn-dial-in (structure)

The information for PSTN conferencing.

CountryCode -> (string)

The zip code.

PhoneNumber -> (string)

The phone number to call to join the conference.

OneClickIdDelay -> (string)

The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

OneClickPinDelay -> (string)

The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

Shorthand Syntax:

CountryCode=string,PhoneNumber=string,OneClickIdDelay=string,OneClickPinDelay=string

JSON Syntax:

{
  "CountryCode": "string",
  "PhoneNumber": "string",
  "OneClickIdDelay": "string",
  "OneClickPinDelay": "string"
}

--meeting-setting (structure)

The meeting settings for the conference provider.

RequirePin -> (string)

The values that indicate whether the pin is always required.

Shorthand Syntax:

RequirePin=string

JSON Syntax:

{
  "RequirePin": "YES"|"NO"|"OPTIONAL"
}

--client-request-token (string)

The request token of the client.

--tags (list)

The tags to be added to the specified resource. Do not provide system tags.

(structure)

A key-value pair that can be associated with a resource.

Key -> (string)

The key of a tag. Tag keys are case-sensitive.

Value -> (string)

The value of a tag. Tag values are case sensitive and can be null.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

ConferenceProviderArn -> (string)

The ARN of the newly-created conference provider.