Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . chime-sdk-media-pipelines ]

start-speaker-search-task

Description

Starts a speaker search task.

Warning

Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

See also: AWS API Documentation

Synopsis

  start-speaker-search-task
--identifier <value>
--voice-profile-domain-arn <value>
[--kinesis-video-stream-source-task-configuration <value>]
[--client-request-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--identifier (string)

The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

--voice-profile-domain-arn (string)

The ARN of the voice profile domain that will store the voice profile.

--kinesis-video-stream-source-task-configuration (structure)

The task configuration for the Kinesis video stream source of the media insights pipeline.

StreamArn -> (string)

The ARN of the stream.

ChannelId -> (integer)

The channel ID.

FragmentNumber -> (string)

The unique identifier of the fragment to begin processing.

Shorthand Syntax:

StreamArn=string,ChannelId=integer,FragmentNumber=string

JSON Syntax:

{
  "StreamArn": "string",
  "ChannelId": integer,
  "FragmentNumber": "string"
}

--client-request-token (string)

The unique identifier for the client request. Use a different token for different speaker search tasks.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

SpeakerSearchTask -> (structure)

The details of the speaker search task.

SpeakerSearchTaskId -> (string)

The speaker search task ID.

SpeakerSearchTaskStatus -> (string)

The status of the speaker search task.

CreatedTimestamp -> (timestamp)

The time at which a speaker search task was created.

UpdatedTimestamp -> (timestamp)

The time at which a speaker search task was updated.