- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
StartUpdateSignalMapCommand
Initiates an update for the specified signal map. Will discover a new signal map if a changed discoveryEntryPointArn is provided.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MediaLiveClient, StartUpdateSignalMapCommand } from "@aws-sdk/client-medialive"; // ES Modules import
// const { MediaLiveClient, StartUpdateSignalMapCommand } = require("@aws-sdk/client-medialive"); // CommonJS import
const client = new MediaLiveClient(config);
const input = { // StartUpdateSignalMapRequest
CloudWatchAlarmTemplateGroupIdentifiers: [ // __listOf__stringPatternS
"STRING_VALUE",
],
Description: "STRING_VALUE",
DiscoveryEntryPointArn: "STRING_VALUE",
EventBridgeRuleTemplateGroupIdentifiers: [
"STRING_VALUE",
],
ForceRediscovery: true || false,
Identifier: "STRING_VALUE", // required
Name: "STRING_VALUE",
};
const command = new StartUpdateSignalMapCommand(input);
const response = await client.send(command);
// { // StartUpdateSignalMapResponse
// Arn: "STRING_VALUE",
// CloudWatchAlarmTemplateGroupIds: [ // __listOf__stringMin7Max11PatternAws097
// "STRING_VALUE",
// ],
// CreatedAt: new Date("TIMESTAMP"),
// Description: "STRING_VALUE",
// DiscoveryEntryPointArn: "STRING_VALUE",
// ErrorMessage: "STRING_VALUE",
// EventBridgeRuleTemplateGroupIds: [
// "STRING_VALUE",
// ],
// FailedMediaResourceMap: { // FailedMediaResourceMap
// "<keys>": { // MediaResource
// Destinations: [ // __listOfMediaResourceNeighbor
// { // MediaResourceNeighbor
// Arn: "STRING_VALUE", // required
// Name: "STRING_VALUE",
// },
// ],
// Name: "STRING_VALUE",
// Sources: [
// {
// Arn: "STRING_VALUE", // required
// Name: "STRING_VALUE",
// },
// ],
// },
// },
// Id: "STRING_VALUE",
// LastDiscoveredAt: new Date("TIMESTAMP"),
// LastSuccessfulMonitorDeployment: { // SuccessfulMonitorDeployment
// DetailsUri: "STRING_VALUE", // required
// Status: "NOT_DEPLOYED" || "DRY_RUN_DEPLOYMENT_COMPLETE" || "DRY_RUN_DEPLOYMENT_FAILED" || "DRY_RUN_DEPLOYMENT_IN_PROGRESS" || "DEPLOYMENT_COMPLETE" || "DEPLOYMENT_FAILED" || "DEPLOYMENT_IN_PROGRESS" || "DELETE_COMPLETE" || "DELETE_FAILED" || "DELETE_IN_PROGRESS", // required
// },
// MediaResourceMap: { // MediaResourceMap
// "<keys>": {
// Destinations: [
// {
// Arn: "STRING_VALUE", // required
// Name: "STRING_VALUE",
// },
// ],
// Name: "STRING_VALUE",
// Sources: [
// {
// Arn: "STRING_VALUE", // required
// Name: "STRING_VALUE",
// },
// ],
// },
// },
// ModifiedAt: new Date("TIMESTAMP"),
// MonitorChangesPendingDeployment: true || false,
// MonitorDeployment: { // MonitorDeployment
// DetailsUri: "STRING_VALUE",
// ErrorMessage: "STRING_VALUE",
// Status: "NOT_DEPLOYED" || "DRY_RUN_DEPLOYMENT_COMPLETE" || "DRY_RUN_DEPLOYMENT_FAILED" || "DRY_RUN_DEPLOYMENT_IN_PROGRESS" || "DEPLOYMENT_COMPLETE" || "DEPLOYMENT_FAILED" || "DEPLOYMENT_IN_PROGRESS" || "DELETE_COMPLETE" || "DELETE_FAILED" || "DELETE_IN_PROGRESS", // required
// },
// Name: "STRING_VALUE",
// Status: "CREATE_IN_PROGRESS" || "CREATE_COMPLETE" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_COMPLETE" || "UPDATE_REVERTED" || "UPDATE_FAILED" || "READY" || "NOT_READY",
// Tags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// };
StartUpdateSignalMapCommand Input
See StartUpdateSignalMapCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
IdentifierRequired | string | undefined | A signal map's identifier. Can be either be its id or current name. |
CloudWatchAlarmTemplateGroupIdentifiers | string[] | undefined | Placeholder documentation for __listOf__stringPatternS |
Description | string | undefined | A resource's optional description. |
DiscoveryEntryPointArn | string | undefined | A top-level supported AWS resource ARN to discovery a signal map from. |
EventBridgeRuleTemplateGroupIdentifiers | string[] | undefined | Placeholder documentation for __listOf__stringPatternS |
ForceRediscovery | boolean | undefined | If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided. |
Name | string | undefined | A resource's name. Names must be unique within the scope of a resource type in a specific region. |
StartUpdateSignalMapCommand Output
See StartUpdateSignalMapCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Arn | string | undefined | A signal map's ARN (Amazon Resource Name) |
CloudWatchAlarmTemplateGroupIds | string[] | undefined | Placeholder documentation for __listOf__stringMin7Max11PatternAws097 |
CreatedAt | Date | undefined | Placeholder documentation for __timestampIso8601 |
Description | string | undefined | A resource's optional description. |
DiscoveryEntryPointArn | string | undefined | A top-level supported AWS resource ARN to discovery a signal map from. |
ErrorMessage | string | undefined | Error message associated with a failed creation or failed update attempt of a signal map. |
EventBridgeRuleTemplateGroupIds | string[] | undefined | Placeholder documentation for __listOf__stringMin7Max11PatternAws097 |
FailedMediaResourceMap | Record<string, MediaResource> | undefined | A map representing an incomplete AWS media workflow as a graph. |
Id | string | undefined | A signal map's id. |
LastDiscoveredAt | Date | undefined | Placeholder documentation for __timestampIso8601 |
LastSuccessfulMonitorDeployment | SuccessfulMonitorDeployment | undefined | Represents the latest successful monitor deployment of a signal map. |
MediaResourceMap | Record<string, MediaResource> | undefined | A map representing an AWS media workflow as a graph. |
ModifiedAt | Date | undefined | Placeholder documentation for __timestampIso8601 |
MonitorChangesPendingDeployment | boolean | undefined | If true, there are pending monitor changes for this signal map that can be deployed. |
MonitorDeployment | MonitorDeployment | undefined | Represents the latest monitor deployment of a signal map. |
Name | string | undefined | A resource's name. Names must be unique within the scope of a resource type in a specific region. |
Status | SignalMapStatus | undefined | A signal map's current status which is dependent on its lifecycle actions or associated jobs. |
Tags | Record<string, string> | undefined | Represents the tags associated with a resource. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BadRequestException | client | Placeholder documentation for BadRequestException |
| ConflictException | client | Placeholder documentation for ConflictException |
| ForbiddenException | client | Placeholder documentation for ForbiddenException |
| InternalServerErrorException | server | Placeholder documentation for InternalServerErrorException |
| NotFoundException | client | Placeholder documentation for NotFoundException |
| TooManyRequestsException | client | Placeholder documentation for TooManyRequestsException |
| MediaLiveServiceException | Base exception class for all service exceptions from MediaLive service. |