flattenedMappedTable =
- enhancedClient.table(getConcreteTableName("table-name"), TABLE_SCHEMA_FLATTEN_RECORD);
@Before
public void createTable() {
@@ -161,249 +145,6 @@ public void updateBehaviors_transactWriteItems_secondUpdate() {
assertThat(persistedRecord.getCreatedAutoUpdateOn()).isEqualTo(firstUpdatedRecord.getCreatedAutoUpdateOn());
}
- @Test
- public void when_updatingNestedObjectWithSingleLevel_existingInformationIsPreserved_ignoreNulls() {
-
- NestedRecordWithUpdateBehavior nestedRecord = createNestedWithDefaults("id456", 5L);
-
- RecordWithUpdateBehaviors record = new RecordWithUpdateBehaviors();
- record.setId("id123");
- record.setNestedRecord(nestedRecord);
-
- mappedTable.putItem(record);
-
- NestedRecordWithUpdateBehavior updatedNestedRecord = new NestedRecordWithUpdateBehavior();
- long updatedNestedCounter = 10L;
- updatedNestedRecord.setNestedCounter(updatedNestedCounter);
- updatedNestedRecord.setAttribute(TEST_ATTRIBUTE);
-
- RecordWithUpdateBehaviors update_record = new RecordWithUpdateBehaviors();
- update_record.setId("id123");
- update_record.setVersion(1L);
- update_record.setNestedRecord(updatedNestedRecord);
-
- mappedTable.updateItem(r -> r.item(update_record).ignoreNulls(true));
-
- RecordWithUpdateBehaviors persistedRecord = mappedTable.getItem(r -> r.key(k -> k.partitionValue("id123")));
-
- verifySingleLevelNestingTargetedUpdateBehavior(persistedRecord, updatedNestedCounter, TEST_ATTRIBUTE);
- }
-
- @Test
- public void when_updatingNestedObjectToEmptyWithSingleLevel_existingInformationIsPreserved_ignoreNulls() {
-
- NestedRecordWithUpdateBehavior nestedRecord = createNestedWithDefaults("id456", 5L);
- nestedRecord.setAttribute(TEST_ATTRIBUTE);
-
- RecordWithUpdateBehaviors record = new RecordWithUpdateBehaviors();
- record.setId("id123");
- record.setNestedRecord(nestedRecord);
-
- mappedTable.putItem(record);
-
- NestedRecordWithUpdateBehavior updatedNestedRecord = new NestedRecordWithUpdateBehavior();
-
- RecordWithUpdateBehaviors update_record = new RecordWithUpdateBehaviors();
- update_record.setId("id123");
- update_record.setVersion(1L);
- update_record.setNestedRecord(updatedNestedRecord);
-
- mappedTable.updateItem(r -> r.item(update_record).ignoreNulls(true));
-
- RecordWithUpdateBehaviors persistedRecord = mappedTable.getItem(r -> r.key(k -> k.partitionValue("id123")));
- assertThat(persistedRecord.getNestedRecord()).isNull();
- }
-
- private NestedRecordWithUpdateBehavior createNestedWithDefaults(String id, Long counter) {
- NestedRecordWithUpdateBehavior nestedRecordWithDefaults = new NestedRecordWithUpdateBehavior();
- nestedRecordWithDefaults.setId(id);
- nestedRecordWithDefaults.setNestedCounter(counter);
- nestedRecordWithDefaults.setNestedUpdateBehaviorAttribute(TEST_BEHAVIOUR_ATTRIBUTE);
- nestedRecordWithDefaults.setNestedTimeAttribute(INSTANT_1);
-
- return nestedRecordWithDefaults;
- }
-
- private void verifyMultipleLevelNestingTargetedUpdateBehavior(RecordWithUpdateBehaviors persistedRecord,
- long updatedOuterNestedCounter,
- long updatedInnerNestedCounter) {
- assertThat(persistedRecord.getNestedRecord()).isNotNull();
- assertThat(persistedRecord.getNestedRecord().getNestedRecord()).isNotNull();
-
- assertThat(persistedRecord.getNestedRecord().getNestedCounter()).isEqualTo(updatedOuterNestedCounter);
- assertThat(persistedRecord.getNestedRecord().getNestedRecord()).isNotNull();
- assertThat(persistedRecord.getNestedRecord().getNestedRecord().getNestedCounter()).isEqualTo(updatedInnerNestedCounter);
- assertThat(persistedRecord.getNestedRecord().getNestedRecord().getNestedUpdateBehaviorAttribute()).isEqualTo(
- TEST_BEHAVIOUR_ATTRIBUTE);
- assertThat(persistedRecord.getNestedRecord().getNestedRecord().getAttribute()).isEqualTo(
- TEST_ATTRIBUTE);
- assertThat(persistedRecord.getNestedRecord().getNestedRecord().getNestedTimeAttribute()).isEqualTo(INSTANT_1);
- }
-
- private void verifySingleLevelNestingTargetedUpdateBehavior(RecordWithUpdateBehaviors persistedRecord,
- long updatedNestedCounter, String testAttribute) {
- assertThat(persistedRecord.getNestedRecord()).isNotNull();
- assertThat(persistedRecord.getNestedRecord().getNestedCounter()).isEqualTo(updatedNestedCounter);
- assertThat(persistedRecord.getNestedRecord().getNestedUpdateBehaviorAttribute()).isEqualTo(TEST_BEHAVIOUR_ATTRIBUTE);
- assertThat(persistedRecord.getNestedRecord().getNestedTimeAttribute()).isEqualTo(INSTANT_1);
- assertThat(persistedRecord.getNestedRecord().getAttribute()).isEqualTo(testAttribute);
- }
-
- @Test
- public void when_updatingNestedObjectWithMultipleLevels_existingInformationIsPreserved() {
-
- NestedRecordWithUpdateBehavior nestedRecord1 = createNestedWithDefaults("id789", 50L);
-
- NestedRecordWithUpdateBehavior nestedRecord2 = createNestedWithDefaults("id456", 0L);
- nestedRecord2.setNestedRecord(nestedRecord1);
-
- RecordWithUpdateBehaviors record = new RecordWithUpdateBehaviors();
- record.setId("id123");
- record.setNestedRecord(nestedRecord2);
-
- mappedTable.putItem(record);
-
- NestedRecordWithUpdateBehavior updatedNestedRecord2 = new NestedRecordWithUpdateBehavior();
- long innerNestedCounter = 100L;
- updatedNestedRecord2.setNestedCounter(innerNestedCounter);
- updatedNestedRecord2.setAttribute(TEST_ATTRIBUTE);
-
- NestedRecordWithUpdateBehavior updatedNestedRecord1 = new NestedRecordWithUpdateBehavior();
- updatedNestedRecord1.setNestedRecord(updatedNestedRecord2);
- long outerNestedCounter = 200L;
- updatedNestedRecord1.setNestedCounter(outerNestedCounter);
-
- RecordWithUpdateBehaviors update_record = new RecordWithUpdateBehaviors();
- update_record.setId("id123");
- update_record.setVersion(1L);
- update_record.setNestedRecord(updatedNestedRecord1);
-
- mappedTable.updateItem(r -> r.item(update_record).ignoreNulls(true));
-
- RecordWithUpdateBehaviors persistedRecord = mappedTable.getItem(r -> r.key(k -> k.partitionValue("id123")));
-
- verifyMultipleLevelNestingTargetedUpdateBehavior(persistedRecord, outerNestedCounter, innerNestedCounter);
- }
-
- @Test
- public void when_updatingNestedNonScalarObject_DynamoDBExceptionIsThrown() {
-
- NestedRecordWithUpdateBehavior nestedRecord = createNestedWithDefaults("id456", 5L);
- nestedRecord.setAttribute(TEST_ATTRIBUTE);
-
- RecordWithUpdateBehaviors record = new RecordWithUpdateBehaviors();
- record.setId("id123");
-
- mappedTable.putItem(record);
-
- RecordWithUpdateBehaviors update_record = new RecordWithUpdateBehaviors();
- update_record.setId("id123");
- update_record.setVersion(1L);
- update_record.setKey("abc");
- update_record.setNestedRecord(nestedRecord);
-
- assertThatThrownBy(() -> mappedTable.updateItem(r -> r.item(update_record).ignoreNulls(true)))
- .isInstanceOf(DynamoDbException.class);
- }
-
- @Test
- public void when_emptyNestedRecordIsSet_emotyMapIsStoredInTable() {
- String key = "id123";
-
- RecordWithUpdateBehaviors record = new RecordWithUpdateBehaviors();
- record.setId(key);
- record.setNestedRecord(new NestedRecordWithUpdateBehavior());
-
- mappedTable.updateItem(r -> r.item(record).ignoreNulls(true));
-
- GetItemResponse getItemResponse = getDynamoDbClient().getItem(GetItemRequest.builder()
- .key(Collections.singletonMap("id",
- AttributeValue.fromS(key)))
- .tableName(getConcreteTableName("table-name"))
- .build());
-
- assertThat(getItemResponse.item().get("nestedRecord")).isNotNull();
- assertThat(getItemResponse.item().get("nestedRecord").toString()).isEqualTo("AttributeValue(M={nestedTimeAttribute"
- + "=AttributeValue(NUL=true), "
- + "nestedRecord=AttributeValue(NUL=true), "
- + "attribute=AttributeValue(NUL=true), "
- + "id=AttributeValue(NUL=true), "
- + "nestedUpdateBehaviorAttribute=AttributeValue"
- + "(NUL=true), nestedCounter=AttributeValue"
- + "(NUL=true), nestedVersionedAttribute"
- + "=AttributeValue(NUL=true)})");
- }
-
-
- @Test
- public void when_updatingNestedObjectWithSingleLevelFlattened_existingInformationIsPreserved() {
-
- NestedRecordWithUpdateBehavior nestedRecord = createNestedWithDefaults("id123", 10L);
-
- CompositeRecord compositeRecord = new CompositeRecord();
- compositeRecord.setNestedRecord(nestedRecord);
-
- FlattenRecord flattenRecord = new FlattenRecord();
- flattenRecord.setCompositeRecord(compositeRecord);
- flattenRecord.setId("id456");
-
- flattenedMappedTable.putItem(r -> r.item(flattenRecord));
-
- NestedRecordWithUpdateBehavior updateNestedRecord = new NestedRecordWithUpdateBehavior();
- updateNestedRecord.setNestedCounter(100L);
-
- CompositeRecord updateCompositeRecord = new CompositeRecord();
- updateCompositeRecord.setNestedRecord(updateNestedRecord);
-
- FlattenRecord updatedFlattenRecord = new FlattenRecord();
- updatedFlattenRecord.setId("id456");
- updatedFlattenRecord.setCompositeRecord(updateCompositeRecord);
-
- FlattenRecord persistedFlattenedRecord = flattenedMappedTable.updateItem(r -> r.item(updatedFlattenRecord).ignoreNulls(true));
-
- assertThat(persistedFlattenedRecord.getCompositeRecord()).isNotNull();
- assertThat(persistedFlattenedRecord.getCompositeRecord().getNestedRecord().getNestedCounter()).isEqualTo(100L);
- }
-
- @Test
- public void when_updatingNestedObjectWithMultipleLevelFlattened_existingInformationIsPreserved() {
-
- NestedRecordWithUpdateBehavior outerNestedRecord = createNestedWithDefaults("id123", 10L);
- NestedRecordWithUpdateBehavior innerNestedRecord = createNestedWithDefaults("id456", 5L);
- outerNestedRecord.setNestedRecord(innerNestedRecord);
-
- CompositeRecord compositeRecord = new CompositeRecord();
- compositeRecord.setNestedRecord(outerNestedRecord);
-
- FlattenRecord flattenRecord = new FlattenRecord();
- flattenRecord.setCompositeRecord(compositeRecord);
- flattenRecord.setId("id789");
-
- flattenedMappedTable.putItem(r -> r.item(flattenRecord));
-
- NestedRecordWithUpdateBehavior updateOuterNestedRecord = new NestedRecordWithUpdateBehavior();
- updateOuterNestedRecord.setNestedCounter(100L);
-
- NestedRecordWithUpdateBehavior updateInnerNestedRecord = new NestedRecordWithUpdateBehavior();
- updateInnerNestedRecord.setNestedCounter(50L);
-
- updateOuterNestedRecord.setNestedRecord(updateInnerNestedRecord);
-
- CompositeRecord updateCompositeRecord = new CompositeRecord();
- updateCompositeRecord.setNestedRecord(updateOuterNestedRecord);
-
- FlattenRecord updateFlattenRecord = new FlattenRecord();
- updateFlattenRecord.setCompositeRecord(updateCompositeRecord);
- updateFlattenRecord.setId("id789");
-
- FlattenRecord persistedFlattenedRecord = flattenedMappedTable.updateItem(r -> r.item(updateFlattenRecord).ignoreNulls(true));
-
- assertThat(persistedFlattenedRecord.getCompositeRecord()).isNotNull();
- assertThat(persistedFlattenedRecord.getCompositeRecord().getNestedRecord().getNestedCounter()).isEqualTo(100L);
- assertThat(persistedFlattenedRecord.getCompositeRecord().getNestedRecord().getNestedRecord().getNestedCounter()).isEqualTo(50L);
- }
-
-
/**
* Currently, nested records are not updated through extensions.
*/
diff --git a/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/CompositeRecord.java b/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/CompositeRecord.java
deleted file mode 100644
index ad9ac6405a58..000000000000
--- a/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/CompositeRecord.java
+++ /dev/null
@@ -1,49 +0,0 @@
-/*
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License").
- * You may not use this file except in compliance with the License.
- * A copy of the License is located at
- *
- * http://aws.amazon.com/apache2.0
- *
- * or in the "license" file accompanying this file. This file is distributed
- * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
- * express or implied. See the License for the specific language governing
- * permissions and limitations under the License.
- */
-
-package software.amazon.awssdk.enhanced.dynamodb.functionaltests.models;
-
-import java.util.Objects;
-import software.amazon.awssdk.enhanced.dynamodb.mapper.annotations.DynamoDbBean;
-
-@DynamoDbBean
-public class CompositeRecord {
- private NestedRecordWithUpdateBehavior nestedRecord;
-
- public void setNestedRecord(NestedRecordWithUpdateBehavior nestedRecord) {
- this.nestedRecord = nestedRecord;
- }
-
- public NestedRecordWithUpdateBehavior getNestedRecord() {
- return nestedRecord;
- }
-
- @Override
- public boolean equals(Object o) {
- if (this == o) {
- return true;
- }
- if (o == null || getClass() != o.getClass()) {
- return false;
- }
- CompositeRecord that = (CompositeRecord) o;
- return Objects.equals(that, this);
- }
-
- @Override
- public int hashCode() {
- return Objects.hash(nestedRecord);
- }
-}
diff --git a/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/FlattenRecord.java b/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/FlattenRecord.java
deleted file mode 100644
index 8506fdf5468f..000000000000
--- a/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/FlattenRecord.java
+++ /dev/null
@@ -1,51 +0,0 @@
-/*
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License").
- * You may not use this file except in compliance with the License.
- * A copy of the License is located at
- *
- * http://aws.amazon.com/apache2.0
- *
- * or in the "license" file accompanying this file. This file is distributed
- * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
- * express or implied. See the License for the specific language governing
- * permissions and limitations under the License.
- */
-
-package software.amazon.awssdk.enhanced.dynamodb.functionaltests.models;
-
-import software.amazon.awssdk.enhanced.dynamodb.mapper.annotations.DynamoDbBean;
-import software.amazon.awssdk.enhanced.dynamodb.mapper.annotations.DynamoDbFlatten;
-import software.amazon.awssdk.enhanced.dynamodb.mapper.annotations.DynamoDbPartitionKey;
-
-@DynamoDbBean
-public class FlattenRecord {
- private String id;
- private String flattenBehaviourAttribute;
- private CompositeRecord compositeRecord;
-
- @DynamoDbPartitionKey
- public String getId() {
- return this.id;
- }
- public void setId(String id) {
- this.id = id;
- }
-
- public String getFlattenBehaviourAttribute() {
- return flattenBehaviourAttribute;
- }
- public void setFlattenBehaviourAttribute(String flattenBehaviourAttribute) {
- this.flattenBehaviourAttribute = flattenBehaviourAttribute;
- }
-
- @DynamoDbFlatten
- public CompositeRecord getCompositeRecord() {
- return compositeRecord;
- }
- public void setCompositeRecord(CompositeRecord compositeRecord) {
- this.compositeRecord = compositeRecord;
- }
-}
-
diff --git a/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/NestedRecordWithUpdateBehavior.java b/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/NestedRecordWithUpdateBehavior.java
index 883a89813c1a..9e31533d97bd 100644
--- a/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/NestedRecordWithUpdateBehavior.java
+++ b/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/NestedRecordWithUpdateBehavior.java
@@ -32,8 +32,6 @@ public class NestedRecordWithUpdateBehavior {
private Long nestedVersionedAttribute;
private Instant nestedTimeAttribute;
private Long nestedCounter;
- private NestedRecordWithUpdateBehavior nestedRecord;
- private String attribute;
@DynamoDbPartitionKey
public String getId() {
@@ -79,20 +77,4 @@ public Long getNestedCounter() {
public void setNestedCounter(Long nestedCounter) {
this.nestedCounter = nestedCounter;
}
-
- public NestedRecordWithUpdateBehavior getNestedRecord() {
- return nestedRecord;
- }
-
- public void setNestedRecord(NestedRecordWithUpdateBehavior nestedRecord) {
- this.nestedRecord = nestedRecord;
- }
-
- public String getAttribute() {
- return attribute;
- }
-
- public void setAttribute(String attribute) {
- this.attribute = attribute;
- }
}
diff --git a/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/RecordWithUpdateBehaviors.java b/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/RecordWithUpdateBehaviors.java
index 8bd874fee002..9b2921b74464 100644
--- a/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/RecordWithUpdateBehaviors.java
+++ b/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/models/RecordWithUpdateBehaviors.java
@@ -39,7 +39,6 @@ public class RecordWithUpdateBehaviors {
private Instant lastAutoUpdatedOnMillis;
private Instant formattedLastAutoUpdatedOn;
private NestedRecordWithUpdateBehavior nestedRecord;
- private String key;
@DynamoDbPartitionKey
public String getId() {
@@ -50,15 +49,6 @@ public void setId(String id) {
this.id = id;
}
- public String getKey() {
- return key;
- }
-
- public void setKey(String key) {
- this.key = key;
- }
-
-
@DynamoDbUpdateBehavior(WRITE_IF_NOT_EXISTS)
@DynamoDbAttribute("created-on") // Forces a test on attribute name cleaning
public Instant getCreatedOn() {
diff --git a/services-custom/iam-policy-builder/pom.xml b/services-custom/iam-policy-builder/pom.xml
index a48bdd51d63f..d63ad2182d1d 100644
--- a/services-custom/iam-policy-builder/pom.xml
+++ b/services-custom/iam-policy-builder/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
aws-sdk-java-pom
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
../../pom.xml
iam-policy-builder
diff --git a/services-custom/pom.xml b/services-custom/pom.xml
index 9a8bd10a6b62..471423f38589 100644
--- a/services-custom/pom.xml
+++ b/services-custom/pom.xml
@@ -19,7 +19,7 @@
software.amazon.awssdk
aws-sdk-java-pom
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
services-custom
AWS Java SDK :: Custom Services
diff --git a/services-custom/s3-event-notifications/pom.xml b/services-custom/s3-event-notifications/pom.xml
index ff5c7e2ad40c..306b55ef0583 100644
--- a/services-custom/s3-event-notifications/pom.xml
+++ b/services-custom/s3-event-notifications/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
aws-sdk-java-pom
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
../../pom.xml
s3-event-notifications
diff --git a/services-custom/s3-transfer-manager/pom.xml b/services-custom/s3-transfer-manager/pom.xml
index 0e175ca26b8f..04e086a79e1b 100644
--- a/services-custom/s3-transfer-manager/pom.xml
+++ b/services-custom/s3-transfer-manager/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
aws-sdk-java-pom
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
../../pom.xml
s3-transfer-manager
diff --git a/services/accessanalyzer/pom.xml b/services/accessanalyzer/pom.xml
index a71fd3b9de65..6aac8561c6cc 100644
--- a/services/accessanalyzer/pom.xml
+++ b/services/accessanalyzer/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
accessanalyzer
AWS Java SDK :: Services :: AccessAnalyzer
diff --git a/services/account/pom.xml b/services/account/pom.xml
index b42a9c99da6f..015573159131 100644
--- a/services/account/pom.xml
+++ b/services/account/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
account
AWS Java SDK :: Services :: Account
diff --git a/services/acm/pom.xml b/services/acm/pom.xml
index 7ee97295ee2e..f710e66e7a55 100644
--- a/services/acm/pom.xml
+++ b/services/acm/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
acm
AWS Java SDK :: Services :: AWS Certificate Manager
diff --git a/services/acmpca/pom.xml b/services/acmpca/pom.xml
index 2b8622d07167..88b3d995c159 100644
--- a/services/acmpca/pom.xml
+++ b/services/acmpca/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
acmpca
AWS Java SDK :: Services :: ACM PCA
diff --git a/services/amp/pom.xml b/services/amp/pom.xml
index 7d981ccd17ad..dcdbcb33286b 100644
--- a/services/amp/pom.xml
+++ b/services/amp/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
amp
AWS Java SDK :: Services :: Amp
diff --git a/services/amplify/pom.xml b/services/amplify/pom.xml
index 7a136f8f0e5d..01cf2c4f74a2 100644
--- a/services/amplify/pom.xml
+++ b/services/amplify/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
amplify
AWS Java SDK :: Services :: Amplify
diff --git a/services/amplifybackend/pom.xml b/services/amplifybackend/pom.xml
index 082a5a806264..7731c86119c8 100644
--- a/services/amplifybackend/pom.xml
+++ b/services/amplifybackend/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
amplifybackend
AWS Java SDK :: Services :: Amplify Backend
diff --git a/services/amplifyuibuilder/pom.xml b/services/amplifyuibuilder/pom.xml
index bc9d1edae54e..d97ddb4597da 100644
--- a/services/amplifyuibuilder/pom.xml
+++ b/services/amplifyuibuilder/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
amplifyuibuilder
AWS Java SDK :: Services :: Amplify UI Builder
diff --git a/services/apigateway/pom.xml b/services/apigateway/pom.xml
index e875f7491746..b1ccb5fc621c 100644
--- a/services/apigateway/pom.xml
+++ b/services/apigateway/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
apigateway
AWS Java SDK :: Services :: Amazon API Gateway
diff --git a/services/apigatewaymanagementapi/pom.xml b/services/apigatewaymanagementapi/pom.xml
index 1d42d9e41fc7..9c1c27e20244 100644
--- a/services/apigatewaymanagementapi/pom.xml
+++ b/services/apigatewaymanagementapi/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
apigatewaymanagementapi
AWS Java SDK :: Services :: ApiGatewayManagementApi
diff --git a/services/apigatewayv2/pom.xml b/services/apigatewayv2/pom.xml
index e654b9d752c5..ccf9f4ffe62d 100644
--- a/services/apigatewayv2/pom.xml
+++ b/services/apigatewayv2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
apigatewayv2
AWS Java SDK :: Services :: ApiGatewayV2
diff --git a/services/appconfig/pom.xml b/services/appconfig/pom.xml
index 98f717774765..e8d944eb26bc 100644
--- a/services/appconfig/pom.xml
+++ b/services/appconfig/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
appconfig
AWS Java SDK :: Services :: AppConfig
diff --git a/services/appconfigdata/pom.xml b/services/appconfigdata/pom.xml
index 725ec9b1c0ba..7c59e29e441a 100644
--- a/services/appconfigdata/pom.xml
+++ b/services/appconfigdata/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
appconfigdata
AWS Java SDK :: Services :: App Config Data
diff --git a/services/appfabric/pom.xml b/services/appfabric/pom.xml
index 0cf25cea600a..4a22a514de4e 100644
--- a/services/appfabric/pom.xml
+++ b/services/appfabric/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
appfabric
AWS Java SDK :: Services :: App Fabric
diff --git a/services/appflow/pom.xml b/services/appflow/pom.xml
index 62acde88f669..22bbfd5d5421 100644
--- a/services/appflow/pom.xml
+++ b/services/appflow/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
appflow
AWS Java SDK :: Services :: Appflow
diff --git a/services/appintegrations/pom.xml b/services/appintegrations/pom.xml
index 01c6dcdf5316..e89d20622cfa 100644
--- a/services/appintegrations/pom.xml
+++ b/services/appintegrations/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
appintegrations
AWS Java SDK :: Services :: App Integrations
diff --git a/services/applicationautoscaling/pom.xml b/services/applicationautoscaling/pom.xml
index 35f81813c403..919cfd01f13c 100644
--- a/services/applicationautoscaling/pom.xml
+++ b/services/applicationautoscaling/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
applicationautoscaling
AWS Java SDK :: Services :: AWS Application Auto Scaling
diff --git a/services/applicationcostprofiler/pom.xml b/services/applicationcostprofiler/pom.xml
index af4fafa71a80..88f09fd33a48 100644
--- a/services/applicationcostprofiler/pom.xml
+++ b/services/applicationcostprofiler/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
applicationcostprofiler
AWS Java SDK :: Services :: Application Cost Profiler
diff --git a/services/applicationdiscovery/pom.xml b/services/applicationdiscovery/pom.xml
index c706afe26d2b..9c36f8e1c404 100644
--- a/services/applicationdiscovery/pom.xml
+++ b/services/applicationdiscovery/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
applicationdiscovery
AWS Java SDK :: Services :: AWS Application Discovery Service
diff --git a/services/applicationinsights/pom.xml b/services/applicationinsights/pom.xml
index 4870907b837c..f2a718d94861 100644
--- a/services/applicationinsights/pom.xml
+++ b/services/applicationinsights/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
applicationinsights
AWS Java SDK :: Services :: Application Insights
diff --git a/services/applicationsignals/pom.xml b/services/applicationsignals/pom.xml
index e798482fa1f9..24e47bb98184 100644
--- a/services/applicationsignals/pom.xml
+++ b/services/applicationsignals/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
applicationsignals
AWS Java SDK :: Services :: Application Signals
diff --git a/services/appmesh/pom.xml b/services/appmesh/pom.xml
index c4ee659a4477..a9224983edbf 100644
--- a/services/appmesh/pom.xml
+++ b/services/appmesh/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
appmesh
AWS Java SDK :: Services :: App Mesh
diff --git a/services/apprunner/pom.xml b/services/apprunner/pom.xml
index 00bd6547cae4..d100b161377b 100644
--- a/services/apprunner/pom.xml
+++ b/services/apprunner/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
apprunner
AWS Java SDK :: Services :: App Runner
diff --git a/services/appstream/pom.xml b/services/appstream/pom.xml
index e26643685ff2..b2faa235503e 100644
--- a/services/appstream/pom.xml
+++ b/services/appstream/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
appstream
AWS Java SDK :: Services :: Amazon AppStream
diff --git a/services/appsync/pom.xml b/services/appsync/pom.xml
index bd8e33994c70..d38259d255cd 100644
--- a/services/appsync/pom.xml
+++ b/services/appsync/pom.xml
@@ -21,7 +21,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
appsync
diff --git a/services/apptest/pom.xml b/services/apptest/pom.xml
index 8dac66146308..748108711cd6 100644
--- a/services/apptest/pom.xml
+++ b/services/apptest/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
apptest
AWS Java SDK :: Services :: App Test
diff --git a/services/arczonalshift/pom.xml b/services/arczonalshift/pom.xml
index 39e3e4ab7039..336ad081d1e4 100644
--- a/services/arczonalshift/pom.xml
+++ b/services/arczonalshift/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
arczonalshift
AWS Java SDK :: Services :: ARC Zonal Shift
diff --git a/services/artifact/pom.xml b/services/artifact/pom.xml
index a6438ef2bc5d..5f432013a7b2 100644
--- a/services/artifact/pom.xml
+++ b/services/artifact/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
artifact
AWS Java SDK :: Services :: Artifact
diff --git a/services/athena/pom.xml b/services/athena/pom.xml
index 9f9561d8066c..9aa815def897 100644
--- a/services/athena/pom.xml
+++ b/services/athena/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
athena
AWS Java SDK :: Services :: Amazon Athena
diff --git a/services/auditmanager/pom.xml b/services/auditmanager/pom.xml
index f4517e891de4..74d234c16b00 100644
--- a/services/auditmanager/pom.xml
+++ b/services/auditmanager/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
auditmanager
AWS Java SDK :: Services :: Audit Manager
diff --git a/services/autoscaling/pom.xml b/services/autoscaling/pom.xml
index 3a703a65490e..0af05592f3da 100644
--- a/services/autoscaling/pom.xml
+++ b/services/autoscaling/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
autoscaling
AWS Java SDK :: Services :: Auto Scaling
diff --git a/services/autoscalingplans/pom.xml b/services/autoscalingplans/pom.xml
index c65771a77fd7..d5f1c69e0d40 100644
--- a/services/autoscalingplans/pom.xml
+++ b/services/autoscalingplans/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
autoscalingplans
AWS Java SDK :: Services :: Auto Scaling Plans
diff --git a/services/b2bi/pom.xml b/services/b2bi/pom.xml
index 5ed6764cbcd3..803b9656809d 100644
--- a/services/b2bi/pom.xml
+++ b/services/b2bi/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
b2bi
AWS Java SDK :: Services :: B2 Bi
diff --git a/services/backup/pom.xml b/services/backup/pom.xml
index 44e383a10fd8..17b001522bcc 100644
--- a/services/backup/pom.xml
+++ b/services/backup/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
backup
AWS Java SDK :: Services :: Backup
diff --git a/services/backupgateway/pom.xml b/services/backupgateway/pom.xml
index 462e08868078..3e902ecb8ddd 100644
--- a/services/backupgateway/pom.xml
+++ b/services/backupgateway/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
backupgateway
AWS Java SDK :: Services :: Backup Gateway
diff --git a/services/batch/pom.xml b/services/batch/pom.xml
index c92ea04106b4..6336e9c8ec72 100644
--- a/services/batch/pom.xml
+++ b/services/batch/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
batch
AWS Java SDK :: Services :: AWS Batch
diff --git a/services/bcmdataexports/pom.xml b/services/bcmdataexports/pom.xml
index 3de18f1159c9..e446db8c4ef7 100644
--- a/services/bcmdataexports/pom.xml
+++ b/services/bcmdataexports/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
bcmdataexports
AWS Java SDK :: Services :: BCM Data Exports
diff --git a/services/bedrock/pom.xml b/services/bedrock/pom.xml
index 6d9f43dd4557..eb07dc9314ec 100644
--- a/services/bedrock/pom.xml
+++ b/services/bedrock/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
bedrock
AWS Java SDK :: Services :: Bedrock
diff --git a/services/bedrockagent/pom.xml b/services/bedrockagent/pom.xml
index d2485a6212a6..b06c6f3b92c6 100644
--- a/services/bedrockagent/pom.xml
+++ b/services/bedrockagent/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
bedrockagent
AWS Java SDK :: Services :: Bedrock Agent
diff --git a/services/bedrockagent/src/main/resources/codegen-resources/service-2.json b/services/bedrockagent/src/main/resources/codegen-resources/service-2.json
index e1bc04b69978..253826604ad8 100644
--- a/services/bedrockagent/src/main/resources/codegen-resources/service-2.json
+++ b/services/bedrockagent/src/main/resources/codegen-resources/service-2.json
@@ -1994,20 +1994,20 @@
"members":{
"modelArn":{
"shape":"BedrockModelArn",
- "documentation":"The model's ARN.
"
+ "documentation":"The ARN of the foundation model or inference profile.
"
},
"parsingPrompt":{
"shape":"ParsingPrompt",
"documentation":"Instructions for interpreting the contents of a document.
"
}
},
- "documentation":"Settings for a foundation model used to parse documents for a data source.
"
+ "documentation":"Settings for a foundation model or inference profile used to parse documents for a data source.
"
},
"BedrockModelArn":{
"type":"string",
"max":2048,
"min":1,
- "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})$"
+ "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)$"
},
"Boolean":{
"type":"boolean",
@@ -6042,7 +6042,7 @@
"documentation":"The parsing strategy for the data source.
"
}
},
- "documentation":"Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.
To use a model to parse PDF documents, set the parsing strategy to BEDROCK_FOUNDATION_MODEL and specify the model to use by ARN. You can also override the default parsing prompt with instructions for how to interpret images and tables in your documents. The following models are supported.
You can get the ARN of a model with the ListFoundationModels action. Standard model usage charges apply for the foundation model parsing strategy.
"
+ "documentation":"Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.
To use a model to parse PDF documents, set the parsing strategy to BEDROCK_FOUNDATION_MODEL and specify the model or inference profile to use by ARN. You can also override the default parsing prompt with instructions for how to interpret images and tables in your documents. The following models are supported.
You can get the ARN of a model with the ListFoundationModels action. Standard model usage charges apply for the foundation model parsing strategy.
"
},
"ParsingPrompt":{
"type":"structure",
diff --git a/services/bedrockagentruntime/pom.xml b/services/bedrockagentruntime/pom.xml
index 60945632a139..2ae5810ab66d 100644
--- a/services/bedrockagentruntime/pom.xml
+++ b/services/bedrockagentruntime/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
bedrockagentruntime
AWS Java SDK :: Services :: Bedrock Agent Runtime
diff --git a/services/bedrockagentruntime/src/main/resources/codegen-resources/service-2.json b/services/bedrockagentruntime/src/main/resources/codegen-resources/service-2.json
index 0108a86c9632..cb8f10ca79c9 100644
--- a/services/bedrockagentruntime/src/main/resources/codegen-resources/service-2.json
+++ b/services/bedrockagentruntime/src/main/resources/codegen-resources/service-2.json
@@ -145,7 +145,7 @@
{"shape":"AccessDeniedException"},
{"shape":"ServiceQuotaExceededException"}
],
- "documentation":"Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.
"
+ "documentation":"Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile. The response only cites sources that are relevant to the query.
"
}
},
"shapes":{
@@ -392,9 +392,9 @@
},
"BedrockModelArn":{
"type":"string",
- "max":1011,
- "min":20,
- "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))$"
+ "max":2048,
+ "min":1,
+ "pattern":"^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))))|(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$"
},
"Boolean":{
"type":"boolean",
@@ -1917,11 +1917,11 @@
},
"knowledgeBaseId":{
"shape":"KnowledgeBaseId",
- "documentation":"The unique identifier of the knowledge base that is queried and the foundation model used for generation.
"
+ "documentation":"The unique identifier of the knowledge base that is queried.
"
},
"modelArn":{
"shape":"BedrockModelArn",
- "documentation":"The ARN of the foundation model used to generate a response.
"
+ "documentation":"The ARN of the foundation model or inference profile used to generate a response.
"
},
"orchestrationConfiguration":{
"shape":"OrchestrationConfiguration",
diff --git a/services/bedrockruntime/pom.xml b/services/bedrockruntime/pom.xml
index f7496c5a03b4..52519044d181 100644
--- a/services/bedrockruntime/pom.xml
+++ b/services/bedrockruntime/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
bedrockruntime
AWS Java SDK :: Services :: Bedrock Runtime
diff --git a/services/billingconductor/pom.xml b/services/billingconductor/pom.xml
index 573c2e712906..24ce1e0d6a9b 100644
--- a/services/billingconductor/pom.xml
+++ b/services/billingconductor/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
billingconductor
AWS Java SDK :: Services :: Billingconductor
diff --git a/services/braket/pom.xml b/services/braket/pom.xml
index f216c1e562ff..f6f1c658b5e1 100644
--- a/services/braket/pom.xml
+++ b/services/braket/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
braket
AWS Java SDK :: Services :: Braket
diff --git a/services/budgets/pom.xml b/services/budgets/pom.xml
index d233ef0f21b5..9e8016dac0e8 100644
--- a/services/budgets/pom.xml
+++ b/services/budgets/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
budgets
AWS Java SDK :: Services :: AWS Budgets
diff --git a/services/chatbot/pom.xml b/services/chatbot/pom.xml
index d94dc4ee5b93..22ba528ce9a0 100644
--- a/services/chatbot/pom.xml
+++ b/services/chatbot/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
chatbot
AWS Java SDK :: Services :: Chatbot
diff --git a/services/chime/pom.xml b/services/chime/pom.xml
index 35faf5dcc4e8..794fe4a35126 100644
--- a/services/chime/pom.xml
+++ b/services/chime/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
chime
AWS Java SDK :: Services :: Chime
diff --git a/services/chimesdkidentity/pom.xml b/services/chimesdkidentity/pom.xml
index 8e39344eb337..c0da1e444c8f 100644
--- a/services/chimesdkidentity/pom.xml
+++ b/services/chimesdkidentity/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
chimesdkidentity
AWS Java SDK :: Services :: Chime SDK Identity
diff --git a/services/chimesdkmediapipelines/pom.xml b/services/chimesdkmediapipelines/pom.xml
index d0cba714f761..11dd4af20a8f 100644
--- a/services/chimesdkmediapipelines/pom.xml
+++ b/services/chimesdkmediapipelines/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
chimesdkmediapipelines
AWS Java SDK :: Services :: Chime SDK Media Pipelines
diff --git a/services/chimesdkmeetings/pom.xml b/services/chimesdkmeetings/pom.xml
index f3054b9efdca..8187274da241 100644
--- a/services/chimesdkmeetings/pom.xml
+++ b/services/chimesdkmeetings/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
chimesdkmeetings
AWS Java SDK :: Services :: Chime SDK Meetings
diff --git a/services/chimesdkmessaging/pom.xml b/services/chimesdkmessaging/pom.xml
index bff541f78e5c..93ec9e9466dd 100644
--- a/services/chimesdkmessaging/pom.xml
+++ b/services/chimesdkmessaging/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
chimesdkmessaging
AWS Java SDK :: Services :: Chime SDK Messaging
diff --git a/services/chimesdkvoice/pom.xml b/services/chimesdkvoice/pom.xml
index cc5944f0e1c8..f73b38f80d56 100644
--- a/services/chimesdkvoice/pom.xml
+++ b/services/chimesdkvoice/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
chimesdkvoice
AWS Java SDK :: Services :: Chime SDK Voice
diff --git a/services/chimesdkvoice/src/main/resources/codegen-resources/service-2.json b/services/chimesdkvoice/src/main/resources/codegen-resources/service-2.json
index 0d0b8ee04141..688027c055a2 100644
--- a/services/chimesdkvoice/src/main/resources/codegen-resources/service-2.json
+++ b/services/chimesdkvoice/src/main/resources/codegen-resources/service-2.json
@@ -4,11 +4,13 @@
"apiVersion":"2022-08-03",
"endpointPrefix":"voice-chime",
"protocol":"rest-json",
+ "protocols":["rest-json"],
"serviceFullName":"Amazon Chime SDK Voice",
"serviceId":"Chime SDK Voice",
"signatureVersion":"v4",
"signingName":"chime",
- "uid":"chime-sdk-voice-2022-08-03"
+ "uid":"chime-sdk-voice-2022-08-03",
+ "auth":["aws.auth#sigv4"]
},
"operations":{
"AssociatePhoneNumbersWithVoiceConnector":{
@@ -3352,7 +3354,7 @@
},
"VoiceToneAnalysisTaskId":{
"shape":"NonEmptyString256",
- "documentation":"The ID of the voice tone anlysis task.
",
+ "documentation":"The ID of the voice tone analysis task.
",
"location":"uri",
"locationName":"VoiceToneAnalysisTaskId"
},
@@ -3805,7 +3807,7 @@
"members":{
"Disabled":{
"shape":"Boolean",
- "documentation":"Denotes the configration as enabled or disabled.
"
+ "documentation":"Denotes the configuration as enabled or disabled.
"
},
"ConfigurationArn":{
"shape":"Arn",
@@ -5710,7 +5712,7 @@
},
"Country":{
"shape":"SensitiveNonEmptyString",
- "documentation":"The country in the address being validated.
"
+ "documentation":"The country in the address being validated as two-letter country code in ISO 3166-1 alpha-2 format, such as US. For more information, see ISO 3166-1 alpha-2 in Wikipedia.
"
},
"PostalCode":{
"shape":"SensitiveNonEmptyString",
@@ -5723,7 +5725,7 @@
"members":{
"ValidationResult":{
"shape":"ValidationResult",
- "documentation":"Number indicating the result of address validation. 0 means the address was perfect as-is and successfully validated. 1 means the address was corrected. 2 means the address sent was not close enough and was not validated.
"
+ "documentation":"Number indicating the result of address validation.
Each possible result is defined as follows:
-
0 - Address validation succeeded.
-
1 - Address validation succeeded. The address was a close enough match and has been corrected as part of the address object.
-
2 - Address validation failed. You should re-submit the validation request with candidates from the CandidateAddressList result, if it's a close match.
"
},
"AddressExternalId":{
"shape":"String",
diff --git a/services/cleanrooms/pom.xml b/services/cleanrooms/pom.xml
index 08b8791d8f18..37dcec2b16b2 100644
--- a/services/cleanrooms/pom.xml
+++ b/services/cleanrooms/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cleanrooms
AWS Java SDK :: Services :: Clean Rooms
diff --git a/services/cleanroomsml/pom.xml b/services/cleanroomsml/pom.xml
index d8890d2297fc..f6607df651bc 100644
--- a/services/cleanroomsml/pom.xml
+++ b/services/cleanroomsml/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cleanroomsml
AWS Java SDK :: Services :: Clean Rooms ML
diff --git a/services/cloud9/pom.xml b/services/cloud9/pom.xml
index 1b1e59ecae76..69b709613311 100644
--- a/services/cloud9/pom.xml
+++ b/services/cloud9/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
cloud9
diff --git a/services/cloudcontrol/pom.xml b/services/cloudcontrol/pom.xml
index 895437337042..3b64e296ab8a 100644
--- a/services/cloudcontrol/pom.xml
+++ b/services/cloudcontrol/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudcontrol
AWS Java SDK :: Services :: Cloud Control
diff --git a/services/clouddirectory/pom.xml b/services/clouddirectory/pom.xml
index c49221cde1ea..c18892c3a021 100644
--- a/services/clouddirectory/pom.xml
+++ b/services/clouddirectory/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
clouddirectory
AWS Java SDK :: Services :: Amazon CloudDirectory
diff --git a/services/cloudformation/pom.xml b/services/cloudformation/pom.xml
index dc2d4ee218df..e150d604b3fd 100644
--- a/services/cloudformation/pom.xml
+++ b/services/cloudformation/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudformation
AWS Java SDK :: Services :: AWS CloudFormation
diff --git a/services/cloudfront/pom.xml b/services/cloudfront/pom.xml
index f5372720f756..695eb5d4440a 100644
--- a/services/cloudfront/pom.xml
+++ b/services/cloudfront/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudfront
AWS Java SDK :: Services :: Amazon CloudFront
diff --git a/services/cloudfrontkeyvaluestore/pom.xml b/services/cloudfrontkeyvaluestore/pom.xml
index 1b997c4e6cae..7de33bff5f96 100644
--- a/services/cloudfrontkeyvaluestore/pom.xml
+++ b/services/cloudfrontkeyvaluestore/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudfrontkeyvaluestore
AWS Java SDK :: Services :: Cloud Front Key Value Store
diff --git a/services/cloudhsm/pom.xml b/services/cloudhsm/pom.xml
index 28cf077dadfe..7e52b9d4eb4a 100644
--- a/services/cloudhsm/pom.xml
+++ b/services/cloudhsm/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudhsm
AWS Java SDK :: Services :: AWS CloudHSM
diff --git a/services/cloudhsmv2/pom.xml b/services/cloudhsmv2/pom.xml
index 2a86102ca73b..7e8de5626088 100644
--- a/services/cloudhsmv2/pom.xml
+++ b/services/cloudhsmv2/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
cloudhsmv2
diff --git a/services/cloudsearch/pom.xml b/services/cloudsearch/pom.xml
index 61bd03bb3033..c8324eb44a27 100644
--- a/services/cloudsearch/pom.xml
+++ b/services/cloudsearch/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudsearch
AWS Java SDK :: Services :: Amazon CloudSearch
diff --git a/services/cloudsearchdomain/pom.xml b/services/cloudsearchdomain/pom.xml
index 271a651c8cfc..bac13445f96a 100644
--- a/services/cloudsearchdomain/pom.xml
+++ b/services/cloudsearchdomain/pom.xml
@@ -22,7 +22,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudsearchdomain
AWS Java SDK :: Services :: Amazon CloudSearch Domain
diff --git a/services/cloudtrail/pom.xml b/services/cloudtrail/pom.xml
index 17dafa8f5445..4a0fb9c7999b 100644
--- a/services/cloudtrail/pom.xml
+++ b/services/cloudtrail/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudtrail
AWS Java SDK :: Services :: AWS CloudTrail
diff --git a/services/cloudtraildata/pom.xml b/services/cloudtraildata/pom.xml
index aa2ad6558339..741a1b4a49b1 100644
--- a/services/cloudtraildata/pom.xml
+++ b/services/cloudtraildata/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudtraildata
AWS Java SDK :: Services :: Cloud Trail Data
diff --git a/services/cloudwatch/pom.xml b/services/cloudwatch/pom.xml
index aa406f261a67..c307c9c17666 100644
--- a/services/cloudwatch/pom.xml
+++ b/services/cloudwatch/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudwatch
AWS Java SDK :: Services :: Amazon CloudWatch
diff --git a/services/cloudwatchevents/pom.xml b/services/cloudwatchevents/pom.xml
index 9328be900662..a247c7c9a6f2 100644
--- a/services/cloudwatchevents/pom.xml
+++ b/services/cloudwatchevents/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudwatchevents
AWS Java SDK :: Services :: Amazon CloudWatch Events
diff --git a/services/cloudwatchlogs/pom.xml b/services/cloudwatchlogs/pom.xml
index 3b420ea3d7f5..b929fa0e522d 100644
--- a/services/cloudwatchlogs/pom.xml
+++ b/services/cloudwatchlogs/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cloudwatchlogs
AWS Java SDK :: Services :: Amazon CloudWatch Logs
diff --git a/services/codeartifact/pom.xml b/services/codeartifact/pom.xml
index ebeea223837d..e5e1022d7cbf 100644
--- a/services/codeartifact/pom.xml
+++ b/services/codeartifact/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codeartifact
AWS Java SDK :: Services :: Codeartifact
diff --git a/services/codebuild/pom.xml b/services/codebuild/pom.xml
index 028e50b1720c..f93016f8d91a 100644
--- a/services/codebuild/pom.xml
+++ b/services/codebuild/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codebuild
AWS Java SDK :: Services :: AWS Code Build
diff --git a/services/codecatalyst/pom.xml b/services/codecatalyst/pom.xml
index 2aa7e9ad6736..78174abe91f4 100644
--- a/services/codecatalyst/pom.xml
+++ b/services/codecatalyst/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codecatalyst
AWS Java SDK :: Services :: Code Catalyst
diff --git a/services/codecommit/pom.xml b/services/codecommit/pom.xml
index 41956cadb5b4..32b6e926541f 100644
--- a/services/codecommit/pom.xml
+++ b/services/codecommit/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codecommit
AWS Java SDK :: Services :: AWS CodeCommit
diff --git a/services/codeconnections/pom.xml b/services/codeconnections/pom.xml
index 0ce0a9be2db2..3affae316a99 100644
--- a/services/codeconnections/pom.xml
+++ b/services/codeconnections/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codeconnections
AWS Java SDK :: Services :: Code Connections
diff --git a/services/codedeploy/pom.xml b/services/codedeploy/pom.xml
index d028e930cf81..33753e5abca3 100644
--- a/services/codedeploy/pom.xml
+++ b/services/codedeploy/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codedeploy
AWS Java SDK :: Services :: AWS CodeDeploy
diff --git a/services/codeguruprofiler/pom.xml b/services/codeguruprofiler/pom.xml
index 50de98152ff6..627d534d998e 100644
--- a/services/codeguruprofiler/pom.xml
+++ b/services/codeguruprofiler/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codeguruprofiler
AWS Java SDK :: Services :: CodeGuruProfiler
diff --git a/services/codegurureviewer/pom.xml b/services/codegurureviewer/pom.xml
index 437bc0db1456..6d73b797fc26 100644
--- a/services/codegurureviewer/pom.xml
+++ b/services/codegurureviewer/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codegurureviewer
AWS Java SDK :: Services :: CodeGuru Reviewer
diff --git a/services/codegurusecurity/pom.xml b/services/codegurusecurity/pom.xml
index f69ca0de721a..f2ecd41f7845 100644
--- a/services/codegurusecurity/pom.xml
+++ b/services/codegurusecurity/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codegurusecurity
AWS Java SDK :: Services :: Code Guru Security
diff --git a/services/codepipeline/pom.xml b/services/codepipeline/pom.xml
index 007752c1a44c..2c0f4925ac22 100644
--- a/services/codepipeline/pom.xml
+++ b/services/codepipeline/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codepipeline
AWS Java SDK :: Services :: AWS CodePipeline
diff --git a/services/codestarconnections/pom.xml b/services/codestarconnections/pom.xml
index fd84c073deaf..724c50043625 100644
--- a/services/codestarconnections/pom.xml
+++ b/services/codestarconnections/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codestarconnections
AWS Java SDK :: Services :: CodeStar connections
diff --git a/services/codestarnotifications/pom.xml b/services/codestarnotifications/pom.xml
index 7f77be699771..79965e7dccce 100644
--- a/services/codestarnotifications/pom.xml
+++ b/services/codestarnotifications/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
codestarnotifications
AWS Java SDK :: Services :: Codestar Notifications
diff --git a/services/cognitoidentity/pom.xml b/services/cognitoidentity/pom.xml
index 4e703f9800d3..d269492b0765 100644
--- a/services/cognitoidentity/pom.xml
+++ b/services/cognitoidentity/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cognitoidentity
AWS Java SDK :: Services :: Amazon Cognito Identity
diff --git a/services/cognitoidentity/src/main/resources/codegen-resources/service-2.json b/services/cognitoidentity/src/main/resources/codegen-resources/service-2.json
index f93ded368d18..9fa19e353000 100644
--- a/services/cognitoidentity/src/main/resources/codegen-resources/service-2.json
+++ b/services/cognitoidentity/src/main/resources/codegen-resources/service-2.json
@@ -1022,7 +1022,8 @@
"IdentityProviderToken":{
"type":"string",
"max":50000,
- "min":1
+ "min":1,
+ "sensitive":true
},
"IdentityProviders":{
"type":"map",
@@ -1318,7 +1319,10 @@
"type":"list",
"member":{"shape":"ARNString"}
},
- "OIDCToken":{"type":"string"},
+ "OIDCToken":{
+ "type":"string",
+ "sensitive":true
+ },
"PaginationKey":{
"type":"string",
"max":65535,
@@ -1427,7 +1431,10 @@
"type":"list",
"member":{"shape":"ARNString"}
},
- "SecretKeyString":{"type":"string"},
+ "SecretKeyString":{
+ "type":"string",
+ "sensitive":true
+ },
"SessionTokenString":{"type":"string"},
"SetIdentityPoolRolesInput":{
"type":"structure",
diff --git a/services/cognitoidentityprovider/pom.xml b/services/cognitoidentityprovider/pom.xml
index 0c8a3a8ca7ce..a4898988bec2 100644
--- a/services/cognitoidentityprovider/pom.xml
+++ b/services/cognitoidentityprovider/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cognitoidentityprovider
AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service
diff --git a/services/cognitosync/pom.xml b/services/cognitosync/pom.xml
index 9f2c65271e45..eaf62db6839f 100644
--- a/services/cognitosync/pom.xml
+++ b/services/cognitosync/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
cognitosync
AWS Java SDK :: Services :: Amazon Cognito Sync
diff --git a/services/comprehend/pom.xml b/services/comprehend/pom.xml
index ba785402b74f..be004ece50cd 100644
--- a/services/comprehend/pom.xml
+++ b/services/comprehend/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
comprehend
diff --git a/services/comprehendmedical/pom.xml b/services/comprehendmedical/pom.xml
index 121c6e7ef4de..2c32e3d26e31 100644
--- a/services/comprehendmedical/pom.xml
+++ b/services/comprehendmedical/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
comprehendmedical
AWS Java SDK :: Services :: ComprehendMedical
diff --git a/services/computeoptimizer/pom.xml b/services/computeoptimizer/pom.xml
index 13e5f2c1e78a..3b2b237713e5 100644
--- a/services/computeoptimizer/pom.xml
+++ b/services/computeoptimizer/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
computeoptimizer
AWS Java SDK :: Services :: Compute Optimizer
diff --git a/services/config/pom.xml b/services/config/pom.xml
index 076deb0fb6d8..830b59bcf05b 100644
--- a/services/config/pom.xml
+++ b/services/config/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
config
AWS Java SDK :: Services :: AWS Config
diff --git a/services/connect/pom.xml b/services/connect/pom.xml
index 63144a35827b..5b3e25a5c4d2 100644
--- a/services/connect/pom.xml
+++ b/services/connect/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
connect
AWS Java SDK :: Services :: Connect
diff --git a/services/connectcampaigns/pom.xml b/services/connectcampaigns/pom.xml
index adf4a98c4ff0..79b5509cebba 100644
--- a/services/connectcampaigns/pom.xml
+++ b/services/connectcampaigns/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
connectcampaigns
AWS Java SDK :: Services :: Connect Campaigns
diff --git a/services/connectcases/pom.xml b/services/connectcases/pom.xml
index 65dfecbca14d..d40b6b111890 100644
--- a/services/connectcases/pom.xml
+++ b/services/connectcases/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
connectcases
AWS Java SDK :: Services :: Connect Cases
diff --git a/services/connectcontactlens/pom.xml b/services/connectcontactlens/pom.xml
index 05fecc9682a1..5cf58e41d386 100644
--- a/services/connectcontactlens/pom.xml
+++ b/services/connectcontactlens/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
connectcontactlens
AWS Java SDK :: Services :: Connect Contact Lens
diff --git a/services/connectparticipant/pom.xml b/services/connectparticipant/pom.xml
index 4b156aa6a9b2..293405abb0b2 100644
--- a/services/connectparticipant/pom.xml
+++ b/services/connectparticipant/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
connectparticipant
AWS Java SDK :: Services :: ConnectParticipant
diff --git a/services/controlcatalog/pom.xml b/services/controlcatalog/pom.xml
index 0477fa19139d..25e2ea1ffbbe 100644
--- a/services/controlcatalog/pom.xml
+++ b/services/controlcatalog/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
controlcatalog
AWS Java SDK :: Services :: Control Catalog
diff --git a/services/controltower/pom.xml b/services/controltower/pom.xml
index 0f93565ed98f..ab01650b081f 100644
--- a/services/controltower/pom.xml
+++ b/services/controltower/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
controltower
AWS Java SDK :: Services :: Control Tower
diff --git a/services/costandusagereport/pom.xml b/services/costandusagereport/pom.xml
index 1ecd5d2f07cc..38b39b19ba92 100644
--- a/services/costandusagereport/pom.xml
+++ b/services/costandusagereport/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
costandusagereport
AWS Java SDK :: Services :: AWS Cost and Usage Report
diff --git a/services/costexplorer/pom.xml b/services/costexplorer/pom.xml
index 260b95622228..014119df8c1b 100644
--- a/services/costexplorer/pom.xml
+++ b/services/costexplorer/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
costexplorer
diff --git a/services/costoptimizationhub/pom.xml b/services/costoptimizationhub/pom.xml
index 80137c8b7d55..bca4f847c46e 100644
--- a/services/costoptimizationhub/pom.xml
+++ b/services/costoptimizationhub/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
costoptimizationhub
AWS Java SDK :: Services :: Cost Optimization Hub
diff --git a/services/customerprofiles/pom.xml b/services/customerprofiles/pom.xml
index d709e45f9eba..10a0cc00631c 100644
--- a/services/customerprofiles/pom.xml
+++ b/services/customerprofiles/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
customerprofiles
AWS Java SDK :: Services :: Customer Profiles
diff --git a/services/databasemigration/pom.xml b/services/databasemigration/pom.xml
index e1571bb2c097..507ea8f1515e 100644
--- a/services/databasemigration/pom.xml
+++ b/services/databasemigration/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
databasemigration
AWS Java SDK :: Services :: AWS Database Migration Service
diff --git a/services/databrew/pom.xml b/services/databrew/pom.xml
index 7119b6f51143..26e42383fe08 100644
--- a/services/databrew/pom.xml
+++ b/services/databrew/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
databrew
AWS Java SDK :: Services :: Data Brew
diff --git a/services/dataexchange/pom.xml b/services/dataexchange/pom.xml
index 818aa6952d8c..524a2d851b16 100644
--- a/services/dataexchange/pom.xml
+++ b/services/dataexchange/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
dataexchange
AWS Java SDK :: Services :: DataExchange
diff --git a/services/datapipeline/pom.xml b/services/datapipeline/pom.xml
index b633e965420c..c3e3d53b9933 100644
--- a/services/datapipeline/pom.xml
+++ b/services/datapipeline/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
datapipeline
AWS Java SDK :: Services :: AWS Data Pipeline
diff --git a/services/datasync/pom.xml b/services/datasync/pom.xml
index 541d848125fc..1d455a8eac75 100644
--- a/services/datasync/pom.xml
+++ b/services/datasync/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
datasync
AWS Java SDK :: Services :: DataSync
diff --git a/services/datazone/pom.xml b/services/datazone/pom.xml
index 0b6096719642..1cc5e08fa2fa 100644
--- a/services/datazone/pom.xml
+++ b/services/datazone/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
datazone
AWS Java SDK :: Services :: Data Zone
diff --git a/services/dax/pom.xml b/services/dax/pom.xml
index 1191efedfb5f..1281294d9139 100644
--- a/services/dax/pom.xml
+++ b/services/dax/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
dax
AWS Java SDK :: Services :: Amazon DynamoDB Accelerator (DAX)
diff --git a/services/deadline/pom.xml b/services/deadline/pom.xml
index b20ffd83134e..64fa778c4471 100644
--- a/services/deadline/pom.xml
+++ b/services/deadline/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
deadline
AWS Java SDK :: Services :: Deadline
diff --git a/services/detective/pom.xml b/services/detective/pom.xml
index bfa91593f80e..9ed824f250a5 100644
--- a/services/detective/pom.xml
+++ b/services/detective/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
detective
AWS Java SDK :: Services :: Detective
diff --git a/services/devicefarm/pom.xml b/services/devicefarm/pom.xml
index 4120bb153322..62a12a028164 100644
--- a/services/devicefarm/pom.xml
+++ b/services/devicefarm/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
devicefarm
AWS Java SDK :: Services :: AWS Device Farm
diff --git a/services/devopsguru/pom.xml b/services/devopsguru/pom.xml
index 9f9278900a1e..684d57ca5b57 100644
--- a/services/devopsguru/pom.xml
+++ b/services/devopsguru/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
devopsguru
AWS Java SDK :: Services :: Dev Ops Guru
diff --git a/services/directconnect/pom.xml b/services/directconnect/pom.xml
index aa98297cfcf3..dd3c0afdf75c 100644
--- a/services/directconnect/pom.xml
+++ b/services/directconnect/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
directconnect
AWS Java SDK :: Services :: AWS Direct Connect
diff --git a/services/directory/pom.xml b/services/directory/pom.xml
index 8a1d8d2b0ba8..654d20cb8a1b 100644
--- a/services/directory/pom.xml
+++ b/services/directory/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
directory
AWS Java SDK :: Services :: AWS Directory Service
diff --git a/services/dlm/pom.xml b/services/dlm/pom.xml
index 9d74853777c8..b016d2010c9e 100644
--- a/services/dlm/pom.xml
+++ b/services/dlm/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
dlm
AWS Java SDK :: Services :: DLM
diff --git a/services/docdb/pom.xml b/services/docdb/pom.xml
index 4db29caa12d7..9f787b84054b 100644
--- a/services/docdb/pom.xml
+++ b/services/docdb/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
docdb
AWS Java SDK :: Services :: DocDB
diff --git a/services/docdbelastic/pom.xml b/services/docdbelastic/pom.xml
index 11761b8e0690..d74ded9f9228 100644
--- a/services/docdbelastic/pom.xml
+++ b/services/docdbelastic/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
docdbelastic
AWS Java SDK :: Services :: Doc DB Elastic
diff --git a/services/drs/pom.xml b/services/drs/pom.xml
index 6769af3213f2..7ff5d0f5ddd2 100644
--- a/services/drs/pom.xml
+++ b/services/drs/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
drs
AWS Java SDK :: Services :: Drs
diff --git a/services/dynamodb/pom.xml b/services/dynamodb/pom.xml
index 2295f7780e37..75c0279aa7df 100644
--- a/services/dynamodb/pom.xml
+++ b/services/dynamodb/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
dynamodb
AWS Java SDK :: Services :: Amazon DynamoDB
diff --git a/services/dynamodb/src/main/resources/codegen-resources/dynamodb/service-2.json b/services/dynamodb/src/main/resources/codegen-resources/dynamodb/service-2.json
index 9b95e4b2019a..e3511f9b90c8 100644
--- a/services/dynamodb/src/main/resources/codegen-resources/dynamodb/service-2.json
+++ b/services/dynamodb/src/main/resources/codegen-resources/dynamodb/service-2.json
@@ -766,7 +766,7 @@
{"shape":"InternalServerError"},
{"shape":"ResourceInUseException"}
],
- "documentation":"Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
",
+ "documentation":"Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.
-
TagResource is an asynchronous operation. If you issue a ListTagsOfResource request immediately after a TagResource request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfResource uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the ListTagsOfResource request again.
-
The application or removal of tags using TagResource and UntagResource APIs is eventually consistent. ListTagsOfResource API will only reflect the changes after a few seconds.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
",
"endpointdiscovery":{
}
},
@@ -823,7 +823,7 @@
{"shape":"InternalServerError"},
{"shape":"ResourceInUseException"}
],
- "documentation":"Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
",
+ "documentation":"Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account.
-
UntagResource is an asynchronous operation. If you issue a ListTagsOfResource request immediately after an UntagResource request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfResource uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the ListTagsOfResource request again.
-
The application or removal of tags using TagResource and UntagResource APIs is eventually consistent. ListTagsOfResource API will only reflect the changes after a few seconds.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
",
"endpointdiscovery":{
}
},
@@ -5230,7 +5230,7 @@
"documentation":"The resource which is being attempted to be changed is in use.
"
}
},
- "documentation":"The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.
",
+ "documentation":"The operation conflicts with the resource's availability. For example:
-
You attempted to recreate an existing table.
-
You tried to delete a table currently in the CREATING state.
-
You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
",
"exception":true
},
"ResourceNotFoundException":{
diff --git a/services/ebs/pom.xml b/services/ebs/pom.xml
index e319b4293873..804624122452 100644
--- a/services/ebs/pom.xml
+++ b/services/ebs/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ebs
AWS Java SDK :: Services :: EBS
diff --git a/services/ec2/pom.xml b/services/ec2/pom.xml
index b7ea7714b399..3e0d89d9cd88 100644
--- a/services/ec2/pom.xml
+++ b/services/ec2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ec2
AWS Java SDK :: Services :: Amazon EC2
diff --git a/services/ec2instanceconnect/pom.xml b/services/ec2instanceconnect/pom.xml
index 309be3f3d9e9..af8aad5dbd73 100644
--- a/services/ec2instanceconnect/pom.xml
+++ b/services/ec2instanceconnect/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ec2instanceconnect
AWS Java SDK :: Services :: EC2 Instance Connect
diff --git a/services/ecr/pom.xml b/services/ecr/pom.xml
index dc834d319416..b1f39b4b7a37 100644
--- a/services/ecr/pom.xml
+++ b/services/ecr/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ecr
AWS Java SDK :: Services :: Amazon EC2 Container Registry
diff --git a/services/ecr/src/main/resources/codegen-resources/service-2.json b/services/ecr/src/main/resources/codegen-resources/service-2.json
index f9d82b95661a..9e35f8afd5b4 100644
--- a/services/ecr/src/main/resources/codegen-resources/service-2.json
+++ b/services/ecr/src/main/resources/codegen-resources/service-2.json
@@ -7,7 +7,7 @@
"protocol":"json",
"protocols":["json"],
"serviceAbbreviation":"Amazon ECR",
- "serviceFullName":"Amazon EC2 Container Registry",
+ "serviceFullName":"Amazon Elastic Container Registry",
"serviceId":"ECR",
"signatureVersion":"v4",
"signingName":"ecr",
@@ -1806,7 +1806,7 @@
"members":{
"encryptionType":{
"shape":"EncryptionType",
- "documentation":"The encryption type to use.
If you use the KMS encryption type, the contents of the repository will be encrypted using server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service Console Developer Guide.
If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm. For more information, see Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the Amazon Simple Storage Service Console Developer Guide.
"
+ "documentation":"The encryption type to use.
If you use the KMS encryption type, the contents of the repository will be encrypted using server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created.
If you use the KMS_DSSE encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the KMS Management Service key stored in KMS. Similar to the KMS encryption type, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you've already created.
If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm. For more information, see Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the Amazon Simple Storage Service Console Developer Guide.
"
},
"kmsKey":{
"shape":"KmsKey",
@@ -1834,7 +1834,8 @@
"type":"string",
"enum":[
"AES256",
- "KMS"
+ "KMS",
+ "KMS_DSSE"
]
},
"EnhancedImageScanFinding":{
diff --git a/services/ecrpublic/pom.xml b/services/ecrpublic/pom.xml
index d1f6b957e339..83bf80fa2d17 100644
--- a/services/ecrpublic/pom.xml
+++ b/services/ecrpublic/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ecrpublic
AWS Java SDK :: Services :: ECR PUBLIC
diff --git a/services/ecs/pom.xml b/services/ecs/pom.xml
index eea80af62b61..0fd135074cc6 100644
--- a/services/ecs/pom.xml
+++ b/services/ecs/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ecs
AWS Java SDK :: Services :: Amazon EC2 Container Service
diff --git a/services/efs/pom.xml b/services/efs/pom.xml
index fddfd8d68299..54c2207bb05a 100644
--- a/services/efs/pom.xml
+++ b/services/efs/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
efs
AWS Java SDK :: Services :: Amazon Elastic File System
diff --git a/services/eks/pom.xml b/services/eks/pom.xml
index 4067ef1ab9cc..64a19763397d 100644
--- a/services/eks/pom.xml
+++ b/services/eks/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
eks
AWS Java SDK :: Services :: EKS
diff --git a/services/eksauth/pom.xml b/services/eksauth/pom.xml
index 8d8225df8582..e068b162c5bf 100644
--- a/services/eksauth/pom.xml
+++ b/services/eksauth/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
eksauth
AWS Java SDK :: Services :: EKS Auth
diff --git a/services/elasticache/pom.xml b/services/elasticache/pom.xml
index c5e4ca38585d..0452347ae175 100644
--- a/services/elasticache/pom.xml
+++ b/services/elasticache/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
elasticache
AWS Java SDK :: Services :: Amazon ElastiCache
diff --git a/services/elasticbeanstalk/pom.xml b/services/elasticbeanstalk/pom.xml
index d47255be2329..50ce4f773fb4 100644
--- a/services/elasticbeanstalk/pom.xml
+++ b/services/elasticbeanstalk/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
elasticbeanstalk
AWS Java SDK :: Services :: AWS Elastic Beanstalk
diff --git a/services/elasticinference/pom.xml b/services/elasticinference/pom.xml
index e7e08312f3b1..d18bbddd8a94 100644
--- a/services/elasticinference/pom.xml
+++ b/services/elasticinference/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
elasticinference
AWS Java SDK :: Services :: Elastic Inference
diff --git a/services/elasticloadbalancing/pom.xml b/services/elasticloadbalancing/pom.xml
index d4ddc2ec47bb..c433d3a3ad7f 100644
--- a/services/elasticloadbalancing/pom.xml
+++ b/services/elasticloadbalancing/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
elasticloadbalancing
AWS Java SDK :: Services :: Elastic Load Balancing
diff --git a/services/elasticloadbalancingv2/pom.xml b/services/elasticloadbalancingv2/pom.xml
index 5d643de13f01..87f7d0123fc0 100644
--- a/services/elasticloadbalancingv2/pom.xml
+++ b/services/elasticloadbalancingv2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
elasticloadbalancingv2
AWS Java SDK :: Services :: Elastic Load Balancing V2
diff --git a/services/elasticloadbalancingv2/src/main/resources/codegen-resources/paginators-1.json b/services/elasticloadbalancingv2/src/main/resources/codegen-resources/paginators-1.json
index ec7152a2d29f..e6876acb2060 100644
--- a/services/elasticloadbalancingv2/src/main/resources/codegen-resources/paginators-1.json
+++ b/services/elasticloadbalancingv2/src/main/resources/codegen-resources/paginators-1.json
@@ -1,5 +1,10 @@
{
"pagination": {
+ "DescribeListenerCertificates": {
+ "input_token": "Marker",
+ "output_token": "NextMarker",
+ "result_key": "Certificates"
+ },
"DescribeListeners": {
"input_token": "Marker",
"output_token": "NextMarker",
@@ -10,6 +15,11 @@
"output_token": "NextMarker",
"result_key": "LoadBalancers"
},
+ "DescribeRules": {
+ "input_token": "Marker",
+ "output_token": "NextMarker",
+ "result_key": "Rules"
+ },
"DescribeTargetGroups": {
"input_token": "Marker",
"output_token": "NextMarker",
diff --git a/services/elasticloadbalancingv2/src/main/resources/codegen-resources/waiters-2.json b/services/elasticloadbalancingv2/src/main/resources/codegen-resources/waiters-2.json
index 9f3d77d828fa..0a7e8afdd5ad 100644
--- a/services/elasticloadbalancingv2/src/main/resources/codegen-resources/waiters-2.json
+++ b/services/elasticloadbalancingv2/src/main/resources/codegen-resources/waiters-2.json
@@ -13,7 +13,7 @@
},
{
"matcher": "error",
- "expected": "LoadBalancerNotFound",
+ "expected": "LoadBalancerNotFoundException",
"state": "retry"
}
]
@@ -38,7 +38,7 @@
{
"state": "retry",
"matcher": "error",
- "expected": "LoadBalancerNotFound"
+ "expected": "LoadBalancerNotFoundException"
}
]
},
@@ -55,7 +55,7 @@
},
{
"matcher": "error",
- "expected": "LoadBalancerNotFound",
+ "expected": "LoadBalancerNotFoundException",
"state": "success"
}
]
diff --git a/services/elasticsearch/pom.xml b/services/elasticsearch/pom.xml
index 55aba69c7701..0fba3bd49c74 100644
--- a/services/elasticsearch/pom.xml
+++ b/services/elasticsearch/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
elasticsearch
AWS Java SDK :: Services :: Amazon Elasticsearch Service
diff --git a/services/elastictranscoder/pom.xml b/services/elastictranscoder/pom.xml
index 0bb7a21e2153..ac029c515bb4 100644
--- a/services/elastictranscoder/pom.xml
+++ b/services/elastictranscoder/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
elastictranscoder
AWS Java SDK :: Services :: Amazon Elastic Transcoder
diff --git a/services/emr/pom.xml b/services/emr/pom.xml
index 4f2b485ec54d..c76b6d44bd7b 100644
--- a/services/emr/pom.xml
+++ b/services/emr/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
emr
AWS Java SDK :: Services :: Amazon EMR
diff --git a/services/emrcontainers/pom.xml b/services/emrcontainers/pom.xml
index 8efad2d6fcac..2bdd351f1bb8 100644
--- a/services/emrcontainers/pom.xml
+++ b/services/emrcontainers/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
emrcontainers
AWS Java SDK :: Services :: EMR Containers
diff --git a/services/emrserverless/pom.xml b/services/emrserverless/pom.xml
index dc9c26ef9278..2af68baada59 100644
--- a/services/emrserverless/pom.xml
+++ b/services/emrserverless/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
emrserverless
AWS Java SDK :: Services :: EMR Serverless
diff --git a/services/entityresolution/pom.xml b/services/entityresolution/pom.xml
index 52e7ee3b0e89..6565c7e7514c 100644
--- a/services/entityresolution/pom.xml
+++ b/services/entityresolution/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
entityresolution
AWS Java SDK :: Services :: Entity Resolution
diff --git a/services/eventbridge/pom.xml b/services/eventbridge/pom.xml
index 270644efeefd..2d7a1b6b3694 100644
--- a/services/eventbridge/pom.xml
+++ b/services/eventbridge/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
eventbridge
AWS Java SDK :: Services :: EventBridge
diff --git a/services/evidently/pom.xml b/services/evidently/pom.xml
index 04057e66e8a3..369d1def1644 100644
--- a/services/evidently/pom.xml
+++ b/services/evidently/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
evidently
AWS Java SDK :: Services :: Evidently
diff --git a/services/finspace/pom.xml b/services/finspace/pom.xml
index 7f8ade8075f4..1a7cce5705b5 100644
--- a/services/finspace/pom.xml
+++ b/services/finspace/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
finspace
AWS Java SDK :: Services :: Finspace
diff --git a/services/finspacedata/pom.xml b/services/finspacedata/pom.xml
index 37f04569523c..a9cffb7974a0 100644
--- a/services/finspacedata/pom.xml
+++ b/services/finspacedata/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
finspacedata
AWS Java SDK :: Services :: Finspace Data
diff --git a/services/firehose/pom.xml b/services/firehose/pom.xml
index 65b5a0cfd843..db427c61d312 100644
--- a/services/firehose/pom.xml
+++ b/services/firehose/pom.xml
@@ -22,7 +22,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
firehose
AWS Java SDK :: Services :: Amazon Kinesis Firehose
diff --git a/services/fis/pom.xml b/services/fis/pom.xml
index 296feb6e054c..cb7b903d2ffd 100644
--- a/services/fis/pom.xml
+++ b/services/fis/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
fis
AWS Java SDK :: Services :: Fis
diff --git a/services/fms/pom.xml b/services/fms/pom.xml
index fe6021039afa..2532092429c6 100644
--- a/services/fms/pom.xml
+++ b/services/fms/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
fms
AWS Java SDK :: Services :: FMS
diff --git a/services/forecast/pom.xml b/services/forecast/pom.xml
index b977f1747793..2d63939975be 100644
--- a/services/forecast/pom.xml
+++ b/services/forecast/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
forecast
AWS Java SDK :: Services :: Forecast
diff --git a/services/forecastquery/pom.xml b/services/forecastquery/pom.xml
index c9492bb6fd21..03d76ed34c78 100644
--- a/services/forecastquery/pom.xml
+++ b/services/forecastquery/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
forecastquery
AWS Java SDK :: Services :: Forecastquery
diff --git a/services/frauddetector/pom.xml b/services/frauddetector/pom.xml
index 6fbaf8c62fb3..2703d8b5829c 100644
--- a/services/frauddetector/pom.xml
+++ b/services/frauddetector/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
frauddetector
AWS Java SDK :: Services :: FraudDetector
diff --git a/services/freetier/pom.xml b/services/freetier/pom.xml
index 9c64abb0ff09..a25a765a17b0 100644
--- a/services/freetier/pom.xml
+++ b/services/freetier/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
freetier
AWS Java SDK :: Services :: Free Tier
diff --git a/services/fsx/pom.xml b/services/fsx/pom.xml
index d97e6f12d2d0..98ee5737efe2 100644
--- a/services/fsx/pom.xml
+++ b/services/fsx/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
fsx
AWS Java SDK :: Services :: FSx
diff --git a/services/gamelift/pom.xml b/services/gamelift/pom.xml
index 362d483a00a6..8167671c8c1c 100644
--- a/services/gamelift/pom.xml
+++ b/services/gamelift/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
gamelift
AWS Java SDK :: Services :: AWS GameLift
diff --git a/services/glacier/pom.xml b/services/glacier/pom.xml
index 4d113beece05..95e6627f1057 100644
--- a/services/glacier/pom.xml
+++ b/services/glacier/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
glacier
AWS Java SDK :: Services :: Amazon Glacier
diff --git a/services/globalaccelerator/pom.xml b/services/globalaccelerator/pom.xml
index 557851b5b7a5..62b1c7c9b0ba 100644
--- a/services/globalaccelerator/pom.xml
+++ b/services/globalaccelerator/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
globalaccelerator
AWS Java SDK :: Services :: Global Accelerator
diff --git a/services/glue/pom.xml b/services/glue/pom.xml
index 2144cfa261b3..663910e50a04 100644
--- a/services/glue/pom.xml
+++ b/services/glue/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
glue
diff --git a/services/grafana/pom.xml b/services/grafana/pom.xml
index 73129699e3f1..392a5fe039ae 100644
--- a/services/grafana/pom.xml
+++ b/services/grafana/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
grafana
AWS Java SDK :: Services :: Grafana
diff --git a/services/greengrass/pom.xml b/services/greengrass/pom.xml
index ea89fadd9b25..57923493d370 100644
--- a/services/greengrass/pom.xml
+++ b/services/greengrass/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
greengrass
AWS Java SDK :: Services :: AWS Greengrass
diff --git a/services/greengrassv2/pom.xml b/services/greengrassv2/pom.xml
index ee228a555270..03f6029b90ca 100644
--- a/services/greengrassv2/pom.xml
+++ b/services/greengrassv2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
greengrassv2
AWS Java SDK :: Services :: Greengrass V2
diff --git a/services/groundstation/pom.xml b/services/groundstation/pom.xml
index 84d453018234..33f71e2abd93 100644
--- a/services/groundstation/pom.xml
+++ b/services/groundstation/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
groundstation
AWS Java SDK :: Services :: GroundStation
diff --git a/services/guardduty/pom.xml b/services/guardduty/pom.xml
index 49a929b975c0..a213c2741558 100644
--- a/services/guardduty/pom.xml
+++ b/services/guardduty/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
guardduty
diff --git a/services/guardduty/src/main/resources/codegen-resources/service-2.json b/services/guardduty/src/main/resources/codegen-resources/service-2.json
index 8100522d2ca1..3d36f7a8c8e1 100644
--- a/services/guardduty/src/main/resources/codegen-resources/service-2.json
+++ b/services/guardduty/src/main/resources/codegen-resources/service-2.json
@@ -151,7 +151,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
- "documentation":"Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation.
"
+ "documentation":"Creates a publishing destination where you can export your GuardDuty findings. Before you start exporting the findings, the destination resource must exist.
"
},
"CreateSampleFindings":{
"name":"CreateSampleFindings",
@@ -484,7 +484,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
- "documentation":"Retrieves an Amazon GuardDuty detector specified by the detectorId.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
"
+ "documentation":"Retrieves a GuardDuty detector specified by the detectorId.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
"
},
"GetFilter":{
"name":"GetFilter",
@@ -529,7 +529,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
- "documentation":"Lists Amazon GuardDuty findings statistics for the specified detector ID.
There might be regional differences because some flags might not be available in all the Regions where GuardDuty is currently supported. For more information, see Regions and endpoints.
"
+ "documentation":"Lists GuardDuty findings statistics for the specified detector ID.
You must provide either findingStatisticTypes or groupBy parameter, and not both. You can use the maxResults and orderBy parameters only when using groupBy.
There might be regional differences because some flags might not be available in all the Regions where GuardDuty is currently supported. For more information, see Regions and endpoints.
"
},
"GetIPSet":{
"name":"GetIPSet",
@@ -1343,6 +1343,27 @@
},
"documentation":"Contains information about the account level permissions on the S3 bucket.
"
},
+ "AccountStatistics":{
+ "type":"structure",
+ "members":{
+ "AccountId":{
+ "shape":"String",
+ "documentation":"The ID of the Amazon Web Services account.
",
+ "locationName":"accountId"
+ },
+ "LastGeneratedAt":{
+ "shape":"Timestamp",
+ "documentation":"The timestamp at which the finding for this account was last generated.
",
+ "locationName":"lastGeneratedAt"
+ },
+ "TotalFindings":{
+ "shape":"Integer",
+ "documentation":"The total number of findings associated with an account.
",
+ "locationName":"totalFindings"
+ }
+ },
+ "documentation":"Represents a list of map of accounts with the number of findings associated with each account.
"
+ },
"Action":{
"type":"structure",
"members":{
@@ -2283,7 +2304,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The ID of the detector belonging to the GuardDuty account that you want to create a filter for.
",
+ "documentation":"The detector ID associated with the GuardDuty account for which you want to create a filter.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -2348,7 +2369,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.
",
+ "documentation":"The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -2411,7 +2432,7 @@
},
"Role":{
"shape":"String",
- "documentation":"IAM role with permissions required to scan and add tags to the associated protected resource.
",
+ "documentation":"Amazon Resource Name (ARN) of the IAM role that has the permissions to scan and add tags to the associated protected resource.
",
"locationName":"role"
},
"ProtectedResource":{
@@ -2450,7 +2471,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector of the GuardDuty account that you want to associate member accounts with.
",
+ "documentation":"The unique ID of the detector of the GuardDuty account for which you want to associate member accounts.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -2548,7 +2569,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The ID of the detector to create sample findings for.
",
+ "documentation":"The ID of the detector for which you need to create sample findings.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -2576,7 +2597,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector of the GuardDuty account that you want to create a threatIntelSet for.
",
+ "documentation":"The unique ID of the detector of the GuardDuty account for which you want to create a ThreatIntelSet.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -2787,6 +2808,32 @@
},
"documentation":"Contains information about which data sources are enabled for the GuardDuty member account.
"
},
+ "DateStatistics":{
+ "type":"structure",
+ "members":{
+ "Date":{
+ "shape":"Timestamp",
+ "documentation":"The timestamp when the total findings count is observed.
For example, Date would look like \"2024-09-05T17:00:00-07:00\" whereas LastGeneratedAt would look like 2024-09-05T17:12:29-07:00\".
",
+ "locationName":"date"
+ },
+ "LastGeneratedAt":{
+ "shape":"Timestamp",
+ "documentation":"The timestamp at which the last finding in the findings count, was generated.
",
+ "locationName":"lastGeneratedAt"
+ },
+ "Severity":{
+ "shape":"Double",
+ "documentation":"The severity of the findings generated on each date.
",
+ "locationName":"severity"
+ },
+ "TotalFindings":{
+ "shape":"Integer",
+ "documentation":"The total number of findings that were generated per severity level on each date.
",
+ "locationName":"totalFindings"
+ }
+ },
+ "documentation":"Represents list a map of dates with a count of total findings generated on each date.
"
+ },
"DeclineInvitationsRequest":{
"type":"structure",
"required":["AccountIds"],
@@ -2851,7 +2898,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector that the filter is associated with.
",
+ "documentation":"The unique ID of the detector that is associated with the filter.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -2994,7 +3041,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector that the threatIntelSet is associated with.
",
+ "documentation":"The unique ID of the detector that is associated with the threatIntelSet.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -3065,7 +3112,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The ID of the detector to retrieve information about the delegated administrator from.
",
+ "documentation":"The detector ID of the delegated administrator for which you need to retrieve the information.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -4035,8 +4082,35 @@
"members":{
"CountBySeverity":{
"shape":"CountBySeverity",
- "documentation":"Represents a map of severity to count statistics for a set of findings.
",
+ "documentation":"Represents a list of map of severity to count statistics for a set of findings.
",
+ "deprecated":true,
+ "deprecatedMessage":"This parameter is deprecated. Please set GroupBy to 'SEVERITY' to return GroupedBySeverity instead.",
"locationName":"countBySeverity"
+ },
+ "GroupedByAccount":{
+ "shape":"GroupedByAccount",
+ "documentation":"Represents a list of map of accounts with a findings count associated with each account.
",
+ "locationName":"groupedByAccount"
+ },
+ "GroupedByDate":{
+ "shape":"GroupedByDate",
+ "documentation":"Represents a list of map of dates with a count of total findings generated on each date per severity level.
",
+ "locationName":"groupedByDate"
+ },
+ "GroupedByFindingType":{
+ "shape":"GroupedByFindingType",
+ "documentation":"Represents a list of map of finding types with a count of total findings generated for each type.
Based on the orderBy parameter, this request returns either the most occurring finding types or the least occurring finding types. If the orderBy parameter is ASC, this will represent the least occurring finding types in your account; otherwise, this will represent the most occurring finding types. The default value of orderBy is DESC.
",
+ "locationName":"groupedByFindingType"
+ },
+ "GroupedByResource":{
+ "shape":"GroupedByResource",
+ "documentation":"Represents a list of map of top resources with a count of total findings.
",
+ "locationName":"groupedByResource"
+ },
+ "GroupedBySeverity":{
+ "shape":"GroupedBySeverity",
+ "documentation":"Represents a list of map of total findings for each severity level.
",
+ "locationName":"groupedBySeverity"
}
},
"documentation":"Contains information about finding statistics.
"
@@ -4046,6 +4120,27 @@
"max":50,
"min":1
},
+ "FindingTypeStatistics":{
+ "type":"structure",
+ "members":{
+ "FindingType":{
+ "shape":"String",
+ "documentation":"Name of the finding type.
",
+ "locationName":"findingType"
+ },
+ "LastGeneratedAt":{
+ "shape":"Timestamp",
+ "documentation":"The timestamp at which this finding type was last generated in your environment.
",
+ "locationName":"lastGeneratedAt"
+ },
+ "TotalFindings":{
+ "shape":"Integer",
+ "documentation":"The total number of findings associated with generated for each distinct finding type.
",
+ "locationName":"totalFindings"
+ }
+ },
+ "documentation":"Information about each finding type associated with the groupedByFindingType statistics.
"
+ },
"FindingTypes":{
"type":"list",
"member":{"shape":"FindingType"},
@@ -4158,13 +4253,13 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the GuardDuty detector associated to the coverage statistics.
",
+ "documentation":"The unique ID of the GuardDuty detector.
",
"location":"uri",
"locationName":"detectorId"
},
"FilterCriteria":{
"shape":"CoverageFilterCriteria",
- "documentation":"Represents the criteria used to filter the coverage statistics
",
+ "documentation":"Represents the criteria used to filter the coverage statistics.
",
"locationName":"filterCriteria"
},
"StatisticsType":{
@@ -4256,7 +4351,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector that the filter is associated with.
",
+ "documentation":"The unique ID of the detector that is associated with this filter.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -4346,26 +4441,40 @@
},
"GetFindingsStatisticsRequest":{
"type":"structure",
- "required":[
- "DetectorId",
- "FindingStatisticTypes"
- ],
+ "required":["DetectorId"],
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The ID of the detector that specifies the GuardDuty service whose findings' statistics you want to retrieve.
",
+ "documentation":"The ID of the detector whose findings statistics you want to retrieve.
",
"location":"uri",
"locationName":"detectorId"
},
"FindingStatisticTypes":{
"shape":"FindingStatisticTypes",
"documentation":"The types of finding statistics to retrieve.
",
+ "deprecated":true,
+ "deprecatedMessage":"This parameter is deprecated, please use GroupBy instead",
"locationName":"findingStatisticTypes"
},
"FindingCriteria":{
"shape":"FindingCriteria",
"documentation":"Represents the criteria that is used for querying findings.
",
"locationName":"findingCriteria"
+ },
+ "GroupBy":{
+ "shape":"GroupByType",
+ "documentation":"Displays the findings statistics grouped by one of the listed valid values.
",
+ "locationName":"groupBy"
+ },
+ "OrderBy":{
+ "shape":"OrderBy",
+ "documentation":"Displays the sorted findings in the requested order. The default value of orderBy is DESC.
You can use this parameter only with the groupBy parameter.
",
+ "locationName":"orderBy"
+ },
+ "MaxResults":{
+ "shape":"MaxResults100",
+ "documentation":"The maximum number of results to be returned in the response. The default value is 25.
You can use this parameter only with the groupBy parameter.
",
+ "locationName":"maxResults"
}
}
},
@@ -4377,6 +4486,11 @@
"shape":"FindingStatistics",
"documentation":"The finding statistics object.
",
"locationName":"findingStatistics"
+ },
+ "NextToken":{
+ "shape":"String",
+ "documentation":"The pagination parameter to be used on the next list operation to retrieve more items.
This parameter is currently not supported.
",
+ "locationName":"nextToken"
}
}
},
@@ -4389,7 +4503,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector that the IPSet is associated with.
",
+ "documentation":"The unique ID of the detector that is associated with the IPSet.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -4474,7 +4588,7 @@
},
"Role":{
"shape":"String",
- "documentation":"IAM role that includes the permissions required to scan and add tags to the associated protected resource.
",
+ "documentation":"Amazon Resource Name (ARN) of the IAM role that includes the permissions to scan and add tags to the associated protected resource.
",
"locationName":"role"
},
"ProtectedResource":{
@@ -4515,7 +4629,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector that the scan setting is associated with.
",
+ "documentation":"The unique ID of the detector that is associated with this scan.
",
"location":"uri",
"locationName":"detectorId"
}
@@ -4578,7 +4692,7 @@
},
"AccountIds":{
"shape":"AccountIds",
- "documentation":"The account ID of the member account.
",
+ "documentation":"A list of member account IDs.
",
"locationName":"accountIds"
}
}
@@ -4692,7 +4806,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector that the threatIntelSet is associated with.
",
+ "documentation":"The unique ID of the detector that is associated with the threatIntelSet.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -4796,6 +4910,36 @@
}
}
},
+ "GroupByType":{
+ "type":"string",
+ "enum":[
+ "ACCOUNT",
+ "DATE",
+ "FINDING_TYPE",
+ "RESOURCE",
+ "SEVERITY"
+ ]
+ },
+ "GroupedByAccount":{
+ "type":"list",
+ "member":{"shape":"AccountStatistics"}
+ },
+ "GroupedByDate":{
+ "type":"list",
+ "member":{"shape":"DateStatistics"}
+ },
+ "GroupedByFindingType":{
+ "type":"list",
+ "member":{"shape":"FindingTypeStatistics"}
+ },
+ "GroupedByResource":{
+ "type":"list",
+ "member":{"shape":"ResourceStatistics"}
+ },
+ "GroupedBySeverity":{
+ "type":"list",
+ "member":{"shape":"SeverityStatistics"}
+ },
"Groups":{
"type":"list",
"member":{"shape":"String"}
@@ -5008,7 +5152,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector of the GuardDuty account that you want to invite members with.
",
+ "documentation":"The unique ID of the detector of the GuardDuty account with which you want to invite members.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -5596,7 +5740,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector that the filter is associated with.
",
+ "documentation":"The unique ID of the detector that is associated with the filter.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -5642,7 +5786,7 @@
},
"FindingCriteria":{
"shape":"FindingCriteria",
- "documentation":"Represents the criteria used for querying findings. Valid values include:
-
JSON field name
-
accountId
-
region
-
confidence
-
id
-
resource.accessKeyDetails.accessKeyId
-
resource.accessKeyDetails.principalId
-
resource.accessKeyDetails.userName
-
resource.accessKeyDetails.userType
-
resource.instanceDetails.iamInstanceProfile.id
-
resource.instanceDetails.imageId
-
resource.instanceDetails.instanceId
-
resource.instanceDetails.networkInterfaces.ipv6Addresses
-
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
-
resource.instanceDetails.networkInterfaces.publicDnsName
-
resource.instanceDetails.networkInterfaces.publicIp
-
resource.instanceDetails.networkInterfaces.securityGroups.groupId
-
resource.instanceDetails.networkInterfaces.securityGroups.groupName
-
resource.instanceDetails.networkInterfaces.subnetId
-
resource.instanceDetails.networkInterfaces.vpcId
-
resource.instanceDetails.tags.key
-
resource.instanceDetails.tags.value
-
resource.resourceType
-
service.action.actionType
-
service.action.awsApiCallAction.api
-
service.action.awsApiCallAction.callerType
-
service.action.awsApiCallAction.remoteIpDetails.city.cityName
-
service.action.awsApiCallAction.remoteIpDetails.country.countryName
-
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
-
service.action.awsApiCallAction.remoteIpDetails.organization.asn
-
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
-
service.action.awsApiCallAction.serviceName
-
service.action.dnsRequestAction.domain
-
service.action.dnsRequestAction.domainWithSuffix
-
service.action.networkConnectionAction.blocked
-
service.action.networkConnectionAction.connectionDirection
-
service.action.networkConnectionAction.localPortDetails.port
-
service.action.networkConnectionAction.protocol
-
service.action.networkConnectionAction.remoteIpDetails.country.countryName
-
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
-
service.action.networkConnectionAction.remoteIpDetails.organization.asn
-
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
-
service.action.networkConnectionAction.remotePortDetails.port
-
service.additionalInfo.threatListName
-
service.archived
When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
-
service.resourceRole
-
severity
-
type
-
updatedAt
Type: Timestamp in Unix Epoch millisecond format: 1486685375000
",
+ "documentation":"Represents the criteria used for querying findings. Valid values include:
-
JSON field name
-
accountId
-
region
-
confidence
-
id
-
resource.accessKeyDetails.accessKeyId
-
resource.accessKeyDetails.principalId
-
resource.accessKeyDetails.userName
-
resource.accessKeyDetails.userType
-
resource.instanceDetails.iamInstanceProfile.id
-
resource.instanceDetails.imageId
-
resource.instanceDetails.instanceId
-
resource.instanceDetails.networkInterfaces.ipv6Addresses
-
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
-
resource.instanceDetails.networkInterfaces.publicDnsName
-
resource.instanceDetails.networkInterfaces.publicIp
-
resource.instanceDetails.networkInterfaces.securityGroups.groupId
-
resource.instanceDetails.networkInterfaces.securityGroups.groupName
-
resource.instanceDetails.networkInterfaces.subnetId
-
resource.instanceDetails.networkInterfaces.vpcId
-
resource.instanceDetails.tags.key
-
resource.instanceDetails.tags.value
-
resource.resourceType
-
service.action.actionType
-
service.action.awsApiCallAction.api
-
service.action.awsApiCallAction.callerType
-
service.action.awsApiCallAction.remoteIpDetails.city.cityName
-
service.action.awsApiCallAction.remoteIpDetails.country.countryName
-
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
-
service.action.awsApiCallAction.remoteIpDetails.organization.asn
-
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
-
service.action.awsApiCallAction.serviceName
-
service.action.dnsRequestAction.domain
-
service.action.dnsRequestAction.domainWithSuffix
-
service.action.networkConnectionAction.blocked
-
service.action.networkConnectionAction.connectionDirection
-
service.action.networkConnectionAction.localPortDetails.port
-
service.action.networkConnectionAction.protocol
-
service.action.networkConnectionAction.remoteIpDetails.country.countryName
-
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
-
service.action.networkConnectionAction.remoteIpDetails.organization.asn
-
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
-
service.action.networkConnectionAction.remotePortDetails.port
-
service.additionalInfo.threatListName
-
service.archived
When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
-
service.ebsVolumeScanDetails.scanId
-
service.resourceRole
-
severity
-
type
-
updatedAt
Type: Timestamp in Unix Epoch millisecond format: 1486685375000
",
"locationName":"findingCriteria"
},
"SortCriteria":{
@@ -5684,7 +5828,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector that the IPSet is associated with.
",
+ "documentation":"The unique ID of the detector that is associated with IPSet.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -5782,7 +5926,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector the member is associated with.
",
+ "documentation":"The unique ID of the detector that is associated with the member.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -5859,7 +6003,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The ID of the detector to retrieve publishing destinations for.
",
+ "documentation":"The detector ID for which you want to retrieve the publishing destination.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -5921,7 +6065,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The unique ID of the detector that the threatIntelSet is associated with.
",
+ "documentation":"The unique ID of the detector that is associated with the threatIntelSet.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -6196,6 +6340,11 @@
"max":50,
"min":1
},
+ "MaxResults100":{
+ "type":"integer",
+ "max":100,
+ "min":1
+ },
"Member":{
"type":"structure",
"required":[
@@ -7421,6 +7570,37 @@
"error":{"httpStatusCode":404},
"exception":true
},
+ "ResourceStatistics":{
+ "type":"structure",
+ "members":{
+ "AccountId":{
+ "shape":"String",
+ "documentation":"The ID of the Amazon Web Services account.
",
+ "locationName":"accountId"
+ },
+ "LastGeneratedAt":{
+ "shape":"Timestamp",
+ "documentation":"The timestamp at which the statistics for this resource was last generated.
",
+ "locationName":"lastGeneratedAt"
+ },
+ "ResourceId":{
+ "shape":"String",
+ "documentation":"ID associated with each resource. The following list provides the mapping of the resource type and resource ID.
Mapping of resource and resource ID
-
AccessKey - resource.accessKeyDetails.accessKeyId
-
Container - resource.containerDetails.id
-
ECSCluster - resource.ecsClusterDetails.name
-
EKSCluster - resource.eksClusterDetails.name
-
Instance - resource.instanceDetails.instanceId
-
KubernetesCluster - resource.kubernetesDetails.kubernetesWorkloadDetails.name
-
Lambda - resource.lambdaDetails.functionName
-
RDSDBInstance - resource.rdsDbInstanceDetails.dbInstanceIdentifier
-
S3Bucket - resource.s3BucketDetails.name
-
S3Object - resource.s3BucketDetails.name
",
+ "locationName":"resourceId"
+ },
+ "ResourceType":{
+ "shape":"String",
+ "documentation":"The type of resource.
",
+ "locationName":"resourceType"
+ },
+ "TotalFindings":{
+ "shape":"Integer",
+ "documentation":"The total number of findings associated with this resource.
",
+ "locationName":"totalFindings"
+ }
+ },
+ "documentation":"Information about each resource type associated with the groupedByResource statistics.
"
+ },
"ResourceType":{
"type":"string",
"enum":[
@@ -7700,7 +7880,7 @@
},
"AdminDetectorId":{
"shape":"DetectorId",
- "documentation":"The unique detector ID of the administrator account that the request is associated with. Note that this value will be the same as the one used for DetectorId if the account is an administrator.
",
+ "documentation":"The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the AdminDetectorId will be the same as the one used for DetectorId.
",
"locationName":"adminDetectorId"
},
"ScanId":{
@@ -8136,6 +8316,27 @@
"type":"list",
"member":{"shape":"String"}
},
+ "SeverityStatistics":{
+ "type":"structure",
+ "members":{
+ "LastGeneratedAt":{
+ "shape":"Timestamp",
+ "documentation":"The timestamp at which a finding type for a specific severity was last generated.
",
+ "locationName":"lastGeneratedAt"
+ },
+ "Severity":{
+ "shape":"Double",
+ "documentation":"The severity level associated with each finding type.
",
+ "locationName":"severity"
+ },
+ "TotalFindings":{
+ "shape":"Integer",
+ "documentation":"The total number of findings associated with this severity.
",
+ "locationName":"totalFindings"
+ }
+ },
+ "documentation":"Information about severity level for each finding type.
"
+ },
"SortCriteria":{
"type":"structure",
"members":{
@@ -8661,7 +8862,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
- "documentation":"The ID of the detector associated with the findings to update feedback for.
",
+ "documentation":"The ID of the detector that is associated with the findings for which you want to update the feedback.
",
"location":"uri",
"locationName":"detectorId"
},
@@ -8740,7 +8941,7 @@
},
"Role":{
"shape":"String",
- "documentation":"IAM role with permissions required to scan and add tags to the associated protected resource.
",
+ "documentation":"Amazon Resource Name (ARN) of the IAM role with permissions to scan and add tags to the associated protected resource.
",
"locationName":"role"
},
"Actions":{
diff --git a/services/health/pom.xml b/services/health/pom.xml
index 7db15e7eb7c4..4336a63f139e 100644
--- a/services/health/pom.xml
+++ b/services/health/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
health
AWS Java SDK :: Services :: AWS Health APIs and Notifications
diff --git a/services/healthlake/pom.xml b/services/healthlake/pom.xml
index cca02fbb20d4..2480bcf3d356 100644
--- a/services/healthlake/pom.xml
+++ b/services/healthlake/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
healthlake
AWS Java SDK :: Services :: Health Lake
diff --git a/services/iam/pom.xml b/services/iam/pom.xml
index 07625f5091bc..480bcc0dd5fd 100644
--- a/services/iam/pom.xml
+++ b/services/iam/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iam
AWS Java SDK :: Services :: AWS IAM
diff --git a/services/identitystore/pom.xml b/services/identitystore/pom.xml
index a74ebd259ead..70fe0c92749e 100644
--- a/services/identitystore/pom.xml
+++ b/services/identitystore/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
identitystore
AWS Java SDK :: Services :: Identitystore
diff --git a/services/imagebuilder/pom.xml b/services/imagebuilder/pom.xml
index 20737471d7d7..e6b993f2013f 100644
--- a/services/imagebuilder/pom.xml
+++ b/services/imagebuilder/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
imagebuilder
AWS Java SDK :: Services :: Imagebuilder
diff --git a/services/inspector/pom.xml b/services/inspector/pom.xml
index 348c1eeb2996..2aeeb8ca5a96 100644
--- a/services/inspector/pom.xml
+++ b/services/inspector/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
inspector
AWS Java SDK :: Services :: Amazon Inspector Service
diff --git a/services/inspector2/pom.xml b/services/inspector2/pom.xml
index ffa16518d816..2848aa31da74 100644
--- a/services/inspector2/pom.xml
+++ b/services/inspector2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
inspector2
AWS Java SDK :: Services :: Inspector2
diff --git a/services/inspectorscan/pom.xml b/services/inspectorscan/pom.xml
index 27e061f58b55..ff457568758d 100644
--- a/services/inspectorscan/pom.xml
+++ b/services/inspectorscan/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
inspectorscan
AWS Java SDK :: Services :: Inspector Scan
diff --git a/services/internetmonitor/pom.xml b/services/internetmonitor/pom.xml
index 6a8edf9d9f6c..488ef878dba1 100644
--- a/services/internetmonitor/pom.xml
+++ b/services/internetmonitor/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
internetmonitor
AWS Java SDK :: Services :: Internet Monitor
diff --git a/services/iot/pom.xml b/services/iot/pom.xml
index 2b60e098e4d4..df27ee30fdbd 100644
--- a/services/iot/pom.xml
+++ b/services/iot/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iot
AWS Java SDK :: Services :: AWS IoT
diff --git a/services/iot1clickdevices/pom.xml b/services/iot1clickdevices/pom.xml
index 5b7059320729..b5966489981f 100644
--- a/services/iot1clickdevices/pom.xml
+++ b/services/iot1clickdevices/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iot1clickdevices
AWS Java SDK :: Services :: IoT 1Click Devices Service
diff --git a/services/iot1clickprojects/pom.xml b/services/iot1clickprojects/pom.xml
index b625b715457e..e92a9ce25f22 100644
--- a/services/iot1clickprojects/pom.xml
+++ b/services/iot1clickprojects/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iot1clickprojects
AWS Java SDK :: Services :: IoT 1Click Projects
diff --git a/services/iotanalytics/pom.xml b/services/iotanalytics/pom.xml
index 3409952a53a9..68b7177dcce3 100644
--- a/services/iotanalytics/pom.xml
+++ b/services/iotanalytics/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iotanalytics
AWS Java SDK :: Services :: IoTAnalytics
diff --git a/services/iotdataplane/pom.xml b/services/iotdataplane/pom.xml
index f9130395dc6c..c45d7d40f423 100644
--- a/services/iotdataplane/pom.xml
+++ b/services/iotdataplane/pom.xml
@@ -22,7 +22,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iotdataplane
AWS Java SDK :: Services :: AWS IoT Data Plane
diff --git a/services/iotdeviceadvisor/pom.xml b/services/iotdeviceadvisor/pom.xml
index 7cdb02186106..ca2675533213 100644
--- a/services/iotdeviceadvisor/pom.xml
+++ b/services/iotdeviceadvisor/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iotdeviceadvisor
AWS Java SDK :: Services :: Iot Device Advisor
diff --git a/services/iotevents/pom.xml b/services/iotevents/pom.xml
index e2bffdafeb4c..fb93ec10ff59 100644
--- a/services/iotevents/pom.xml
+++ b/services/iotevents/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iotevents
AWS Java SDK :: Services :: IoT Events
diff --git a/services/ioteventsdata/pom.xml b/services/ioteventsdata/pom.xml
index 53578ef71ab5..37b939019865 100644
--- a/services/ioteventsdata/pom.xml
+++ b/services/ioteventsdata/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ioteventsdata
AWS Java SDK :: Services :: IoT Events Data
diff --git a/services/iotfleethub/pom.xml b/services/iotfleethub/pom.xml
index ee910754dbc8..7cb79f9453c9 100644
--- a/services/iotfleethub/pom.xml
+++ b/services/iotfleethub/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iotfleethub
AWS Java SDK :: Services :: Io T Fleet Hub
diff --git a/services/iotfleetwise/pom.xml b/services/iotfleetwise/pom.xml
index a2fb95703adf..dc7245b05978 100644
--- a/services/iotfleetwise/pom.xml
+++ b/services/iotfleetwise/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iotfleetwise
AWS Java SDK :: Services :: Io T Fleet Wise
diff --git a/services/iotjobsdataplane/pom.xml b/services/iotjobsdataplane/pom.xml
index d62b1e3f2524..79a72491bce3 100644
--- a/services/iotjobsdataplane/pom.xml
+++ b/services/iotjobsdataplane/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iotjobsdataplane
AWS Java SDK :: Services :: IoT Jobs Data Plane
diff --git a/services/iotsecuretunneling/pom.xml b/services/iotsecuretunneling/pom.xml
index f8e58bbe9dba..6b708cdc46dc 100644
--- a/services/iotsecuretunneling/pom.xml
+++ b/services/iotsecuretunneling/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iotsecuretunneling
AWS Java SDK :: Services :: IoTSecureTunneling
diff --git a/services/iotsitewise/pom.xml b/services/iotsitewise/pom.xml
index e7f012c0d58e..6b69fe2ed46d 100644
--- a/services/iotsitewise/pom.xml
+++ b/services/iotsitewise/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iotsitewise
AWS Java SDK :: Services :: Io T Site Wise
diff --git a/services/iotthingsgraph/pom.xml b/services/iotthingsgraph/pom.xml
index de273b25ac34..90243a38b0b1 100644
--- a/services/iotthingsgraph/pom.xml
+++ b/services/iotthingsgraph/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iotthingsgraph
AWS Java SDK :: Services :: IoTThingsGraph
diff --git a/services/iottwinmaker/pom.xml b/services/iottwinmaker/pom.xml
index b213a9b93998..9e9f868d8cf5 100644
--- a/services/iottwinmaker/pom.xml
+++ b/services/iottwinmaker/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iottwinmaker
AWS Java SDK :: Services :: Io T Twin Maker
diff --git a/services/iotwireless/pom.xml b/services/iotwireless/pom.xml
index 0f8697a8f18a..2899dcf54e44 100644
--- a/services/iotwireless/pom.xml
+++ b/services/iotwireless/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
iotwireless
AWS Java SDK :: Services :: IoT Wireless
diff --git a/services/ivs/pom.xml b/services/ivs/pom.xml
index 4ee41bdac3a1..addf6c35a5f5 100644
--- a/services/ivs/pom.xml
+++ b/services/ivs/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ivs
AWS Java SDK :: Services :: Ivs
diff --git a/services/ivschat/pom.xml b/services/ivschat/pom.xml
index f8a04281d9f3..4f50ab378978 100644
--- a/services/ivschat/pom.xml
+++ b/services/ivschat/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ivschat
AWS Java SDK :: Services :: Ivschat
diff --git a/services/ivsrealtime/pom.xml b/services/ivsrealtime/pom.xml
index 18d3d17c7deb..b7e96955f175 100644
--- a/services/ivsrealtime/pom.xml
+++ b/services/ivsrealtime/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ivsrealtime
AWS Java SDK :: Services :: IVS Real Time
diff --git a/services/ivsrealtime/src/main/resources/codegen-resources/paginators-1.json b/services/ivsrealtime/src/main/resources/codegen-resources/paginators-1.json
index f8e81fa57e5c..309300d0e943 100644
--- a/services/ivsrealtime/src/main/resources/codegen-resources/paginators-1.json
+++ b/services/ivsrealtime/src/main/resources/codegen-resources/paginators-1.json
@@ -10,6 +10,12 @@
"output_token": "nextToken",
"limit_key": "maxResults"
},
+ "ListIngestConfigurations": {
+ "input_token": "nextToken",
+ "output_token": "nextToken",
+ "limit_key": "maxResults",
+ "result_key": "ingestConfigurations"
+ },
"ListParticipantEvents": {
"input_token": "nextToken",
"output_token": "nextToken",
diff --git a/services/ivsrealtime/src/main/resources/codegen-resources/service-2.json b/services/ivsrealtime/src/main/resources/codegen-resources/service-2.json
index 76bbe212f35a..6d76fe7d40e3 100644
--- a/services/ivsrealtime/src/main/resources/codegen-resources/service-2.json
+++ b/services/ivsrealtime/src/main/resources/codegen-resources/service-2.json
@@ -3,8 +3,8 @@
"metadata":{
"apiVersion":"2020-07-14",
"endpointPrefix":"ivsrealtime",
+ "jsonVersion":"1.1",
"protocol":"rest-json",
- "protocols":["rest-json"],
"serviceAbbreviation":"ivsrealtime",
"serviceFullName":"Amazon Interactive Video Service RealTime",
"serviceId":"IVS RealTime",
@@ -33,6 +33,23 @@
],
"documentation":"Creates an EncoderConfiguration object.
"
},
+ "CreateIngestConfiguration":{
+ "name":"CreateIngestConfiguration",
+ "http":{
+ "method":"POST",
+ "requestUri":"/CreateIngestConfiguration",
+ "responseCode":200
+ },
+ "input":{"shape":"CreateIngestConfigurationRequest"},
+ "output":{"shape":"CreateIngestConfigurationResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"PendingVerification"}
+ ],
+ "documentation":"Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.
"
+ },
"CreateParticipantToken":{
"name":"CreateParticipantToken",
"http":{
@@ -107,6 +124,24 @@
],
"documentation":"Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
"
},
+ "DeleteIngestConfiguration":{
+ "name":"DeleteIngestConfiguration",
+ "http":{
+ "method":"POST",
+ "requestUri":"/DeleteIngestConfiguration",
+ "responseCode":200
+ },
+ "input":{"shape":"DeleteIngestConfigurationRequest"},
+ "output":{"shape":"DeleteIngestConfigurationResponse"},
+ "errors":[
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ConflictException"},
+ {"shape":"PendingVerification"}
+ ],
+ "documentation":"Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true.
"
+ },
"DeletePublicKey":{
"name":"DeletePublicKey",
"http":{
@@ -141,7 +176,7 @@
{"shape":"ConflictException"},
{"shape":"PendingVerification"}
],
- "documentation":"Shuts down and deletes the specified stage (disconnecting all participants).
"
+ "documentation":"Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.
"
},
"DeleteStorageConfiguration":{
"name":"DeleteStorageConfiguration",
@@ -177,7 +212,7 @@
{"shape":"AccessDeniedException"},
{"shape":"PendingVerification"}
],
- "documentation":"Disconnects a specified participant and revokes the participant permanently from a specified stage.
"
+ "documentation":"Disconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.
"
},
"GetComposition":{
"name":"GetComposition",
@@ -217,6 +252,22 @@
],
"documentation":"Gets information about the specified EncoderConfiguration resource.
"
},
+ "GetIngestConfiguration":{
+ "name":"GetIngestConfiguration",
+ "http":{
+ "method":"POST",
+ "requestUri":"/GetIngestConfiguration",
+ "responseCode":200
+ },
+ "input":{"shape":"GetIngestConfigurationRequest"},
+ "output":{"shape":"GetIngestConfigurationResponse"},
+ "errors":[
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"}
+ ],
+ "documentation":"Gets information about the specified IngestConfiguration.
"
+ },
"GetParticipant":{
"name":"GetParticipant",
"http":{
@@ -354,6 +405,21 @@
],
"documentation":"Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
"
},
+ "ListIngestConfigurations":{
+ "name":"ListIngestConfigurations",
+ "http":{
+ "method":"POST",
+ "requestUri":"/ListIngestConfigurations",
+ "responseCode":200
+ },
+ "input":{"shape":"ListIngestConfigurationsRequest"},
+ "output":{"shape":"ListIngestConfigurationsResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"}
+ ],
+ "documentation":"Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.
"
+ },
"ListParticipantEvents":{
"name":"ListParticipantEvents",
"http":{
@@ -482,7 +548,7 @@
{"shape":"ConflictException"},
{"shape":"PendingVerification"}
],
- "documentation":"Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this endpoint returns successfully. Composition stops and the resource is deleted:
-
When StopComposition is called.
-
After a 1-minute timeout, when all participants are disconnected from the stage.
-
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
-
When broadcasting to the IVS channel fails and all retries are exhausted.
-
When broadcasting is disconnected and all attempts to reconnect are exhausted.
"
+ "documentation":"Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted:
-
When StopComposition is called.
-
After a 1-minute timeout, when all participants are disconnected from the stage.
-
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
-
When broadcasting to the IVS channel fails and all retries are exhausted.
-
When broadcasting is disconnected and all attempts to reconnect are exhausted.
"
},
"StopComposition":{
"name":"StopComposition",
@@ -536,6 +602,24 @@
"documentation":"Removes tags from the resource with the specified ARN.
",
"idempotent":true
},
+ "UpdateIngestConfiguration":{
+ "name":"UpdateIngestConfiguration",
+ "http":{
+ "method":"POST",
+ "requestUri":"/UpdateIngestConfiguration",
+ "responseCode":200
+ },
+ "input":{"shape":"UpdateIngestConfigurationRequest"},
+ "output":{"shape":"UpdateIngestConfigurationResponse"},
+ "errors":[
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ConflictException"},
+ {"shape":"PendingVerification"}
+ ],
+ "documentation":"Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.
"
+ },
"UpdateStage":{
"name":"UpdateStage",
"http":{
@@ -605,6 +689,7 @@
"max":8500000,
"min":1
},
+ "Boolean":{"type":"boolean"},
"ChannelArn":{
"type":"string",
"max":128,
@@ -658,7 +743,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
},
"startTime":{
"shape":"Time",
@@ -720,7 +805,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
},
"startTime":{
"shape":"Time",
@@ -765,7 +850,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
}
},
@@ -778,6 +863,49 @@
}
}
},
+ "CreateIngestConfigurationRequest":{
+ "type":"structure",
+ "required":["ingestProtocol"],
+ "members":{
+ "name":{
+ "shape":"IngestConfigurationName",
+ "documentation":"Optional name that can be specified for the IngestConfiguration being created.
"
+ },
+ "stageArn":{
+ "shape":"IngestConfigurationStageArn",
+ "documentation":"ARN of the stage with which the IngestConfiguration is associated.
"
+ },
+ "userId":{
+ "shape":"UserId",
+ "documentation":"Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
"
+ },
+ "attributes":{
+ "shape":"ParticipantAttributes",
+ "documentation":"Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
"
+ },
+ "ingestProtocol":{
+ "shape":"IngestProtocol",
+ "documentation":"Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.
"
+ },
+ "insecureIngest":{
+ "shape":"InsecureIngest",
+ "documentation":"Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.
"
+ },
+ "tags":{
+ "shape":"Tags",
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ }
+ }
+ },
+ "CreateIngestConfigurationResponse":{
+ "type":"structure",
+ "members":{
+ "ingestConfiguration":{
+ "shape":"IngestConfiguration",
+ "documentation":"The IngestConfiguration that was created.
"
+ }
+ }
+ },
"CreateParticipantTokenRequest":{
"type":"structure",
"required":["stageArn"],
@@ -826,7 +954,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
},
"autoParticipantRecordingConfiguration":{
"shape":"AutoParticipantRecordingConfiguration",
@@ -861,7 +989,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
}
},
@@ -889,6 +1017,25 @@
"members":{
}
},
+ "DeleteIngestConfigurationRequest":{
+ "type":"structure",
+ "required":["arn"],
+ "members":{
+ "arn":{
+ "shape":"IngestConfigurationArn",
+ "documentation":"ARN of the IngestConfiguration.
"
+ },
+ "force":{
+ "shape":"Boolean",
+ "documentation":"Optional field to force deletion of the IngestConfiguration. If this is set to true when a participant is actively publishing, the participant is disconnected from the stage, followed by deletion of the IngestConfiguration. Default: false.
"
+ }
+ }
+ },
+ "DeleteIngestConfigurationResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
"DeletePublicKeyRequest":{
"type":"structure",
"required":["arn"],
@@ -1076,7 +1223,7 @@
},
"participantId":{
"shape":"ParticipantTokenId",
- "documentation":"Identifier of the participant to be disconnected. This is assigned by IVS and returned by CreateParticipantToken.
"
+ "documentation":"Identifier of the participant to be disconnected. IVS assigns this; it is returned by CreateParticipantToken (for streams using WebRTC ingest) or CreateIngestConfiguration (for streams using RTMP ingest).
"
},
"reason":{
"shape":"DisconnectParticipantReason",
@@ -1107,7 +1254,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
},
"documentation":"Settings for transcoding.
"
@@ -1144,7 +1291,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
},
"documentation":"Summary information about an EncoderConfiguration.
"
@@ -1184,7 +1331,15 @@
"enum":[
"INSUFFICIENT_CAPABILITIES",
"QUOTA_EXCEEDED",
- "PUBLISHER_NOT_FOUND"
+ "PUBLISHER_NOT_FOUND",
+ "BITRATE_EXCEEDED",
+ "RESOLUTION_EXCEEDED",
+ "STREAM_DURATION_EXCEEDED",
+ "INVALID_AUDIO_CODEC",
+ "INVALID_VIDEO_CODEC",
+ "INVALID_PROTOCOL",
+ "INVALID_STREAM_KEY",
+ "REUSE_OF_STREAM_KEY"
]
},
"EventList":{
@@ -1249,6 +1404,25 @@
}
}
},
+ "GetIngestConfigurationRequest":{
+ "type":"structure",
+ "required":["arn"],
+ "members":{
+ "arn":{
+ "shape":"IngestConfigurationArn",
+ "documentation":"ARN of the ingest for which the information is to be retrieved.
"
+ }
+ }
+ },
+ "GetIngestConfigurationResponse":{
+ "type":"structure",
+ "members":{
+ "ingestConfiguration":{
+ "shape":"IngestConfiguration",
+ "documentation":"The IngestConfiguration that was returned.
"
+ }
+ }
+ },
"GetParticipantRequest":{
"type":"structure",
"required":[
@@ -1413,7 +1587,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
}
},
@@ -1426,6 +1600,138 @@
}
}
},
+ "IngestConfiguration":{
+ "type":"structure",
+ "required":[
+ "arn",
+ "ingestProtocol",
+ "streamKey",
+ "stageArn",
+ "participantId",
+ "state"
+ ],
+ "members":{
+ "name":{
+ "shape":"IngestConfigurationName",
+ "documentation":"Ingest name
"
+ },
+ "arn":{
+ "shape":"IngestConfigurationArn",
+ "documentation":"Ingest configuration ARN.
"
+ },
+ "ingestProtocol":{
+ "shape":"IngestProtocol",
+ "documentation":"Type of ingest protocol that the user employs for broadcasting.
"
+ },
+ "streamKey":{
+ "shape":"StreamKey",
+ "documentation":"Ingest-key value for the RTMP(S) protocol.
"
+ },
+ "stageArn":{
+ "shape":"IngestConfigurationStageArn",
+ "documentation":"ARN of the stage with which the IngestConfiguration is associated.
"
+ },
+ "participantId":{
+ "shape":"ParticipantId",
+ "documentation":"ID of the participant within the stage.
"
+ },
+ "state":{
+ "shape":"IngestConfigurationState",
+ "documentation":"State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
"
+ },
+ "userId":{
+ "shape":"UserId",
+ "documentation":"Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
"
+ },
+ "attributes":{
+ "shape":"ParticipantAttributes",
+ "documentation":"Application-provided attributes to to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
"
+ },
+ "tags":{
+ "shape":"Tags",
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ }
+ },
+ "documentation":"Object specifying an ingest configuration.
"
+ },
+ "IngestConfigurationArn":{
+ "type":"string",
+ "max":128,
+ "min":1,
+ "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:ingest-configuration/[a-zA-Z0-9-]+"
+ },
+ "IngestConfigurationList":{
+ "type":"list",
+ "member":{"shape":"IngestConfigurationSummary"}
+ },
+ "IngestConfigurationName":{
+ "type":"string",
+ "max":128,
+ "min":0,
+ "pattern":"[a-zA-Z0-9-_]*"
+ },
+ "IngestConfigurationStageArn":{
+ "type":"string",
+ "max":128,
+ "min":0,
+ "pattern":"^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$"
+ },
+ "IngestConfigurationState":{
+ "type":"string",
+ "enum":[
+ "ACTIVE",
+ "INACTIVE"
+ ]
+ },
+ "IngestConfigurationSummary":{
+ "type":"structure",
+ "required":[
+ "arn",
+ "ingestProtocol",
+ "stageArn",
+ "participantId",
+ "state"
+ ],
+ "members":{
+ "name":{
+ "shape":"IngestConfigurationName",
+ "documentation":"Ingest name.
"
+ },
+ "arn":{
+ "shape":"IngestConfigurationArn",
+ "documentation":"Ingest configuration ARN.
"
+ },
+ "ingestProtocol":{
+ "shape":"IngestProtocol",
+ "documentation":"Type of ingest protocol that the user employs for broadcasting.
"
+ },
+ "stageArn":{
+ "shape":"IngestConfigurationStageArn",
+ "documentation":"ARN of the stage with which the IngestConfiguration is associated.
"
+ },
+ "participantId":{
+ "shape":"ParticipantId",
+ "documentation":"ID of the participant within the stage.
"
+ },
+ "state":{
+ "shape":"IngestConfigurationState",
+ "documentation":"State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
"
+ },
+ "userId":{
+ "shape":"UserId",
+ "documentation":"Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
"
+ }
+ },
+ "documentation":"Summary information about an IngestConfiguration.
"
+ },
+ "IngestProtocol":{
+ "type":"string",
+ "enum":[
+ "RTMP",
+ "RTMPS"
+ ]
+ },
+ "InsecureIngest":{"type":"boolean"},
"InternalServerException":{
"type":"structure",
"members":{
@@ -1515,6 +1821,41 @@
}
}
},
+ "ListIngestConfigurationsRequest":{
+ "type":"structure",
+ "members":{
+ "filterByStageArn":{
+ "shape":"StageArn",
+ "documentation":"Filters the response list to match the specified stage ARN. Only one filter (by stage ARN or by state) can be used at a time.
"
+ },
+ "filterByState":{
+ "shape":"IngestConfigurationState",
+ "documentation":"Filters the response list to match the specified state. Only one filter (by stage ARN or by state) can be used at a time.
"
+ },
+ "nextToken":{
+ "shape":"PaginationToken",
+ "documentation":"The first IngestConfiguration to retrieve. This is used for pagination; see the nextToken response field.
"
+ },
+ "maxResults":{
+ "shape":"MaxIngestConfigurationResults",
+ "documentation":"Maximum number of results to return. Default: 50.
"
+ }
+ }
+ },
+ "ListIngestConfigurationsResponse":{
+ "type":"structure",
+ "required":["ingestConfigurations"],
+ "members":{
+ "ingestConfigurations":{
+ "shape":"IngestConfigurationList",
+ "documentation":"List of the matching ingest configurations (summary information only).
"
+ },
+ "nextToken":{
+ "shape":"PaginationToken",
+ "documentation":"If there are more IngestConfigurations than maxResults, use nextToken in the request to get the next set.
"
+ }
+ }
+ },
"ListParticipantEventsRequest":{
"type":"structure",
"required":[
@@ -1761,6 +2102,12 @@
"max":100,
"min":1
},
+ "MaxIngestConfigurationResults":{
+ "type":"integer",
+ "box":true,
+ "max":100,
+ "min":1
+ },
"MaxParticipantEventResults":{
"type":"integer",
"box":true,
@@ -1866,6 +2213,10 @@
"recordingState":{
"shape":"ParticipantRecordingState",
"documentation":"The participant’s recording state.
"
+ },
+ "protocol":{
+ "shape":"ParticipantProtocol",
+ "documentation":"Type of ingest protocol that the participant employs for broadcasting.
"
}
},
"documentation":"Object describing a participant that has joined a stage.
"
@@ -1891,6 +2242,15 @@
"type":"list",
"member":{"shape":"ParticipantSummary"}
},
+ "ParticipantProtocol":{
+ "type":"string",
+ "enum":[
+ "UNKNOWN",
+ "WHIP",
+ "RTMP",
+ "RTMPS"
+ ]
+ },
"ParticipantRecordingFilterByRecordingState":{
"type":"string",
"enum":[
@@ -2190,7 +2550,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
},
"documentation":"Object specifying a public key used to sign stage participant tokens.
"
@@ -2229,7 +2589,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
},
"documentation":"Summary information about a public key.
"
@@ -2353,7 +2713,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
},
"autoParticipantRecordingConfiguration":{
"shape":"AutoParticipantRecordingConfiguration",
@@ -2386,10 +2746,18 @@
},
"whip":{
"shape":"StageEndpoint",
- "documentation":"WHIP endpoint.
"
+ "documentation":"The endpoint to be used for IVS real-time streaming using the WHIP protocol.
"
+ },
+ "rtmp":{
+ "shape":"StageEndpoint",
+ "documentation":"The endpoint to be used for IVS real-time streaming using the RTMP protocol.
"
+ },
+ "rtmps":{
+ "shape":"StageEndpoint",
+ "documentation":"The endpoint to be used for IVS real-time streaming using the RTMPS protocol.
"
}
},
- "documentation":"Summary information about various endpoints for a stage.
"
+ "documentation":"Summary information about various endpoints for a stage. We recommend that you cache these values at stage creation; the values can be cached for up to 14 days.
"
},
"StageName":{
"type":"string",
@@ -2461,7 +2829,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
},
"documentation":"Summary information about a stage.
"
@@ -2496,7 +2864,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
}
},
@@ -2542,7 +2910,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
},
"documentation":"A complex type that describes a location where recorded videos will be stored.
"
@@ -2577,7 +2945,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
+ "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
},
"documentation":"Summary information about a storage configuration.
"
@@ -2586,6 +2954,11 @@
"type":"list",
"member":{"shape":"StorageConfigurationSummary"}
},
+ "StreamKey":{
+ "type":"string",
+ "pattern":"rt_[0-9]+_[a-z0-9-]+_[a-zA-Z0-9-]+_.+",
+ "sensitive":true
+ },
"String":{"type":"string"},
"TagKey":{
"type":"string",
@@ -2613,7 +2986,7 @@
},
"tags":{
"shape":"Tags",
- "documentation":"Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints beyond what is documented there.
"
+ "documentation":"Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
"
}
}
},
@@ -2653,7 +3026,7 @@
},
"tagKeys":{
"shape":"TagKeyList",
- "documentation":"Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints beyond what is documented there.
",
+ "documentation":"Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
",
"location":"querystring",
"locationName":"tagKeys"
}
@@ -2664,6 +3037,29 @@
"members":{
}
},
+ "UpdateIngestConfigurationRequest":{
+ "type":"structure",
+ "required":["arn"],
+ "members":{
+ "arn":{
+ "shape":"IngestConfigurationArn",
+ "documentation":"ARN of the IngestConfiguration, for which the related stage ARN needs to be updated.
"
+ },
+ "stageArn":{
+ "shape":"IngestConfigurationStageArn",
+ "documentation":"Stage ARN that needs to be updated.
"
+ }
+ }
+ },
+ "UpdateIngestConfigurationResponse":{
+ "type":"structure",
+ "members":{
+ "ingestConfiguration":{
+ "shape":"IngestConfiguration",
+ "documentation":"The updated IngestConfiguration.
"
+ }
+ }
+ },
"UpdateStageRequest":{
"type":"structure",
"required":["arn"],
@@ -2758,5 +3154,5 @@
},
"errorMessage":{"type":"string"}
},
- "documentation":"The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Key Concepts
-
Stage — A virtual space where participants can exchange video in real time.
-
Participant token — A token that authenticates a participant when they join a stage.
-
Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
For server-side composition:
-
Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.
-
Composition — Controls the look of the outputs, including how participants are positioned in the video.
For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
"
+ "documentation":"The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Key Concepts
-
Stage — A virtual space where participants can exchange video in real time.
-
Participant token — A token that authenticates a participant when they join a stage.
-
Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
For server-side composition:
-
Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.
-
Composition — Controls the look of the outputs, including how participants are positioned in the video.
For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
"
}
diff --git a/services/kafka/pom.xml b/services/kafka/pom.xml
index 04c7273dd8b9..9a30a5980947 100644
--- a/services/kafka/pom.xml
+++ b/services/kafka/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kafka
AWS Java SDK :: Services :: Kafka
diff --git a/services/kafka/src/main/resources/codegen-resources/service-2.json b/services/kafka/src/main/resources/codegen-resources/service-2.json
index 8c09d4924967..0ebb38802481 100644
--- a/services/kafka/src/main/resources/codegen-resources/service-2.json
+++ b/services/kafka/src/main/resources/codegen-resources/service-2.json
@@ -9,46 +9,57 @@
"protocol": "rest-json",
"jsonVersion": "1.1",
"uid": "kafka-2018-11-14",
- "signatureVersion": "v4"
+ "signatureVersion": "v4",
+ "auth": [
+ "aws.auth#sigv4"
+ ]
},
"operations": {
- "BatchAssociateScramSecret" : {
- "name" : "BatchAssociateScramSecret",
- "http" : {
- "method" : "POST",
- "requestUri" : "/v1/clusters/{clusterArn}/scram-secrets",
- "responseCode" : 200
- },
- "input" : {
- "shape" : "BatchAssociateScramSecretRequest"
- },
- "output" : {
- "shape" : "BatchAssociateScramSecretResponse",
+ "BatchAssociateScramSecret": {
+ "name": "BatchAssociateScramSecret",
+ "http": {
+ "method": "POST",
+ "requestUri": "/v1/clusters/{clusterArn}/scram-secrets",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "BatchAssociateScramSecretRequest"
+ },
+ "output": {
+ "shape": "BatchAssociateScramSecretResponse",
"documentation": "\n 200 response
\n "
},
- "errors" : [ {
- "shape" : "BadRequestException",
- "documentation" : "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
- }, {
- "shape" : "UnauthorizedException",
- "documentation" : "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
- }, {
- "shape" : "InternalServerErrorException",
- "documentation" : "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
- }, {
- "shape" : "ForbiddenException",
- "documentation" : "\n Access forbidden. Check your credentials and then retry your request.
\n "
- }, {
- "shape" : "NotFoundException",
- "documentation" : "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
- }, {
- "shape" : "ServiceUnavailableException",
- "documentation" : "\n 503 response
\n "
- }, {
- "shape" : "TooManyRequestsException",
- "documentation" : "\n 429 response
\n "
- } ],
- "documentation" : "\n Associates one or more Scram Secrets with an Amazon MSK cluster.
\n "
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
+ },
+ {
+ "shape": "UnauthorizedException",
+ "documentation": "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "\n Access forbidden. Check your credentials and then retry your request.
\n "
+ },
+ {
+ "shape": "NotFoundException",
+ "documentation": "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
+ },
+ {
+ "shape": "ServiceUnavailableException",
+ "documentation": "\n 503 response
\n "
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "\n 429 response
\n "
+ }
+ ],
+ "documentation": "\n Associates one or more Scram Secrets with an Amazon MSK cluster.
\n "
},
"CreateCluster": {
"name": "CreateCluster",
@@ -398,7 +409,8 @@
{
"shape": "BadRequestException",
"documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
"
- }, {
+ },
+ {
"shape": "UnauthorizedException",
"documentation": "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
"
},
@@ -573,43 +585,51 @@
],
"documentation": "\n Returns a description of the cluster operation specified by the ARN.
\n "
},
- "DescribeClusterOperationV2" : {
- "name" : "DescribeClusterOperationV2",
- "http" : {
- "method" : "GET",
- "requestUri" : "/api/v2/operations/{clusterOperationArn}",
- "responseCode" : 200
- },
- "input" : {
- "shape" : "DescribeClusterOperationV2Request"
- },
- "output" : {
- "shape" : "DescribeClusterOperationV2Response",
- "documentation" : "\n HTTP Status Code 200: OK.
"
- },
- "errors" : [ {
- "shape" : "BadRequestException",
- "documentation" : "\n HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
"
- }, {
- "shape" : "UnauthorizedException",
- "documentation" : "\n HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
"
- }, {
- "shape" : "InternalServerErrorException",
- "documentation" : "\n HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
"
- }, {
- "shape" : "ForbiddenException",
- "documentation" : "\n HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
"
- }, {
- "shape" : "NotFoundException",
- "documentation" : "\n HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
"
- }, {
- "shape" : "ServiceUnavailableException",
- "documentation" : "\n HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
"
- }, {
- "shape" : "TooManyRequestsException",
- "documentation" : "\n HTTP Status Code 429: Limit exceeded. Resource limit reached.
"
- } ],
- "documentation" : "\n Returns a description of the cluster operation specified by the ARN.
\n"
+ "DescribeClusterOperationV2": {
+ "name": "DescribeClusterOperationV2",
+ "http": {
+ "method": "GET",
+ "requestUri": "/api/v2/operations/{clusterOperationArn}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DescribeClusterOperationV2Request"
+ },
+ "output": {
+ "shape": "DescribeClusterOperationV2Response",
+ "documentation": "\n HTTP Status Code 200: OK.
"
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "\n HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
"
+ },
+ {
+ "shape": "UnauthorizedException",
+ "documentation": "\n HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
"
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "\n HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
"
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "\n HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
"
+ },
+ {
+ "shape": "NotFoundException",
+ "documentation": "\n HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
"
+ },
+ {
+ "shape": "ServiceUnavailableException",
+ "documentation": "\n HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
"
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "\n HTTP Status Code 429: Limit exceeded. Resource limit reached.
"
+ }
+ ],
+ "documentation": "\n Returns a description of the cluster operation specified by the ARN.
\n"
},
"DescribeConfiguration": {
"name": "DescribeConfiguration",
@@ -783,43 +803,51 @@
],
"documentation": "\n Returns a description of this MSK VPC connection.
\n "
},
- "BatchDisassociateScramSecret" : {
- "name" : "BatchDisassociateScramSecret",
- "http" : {
- "method" : "PATCH",
- "requestUri" : "/v1/clusters/{clusterArn}/scram-secrets",
- "responseCode" : 200
+ "BatchDisassociateScramSecret": {
+ "name": "BatchDisassociateScramSecret",
+ "http": {
+ "method": "PATCH",
+ "requestUri": "/v1/clusters/{clusterArn}/scram-secrets",
+ "responseCode": 200
},
- "input" : {
- "shape" : "BatchDisassociateScramSecretRequest"
+ "input": {
+ "shape": "BatchDisassociateScramSecretRequest"
},
- "output" : {
- "shape" : "BatchDisassociateScramSecretResponse",
+ "output": {
+ "shape": "BatchDisassociateScramSecretResponse",
"documentation": "\n 200 response
\n "
},
- "errors" : [ {
- "shape" : "BadRequestException",
- "documentation" : "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
- }, {
- "shape" : "UnauthorizedException",
- "documentation" : "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
- }, {
- "shape" : "InternalServerErrorException",
- "documentation" : "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
- }, {
- "shape" : "ForbiddenException",
- "documentation" : "\n Access forbidden. Check your credentials and then retry your request.
\n "
- }, {
- "shape" : "NotFoundException",
- "documentation" : "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
- }, {
- "shape" : "ServiceUnavailableException",
- "documentation" : "\n 503 response
\n "
- }, {
- "shape" : "TooManyRequestsException",
- "documentation" : "\n 429 response
\n "
- } ],
- "documentation" : "\n Disassociates one or more Scram Secrets from an Amazon MSK cluster.
\n "
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
+ },
+ {
+ "shape": "UnauthorizedException",
+ "documentation": "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "\n Access forbidden. Check your credentials and then retry your request.
\n "
+ },
+ {
+ "shape": "NotFoundException",
+ "documentation": "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
+ },
+ {
+ "shape": "ServiceUnavailableException",
+ "documentation": "\n 503 response
\n "
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "\n 429 response
\n "
+ }
+ ],
+ "documentation": "\n Disassociates one or more Scram Secrets from an Amazon MSK cluster.
\n "
},
"GetBootstrapBrokers": {
"name": "GetBootstrapBrokers",
@@ -857,51 +885,50 @@
"documentation": "\n Access forbidden. Check your credentials and then retry your request.
\n "
}
],
- "documentation": "\n A list of brokers that a client application can use to bootstrap.
\n "
+ "documentation": "\n A list of brokers that a client application can use to bootstrap. This list doesn't necessarily include all of the brokers in the cluster. The following Python 3.6 example shows how you can use the Amazon Resource Name (ARN) of a cluster to get its bootstrap brokers. If you don't know the ARN of your cluster, you can use the ListClusters operation to get the ARNs of all the clusters in this account and Region.
\n "
},
- "GetCompatibleKafkaVersions" : {
- "name" : "GetCompatibleKafkaVersions",
- "http" : {
- "method" : "GET",
- "requestUri" : "/v1/compatible-kafka-versions",
- "responseCode" : 200
+ "GetCompatibleKafkaVersions": {
+ "name": "GetCompatibleKafkaVersions",
+ "http": {
+ "method": "GET",
+ "requestUri": "/v1/compatible-kafka-versions",
+ "responseCode": 200
},
- "input" : {
- "shape" : "GetCompatibleKafkaVersionsRequest"
+ "input": {
+ "shape": "GetCompatibleKafkaVersionsRequest"
},
- "output" : {
- "shape" : "GetCompatibleKafkaVersionsResponse",
+ "output": {
+ "shape": "GetCompatibleKafkaVersionsResponse",
"documentation": "\n Successful response.
\n "
},
- "errors" :
- [
+ "errors": [
{
- "shape" : "BadRequestException",
- "documentation" : "n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
n "
+ "shape": "BadRequestException",
+ "documentation": "n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
n "
},
{
- "shape" : "UnauthorizedException",
- "documentation" : "n The request is not authorized. The provided credentials couldn't be validated.
n "
+ "shape": "UnauthorizedException",
+ "documentation": "n The request is not authorized. The provided credentials couldn't be validated.
n "
},
{
- "shape" : "InternalServerErrorException",
- "documentation" : "n There was an unexpected internal server error. Retrying your request might resolve the issue.
n "
+ "shape": "InternalServerErrorException",
+ "documentation": "n There was an unexpected internal server error. Retrying your request might resolve the issue.
n "
},
{
- "shape" : "ForbiddenException",
- "documentation" : "n Access forbidden. Check your credentials and then retry your request.
n "
+ "shape": "ForbiddenException",
+ "documentation": "n Access forbidden. Check your credentials and then retry your request.
n "
},
{
- "shape" : "NotFoundException",
- "documentation" : "n The resource could not be found due to incorrect input. Correct the input, then retry the request.
n "
+ "shape": "NotFoundException",
+ "documentation": "n The resource could not be found due to incorrect input. Correct the input, then retry the request.
n "
},
{
- "shape" : "ServiceUnavailableException",
- "documentation" : "n 503 response
n "
+ "shape": "ServiceUnavailableException",
+ "documentation": "n 503 response
n "
},
{
- "shape" : "TooManyRequestsException",
- "documentation" : "n 429 response
n "
+ "shape": "TooManyRequestsException",
+ "documentation": "n 429 response
n "
}
],
"documentation": "\n Gets the Apache Kafka versions to which you can update the MSK cluster.
\n "
@@ -974,43 +1001,51 @@
],
"documentation": "\n Returns a list of all the operations that have been performed on the specified MSK cluster.
\n "
},
- "ListClusterOperationsV2" : {
- "name" : "ListClusterOperationsV2",
- "http" : {
- "method" : "GET",
- "requestUri" : "/api/v2/clusters/{clusterArn}/operations",
- "responseCode" : 200
- },
- "input" : {
- "shape" : "ListClusterOperationsV2Request"
- },
- "output" : {
- "shape" : "ListClusterOperationsV2Response",
- "documentation" : "\n HTTP Status Code 200: OK.
"
- },
- "errors" : [ {
- "shape" : "BadRequestException",
- "documentation" : "\n HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
"
- }, {
- "shape" : "UnauthorizedException",
- "documentation" : "\n HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
"
- }, {
- "shape" : "InternalServerErrorException",
- "documentation" : "\n HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
"
- }, {
- "shape" : "ForbiddenException",
- "documentation" : "\n HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
"
- }, {
- "shape" : "NotFoundException",
- "documentation" : "\n HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
"
- }, {
- "shape" : "ServiceUnavailableException",
- "documentation" : "\n HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
"
- }, {
- "shape" : "TooManyRequestsException",
- "documentation" : "\n HTTP Status Code 429: Limit exceeded. Resource limit reached.
"
- } ],
- "documentation" : "\n Returns a list of all the operations that have been performed on the specified MSK cluster.
\n "
+ "ListClusterOperationsV2": {
+ "name": "ListClusterOperationsV2",
+ "http": {
+ "method": "GET",
+ "requestUri": "/api/v2/clusters/{clusterArn}/operations",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListClusterOperationsV2Request"
+ },
+ "output": {
+ "shape": "ListClusterOperationsV2Response",
+ "documentation": "\n HTTP Status Code 200: OK.
"
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "\n HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
"
+ },
+ {
+ "shape": "UnauthorizedException",
+ "documentation": "\n HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
"
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "\n HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
"
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "\n HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
"
+ },
+ {
+ "shape": "NotFoundException",
+ "documentation": "\n HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
"
+ },
+ {
+ "shape": "ServiceUnavailableException",
+ "documentation": "\n HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
"
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "\n HTTP Status Code 429: Limit exceeded. Resource limit reached.
"
+ }
+ ],
+ "documentation": "\n Returns a list of all the operations that have been performed on the specified MSK cluster.
\n "
},
"ListClusters": {
"name": "ListClusters",
@@ -1273,43 +1308,51 @@
],
"documentation": "Lists the replicators.
"
},
- "ListScramSecrets" : {
- "name" : "ListScramSecrets",
- "http" : {
- "method" : "GET",
- "requestUri" : "/v1/clusters/{clusterArn}/scram-secrets",
- "responseCode" : 200
+ "ListScramSecrets": {
+ "name": "ListScramSecrets",
+ "http": {
+ "method": "GET",
+ "requestUri": "/v1/clusters/{clusterArn}/scram-secrets",
+ "responseCode": 200
},
- "input" : {
- "shape" : "ListScramSecretsRequest"
+ "input": {
+ "shape": "ListScramSecretsRequest"
},
- "output" : {
- "shape" : "ListScramSecretsResponse",
+ "output": {
+ "shape": "ListScramSecretsResponse",
"documentation": "\n 200 response
\n "
},
- "errors" : [ {
- "shape" : "BadRequestException",
- "documentation" : "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
- }, {
- "shape" : "UnauthorizedException",
- "documentation" : "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
- }, {
- "shape" : "InternalServerErrorException",
- "documentation" : "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
- }, {
- "shape" : "ForbiddenException",
- "documentation" : "\n Access forbidden. Check your credentials and then retry your request.
\n "
- }, {
- "shape" : "NotFoundException",
- "documentation" : "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
- }, {
- "shape" : "ServiceUnavailableException",
- "documentation" : "\n 503 response
\n "
- }, {
- "shape" : "TooManyRequestsException",
- "documentation" : "\n 429 response
\n "
- } ],
- "documentation" : "\n Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
\n "
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
+ },
+ {
+ "shape": "UnauthorizedException",
+ "documentation": "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "\n Access forbidden. Check your credentials and then retry your request.
\n "
+ },
+ {
+ "shape": "NotFoundException",
+ "documentation": "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
+ },
+ {
+ "shape": "ServiceUnavailableException",
+ "documentation": "\n 503 response
\n "
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "\n 429 response
\n "
+ }
+ ],
+ "documentation": "\n Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
\n "
},
"ListTagsForResource": {
"name": "ListTagsForResource",
@@ -1485,51 +1528,51 @@
],
"documentation": "\n Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.
\n "
},
- "RebootBroker" : {
- "name" : "RebootBroker",
- "http" : {
- "method" : "PUT",
- "requestUri" : "/v1/clusters/{clusterArn}/reboot-broker",
- "responseCode" : 200
+ "RebootBroker": {
+ "name": "RebootBroker",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/v1/clusters/{clusterArn}/reboot-broker",
+ "responseCode": 200
},
- "input" : {
- "shape" : "RebootBrokerRequest"
+ "input": {
+ "shape": "RebootBrokerRequest"
},
- "output" : {
- "shape" : "RebootBrokerResponse",
+ "output": {
+ "shape": "RebootBrokerResponse",
"documentation": "\n Successful response.
\n "
},
- "errors" : [
+ "errors": [
{
- "shape" : "BadRequestException",
+ "shape": "BadRequestException",
"documentation": "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
},
{
- "shape" : "UnauthorizedException",
+ "shape": "UnauthorizedException",
"documentation": "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
},
{
- "shape" : "InternalServerErrorException",
+ "shape": "InternalServerErrorException",
"documentation": "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
},
{
- "shape" : "ForbiddenException",
+ "shape": "ForbiddenException",
"documentation": "\n Access forbidden. Check your credentials and then retry your request.
\n "
},
{
- "shape" : "NotFoundException",
+ "shape": "NotFoundException",
"documentation": "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
},
{
- "shape" : "ServiceUnavailableException",
+ "shape": "ServiceUnavailableException",
"documentation": "\n 503 response
\n "
},
{
- "shape" : "TooManyRequestsException",
- "documentation" : "\n 429 response
\n "
+ "shape": "TooManyRequestsException",
+ "documentation": "\n 429 response
\n "
}
],
- "documentation" : "Reboots brokers."
+ "documentation": "Reboots brokers."
},
"TagResource": {
"name": "TagResource",
@@ -1637,32 +1680,32 @@
},
"errors": [
{
- "shape" : "BadRequestException",
- "documentation" : "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
+ "shape": "BadRequestException",
+ "documentation": "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
},
{
- "shape" : "UnauthorizedException",
- "documentation" : "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
+ "shape": "UnauthorizedException",
+ "documentation": "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
},
{
- "shape" : "InternalServerErrorException",
- "documentation" : "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
+ "shape": "InternalServerErrorException",
+ "documentation": "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
},
{
- "shape" : "ForbiddenException",
- "documentation" : "\n Access forbidden. Check your credentials and then retry your request.
\n "
+ "shape": "ForbiddenException",
+ "documentation": "\n Access forbidden. Check your credentials and then retry your request.
\n "
},
{
- "shape" : "NotFoundException",
- "documentation" : "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
+ "shape": "NotFoundException",
+ "documentation": "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
},
{
- "shape" : "ServiceUnavailableException",
- "documentation" : "\n 503 response
\n "
+ "shape": "ServiceUnavailableException",
+ "documentation": "\n 503 response
\n "
},
{
- "shape" : "TooManyRequestsException",
- "documentation" : "\n 429 response
\n "
+ "shape": "TooManyRequestsException",
+ "documentation": "\n 429 response
\n "
}
],
"documentation": "\n Updates EC2 instance type.
\n "
@@ -1747,18 +1790,18 @@
],
"documentation": "\n Updates an MSK configuration.
\n "
},
- "UpdateConnectivity" : {
- "name" : "UpdateConnectivity",
- "http" : {
- "method" : "PUT",
- "requestUri" : "/v1/clusters/{clusterArn}/connectivity",
- "responseCode" : 200
+ "UpdateConnectivity": {
+ "name": "UpdateConnectivity",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/v1/clusters/{clusterArn}/connectivity",
+ "responseCode": 200
},
- "input" : {
- "shape" : "UpdateConnectivityRequest"
+ "input": {
+ "shape": "UpdateConnectivityRequest"
},
- "output" : {
- "shape" : "UpdateConnectivityResponse",
+ "output": {
+ "shape": "UpdateConnectivityResponse",
"documentation": "\n Successful response.
\n "
},
"errors": [
@@ -1787,7 +1830,7 @@
"documentation": "\n 503 response
\n "
}
],
- "documentation" : "\n Updates the cluster's connectivity configuration.
\n "
+ "documentation": "\n Updates the cluster's connectivity configuration.
\n "
},
"UpdateClusterConfiguration": {
"name": "UpdateClusterConfiguration",
@@ -1831,83 +1874,89 @@
],
"documentation": "\n Updates the cluster with the configuration that is specified in the request body.
\n "
},
- "UpdateClusterKafkaVersion" : {
- "name" : "UpdateClusterKafkaVersion",
- "http" : {
- "method" : "PUT",
- "requestUri" : "/v1/clusters/{clusterArn}/version",
- "responseCode" : 200
+ "UpdateClusterKafkaVersion": {
+ "name": "UpdateClusterKafkaVersion",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/v1/clusters/{clusterArn}/version",
+ "responseCode": 200
},
- "input" : {
- "shape" : "UpdateClusterKafkaVersionRequest"
+ "input": {
+ "shape": "UpdateClusterKafkaVersionRequest"
},
- "output" : {
- "shape" : "UpdateClusterKafkaVersionResponse",
- "documentation" : "\n Successful response.
\n "
+ "output": {
+ "shape": "UpdateClusterKafkaVersionResponse",
+ "documentation": "\n Successful response.
\n "
},
- "errors" : [
+ "errors": [
{
- "shape" : "BadRequestException",
- "documentation" : "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
+ "shape": "BadRequestException",
+ "documentation": "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
},
{
- "shape" : "UnauthorizedException",
- "documentation" : "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
+ "shape": "UnauthorizedException",
+ "documentation": "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
},
{
- "shape" : "InternalServerErrorException",
- "documentation" : "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
+ "shape": "InternalServerErrorException",
+ "documentation": "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
},
{
- "shape" : "ForbiddenException",
- "documentation" : "\n Access forbidden. Check your credentials and then retry your request.
\n "
+ "shape": "ForbiddenException",
+ "documentation": "\n Access forbidden. Check your credentials and then retry your request.
\n "
},
{
- "shape" : "NotFoundException",
- "documentation" : "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
+ "shape": "NotFoundException",
+ "documentation": "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
},
{
- "shape" : "ServiceUnavailableException",
- "documentation" : "\n 503 response
\n "
+ "shape": "ServiceUnavailableException",
+ "documentation": "\n 503 response
\n "
},
{
- "shape" : "TooManyRequestsException",
- "documentation" : "\n 429 response
\n "
+ "shape": "TooManyRequestsException",
+ "documentation": "\n 429 response
\n "
}
],
"documentation": "\n Updates the Apache Kafka version for the cluster.
\n "
},
- "UpdateMonitoring" : {
- "name" : "UpdateMonitoring",
- "http" : {
- "method" : "PUT",
- "requestUri" : "/v1/clusters/{clusterArn}/monitoring",
- "responseCode" : 200
- },
- "input" : {
- "shape" : "UpdateMonitoringRequest"
- },
- "output" : {
- "shape" : "UpdateMonitoringResponse",
- "documentation" : "\n HTTP Status Code 200: OK.
\n "
- },
- "errors" : [ {
- "shape" : "ServiceUnavailableException",
- "documentation" : "\n 503 response
\n "
- }, {
- "shape" : "BadRequestException",
- "documentation" : "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
- }, {
- "shape" : "UnauthorizedException",
- "documentation" : "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
- }, {
- "shape" : "InternalServerErrorException",
- "documentation" : "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
- }, {
- "shape" : "ForbiddenException",
- "documentation" : "\n Access forbidden. Check your credentials and then retry your request.
\n "
- } ],
- "documentation" : "\n Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.
\n "
+ "UpdateMonitoring": {
+ "name": "UpdateMonitoring",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/v1/clusters/{clusterArn}/monitoring",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateMonitoringRequest"
+ },
+ "output": {
+ "shape": "UpdateMonitoringResponse",
+ "documentation": "\n HTTP Status Code 200: OK.
\n "
+ },
+ "errors": [
+ {
+ "shape": "ServiceUnavailableException",
+ "documentation": "\n 503 response
\n "
+ },
+ {
+ "shape": "BadRequestException",
+ "documentation": "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
+ },
+ {
+ "shape": "UnauthorizedException",
+ "documentation": "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "\n Access forbidden. Check your credentials and then retry your request.
\n "
+ }
+ ],
+ "documentation": "\n Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.
\n "
},
"UpdateReplicationInfo": {
"name": "UpdateReplicationInfo",
@@ -1955,84 +2004,100 @@
],
"documentation": "Updates replication info of a replicator.
"
},
- "UpdateSecurity" : {
- "name" : "UpdateSecurity",
- "http" : {
- "method" : "PATCH",
- "requestUri" : "/v1/clusters/{clusterArn}/security",
- "responseCode" : 200
- },
- "input" : {
- "shape" : "UpdateSecurityRequest"
- },
- "output" : {
- "shape" : "UpdateSecurityResponse"
- },
- "errors" : [ {
- "shape" : "BadRequestException",
- "documentation" : "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
- }, {
- "shape" : "UnauthorizedException",
- "documentation" : "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
- }, {
- "shape" : "InternalServerErrorException",
- "documentation" : "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
- }, {
- "shape" : "ForbiddenException",
- "documentation" : "\n Access forbidden. Check your credentials and then retry your request.
\n "
- }, {
- "shape" : "NotFoundException",
- "documentation" : "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
- }, {
- "shape" : "ServiceUnavailableException",
- "documentation" : "\n The service cannot complete the request.
\n "
- }, {
- "shape" : "TooManyRequestsException",
- "documentation" : "\n The request throughput limit was exceeded.
\n "
- } ],
- "documentation" : "\n Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.
\n "
- },
- "UpdateStorage" : {
- "name" : "UpdateStorage",
- "http" : {
- "method" : "PUT",
- "requestUri" : "/v1/clusters/{clusterArn}/storage",
- "responseCode" : 200
- },
- "input" : {
- "shape" : "UpdateStorageRequest"
- },
- "output" : {
- "shape" : "UpdateStorageResponse",
- "documentation" : "HTTP Status Code 200: OK."
- },
- "errors" : [ {
- "shape" : "BadRequestException",
- "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it."
- }, {
- "shape" : "UnauthorizedException",
- "documentation" : "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated."
- }, {
- "shape" : "InternalServerErrorException",
- "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue."
- }, {
- "shape" : "ForbiddenException",
- "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request."
- }, {
- "shape" : "NotFoundException",
- "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it."
- }, {
- "shape" : "ServiceUnavailableException",
- "documentation" : "HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue."
- }, {
- "shape" : "TooManyRequestsException",
- "documentation" : "HTTP Status Code 429: Limit exceeded. Resource limit reached."
- } ],
- "documentation" : "Updates cluster broker volume size (or) sets cluster storage mode to TIERED."
- }
- },
- "shapes": {
- "AmazonMskCluster": {
+ "UpdateSecurity": {
+ "name": "UpdateSecurity",
+ "http": {
+ "method": "PATCH",
+ "requestUri": "/v1/clusters/{clusterArn}/security",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateSecurityRequest"
+ },
+ "output": {
+ "shape": "UpdateSecurityResponse"
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "\n The request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n "
+ },
+ {
+ "shape": "UnauthorizedException",
+ "documentation": "\n The request is not authorized. The provided credentials couldn't be validated.
\n "
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "\n There was an unexpected internal server error. Retrying your request might resolve the issue.
\n "
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "\n Access forbidden. Check your credentials and then retry your request.
\n "
+ },
+ {
+ "shape": "NotFoundException",
+ "documentation": "\n The resource could not be found due to incorrect input. Correct the input, then retry the request.
\n "
+ },
+ {
+ "shape": "ServiceUnavailableException",
+ "documentation": "\n The service cannot complete the request.
\n "
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "\n The request throughput limit was exceeded.
\n "
+ }
+ ],
+ "documentation": "\n Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.
\n "
+ },
+ "UpdateStorage": {
+ "name": "UpdateStorage",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/v1/clusters/{clusterArn}/storage",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateStorageRequest"
+ },
+ "output": {
+ "shape": "UpdateStorageResponse",
+ "documentation": "HTTP Status Code 200: OK."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it."
+ },
+ {
+ "shape": "UnauthorizedException",
+ "documentation": "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated."
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue."
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request."
+ },
+ {
+ "shape": "NotFoundException",
+ "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it."
+ },
+ {
+ "shape": "ServiceUnavailableException",
+ "documentation": "HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "HTTP Status Code 429: Limit exceeded. Resource limit reached."
+ }
+ ],
+ "documentation": "Updates cluster broker volume size (or) sets cluster storage mode to TIERED."
+ }
+ },
+ "shapes": {
+ "AmazonMskCluster": {
"type": "structure",
"members": {
"MskClusterArn": {
@@ -2042,38 +2107,43 @@
}
},
"documentation": "Details of an Amazon MSK Cluster.
",
- "required": ["MskClusterArn"]
- },
- "BatchAssociateScramSecretRequest" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster to be updated.
\n "
- },
- "SecretArnList" : {
- "shape" : "__listOf__string",
- "locationName" : "secretArnList",
- "documentation" : "\n List of AWS Secrets Manager secret ARNs.
\n "
- }
- },
- "documentation" : "\n Associates sasl scram secrets to cluster.
\n ",
- "required" : [ "ClusterArn", "SecretArnList" ]
- },
- "BatchAssociateScramSecretResponse" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster.
\n "
- },
- "UnprocessedScramSecrets" : {
- "shape" : "__listOfUnprocessedScramSecret",
- "locationName" : "unprocessedScramSecrets",
- "documentation" : "\n List of errors when associating secrets to cluster.
\n "
+ "required": [
+ "MskClusterArn"
+ ]
+ },
+ "BatchAssociateScramSecretRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster to be updated.
\n "
+ },
+ "SecretArnList": {
+ "shape": "__listOf__string",
+ "locationName": "secretArnList",
+ "documentation": "\n List of AWS Secrets Manager secret ARNs.
\n "
+ }
+ },
+ "documentation": "\n Associates sasl scram secrets to cluster.
\n ",
+ "required": [
+ "ClusterArn",
+ "SecretArnList"
+ ]
+ },
+ "BatchAssociateScramSecretResponse": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster.
\n "
+ },
+ "UnprocessedScramSecrets": {
+ "shape": "__listOfUnprocessedScramSecret",
+ "locationName": "unprocessedScramSecrets",
+ "documentation": "\n List of errors when associating secrets to cluster.
\n "
}
}
},
@@ -2104,17 +2174,17 @@
"DEFAULT"
]
},
- "BrokerCountUpdateInfo" : {
- "type" : "structure",
- "members" : {
- "CreatedBrokerIds" : {
- "shape" : "__listOf__double",
- "locationName" : "createdBrokerIds",
+ "BrokerCountUpdateInfo": {
+ "type": "structure",
+ "members": {
+ "CreatedBrokerIds": {
+ "shape": "__listOf__double",
+ "locationName": "createdBrokerIds",
"documentation": "\n Kafka Broker IDs of brokers being created.
\n "
},
- "DeletedBrokerIds" : {
- "shape" : "__listOf__double",
- "locationName" : "deletedBrokerIds",
+ "DeletedBrokerIds": {
+ "shape": "__listOf__double",
+ "locationName": "deletedBrokerIds",
"documentation": "\n Kafka Broker IDs of brokers being deleted.
\n "
}
},
@@ -2128,10 +2198,10 @@
"locationName": "kafkaBrokerNodeId",
"documentation": "\n The ID of the broker to update.
\n "
},
- "ProvisionedThroughput" : {
- "shape" : "ProvisionedThroughput",
- "locationName" : "provisionedThroughput",
- "documentation" : "\n EBS volume provisioned throughput information.
\n "
+ "ProvisionedThroughput": {
+ "shape": "ProvisionedThroughput",
+ "locationName": "provisionedThroughput",
+ "documentation": "\n EBS volume provisioned throughput information.
\n "
},
"VolumeSizeGB": {
"shape": "__integer",
@@ -2189,10 +2259,10 @@
"locationName": "storageInfo",
"documentation": "\n Contains information about storage volumes attached to MSK broker nodes.
\n "
},
- "ConnectivityInfo" : {
- "shape" : "ConnectivityInfo",
- "locationName" : "connectivityInfo",
- "documentation" : "\n Information about the broker access configuration.
\n "
+ "ConnectivityInfo": {
+ "shape": "ConnectivityInfo",
+ "locationName": "connectivityInfo",
+ "documentation": "\n Information about the broker access configuration.
\n "
},
"ZoneIds": {
"shape": "__listOf__string",
@@ -2263,34 +2333,34 @@
},
"documentation": "\n Information about the current software installed on the cluster.
\n "
},
- "ClientAuthentication" : {
- "type" : "structure",
- "members" : {
- "Sasl" : {
- "shape" : "Sasl",
- "locationName" : "sasl",
- "documentation" : "\n Details for ClientAuthentication using SASL.
\n "
+ "ClientAuthentication": {
+ "type": "structure",
+ "members": {
+ "Sasl": {
+ "shape": "Sasl",
+ "locationName": "sasl",
+ "documentation": "\n Details for ClientAuthentication using SASL.
\n "
},
"Tls": {
"shape": "Tls",
"locationName": "tls",
"documentation": "\n Details for ClientAuthentication using TLS.
\n "
},
- "Unauthenticated" : {
- "shape" : "Unauthenticated",
- "locationName" : "unauthenticated",
+ "Unauthenticated": {
+ "shape": "Unauthenticated",
+ "locationName": "unauthenticated",
"documentation": "\n Contains information about unauthenticated traffic to the cluster.
\n "
}
},
- "documentation" : "\n Includes all client authentication information.
\n "
+ "documentation": "\n Includes all client authentication information.
\n "
},
- "VpcConnectivityClientAuthentication" : {
- "type" : "structure",
- "members" : {
- "Sasl" : {
- "shape" : "VpcConnectivitySasl",
- "locationName" : "sasl",
- "documentation" : "\n SASL authentication type details for VPC connectivity.
\n "
+ "VpcConnectivityClientAuthentication": {
+ "type": "structure",
+ "members": {
+ "Sasl": {
+ "shape": "VpcConnectivitySasl",
+ "locationName": "sasl",
+ "documentation": "\n SASL authentication type details for VPC connectivity.
\n "
},
"Tls": {
"shape": "VpcConnectivityTls",
@@ -2298,18 +2368,18 @@
"documentation": "\n TLS authentication type details for VPC connectivity.
\n "
}
},
- "documentation" : "\n Includes all client authentication information for VPC connectivity.
\n "
+ "documentation": "\n Includes all client authentication information for VPC connectivity.
\n "
},
- "ServerlessClientAuthentication" : {
- "type" : "structure",
- "members" : {
- "Sasl" : {
- "shape" : "ServerlessSasl",
- "locationName" : "sasl",
- "documentation" : "\n Details for ClientAuthentication using SASL.
\n "
+ "ServerlessClientAuthentication": {
+ "type": "structure",
+ "members": {
+ "Sasl": {
+ "shape": "ServerlessSasl",
+ "locationName": "sasl",
+ "documentation": "\n Details for ClientAuthentication using SASL.
\n "
}
},
- "documentation" : "\n Includes all client authentication information.
\n "
+ "documentation": "\n Includes all client authentication information.
\n "
},
"ClientBroker": {
"type": "string",
@@ -2320,19 +2390,21 @@
"PLAINTEXT"
]
},
- "CloudWatchLogs" : {
- "type" : "structure",
- "members" : {
- "Enabled" : {
- "shape" : "__boolean",
- "locationName" : "enabled"
+ "CloudWatchLogs": {
+ "type": "structure",
+ "members": {
+ "Enabled": {
+ "shape": "__boolean",
+ "locationName": "enabled"
},
- "LogGroup" : {
- "shape" : "__string",
- "locationName" : "logGroup"
+ "LogGroup": {
+ "shape": "__string",
+ "locationName": "logGroup"
}
},
- "required" : [ "Enabled" ]
+ "required": [
+ "Enabled"
+ ]
},
"ClusterInfo": {
"type": "structure",
@@ -2387,10 +2459,10 @@
"locationName": "enhancedMonitoring",
"documentation": "\n Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
\n "
},
- "OpenMonitoring" : {
- "shape" : "OpenMonitoring",
- "locationName" : "openMonitoring",
- "documentation" : "\n Settings for open monitoring using Prometheus.
\n "
+ "OpenMonitoring": {
+ "shape": "OpenMonitoring",
+ "locationName": "openMonitoring",
+ "documentation": "\n Settings for open monitoring using Prometheus.
\n "
},
"LoggingInfo": {
"shape": "LoggingInfo",
@@ -2406,9 +2478,9 @@
"locationName": "state",
"documentation": "\n The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
\n "
},
- "StateInfo" : {
- "shape" : "StateInfo",
- "locationName" : "stateInfo"
+ "StateInfo": {
+ "shape": "StateInfo",
+ "locationName": "stateInfo"
},
"Tags": {
"shape": "__mapOf__string",
@@ -2420,15 +2492,15 @@
"locationName": "zookeeperConnectString",
"documentation": "\n The connection string to use to connect to the Apache ZooKeeper cluster.
\n "
},
- "ZookeeperConnectStringTls" : {
- "shape" : "__string",
- "locationName" : "zookeeperConnectStringTls",
- "documentation" : "\n The connection string to use to connect to zookeeper cluster on Tls port.
\n "
+ "ZookeeperConnectStringTls": {
+ "shape": "__string",
+ "locationName": "zookeeperConnectStringTls",
+ "documentation": "\n The connection string to use to connect to zookeeper cluster on Tls port.
\n "
},
- "StorageMode" : {
- "shape" : "StorageMode",
- "locationName" : "storageMode",
- "documentation" : "\n This controls storage mode for supported storage tiers.
\n "
+ "StorageMode": {
+ "shape": "StorageMode",
+ "locationName": "storageMode",
+ "documentation": "\n This controls storage mode for supported storage tiers.
\n "
},
"CustomerActionStatus": {
"shape": "CustomerActionStatus",
@@ -2476,9 +2548,9 @@
"locationName": "state",
"documentation": "\n The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
\n "
},
- "StateInfo" : {
- "shape" : "StateInfo",
- "locationName" : "stateInfo",
+ "StateInfo": {
+ "shape": "StateInfo",
+ "locationName": "stateInfo",
"documentation": "\n State Info for the Amazon MSK cluster.
\n "
},
"Tags": {
@@ -2537,10 +2609,10 @@
"locationName": "operationState",
"documentation": "\n State of the cluster operation.
\n "
},
- "OperationSteps" : {
- "shape" : "__listOfClusterOperationStep",
- "locationName" : "operationSteps",
- "documentation" : "\n Steps completed during the operation.
\n "
+ "OperationSteps": {
+ "shape": "__listOfClusterOperationStep",
+ "locationName": "operationSteps",
+ "documentation": "\n Steps completed during the operation.
\n "
},
"OperationType": {
"shape": "__string",
@@ -2565,32 +2637,32 @@
},
"documentation": "\n Returns information about a cluster operation.
\n "
},
- "ClusterOperationStep" : {
- "type" : "structure",
- "members" : {
- "StepInfo" : {
- "shape" : "ClusterOperationStepInfo",
- "locationName" : "stepInfo",
- "documentation" : "\n Information about the step and its status.
\n "
+ "ClusterOperationStep": {
+ "type": "structure",
+ "members": {
+ "StepInfo": {
+ "shape": "ClusterOperationStepInfo",
+ "locationName": "stepInfo",
+ "documentation": "\n Information about the step and its status.
\n "
},
- "StepName" : {
- "shape" : "__string",
- "locationName" : "stepName",
- "documentation" : "\n The name of the step.
\n "
+ "StepName": {
+ "shape": "__string",
+ "locationName": "stepName",
+ "documentation": "\n The name of the step.
\n "
}
},
- "documentation" : "\n Step taken during a cluster operation.
\n "
+ "documentation": "\n Step taken during a cluster operation.
\n "
},
- "ClusterOperationStepInfo" : {
- "type" : "structure",
- "members" : {
- "StepStatus" : {
- "shape" : "__string",
- "locationName" : "stepStatus",
- "documentation" : "\n The steps current status.
\n "
+ "ClusterOperationStepInfo": {
+ "type": "structure",
+ "members": {
+ "StepStatus": {
+ "shape": "__string",
+ "locationName": "stepStatus",
+ "documentation": "\n The steps current status.
\n "
}
},
- "documentation" : "\n State information about the operation step.
\n "
+ "documentation": "\n State information about the operation step.
\n "
},
"ClusterState": {
"type": "string",
@@ -2615,9 +2687,9 @@
]
},
"ProvisionedRequest": {
- "type" : "structure",
+ "type": "structure",
"documentation": "\n Provisioned cluster request.
\n ",
- "members" : {
+ "members": {
"BrokerNodeGroupInfo": {
"shape": "BrokerNodeGroupInfo",
"locationName": "brokerNodeGroupInfo",
@@ -2643,10 +2715,10 @@
"locationName": "enhancedMonitoring",
"documentation": "\n Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
\n "
},
- "OpenMonitoring" : {
- "shape" : "OpenMonitoringInfo",
- "locationName" : "openMonitoring",
- "documentation" : "\n The settings for open monitoring.
\n "
+ "OpenMonitoring": {
+ "shape": "OpenMonitoringInfo",
+ "locationName": "openMonitoring",
+ "documentation": "\n The settings for open monitoring.
\n "
},
"KafkaVersion": {
"shape": "__stringMin1Max128",
@@ -2663,10 +2735,10 @@
"locationName": "numberOfBrokerNodes",
"documentation": "\n The number of broker nodes in the cluster.
\n "
},
- "StorageMode" : {
- "shape" : "StorageMode",
- "locationName" : "storageMode",
- "documentation" : "\n This controls storage mode for supported storage tiers.
\n "
+ "StorageMode": {
+ "shape": "StorageMode",
+ "locationName": "storageMode",
+ "documentation": "\n This controls storage mode for supported storage tiers.
\n "
}
},
"required": [
@@ -2676,9 +2748,9 @@
]
},
"Provisioned": {
- "type" : "structure",
+ "type": "structure",
"documentation": "\n Provisioned cluster.
\n ",
- "members" : {
+ "members": {
"BrokerNodeGroupInfo": {
"shape": "BrokerNodeGroupInfo",
"locationName": "brokerNodeGroupInfo",
@@ -2704,10 +2776,10 @@
"locationName": "enhancedMonitoring",
"documentation": "\n Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
\n "
},
- "OpenMonitoring" : {
- "shape" : "OpenMonitoringInfo",
- "locationName" : "openMonitoring",
- "documentation" : "\n The settings for open monitoring.
\n "
+ "OpenMonitoring": {
+ "shape": "OpenMonitoringInfo",
+ "locationName": "openMonitoring",
+ "documentation": "\n The settings for open monitoring.
\n "
},
"LoggingInfo": {
"shape": "LoggingInfo",
@@ -2724,15 +2796,15 @@
"locationName": "zookeeperConnectString",
"documentation": "\n The connection string to use to connect to the Apache ZooKeeper cluster.
\n "
},
- "ZookeeperConnectStringTls" : {
- "shape" : "__string",
- "locationName" : "zookeeperConnectStringTls",
- "documentation" : "\n The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
\n "
+ "ZookeeperConnectStringTls": {
+ "shape": "__string",
+ "locationName": "zookeeperConnectStringTls",
+ "documentation": "\n The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
\n "
},
- "StorageMode" : {
- "shape" : "StorageMode",
- "locationName" : "storageMode",
- "documentation" : "\n This controls storage mode for supported storage tiers.
\n "
+ "StorageMode": {
+ "shape": "StorageMode",
+ "locationName": "storageMode",
+ "documentation": "\n This controls storage mode for supported storage tiers.
\n "
},
"CustomerActionStatus": {
"shape": "CustomerActionStatus",
@@ -2746,18 +2818,18 @@
]
},
"VpcConfig": {
- "type" : "structure",
+ "type": "structure",
"documentation": "\n The configuration of the Amazon VPCs for the cluster.
\n ",
"members": {
"SubnetIds": {
"shape": "__listOf__string",
"locationName": "subnetIds",
- "documentation" : "\n The IDs of the subnets associated with the cluster.
\n "
+ "documentation": "\n The IDs of the subnets associated with the cluster.
\n "
},
"SecurityGroupIds": {
"shape": "__listOf__string",
"locationName": "securityGroupIds",
- "documentation" : "\n The IDs of the security groups associated with the cluster.
\n "
+ "documentation": "\n The IDs of the security groups associated with the cluster.
\n "
}
},
"required": [
@@ -2765,9 +2837,9 @@
]
},
"ServerlessRequest": {
- "type" : "structure",
+ "type": "structure",
"documentation": "\n Serverless cluster request.
\n ",
- "members" : {
+ "members": {
"VpcConfigs": {
"shape": "__listOfVpcConfig",
"locationName": "vpcConfigs",
@@ -2784,9 +2856,9 @@
]
},
"Serverless": {
- "type" : "structure",
+ "type": "structure",
"documentation": "\n Serverless cluster.
\n ",
- "members" : {
+ "members": {
"VpcConfigs": {
"shape": "__listOfVpcConfig",
"locationName": "vpcConfigs",
@@ -2810,7 +2882,6 @@
"shape": "__string",
"locationName": "authentication",
"documentation": "\n Information about the auth scheme of Vpc Connection.
\n "
-
},
"CreationTime": {
"shape": "__timestampIso8601",
@@ -2831,7 +2902,6 @@
"shape": "__string",
"locationName": "owner",
"documentation": "\n The Owner of the Vpc Connection.
\n "
-
}
},
"required": [
@@ -2878,17 +2948,17 @@
"TargetClusterArn"
]
},
- "CompatibleKafkaVersion" : {
- "type" : "structure",
- "members" : {
- "SourceVersion" : {
- "shape" : "__string",
- "locationName" : "sourceVersion",
+ "CompatibleKafkaVersion": {
+ "type": "structure",
+ "members": {
+ "SourceVersion": {
+ "shape": "__string",
+ "locationName": "sourceVersion",
"documentation": "\n An Apache Kafka version.
\n "
},
- "TargetVersions" : {
- "shape" : "__listOf__string",
- "locationName" : "targetVersions",
+ "TargetVersions": {
+ "shape": "__listOf__string",
+ "locationName": "targetVersions",
"documentation": "\n A list of Apache Kafka versions.
\n "
}
},
@@ -3018,7 +3088,7 @@
"httpStatusCode": 409
}
},
- "ConnectivityInfo" : {
+ "ConnectivityInfo": {
"type": "structure",
"members": {
"PublicAccess": {
@@ -3048,18 +3118,20 @@
"documentation": "List of regular expression patterns indicating the consumer groups to copy.
"
},
"DetectAndCopyNewConsumerGroups": {
- "shape": "__boolean",
- "locationName": "detectAndCopyNewConsumerGroups",
- "documentation": "Enables synchronization of consumer groups to target cluster.
"
+ "shape": "__boolean",
+ "locationName": "detectAndCopyNewConsumerGroups",
+ "documentation": "Enables synchronization of consumer groups to target cluster.
"
},
"SynchroniseConsumerGroupOffsets": {
"shape": "__boolean",
"locationName": "synchroniseConsumerGroupOffsets",
"documentation": "Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.
"
- }
- },
- "documentation": "Details about consumer group replication.
",
- "required": ["ConsumerGroupsToReplicate"]
+ }
+ },
+ "documentation": "Details about consumer group replication.
",
+ "required": [
+ "ConsumerGroupsToReplicate"
+ ]
},
"ConsumerGroupReplicationUpdate": {
"type": "structure",
@@ -3086,7 +3158,12 @@
}
},
"documentation": "Details about consumer group replication.
",
- "required": ["ConsumerGroupsToReplicate", "ConsumerGroupsToExclude", "SynchroniseConsumerGroupOffsets", "DetectAndCopyNewConsumerGroups"]
+ "required": [
+ "ConsumerGroupsToReplicate",
+ "ConsumerGroupsToExclude",
+ "SynchroniseConsumerGroupOffsets",
+ "DetectAndCopyNewConsumerGroups"
+ ]
},
"CreateClusterV2Request": {
"type": "structure",
@@ -3149,10 +3226,10 @@
"locationName": "enhancedMonitoring",
"documentation": "\n Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
\n "
},
- "OpenMonitoring" : {
- "shape" : "OpenMonitoringInfo",
- "locationName" : "openMonitoring",
- "documentation" : "\n The settings for open monitoring.
\n "
+ "OpenMonitoring": {
+ "shape": "OpenMonitoringInfo",
+ "locationName": "openMonitoring",
+ "documentation": "\n The settings for open monitoring.
\n "
},
"KafkaVersion": {
"shape": "__stringMin1Max128",
@@ -3173,10 +3250,10 @@
"locationName": "tags",
"documentation": "\n Create tags when creating the cluster.
\n "
},
- "StorageMode" : {
- "shape" : "StorageMode",
- "locationName" : "storageMode",
- "documentation" : "\n This controls storage mode for supported storage tiers.
\n "
+ "StorageMode": {
+ "shape": "StorageMode",
+ "locationName": "storageMode",
+ "documentation": "\n This controls storage mode for supported storage tiers.
\n "
}
},
"required": [
@@ -3325,7 +3402,12 @@
}
},
"documentation": "Creates a replicator using the specified configuration.
",
- "required": ["ServiceExecutionRoleArn", "ReplicatorName", "ReplicationInfoList", "KafkaClusters"]
+ "required": [
+ "ServiceExecutionRoleArn",
+ "ReplicatorName",
+ "ReplicationInfoList",
+ "KafkaClusters"
+ ]
},
"CreateReplicatorResponse": {
"type": "structure",
@@ -3401,7 +3483,6 @@
"shape": "VpcConnectionState",
"locationName": "state",
"documentation": "\n The State of Vpc Connection.
\n "
-
},
"Authentication": {
"shape": "__string",
@@ -3435,139 +3516,139 @@
}
}
},
- "ClusterOperationV2" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "locationName" : "clusterArn",
- "documentation" : "\n ARN of the cluster.
"
- },
- "ClusterType" : {
- "shape" : "ClusterType",
- "locationName" : "clusterType",
- "documentation" : "\n Type of the backend cluster.
"
- },
- "StartTime" : {
- "shape" : "__timestampIso8601",
- "locationName" : "startTime",
- "documentation" : "\n The time at which operation was started.
"
- },
- "EndTime" : {
- "shape" : "__timestampIso8601",
- "locationName" : "endTime",
- "documentation" : "\n The time at which the operation finished.
"
- },
- "ErrorInfo" : {
- "shape" : "ErrorInfo",
- "locationName" : "errorInfo",
- "documentation" : "\n If cluster operation failed from an error, it describes the error.
"
- },
- "OperationArn" : {
- "shape" : "__string",
- "locationName" : "operationArn",
- "documentation" : "\n ARN of the cluster operation.
"
- },
- "OperationState" : {
- "shape" : "__string",
- "locationName" : "operationState",
- "documentation" : "\n State of the cluster operation.
"
- },
- "OperationType" : {
- "shape" : "__string",
- "locationName" : "operationType",
- "documentation" : "\n Type of the cluster operation.
"
- },
- "Provisioned" : {
- "shape" : "ClusterOperationV2Provisioned",
- "locationName" : "provisioned",
- "documentation" : "\n Properties of a provisioned cluster.
"
- },
- "Serverless" : {
- "shape" : "ClusterOperationV2Serverless",
- "locationName" : "serverless",
- "documentation" : "\n Properties of a serverless cluster.
"
- }
- },
- "documentation" : "\n Returns information about a cluster operation.
"
- },
- "ClusterOperationV2Provisioned" : {
- "type" : "structure",
- "members" : {
- "OperationSteps" : {
- "shape" : "__listOfClusterOperationStep",
- "locationName" : "operationSteps",
- "documentation" : "\n Steps completed during the operation.
"
- },
- "SourceClusterInfo" : {
- "shape" : "MutableClusterInfo",
- "locationName" : "sourceClusterInfo",
- "documentation" : "\n Information about cluster attributes before a cluster is updated.
"
- },
- "TargetClusterInfo" : {
- "shape" : "MutableClusterInfo",
- "locationName" : "targetClusterInfo",
- "documentation" : "\n Information about cluster attributes after a cluster is updated.
"
- },
- "VpcConnectionInfo" : {
- "shape" : "VpcConnectionInfo",
- "locationName" : "vpcConnectionInfo",
- "documentation" : "\n Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
"
- }
- },
- "documentation" : "\n Returns information about a provisioned cluster operation.
"
- },
- "ClusterOperationV2Serverless" : {
- "type" : "structure",
- "members" : {
- "VpcConnectionInfo" : {
- "shape" : "VpcConnectionInfoServerless",
- "locationName" : "vpcConnectionInfo",
- "documentation" : "\n Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
"
- }
- },
- "documentation" : "\n Returns information about a serverless cluster operation.
"
- },
- "ClusterOperationV2Summary" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "locationName" : "clusterArn",
- "documentation" : "\n ARN of the cluster.
"
- },
- "ClusterType" : {
- "shape" : "ClusterType",
- "locationName" : "clusterType",
- "documentation" : "\n Type of the backend cluster.
"
- },
- "StartTime" : {
- "shape" : "__timestampIso8601",
- "locationName" : "startTime",
- "documentation" : "\n The time at which operation was started.
"
- },
- "EndTime" : {
- "shape" : "__timestampIso8601",
- "locationName" : "endTime",
- "documentation" : "\n The time at which the operation finished.
"
- },
- "OperationArn" : {
- "shape" : "__string",
- "locationName" : "operationArn",
- "documentation" : "\n ARN of the cluster operation.
"
- },
- "OperationState" : {
- "shape" : "__string",
- "locationName" : "operationState",
- "documentation" : "\n State of the cluster operation.
"
- },
- "OperationType" : {
- "shape" : "__string",
- "locationName" : "operationType",
- "documentation" : "\n Type of the cluster operation.
"
- }
+ "ClusterOperationV2": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "locationName": "clusterArn",
+ "documentation": "\n ARN of the cluster.
"
+ },
+ "ClusterType": {
+ "shape": "ClusterType",
+ "locationName": "clusterType",
+ "documentation": "\n Type of the backend cluster.
"
+ },
+ "StartTime": {
+ "shape": "__timestampIso8601",
+ "locationName": "startTime",
+ "documentation": "\n The time at which operation was started.
"
+ },
+ "EndTime": {
+ "shape": "__timestampIso8601",
+ "locationName": "endTime",
+ "documentation": "\n The time at which the operation finished.
"
+ },
+ "ErrorInfo": {
+ "shape": "ErrorInfo",
+ "locationName": "errorInfo",
+ "documentation": "\n If cluster operation failed from an error, it describes the error.
"
+ },
+ "OperationArn": {
+ "shape": "__string",
+ "locationName": "operationArn",
+ "documentation": "\n ARN of the cluster operation.
"
+ },
+ "OperationState": {
+ "shape": "__string",
+ "locationName": "operationState",
+ "documentation": "\n State of the cluster operation.
"
+ },
+ "OperationType": {
+ "shape": "__string",
+ "locationName": "operationType",
+ "documentation": "\n Type of the cluster operation.
"
+ },
+ "Provisioned": {
+ "shape": "ClusterOperationV2Provisioned",
+ "locationName": "provisioned",
+ "documentation": "\n Properties of a provisioned cluster.
"
+ },
+ "Serverless": {
+ "shape": "ClusterOperationV2Serverless",
+ "locationName": "serverless",
+ "documentation": "\n Properties of a serverless cluster.
"
+ }
+ },
+ "documentation": "\n Returns information about a cluster operation.
"
+ },
+ "ClusterOperationV2Provisioned": {
+ "type": "structure",
+ "members": {
+ "OperationSteps": {
+ "shape": "__listOfClusterOperationStep",
+ "locationName": "operationSteps",
+ "documentation": "\n Steps completed during the operation.
"
+ },
+ "SourceClusterInfo": {
+ "shape": "MutableClusterInfo",
+ "locationName": "sourceClusterInfo",
+ "documentation": "\n Information about cluster attributes before a cluster is updated.
"
+ },
+ "TargetClusterInfo": {
+ "shape": "MutableClusterInfo",
+ "locationName": "targetClusterInfo",
+ "documentation": "\n Information about cluster attributes after a cluster is updated.
"
+ },
+ "VpcConnectionInfo": {
+ "shape": "VpcConnectionInfo",
+ "locationName": "vpcConnectionInfo",
+ "documentation": "\n Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
"
+ }
+ },
+ "documentation": "\n Returns information about a provisioned cluster operation.
"
+ },
+ "ClusterOperationV2Serverless": {
+ "type": "structure",
+ "members": {
+ "VpcConnectionInfo": {
+ "shape": "VpcConnectionInfoServerless",
+ "locationName": "vpcConnectionInfo",
+ "documentation": "\n Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
"
+ }
+ },
+ "documentation": "\n Returns information about a serverless cluster operation.
"
+ },
+ "ClusterOperationV2Summary": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "locationName": "clusterArn",
+ "documentation": "\n ARN of the cluster.
"
+ },
+ "ClusterType": {
+ "shape": "ClusterType",
+ "locationName": "clusterType",
+ "documentation": "\n Type of the backend cluster.
"
+ },
+ "StartTime": {
+ "shape": "__timestampIso8601",
+ "locationName": "startTime",
+ "documentation": "\n The time at which operation was started.
"
+ },
+ "EndTime": {
+ "shape": "__timestampIso8601",
+ "locationName": "endTime",
+ "documentation": "\n The time at which the operation finished.
"
+ },
+ "OperationArn": {
+ "shape": "__string",
+ "locationName": "operationArn",
+ "documentation": "\n ARN of the cluster operation.
"
+ },
+ "OperationState": {
+ "shape": "__string",
+ "locationName": "operationState",
+ "documentation": "\n State of the cluster operation.
"
+ },
+ "OperationType": {
+ "shape": "__string",
+ "locationName": "operationType",
+ "documentation": "\n Type of the cluster operation.
"
+ }
},
- "documentation" : "\n Returns information about a cluster operation.
"
+ "documentation": "\n Returns information about a cluster operation.
"
},
"ControllerNodeInfo": {
"type": "structure",
@@ -3583,7 +3664,11 @@
"CustomerActionStatus": {
"type": "string",
"documentation": "\n A type of an action required from the customer.
",
- "enum": [ "CRITICAL_ACTION_REQUIRED", "ACTION_RECOMMENDED", "NONE" ]
+ "enum": [
+ "CRITICAL_ACTION_REQUIRED",
+ "ACTION_RECOMMENDED",
+ "NONE"
+ ]
},
"DeleteClusterRequest": {
"type": "structure",
@@ -3684,7 +3769,9 @@
"documentation": "The Amazon Resource Name (ARN) of the replicator to be deleted.
"
}
},
- "required": ["ReplicatorArn"]
+ "required": [
+ "ReplicatorArn"
+ ]
},
"DeleteReplicatorResponse": {
"type": "structure",
@@ -3744,17 +3831,19 @@
"ClusterOperationArn"
]
},
- "DescribeClusterOperationV2Request" : {
- "type" : "structure",
- "members" : {
- "ClusterOperationArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterOperationArn",
- "documentation" : "ARN of the cluster operation to describe."
+ "DescribeClusterOperationV2Request": {
+ "type": "structure",
+ "members": {
+ "ClusterOperationArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterOperationArn",
+ "documentation": "ARN of the cluster operation to describe."
}
},
- "required" : [ "ClusterOperationArn" ]
+ "required": [
+ "ClusterOperationArn"
+ ]
},
"DescribeClusterOperationResponse": {
"type": "structure",
@@ -3766,13 +3855,13 @@
}
}
},
- "DescribeClusterOperationV2Response" : {
- "type" : "structure",
- "members" : {
- "ClusterOperationInfo" : {
- "shape" : "ClusterOperationV2",
- "locationName" : "clusterOperationInfo",
- "documentation" : "\n Cluster operation information
"
+ "DescribeClusterOperationV2Response": {
+ "type": "structure",
+ "members": {
+ "ClusterOperationInfo": {
+ "shape": "ClusterOperationV2",
+ "locationName": "clusterOperationInfo",
+ "documentation": "\n Cluster operation information
"
}
}
},
@@ -3953,7 +4042,9 @@
"documentation": "The Amazon Resource Name (ARN) of the replicator to be described.
"
}
},
- "required": ["ReplicatorArn"]
+ "required": [
+ "ReplicatorArn"
+ ]
},
"DescribeReplicatorResponse": {
"type": "structure",
@@ -4057,19 +4148,16 @@
"shape": "__listOf__string",
"locationName": "subnets",
"documentation": "\n The list of subnets for the VPC connection.
\n "
-
},
"SecurityGroups": {
"shape": "__listOf__string",
"locationName": "securityGroups",
"documentation": "\n The list of security groups for the VPC connection.
\n "
-
},
"CreationTime": {
"shape": "__timestampIso8601",
"locationName": "creationTime",
"documentation": "\n The creation time of the VPC connection.
\n "
-
},
"Tags": {
"shape": "__mapOf__string",
@@ -4078,46 +4166,49 @@
}
}
},
- "BatchDisassociateScramSecretRequest" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster to be updated.
\n "
- },
- "SecretArnList" : {
- "shape" : "__listOf__string",
- "locationName" : "secretArnList",
- "documentation" : "\n List of AWS Secrets Manager secret ARNs.
\n "
- }
- },
- "documentation" : "\n Disassociates sasl scram secrets to cluster.
\n ",
- "required" : [ "ClusterArn", "SecretArnList" ]
- },
- "BatchDisassociateScramSecretResponse" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster.
\n "
- },
- "UnprocessedScramSecrets" : {
- "shape" : "__listOfUnprocessedScramSecret",
- "locationName" : "unprocessedScramSecrets",
- "documentation" : "\n List of errors when disassociating secrets to cluster.
\n "
+ "BatchDisassociateScramSecretRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster to be updated.
\n "
+ },
+ "SecretArnList": {
+ "shape": "__listOf__string",
+ "locationName": "secretArnList",
+ "documentation": "\n List of AWS Secrets Manager secret ARNs.
\n "
+ }
+ },
+ "documentation": "\n Disassociates sasl scram secrets to cluster.
\n ",
+ "required": [
+ "ClusterArn",
+ "SecretArnList"
+ ]
+ },
+ "BatchDisassociateScramSecretResponse": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster.
\n "
+ },
+ "UnprocessedScramSecrets": {
+ "shape": "__listOfUnprocessedScramSecret",
+ "locationName": "unprocessedScramSecrets",
+ "documentation": "\n List of errors when disassociating secrets to cluster.
\n "
}
}
},
"EBSStorageInfo": {
"type": "structure",
"members": {
- "ProvisionedThroughput" : {
- "shape" : "ProvisionedThroughput",
- "locationName" : "provisionedThroughput",
- "documentation" : "\n EBS volume provisioned throughput information.
\n "
+ "ProvisionedThroughput": {
+ "shape": "ProvisionedThroughput",
+ "locationName": "provisionedThroughput",
+ "documentation": "\n EBS volume provisioned throughput information.
\n "
},
"VolumeSize": {
"shape": "__integerMin1Max16384",
@@ -4215,19 +4306,21 @@
},
"documentation": "\n Returns information about an error state of the cluster.
\n "
},
- "Firehose" : {
- "type" : "structure",
- "members" : {
- "DeliveryStream" : {
- "shape" : "__string",
- "locationName" : "deliveryStream"
+ "Firehose": {
+ "type": "structure",
+ "members": {
+ "DeliveryStream": {
+ "shape": "__string",
+ "locationName": "deliveryStream"
},
- "Enabled" : {
- "shape" : "__boolean",
- "locationName" : "enabled"
+ "Enabled": {
+ "shape": "__boolean",
+ "locationName": "enabled"
}
},
- "required" : [ "Enabled" ]
+ "required": [
+ "Enabled"
+ ]
},
"ForbiddenException": {
"type": "structure",
@@ -4318,23 +4411,23 @@
}
}
},
- "GetCompatibleKafkaVersionsRequest" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "querystring",
- "locationName" : "clusterArn",
+ "GetCompatibleKafkaVersionsRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "clusterArn",
"documentation": "\n The Amazon Resource Name (ARN) of the cluster check.
\n "
}
}
},
- "GetCompatibleKafkaVersionsResponse" : {
- "type" : "structure",
- "members" : {
- "CompatibleKafkaVersions" : {
- "shape" : "__listOfCompatibleKafkaVersion",
- "locationName" : "compatibleKafkaVersions",
+ "GetCompatibleKafkaVersionsResponse": {
+ "type": "structure",
+ "members": {
+ "CompatibleKafkaVersions": {
+ "shape": "__listOfCompatibleKafkaVersion",
+ "locationName": "compatibleKafkaVersions",
"documentation": "\n A list of CompatibleKafkaVersion objects.
\n "
}
}
@@ -4365,7 +4458,6 @@
"shape": "__string",
"locationName": "policy",
"documentation": "\n The cluster policy.
\n "
-
}
}
},
@@ -4404,24 +4496,29 @@
}
},
"documentation": "Information about Kafka Cluster to be used as source / target for replication.
",
- "required": ["VpcConfig", "AmazonMskCluster"]
+ "required": [
+ "VpcConfig",
+ "AmazonMskCluster"
+ ]
},
- "KafkaClusterClientVpcConfig" : {
- "type" : "structure",
- "members" : {
- "SecurityGroupIds" : {
- "shape" : "__listOf__string",
- "locationName" : "securityGroupIds",
- "documentation" : "The security groups to attach to the ENIs for the broker nodes.
"
+ "KafkaClusterClientVpcConfig": {
+ "type": "structure",
+ "members": {
+ "SecurityGroupIds": {
+ "shape": "__listOf__string",
+ "locationName": "securityGroupIds",
+ "documentation": "The security groups to attach to the ENIs for the broker nodes.
"
},
- "SubnetIds" : {
- "shape" : "__listOf__string",
- "locationName" : "subnetIds",
- "documentation" : "The list of subnets in the client VPC to connect to.
"
+ "SubnetIds": {
+ "shape": "__listOf__string",
+ "locationName": "subnetIds",
+ "documentation": "The list of subnets in the client VPC to connect to.
"
}
},
- "documentation" : "Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
",
- "required" : [ "SubnetIds" ]
+ "documentation": "Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
",
+ "required": [
+ "SubnetIds"
+ ]
},
"KafkaClusterDescription": {
"type": "structure",
@@ -4506,29 +4603,31 @@
"ClusterArn"
]
},
- "ListClusterOperationsV2Request" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterArn",
- "documentation" : "The arn of the cluster whose operations are being requested."
+ "ListClusterOperationsV2Request": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterArn",
+ "documentation": "The arn of the cluster whose operations are being requested."
},
- "MaxResults" : {
- "shape" : "MaxResults",
- "location" : "querystring",
- "locationName" : "maxResults",
- "documentation" : "The maxResults of the query."
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults",
+ "documentation": "The maxResults of the query."
},
- "NextToken" : {
- "shape" : "__string",
- "location" : "querystring",
- "locationName" : "nextToken",
- "documentation" : "The nextToken of the query."
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "The nextToken of the query."
}
},
- "required" : [ "ClusterArn" ]
+ "required": [
+ "ClusterArn"
+ ]
},
"ListClusterOperationsResponse": {
"type": "structure",
@@ -4545,18 +4644,18 @@
}
}
},
- "ListClusterOperationsV2Response" : {
- "type" : "structure",
- "members" : {
- "ClusterOperationInfoList" : {
- "shape" : "__listOfClusterOperationV2Summary",
- "locationName" : "clusterOperationInfoList",
- "documentation" : "\n An array of cluster operation information objects.
"
+ "ListClusterOperationsV2Response": {
+ "type": "structure",
+ "members": {
+ "ClusterOperationInfoList": {
+ "shape": "__listOfClusterOperationV2Summary",
+ "locationName": "clusterOperationInfoList",
+ "documentation": "\n An array of cluster operation information objects.
"
},
- "NextToken" : {
- "shape" : "__string",
- "locationName" : "nextToken",
- "documentation" : "\n If the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.
"
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "\n If the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.
"
}
}
},
@@ -4824,42 +4923,44 @@
}
}
},
- "ListScramSecretsRequest" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterArn",
- "documentation" : "\n The arn of the cluster.
\n "
- },
- "MaxResults" : {
- "shape" : "MaxResults",
- "location" : "querystring",
- "locationName" : "maxResults",
- "documentation" : "\n The maxResults of the query.
\n "
- },
- "NextToken" : {
- "shape" : "__string",
- "location" : "querystring",
- "locationName" : "nextToken",
- "documentation" : "\n The nextToken of the query.
\n "
- }
- },
- "required" : [ "ClusterArn" ]
- },
- "ListScramSecretsResponse" : {
- "type" : "structure",
- "members" : {
- "NextToken" : {
- "shape" : "__string",
- "locationName" : "nextToken",
- "documentation" : "\n Paginated results marker.
\n "
- },
- "SecretArnList" : {
- "shape" : "__listOf__string",
- "locationName" : "secretArnList",
- "documentation" : "\n The list of scram secrets associated with the cluster.
\n "
+ "ListScramSecretsRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterArn",
+ "documentation": "\n The arn of the cluster.
\n "
+ },
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults",
+ "documentation": "\n The maxResults of the query.
\n "
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "\n The nextToken of the query.
\n "
+ }
+ },
+ "required": [
+ "ClusterArn"
+ ]
+ },
+ "ListScramSecretsResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "\n Paginated results marker.
\n "
+ },
+ "SecretArnList": {
+ "shape": "__listOf__string",
+ "locationName": "secretArnList",
+ "documentation": "\n The list of scram secrets associated with the cluster.
\n "
}
}
},
@@ -4890,11 +4991,11 @@
"ListClientVpcConnectionsRequest": {
"type": "structure",
"members": {
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster.
\n "
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster.
\n "
},
"MaxResults": {
"shape": "MaxResults",
@@ -4909,14 +5010,16 @@
"documentation": "\n The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.
\n "
}
},
- "required": [ "ClusterArn" ]
+ "required": [
+ "ClusterArn"
+ ]
},
"ListClientVpcConnectionsResponse": {
"type": "structure",
"members": {
- "ClientVpcConnections" : {
- "shape" : "__listOfClientVpcConnection",
- "locationName" : "clientVpcConnections",
+ "ClientVpcConnections": {
+ "shape": "__listOfClientVpcConnection",
+ "locationName": "clientVpcConnections",
"documentation": "\n List of client VPC connections.
\n "
},
"NextToken": {
@@ -4946,9 +5049,9 @@
"ListVpcConnectionsResponse": {
"type": "structure",
"members": {
- "VpcConnections" : {
- "shape" : "__listOfVpcConnection",
- "locationName" : "vpcConnections",
+ "VpcConnections": {
+ "shape": "__listOfVpcConnection",
+ "locationName": "vpcConnections",
"documentation": "\n List of VPC connections.
\n "
},
"NextToken": {
@@ -4958,14 +5061,14 @@
}
}
},
- "RejectClientVpcConnectionRequest" : {
- "type" : "structure",
- "members" : {
+ "RejectClientVpcConnectionRequest": {
+ "type": "structure",
+ "members": {
"ClusterArn": {
"shape": "__string",
"location": "uri",
"locationName": "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster.
\n "
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster.
\n "
},
"VpcConnectionArn": {
"shape": "__string",
@@ -4973,9 +5076,12 @@
"documentation": "\n The VPC connection ARN.
\n "
}
},
- "required" : [ "VpcConnectionArn", "ClusterArn" ]
+ "required": [
+ "VpcConnectionArn",
+ "ClusterArn"
+ ]
},
- "RejectClientVpcConnectionResponse" : {
+ "RejectClientVpcConnectionResponse": {
"type": "structure",
"members": {
}
@@ -4993,7 +5099,9 @@
"locationName": "brokerLogs"
}
},
- "required": [ "BrokerLogs" ]
+ "required": [
+ "BrokerLogs"
+ ]
},
"MutableClusterInfo": {
"type": "structure",
@@ -5013,189 +5121,201 @@
"locationName": "numberOfBrokerNodes",
"documentation": "\n The number of broker nodes in the cluster.
\n "
},
- "EnhancedMonitoring" : {
- "shape" : "EnhancedMonitoring",
- "locationName" : "enhancedMonitoring",
- "documentation" : "\n Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
\n "
+ "EnhancedMonitoring": {
+ "shape": "EnhancedMonitoring",
+ "locationName": "enhancedMonitoring",
+ "documentation": "\n Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
\n "
},
- "OpenMonitoring" : {
- "shape" : "OpenMonitoring",
- "locationName" : "openMonitoring",
- "documentation" : "\n The settings for open monitoring.
\n "
+ "OpenMonitoring": {
+ "shape": "OpenMonitoring",
+ "locationName": "openMonitoring",
+ "documentation": "\n The settings for open monitoring.
\n "
},
- "KafkaVersion" : {
- "shape" : "__string",
- "locationName" : "kafkaVersion",
- "documentation" : "\n The Apache Kafka version.
\n "
+ "KafkaVersion": {
+ "shape": "__string",
+ "locationName": "kafkaVersion",
+ "documentation": "\n The Apache Kafka version.
\n "
},
"LoggingInfo": {
"shape": "LoggingInfo",
"locationName": "loggingInfo",
- "documentation" : "\n You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
\n "
+ "documentation": "\n You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
\n "
},
"InstanceType": {
- "shape" : "__stringMin5Max32",
- "locationName" : "instanceType",
- "documentation" : "\n Information about the Amazon MSK broker type.
\n "
+ "shape": "__stringMin5Max32",
+ "locationName": "instanceType",
+ "documentation": "\n Information about the Amazon MSK broker type.
\n "
},
- "ClientAuthentication" : {
- "shape" : "ClientAuthentication",
- "locationName" : "clientAuthentication",
+ "ClientAuthentication": {
+ "shape": "ClientAuthentication",
+ "locationName": "clientAuthentication",
"documentation": "\n Includes all client authentication information.
\n "
},
- "EncryptionInfo" : {
- "shape" : "EncryptionInfo",
- "locationName" : "encryptionInfo",
+ "EncryptionInfo": {
+ "shape": "EncryptionInfo",
+ "locationName": "encryptionInfo",
"documentation": "\n Includes all encryption-related information.
\n "
},
- "ConnectivityInfo" : {
- "shape" : "ConnectivityInfo",
- "locationName" : "connectivityInfo",
- "documentation" : "\n Information about the broker access configuration.
\n "
+ "ConnectivityInfo": {
+ "shape": "ConnectivityInfo",
+ "locationName": "connectivityInfo",
+ "documentation": "\n Information about the broker access configuration.
\n "
},
- "StorageMode" : {
- "shape" : "StorageMode",
- "locationName" : "storageMode",
- "documentation" : "\n This controls storage mode for supported storage tiers.
\n "
+ "StorageMode": {
+ "shape": "StorageMode",
+ "locationName": "storageMode",
+ "documentation": "\n This controls storage mode for supported storage tiers.
\n "
},
- "BrokerCountUpdateInfo" : {
+ "BrokerCountUpdateInfo": {
"shape": "BrokerCountUpdateInfo",
- "locationName" : "brokerCountUpdateInfo",
- "documentation" : "\n Describes brokers being changed during a broker count update.
\n "
+ "locationName": "brokerCountUpdateInfo",
+ "documentation": "\n Describes brokers being changed during a broker count update.
\n "
}
},
"documentation": "\n Information about cluster attributes that can be updated via update APIs.
\n "
},
- "NodeExporter" : {
- "type" : "structure",
- "members" : {
- "EnabledInBroker" : {
- "shape" : "__boolean",
- "locationName" : "enabledInBroker",
- "documentation" : "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n "
+ "NodeExporter": {
+ "type": "structure",
+ "members": {
+ "EnabledInBroker": {
+ "shape": "__boolean",
+ "locationName": "enabledInBroker",
+ "documentation": "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n "
}
},
- "documentation" : "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n ",
- "required" : [ "EnabledInBroker" ]
+ "documentation": "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n ",
+ "required": [
+ "EnabledInBroker"
+ ]
},
- "NodeExporterInfo" : {
- "type" : "structure",
- "members" : {
- "EnabledInBroker" : {
- "shape" : "__boolean",
- "locationName" : "enabledInBroker",
- "documentation" : "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n "
+ "NodeExporterInfo": {
+ "type": "structure",
+ "members": {
+ "EnabledInBroker": {
+ "shape": "__boolean",
+ "locationName": "enabledInBroker",
+ "documentation": "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n "
}
},
- "documentation" : "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n ",
- "required" : [ "EnabledInBroker" ]
+ "documentation": "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n ",
+ "required": [
+ "EnabledInBroker"
+ ]
},
- "JmxExporter" : {
- "type" : "structure",
- "members" : {
- "EnabledInBroker" : {
- "shape" : "__boolean",
- "locationName" : "enabledInBroker",
- "documentation" : "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n "
+ "JmxExporter": {
+ "type": "structure",
+ "members": {
+ "EnabledInBroker": {
+ "shape": "__boolean",
+ "locationName": "enabledInBroker",
+ "documentation": "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n "
}
},
- "documentation" : "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n ",
- "required" : [ "EnabledInBroker" ]
+ "documentation": "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n ",
+ "required": [
+ "EnabledInBroker"
+ ]
},
- "JmxExporterInfo" : {
- "type" : "structure",
- "members" : {
- "EnabledInBroker" : {
- "shape" : "__boolean",
- "locationName" : "enabledInBroker",
- "documentation" : "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n "
+ "JmxExporterInfo": {
+ "type": "structure",
+ "members": {
+ "EnabledInBroker": {
+ "shape": "__boolean",
+ "locationName": "enabledInBroker",
+ "documentation": "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n "
}
},
- "documentation" : "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n ",
- "required" : [ "EnabledInBroker" ]
+ "documentation": "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n ",
+ "required": [
+ "EnabledInBroker"
+ ]
},
- "OpenMonitoring" : {
- "type" : "structure",
- "members" : {
- "Prometheus" : {
- "shape" : "Prometheus",
- "locationName" : "prometheus",
- "documentation" : "\n Prometheus settings.
\n "
+ "OpenMonitoring": {
+ "type": "structure",
+ "members": {
+ "Prometheus": {
+ "shape": "Prometheus",
+ "locationName": "prometheus",
+ "documentation": "\n Prometheus settings.
\n "
}
},
- "documentation" : "\n JMX and Node monitoring for the MSK cluster.
\n ",
- "required" : [ "Prometheus" ]
+ "documentation": "\n JMX and Node monitoring for the MSK cluster.
\n ",
+ "required": [
+ "Prometheus"
+ ]
},
- "OpenMonitoringInfo" : {
- "type" : "structure",
- "members" : {
- "Prometheus" : {
- "shape" : "PrometheusInfo",
- "locationName" : "prometheus",
- "documentation" : "\n Prometheus settings.
\n "
+ "OpenMonitoringInfo": {
+ "type": "structure",
+ "members": {
+ "Prometheus": {
+ "shape": "PrometheusInfo",
+ "locationName": "prometheus",
+ "documentation": "\n Prometheus settings.
\n "
}
},
- "documentation" : "\n JMX and Node monitoring for the MSK cluster.
\n ",
- "required" : [ "Prometheus" ]
+ "documentation": "\n JMX and Node monitoring for the MSK cluster.
\n ",
+ "required": [
+ "Prometheus"
+ ]
},
- "Prometheus" : {
- "type" : "structure",
- "members" : {
- "JmxExporter" : {
- "shape" : "JmxExporter",
- "locationName" : "jmxExporter",
- "documentation" : "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n "
+ "Prometheus": {
+ "type": "structure",
+ "members": {
+ "JmxExporter": {
+ "shape": "JmxExporter",
+ "locationName": "jmxExporter",
+ "documentation": "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n "
},
- "NodeExporter" : {
- "shape" : "NodeExporter",
- "locationName" : "nodeExporter",
- "documentation" : "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n "
+ "NodeExporter": {
+ "shape": "NodeExporter",
+ "locationName": "nodeExporter",
+ "documentation": "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n "
}
},
- "documentation" : "\n Prometheus settings.
\n "
+ "documentation": "\n Prometheus settings.
\n "
},
- "PrometheusInfo" : {
- "type" : "structure",
- "members" : {
- "JmxExporter" : {
- "shape" : "JmxExporterInfo",
- "locationName" : "jmxExporter",
- "documentation" : "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n "
+ "PrometheusInfo": {
+ "type": "structure",
+ "members": {
+ "JmxExporter": {
+ "shape": "JmxExporterInfo",
+ "locationName": "jmxExporter",
+ "documentation": "\n Indicates whether you want to turn on or turn off the JMX Exporter.
\n "
},
- "NodeExporter" : {
- "shape" : "NodeExporterInfo",
- "locationName" : "nodeExporter",
- "documentation" : "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n "
+ "NodeExporter": {
+ "shape": "NodeExporterInfo",
+ "locationName": "nodeExporter",
+ "documentation": "\n Indicates whether you want to turn on or turn off the Node Exporter.
\n "
}
},
- "documentation" : "\n Prometheus settings.
\n "
+ "documentation": "\n Prometheus settings.
\n "
},
- "ProvisionedThroughput" : {
- "type" : "structure",
- "members" : {
- "Enabled" : {
- "shape" : "__boolean",
- "locationName" : "enabled",
- "documentation" : "\n Provisioned throughput is enabled or not.
\n "
+ "ProvisionedThroughput": {
+ "type": "structure",
+ "members": {
+ "Enabled": {
+ "shape": "__boolean",
+ "locationName": "enabled",
+ "documentation": "\n Provisioned throughput is enabled or not.
\n "
},
- "VolumeThroughput" : {
- "shape" : "__integer",
- "locationName" : "volumeThroughput",
- "documentation" : "\n Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
\n "
+ "VolumeThroughput": {
+ "shape": "__integer",
+ "locationName": "volumeThroughput",
+ "documentation": "\n Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
\n "
}
},
- "documentation" : "\n Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
\n "
+ "documentation": "\n Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
\n "
},
- "PublicAccess" : {
- "type" : "structure",
- "members" : {
- "Type" : {
- "shape" : "__string",
- "locationName" : "type",
- "documentation" : "\n The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
\n "
+ "PublicAccess": {
+ "type": "structure",
+ "members": {
+ "Type": {
+ "shape": "__string",
+ "locationName": "type",
+ "documentation": "\n The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
\n "
}
},
- "documentation" : "Public access control for brokers."
+ "documentation": "Public access control for brokers."
},
"PutClusterPolicyRequest": {
"type": "structure",
@@ -5204,18 +5324,17 @@
"shape": "__string",
"location": "uri",
"locationName": "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster.
\n "
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster.
\n "
},
"CurrentVersion": {
"shape": "__string",
"locationName": "currentVersion",
- "documentation" : "\n The policy version.
\n "
+ "documentation": "\n The policy version.
\n "
},
"Policy": {
"shape": "__string",
"locationName": "policy",
- "documentation" : "\n The policy.
\n "
-
+ "documentation": "\n The policy.
\n "
}
},
"required": [
@@ -5229,147 +5348,152 @@
"CurrentVersion": {
"shape": "__string",
"locationName": "currentVersion",
- "documentation" : "\n The policy version.
\n "
+ "documentation": "\n The policy version.
\n "
}
}
},
- "RebootBrokerRequest" : {
- "type" : "structure",
- "members" : {
- "BrokerIds" : {
- "shape" : "__listOf__string",
- "locationName" : "brokerIds",
- "documentation" : "\n The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.
\n "
- },
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster to be updated.
\n "
- }
- },
- "documentation" : "Reboots a node.",
- "required" : [ "ClusterArn", "BrokerIds" ]
- },
- "RebootBrokerResponse" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster.
\n "
- },
- "ClusterOperationArn" : {
- "shape" : "__string",
- "locationName" : "clusterOperationArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster operation.
\n "
+ "RebootBrokerRequest": {
+ "type": "structure",
+ "members": {
+ "BrokerIds": {
+ "shape": "__listOf__string",
+ "locationName": "brokerIds",
+ "documentation": "\n The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.
\n "
+ },
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster to be updated.
\n "
+ }
+ },
+ "documentation": "Reboots a node.",
+ "required": [
+ "ClusterArn",
+ "BrokerIds"
+ ]
+ },
+ "RebootBrokerResponse": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster.
\n "
+ },
+ "ClusterOperationArn": {
+ "shape": "__string",
+ "locationName": "clusterOperationArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster operation.
\n "
}
}
},
- "S3" : {
- "type" : "structure",
- "members" : {
- "Bucket" : {
- "shape" : "__string",
- "locationName" : "bucket"
+ "S3": {
+ "type": "structure",
+ "members": {
+ "Bucket": {
+ "shape": "__string",
+ "locationName": "bucket"
},
- "Enabled" : {
- "shape" : "__boolean",
- "locationName" : "enabled"
+ "Enabled": {
+ "shape": "__boolean",
+ "locationName": "enabled"
},
- "Prefix" : {
- "shape" : "__string",
- "locationName" : "prefix"
+ "Prefix": {
+ "shape": "__string",
+ "locationName": "prefix"
}
},
- "required" : [ "Enabled" ]
+ "required": [
+ "Enabled"
+ ]
},
- "ServerlessSasl" : {
- "type" : "structure",
- "members" : {
- "Iam" : {
- "shape" : "Iam",
- "locationName" : "iam",
- "documentation" : "\n Indicates whether IAM access control is enabled.
\n "
+ "ServerlessSasl": {
+ "type": "structure",
+ "members": {
+ "Iam": {
+ "shape": "Iam",
+ "locationName": "iam",
+ "documentation": "\n Indicates whether IAM access control is enabled.
\n "
}
},
- "documentation" : "\n Details for client authentication using SASL.
\n "
+ "documentation": "\n Details for client authentication using SASL.
\n "
},
- "Sasl" : {
- "type" : "structure",
- "members" : {
- "Scram" : {
- "shape" : "Scram",
- "locationName" : "scram",
- "documentation" : "\n Details for SASL/SCRAM client authentication.
\n "
+ "Sasl": {
+ "type": "structure",
+ "members": {
+ "Scram": {
+ "shape": "Scram",
+ "locationName": "scram",
+ "documentation": "\n Details for SASL/SCRAM client authentication.
\n "
},
- "Iam" : {
- "shape" : "Iam",
- "locationName" : "iam",
- "documentation" : "\n Indicates whether IAM access control is enabled.
\n "
+ "Iam": {
+ "shape": "Iam",
+ "locationName": "iam",
+ "documentation": "\n Indicates whether IAM access control is enabled.
\n "
}
},
- "documentation" : "\n Details for client authentication using SASL.
\n "
+ "documentation": "\n Details for client authentication using SASL.
\n "
},
- "VpcConnectivitySasl" : {
- "type" : "structure",
- "members" : {
- "Scram" : {
- "shape" : "VpcConnectivityScram",
- "locationName" : "scram",
- "documentation" : "\n Details for SASL/SCRAM client authentication for VPC connectivity.
\n "
+ "VpcConnectivitySasl": {
+ "type": "structure",
+ "members": {
+ "Scram": {
+ "shape": "VpcConnectivityScram",
+ "locationName": "scram",
+ "documentation": "\n Details for SASL/SCRAM client authentication for VPC connectivity.
\n "
},
- "Iam" : {
- "shape" : "VpcConnectivityIam",
- "locationName" : "iam",
- "documentation" : "\n Details for SASL/IAM client authentication for VPC connectivity.
\n "
+ "Iam": {
+ "shape": "VpcConnectivityIam",
+ "locationName": "iam",
+ "documentation": "\n Details for SASL/IAM client authentication for VPC connectivity.
\n "
}
},
- "documentation" : "\n Details for SASL client authentication for VPC connectivity.
\n "
+ "documentation": "\n Details for SASL client authentication for VPC connectivity.
\n "
},
- "Scram" : {
- "type" : "structure",
- "members" : {
- "Enabled" : {
- "shape" : "__boolean",
- "locationName" : "enabled",
- "documentation" : "\n SASL/SCRAM authentication is enabled or not.
\n "
+ "Scram": {
+ "type": "structure",
+ "members": {
+ "Enabled": {
+ "shape": "__boolean",
+ "locationName": "enabled",
+ "documentation": "\n SASL/SCRAM authentication is enabled or not.
\n "
}
},
- "documentation" : "\n Details for SASL/SCRAM client authentication.
\n "
+ "documentation": "\n Details for SASL/SCRAM client authentication.
\n "
},
- "VpcConnectivityScram" : {
- "type" : "structure",
- "members" : {
- "Enabled" : {
- "shape" : "__boolean",
- "locationName" : "enabled",
- "documentation" : "\n SASL/SCRAM authentication is on or off for VPC connectivity.
\n "
+ "VpcConnectivityScram": {
+ "type": "structure",
+ "members": {
+ "Enabled": {
+ "shape": "__boolean",
+ "locationName": "enabled",
+ "documentation": "\n SASL/SCRAM authentication is on or off for VPC connectivity.
\n "
}
},
- "documentation" : "\n Details for SASL/SCRAM client authentication for VPC connectivity.
\n "
+ "documentation": "\n Details for SASL/SCRAM client authentication for VPC connectivity.
\n "
},
- "Iam" : {
- "type" : "structure",
- "members" : {
- "Enabled" : {
- "shape" : "__boolean",
- "locationName" : "enabled",
- "documentation" : "\n Indicates whether IAM access control is enabled.
\n "
+ "Iam": {
+ "type": "structure",
+ "members": {
+ "Enabled": {
+ "shape": "__boolean",
+ "locationName": "enabled",
+ "documentation": "\n Indicates whether IAM access control is enabled.
\n "
}
},
- "documentation" : "\n Details for IAM access control.
\n "
+ "documentation": "\n Details for IAM access control.
\n "
},
- "VpcConnectivityIam" : {
- "type" : "structure",
- "members" : {
- "Enabled" : {
- "shape" : "__boolean",
- "locationName" : "enabled",
- "documentation" : "\n SASL/IAM authentication is on or off for VPC connectivity.
\n "
+ "VpcConnectivityIam": {
+ "type": "structure",
+ "members": {
+ "Enabled": {
+ "shape": "__boolean",
+ "locationName": "enabled",
+ "documentation": "\n SASL/IAM authentication is on or off for VPC connectivity.
\n "
}
},
- "documentation" : "\n Details for IAM access control for VPC connectivity.
\n "
+ "documentation": "\n Details for IAM access control for VPC connectivity.
\n "
},
"NodeInfo": {
"type": "structure",
@@ -5469,7 +5593,13 @@
}
},
"documentation": "Specifies configuration for replication between a source and target Kafka cluster.
",
- "required": ["TargetCompressionType", "TopicReplication", "ConsumerGroupReplication", "SourceKafkaClusterArn", "TargetKafkaClusterArn"]
+ "required": [
+ "TargetCompressionType",
+ "TopicReplication",
+ "ConsumerGroupReplication",
+ "SourceKafkaClusterArn",
+ "TargetKafkaClusterArn"
+ ]
},
"ReplicationInfoDescription": {
"type": "structure",
@@ -5518,42 +5648,70 @@
},
"documentation": "Summarized information of replication between clusters.
"
},
- "ReplicationStartingPosition" : {
- "type" : "structure",
- "members" : {
- "Type" : {
- "shape" : "ReplicationStartingPositionType",
- "locationName" : "type",
+ "ReplicationStartingPosition": {
+ "type": "structure",
+ "members": {
+ "Type": {
+ "shape": "ReplicationStartingPositionType",
+ "locationName": "type",
"documentation": "The type of replication starting position.
"
}
},
"documentation": "Configuration for specifying the position in the topics to start replicating from.
"
},
- "ReplicationStartingPositionType" : {
- "type" : "string",
- "enum" : [ "LATEST", "EARLIEST" ],
+ "ReplicationStartingPositionType": {
+ "type": "string",
+ "enum": [
+ "LATEST",
+ "EARLIEST"
+ ],
"documentation": "The type of replication starting position.
"
},
- "ReplicationStateInfo" : {
- "type" : "structure",
- "members" : {
- "Code" : {
- "shape" : "__string",
- "locationName" : "code",
- "documentation" : "Code that describes the current state of the replicator."
+ "ReplicationTopicNameConfiguration": {
+ "type": "structure",
+ "members": {
+ "Type": {
+ "shape": "ReplicationTopicNameConfigurationType",
+ "locationName": "type",
+ "documentation": "The type of replicated topic name.
"
+ }
+ },
+ "documentation": "Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
"
+ },
+ "ReplicationTopicNameConfigurationType": {
+ "type": "string",
+ "enum": [
+ "PREFIXED_WITH_SOURCE_CLUSTER_ALIAS",
+ "IDENTICAL"
+ ],
+ "documentation": "The type of replicated topic name.
"
+ },
+ "ReplicationStateInfo": {
+ "type": "structure",
+ "members": {
+ "Code": {
+ "shape": "__string",
+ "locationName": "code",
+ "documentation": "Code that describes the current state of the replicator."
},
- "Message" : {
- "shape" : "__string",
- "locationName" : "message",
- "documentation" : "Message that describes the state of the replicator."
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "Message that describes the state of the replicator."
}
},
- "documentation" : "Details about the state of a replicator"
+ "documentation": "Details about the state of a replicator"
},
"ReplicatorState": {
"type": "string",
"documentation": "The state of a replicator.
",
- "enum": ["RUNNING", "CREATING", "UPDATING", "DELETING", "FAILED"]
+ "enum": [
+ "RUNNING",
+ "CREATING",
+ "UPDATING",
+ "DELETING",
+ "FAILED"
+ ]
},
"ReplicatorSummary": {
"type": "structure",
@@ -5626,16 +5784,16 @@
"httpStatusCode": 503
}
},
- "StateInfo" : {
- "type" : "structure",
- "members" : {
- "Code" : {
- "shape" : "__string",
- "locationName" : "code"
+ "StateInfo": {
+ "type": "structure",
+ "members": {
+ "Code": {
+ "shape": "__string",
+ "locationName": "code"
},
- "Message" : {
- "shape" : "__string",
- "locationName" : "message"
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
}
}
},
@@ -5650,10 +5808,13 @@
},
"documentation": "\n Contains information about storage volumes attached to MSK broker nodes.
\n "
},
- "StorageMode" : {
- "type" : "string",
- "documentation" : "Controls storage mode for various supported storage tiers.",
- "enum" : [ "LOCAL", "TIERED" ]
+ "StorageMode": {
+ "type": "string",
+ "documentation": "Controls storage mode for various supported storage tiers.",
+ "enum": [
+ "LOCAL",
+ "TIERED"
+ ]
},
"TagResourceRequest": {
"type": "structure",
@@ -5678,7 +5839,13 @@
"TargetCompressionType": {
"type": "string",
"documentation": "The type of compression to use producing records to the target cluster.
",
- "enum": ["NONE", "GZIP", "SNAPPY", "LZ4", "ZSTD"]
+ "enum": [
+ "NONE",
+ "GZIP",
+ "SNAPPY",
+ "LZ4",
+ "ZSTD"
+ ]
},
"Tls": {
"type": "structure",
@@ -5688,10 +5855,10 @@
"locationName": "certificateAuthorityArnList",
"documentation": "\n List of ACM Certificate Authority ARNs.
\n "
},
- "Enabled" : {
- "shape" : "__boolean",
- "locationName" : "enabled",
- "documentation" : "\n Specifies whether you want to turn on or turn off TLS authentication.
\n "
+ "Enabled": {
+ "shape": "__boolean",
+ "locationName": "enabled",
+ "documentation": "\n Specifies whether you want to turn on or turn off TLS authentication.
\n "
}
},
"documentation": "\n Details for client authentication using TLS.
\n "
@@ -5699,10 +5866,10 @@
"VpcConnectivityTls": {
"type": "structure",
"members": {
- "Enabled" : {
- "shape" : "__boolean",
- "locationName" : "enabled",
- "documentation" : "\n TLS authentication is on or off for VPC connectivity.
\n "
+ "Enabled": {
+ "shape": "__boolean",
+ "locationName": "enabled",
+ "documentation": "\n TLS authentication is on or off for VPC connectivity.
\n "
}
},
"documentation": "\n Details for TLS client authentication for VPC connectivity.
\n "
@@ -5745,11 +5912,16 @@
"locationName": "detectAndCopyNewTopics",
"documentation": "Whether to periodically check for new topics and partitions.
"
},
- "StartingPosition" : {
- "shape" : "ReplicationStartingPosition",
- "locationName" : "startingPosition",
+ "StartingPosition": {
+ "shape": "ReplicationStartingPosition",
+ "locationName": "startingPosition",
"documentation": "Configuration for specifying the position in the topics to start replicating from.
"
},
+ "TopicNameConfiguration": {
+ "shape": "ReplicationTopicNameConfiguration",
+ "locationName": "topicNameConfiguration",
+ "documentation": "Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
"
+ },
"TopicsToExclude": {
"shape": "__listOf__stringMax249",
"locationName": "topicsToExclude",
@@ -5762,7 +5934,9 @@
}
},
"documentation": "Details about topic replication.
",
- "required": ["TopicsToReplicate"]
+ "required": [
+ "TopicsToReplicate"
+ ]
},
"TopicReplicationUpdate": {
"type": "structure",
@@ -5794,15 +5968,21 @@
}
},
"documentation": "Details for updating the topic replication of a replicator.
",
- "required": ["TopicsToReplicate", "TopicsToExclude", "CopyTopicConfigurations", "DetectAndCopyNewTopics", "CopyAccessControlListsForTopics"]
+ "required": [
+ "TopicsToReplicate",
+ "TopicsToExclude",
+ "CopyTopicConfigurations",
+ "DetectAndCopyNewTopics",
+ "CopyAccessControlListsForTopics"
+ ]
},
- "Unauthenticated" : {
- "type" : "structure",
- "members" : {
- "Enabled" : {
- "shape" : "__boolean",
- "locationName" : "enabled",
- "documentation" : "\n Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
\n "
+ "Unauthenticated": {
+ "type": "structure",
+ "members": {
+ "Enabled": {
+ "shape": "__boolean",
+ "locationName": "enabled",
+ "documentation": "\n Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
\n "
}
}
},
@@ -5826,26 +6006,26 @@
"httpStatusCode": 401
}
},
- "UnprocessedScramSecret" : {
- "type" : "structure",
- "members" : {
- "ErrorCode" : {
- "shape" : "__string",
- "locationName" : "errorCode",
- "documentation" : "\n Error code for associate/disassociate failure.
\n "
+ "UnprocessedScramSecret": {
+ "type": "structure",
+ "members": {
+ "ErrorCode": {
+ "shape": "__string",
+ "locationName": "errorCode",
+ "documentation": "\n Error code for associate/disassociate failure.
\n "
},
- "ErrorMessage" : {
- "shape" : "__string",
- "locationName" : "errorMessage",
- "documentation" : "\n Error message for associate/disassociate failure.
\n "
+ "ErrorMessage": {
+ "shape": "__string",
+ "locationName": "errorMessage",
+ "documentation": "\n Error message for associate/disassociate failure.
\n "
},
- "SecretArn" : {
- "shape" : "__string",
- "locationName" : "secretArn",
- "documentation" : "\n AWS Secrets Manager secret ARN.
\n "
+ "SecretArn": {
+ "shape": "__string",
+ "locationName": "secretArn",
+ "documentation": "\n AWS Secrets Manager secret ARN.
\n "
}
},
- "documentation" : "\n Error info for scram secret associate/disassociate failure.
\n "
+ "documentation": "\n Error info for scram secret associate/disassociate failure.
\n "
},
"UntagResourceRequest": {
"type": "structure",
@@ -6032,92 +6212,99 @@
}
}
},
- "UpdateClusterKafkaVersionRequest" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster to be updated.
\n "
- },
- "ConfigurationInfo" : {
- "shape" : "ConfigurationInfo",
- "locationName" : "configurationInfo",
+ "UpdateClusterKafkaVersionRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster to be updated.
\n "
+ },
+ "ConfigurationInfo": {
+ "shape": "ConfigurationInfo",
+ "locationName": "configurationInfo",
"documentation": "\n The custom configuration that should be applied on the new version of cluster.
\n "
},
- "CurrentVersion" : {
- "shape" : "__string",
- "locationName" : "currentVersion",
+ "CurrentVersion": {
+ "shape": "__string",
+ "locationName": "currentVersion",
"documentation": "\n Current cluster version.
\n "
},
- "TargetKafkaVersion" : {
- "shape" : "__string",
- "locationName" : "targetKafkaVersion"
- ,"documentation": "\n Target Kafka version.
\n "
+ "TargetKafkaVersion": {
+ "shape": "__string",
+ "locationName": "targetKafkaVersion",
+ "documentation": "\n Target Kafka version.
\n "
}
},
- "required" : [ "ClusterArn", "TargetKafkaVersion", "CurrentVersion" ]
+ "required": [
+ "ClusterArn",
+ "TargetKafkaVersion",
+ "CurrentVersion"
+ ]
},
- "UpdateClusterKafkaVersionResponse" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "locationName" : "clusterArn",
+ "UpdateClusterKafkaVersionResponse": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "locationName": "clusterArn",
"documentation": "\n The Amazon Resource Name (ARN) of the cluster.
\n "
},
- "ClusterOperationArn" : {
- "shape" : "__string",
- "locationName" : "clusterOperationArn",
+ "ClusterOperationArn": {
+ "shape": "__string",
+ "locationName": "clusterOperationArn",
"documentation": "\n The Amazon Resource Name (ARN) of the cluster operation.
\n "
}
}
},
- "UpdateMonitoringRequest" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n "
- },
- "CurrentVersion" : {
- "shape" : "__string",
- "locationName" : "currentVersion",
- "documentation" : "\n The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n "
- },
- "EnhancedMonitoring" : {
- "shape" : "EnhancedMonitoring",
- "locationName" : "enhancedMonitoring",
- "documentation" : "\n Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
\n "
- },
- "OpenMonitoring" : {
- "shape" : "OpenMonitoringInfo",
- "locationName" : "openMonitoring",
- "documentation" : "\n The settings for open monitoring.
\n "
+ "UpdateMonitoringRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n "
+ },
+ "CurrentVersion": {
+ "shape": "__string",
+ "locationName": "currentVersion",
+ "documentation": "\n The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n "
+ },
+ "EnhancedMonitoring": {
+ "shape": "EnhancedMonitoring",
+ "locationName": "enhancedMonitoring",
+ "documentation": "\n Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
\n "
+ },
+ "OpenMonitoring": {
+ "shape": "OpenMonitoringInfo",
+ "locationName": "openMonitoring",
+ "documentation": "\n The settings for open monitoring.
\n "
},
"LoggingInfo": {
"shape": "LoggingInfo",
"locationName": "loggingInfo"
}
},
- "documentation" : "Request body for UpdateMonitoring.",
- "required" : [ "ClusterArn", "CurrentVersion" ]
+ "documentation": "Request body for UpdateMonitoring.",
+ "required": [
+ "ClusterArn",
+ "CurrentVersion"
+ ]
},
- "UpdateMonitoringResponse" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster.
\n "
+ "UpdateMonitoringResponse": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster.
\n "
},
- "ClusterOperationArn" : {
- "shape" : "__string",
- "locationName" : "clusterOperationArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster operation.
\n "
+ "ClusterOperationArn": {
+ "shape": "__string",
+ "locationName": "clusterOperationArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster operation.
\n "
}
}
},
@@ -6157,7 +6344,12 @@
}
},
"documentation": "Update information relating to replication between a given source and target Kafka cluster.
",
- "required": ["ReplicatorArn", "SourceKafkaClusterArn", "CurrentVersion", "TargetKafkaClusterArn"]
+ "required": [
+ "ReplicatorArn",
+ "SourceKafkaClusterArn",
+ "CurrentVersion",
+ "TargetKafkaClusterArn"
+ ]
},
"UpdateReplicationInfoResponse": {
"type": "structure",
@@ -6174,93 +6366,99 @@
}
}
},
- "UpdateSecurityRequest" : {
- "type" : "structure",
- "members" : {
- "ClientAuthentication" : {
- "shape" : "ClientAuthentication",
- "locationName" : "clientAuthentication",
- "documentation" : "\n Includes all client authentication related information.
\n "
- },
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n "
- },
- "CurrentVersion" : {
- "shape" : "__string",
- "locationName" : "currentVersion",
- "documentation" : "\n The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n "
- },
- "EncryptionInfo" : {
- "shape" : "EncryptionInfo",
- "locationName" : "encryptionInfo",
- "documentation" : "\n Includes all encryption-related information.
\n "
- }
- },
- "required" : [ "ClusterArn", "CurrentVersion" ]
- },
- "UpdateSecurityResponse" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster.
\n "
- },
- "ClusterOperationArn" : {
- "shape" : "__string",
- "locationName" : "clusterOperationArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster operation.
\n "
+ "UpdateSecurityRequest": {
+ "type": "structure",
+ "members": {
+ "ClientAuthentication": {
+ "shape": "ClientAuthentication",
+ "locationName": "clientAuthentication",
+ "documentation": "\n Includes all client authentication related information.
\n "
+ },
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n "
+ },
+ "CurrentVersion": {
+ "shape": "__string",
+ "locationName": "currentVersion",
+ "documentation": "\n The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n "
+ },
+ "EncryptionInfo": {
+ "shape": "EncryptionInfo",
+ "locationName": "encryptionInfo",
+ "documentation": "\n Includes all encryption-related information.
\n "
+ }
+ },
+ "required": [
+ "ClusterArn",
+ "CurrentVersion"
+ ]
+ },
+ "UpdateSecurityResponse": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster.
\n "
+ },
+ "ClusterOperationArn": {
+ "shape": "__string",
+ "locationName": "clusterOperationArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster operation.
\n "
}
}
},
- "UpdateStorageRequest" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster to be updated.
\n "
- },
- "CurrentVersion" : {
- "shape" : "__string",
- "locationName" : "currentVersion",
- "documentation" : "\n The version of cluster to update from. A successful operation will then generate a new version.
\n "
- },
- "ProvisionedThroughput" : {
- "shape" : "ProvisionedThroughput",
- "locationName" : "provisionedThroughput",
- "documentation" : "\n EBS volume provisioned throughput information.
\n "
- },
- "StorageMode" : {
- "shape" : "StorageMode",
- "locationName" : "storageMode",
- "documentation" : "\n Controls storage mode for supported storage tiers.
\n "
- },
- "VolumeSizeGB" : {
- "shape" : "__integer",
- "locationName" : "volumeSizeGB",
- "documentation" : "\n size of the EBS volume to update.
\n "
- }
- },
- "documentation" : "\n Request object for UpdateStorage api. Its used to update the storage attributes for the cluster.
\n ",
- "required" : [ "ClusterArn", "CurrentVersion" ]
- },
- "UpdateStorageResponse" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster.
\n "
- },
- "ClusterOperationArn" : {
- "shape" : "__string",
- "locationName" : "clusterOperationArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster operation.
\n "
+ "UpdateStorageRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster to be updated.
\n "
+ },
+ "CurrentVersion": {
+ "shape": "__string",
+ "locationName": "currentVersion",
+ "documentation": "\n The version of cluster to update from. A successful operation will then generate a new version.
\n "
+ },
+ "ProvisionedThroughput": {
+ "shape": "ProvisionedThroughput",
+ "locationName": "provisionedThroughput",
+ "documentation": "\n EBS volume provisioned throughput information.
\n "
+ },
+ "StorageMode": {
+ "shape": "StorageMode",
+ "locationName": "storageMode",
+ "documentation": "\n Controls storage mode for supported storage tiers.
\n "
+ },
+ "VolumeSizeGB": {
+ "shape": "__integer",
+ "locationName": "volumeSizeGB",
+ "documentation": "\n size of the EBS volume to update.
\n "
+ }
+ },
+ "documentation": "\n Request object for UpdateStorage api. Its used to update the storage attributes for the cluster.
\n ",
+ "required": [
+ "ClusterArn",
+ "CurrentVersion"
+ ]
+ },
+ "UpdateStorageResponse": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster.
\n "
+ },
+ "ClusterOperationArn": {
+ "shape": "__string",
+ "locationName": "clusterOperationArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster operation.
\n "
}
}
},
@@ -6269,7 +6467,7 @@
"members": {
"Arn": {
"shape": "__string",
- "location" : "uri",
+ "location": "uri",
"locationName": "arn",
"documentation": "\n The Amazon Resource Name (ARN) of the configuration.
\n "
},
@@ -6304,41 +6502,45 @@
}
}
},
- "UpdateConnectivityRequest" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "location" : "uri",
- "locationName" : "clusterArn",
+ "UpdateConnectivityRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterArn",
"documentation": "\n The Amazon Resource Name (ARN) of the configuration.
\n "
},
- "ConnectivityInfo" : {
- "shape" : "ConnectivityInfo",
- "locationName" : "connectivityInfo",
- "documentation" : "\n Information about the broker access configuration.
\n "
+ "ConnectivityInfo": {
+ "shape": "ConnectivityInfo",
+ "locationName": "connectivityInfo",
+ "documentation": "\n Information about the broker access configuration.
\n "
},
- "CurrentVersion" : {
- "shape" : "__string",
- "locationName" : "currentVersion",
- "documentation" : "\n The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n "
+ "CurrentVersion": {
+ "shape": "__string",
+ "locationName": "currentVersion",
+ "documentation": "\n The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n "
}
},
- "documentation" : "Request body for UpdateConnectivity.",
- "required" : [ "ClusterArn", "ConnectivityInfo", "CurrentVersion" ]
+ "documentation": "Request body for UpdateConnectivity.",
+ "required": [
+ "ClusterArn",
+ "ConnectivityInfo",
+ "CurrentVersion"
+ ]
},
- "UpdateConnectivityResponse" : {
- "type" : "structure",
- "members" : {
- "ClusterArn" : {
- "shape" : "__string",
- "locationName" : "clusterArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster.
\n "
+ "UpdateConnectivityResponse": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "locationName": "clusterArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster.
\n "
},
- "ClusterOperationArn" : {
- "shape" : "__string",
- "locationName" : "clusterOperationArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the cluster operation.
\n "
+ "ClusterOperationArn": {
+ "shape": "__string",
+ "locationName": "clusterOperationArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the cluster operation.
\n "
}
}
},
@@ -6348,15 +6550,15 @@
"Type": {
"shape": "UserIdentityType",
"locationName": "type",
- "documentation" : "\n The identity type of the requester that calls the API operation.
\n "
+ "documentation": "\n The identity type of the requester that calls the API operation.
\n "
},
"PrincipalId": {
"shape": "__string",
"locationName": "principalId",
- "documentation" : "\n A unique identifier for the requester that calls the API operation.
\n "
+ "documentation": "\n A unique identifier for the requester that calls the API operation.
\n "
}
},
- "documentation" : "\n Description of the requester that calls the API operation.
\n "
+ "documentation": "\n Description of the requester that calls the API operation.
\n "
},
"UserIdentityType": {
"type": "string",
@@ -6372,51 +6574,51 @@
"VpcConnectionArn": {
"shape": "__string",
"locationName": "vpcConnectionArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the VPC connection.
\n "
+ "documentation": "\n The Amazon Resource Name (ARN) of the VPC connection.
\n "
},
"Owner": {
"shape": "__string",
"locationName": "owner",
- "documentation" : "\n The owner of the VPC Connection.
\n "
+ "documentation": "\n The owner of the VPC Connection.
\n "
},
"UserIdentity": {
"shape": "UserIdentity",
"locationName": "userIdentity",
- "documentation" : "\n Description of the requester that calls the API operation.
\n "
+ "documentation": "\n Description of the requester that calls the API operation.
\n "
},
"CreationTime": {
"shape": "__timestampIso8601",
"locationName": "creationTime",
- "documentation" : "\n The time when Amazon MSK creates the VPC Connnection.
\n "
+ "documentation": "\n The time when Amazon MSK creates the VPC Connnection.
\n "
}
},
"documentation": "\n Description of the VPC connection.
\n "
},
- "VpcConnectionInfoServerless" : {
- "type" : "structure",
- "members" : {
- "CreationTime" : {
- "shape" : "__timestampIso8601",
- "locationName" : "creationTime",
- "documentation" : "\n The time when Amazon MSK creates the VPC Connnection.
"
+ "VpcConnectionInfoServerless": {
+ "type": "structure",
+ "members": {
+ "CreationTime": {
+ "shape": "__timestampIso8601",
+ "locationName": "creationTime",
+ "documentation": "\n The time when Amazon MSK creates the VPC Connnection.
"
},
- "Owner" : {
- "shape" : "__string",
- "locationName" : "owner",
- "documentation" : "\n The owner of the VPC Connection.
"
+ "Owner": {
+ "shape": "__string",
+ "locationName": "owner",
+ "documentation": "\n The owner of the VPC Connection.
"
},
- "UserIdentity" : {
- "shape" : "UserIdentity",
- "locationName" : "userIdentity",
- "documentation" : "\n Description of the requester that calls the API operation.
"
+ "UserIdentity": {
+ "shape": "UserIdentity",
+ "locationName": "userIdentity",
+ "documentation": "\n Description of the requester that calls the API operation.
"
},
- "VpcConnectionArn" : {
- "shape" : "__string",
- "locationName" : "vpcConnectionArn",
- "documentation" : "\n The Amazon Resource Name (ARN) of the VPC connection.
"
+ "VpcConnectionArn": {
+ "shape": "__string",
+ "locationName": "vpcConnectionArn",
+ "documentation": "\n The Amazon Resource Name (ARN) of the VPC connection.
"
}
},
- "documentation" : "Description of the VPC connection."
+ "documentation": "Description of the VPC connection."
},
"VpcConnectionState": {
"type": "string",
@@ -6432,16 +6634,16 @@
"REJECTING"
]
},
- "VpcConnectivity" : {
- "type" : "structure",
- "members" : {
+ "VpcConnectivity": {
+ "type": "structure",
+ "members": {
"ClientAuthentication": {
"shape": "VpcConnectivityClientAuthentication",
"locationName": "clientAuthentication",
"documentation": "\n Includes all client authentication information for VPC connectivity.
\n "
}
},
- "documentation" : "VPC connectivity access control for brokers."
+ "documentation": "VPC connectivity access control for brokers."
},
"ZookeeperNodeInfo": {
"type": "structure",
@@ -6520,28 +6722,28 @@
"shape": "ClusterOperationInfo"
}
},
- "__listOfClusterOperationV2Summary" : {
- "type" : "list",
- "member" : {
- "shape" : "ClusterOperationV2Summary"
+ "__listOfClusterOperationV2Summary": {
+ "type": "list",
+ "member": {
+ "shape": "ClusterOperationV2Summary"
}
},
- "__listOfClusterOperationStep" : {
- "type" : "list",
- "member" : {
- "shape" : "ClusterOperationStep"
+ "__listOfClusterOperationStep": {
+ "type": "list",
+ "member": {
+ "shape": "ClusterOperationStep"
}
},
- "__listOfCompatibleKafkaVersion" : {
- "type" : "list",
- "member" : {
- "shape" : "CompatibleKafkaVersion"
+ "__listOfCompatibleKafkaVersion": {
+ "type": "list",
+ "member": {
+ "shape": "CompatibleKafkaVersion"
}
},
- "__listOfVpcConfig" : {
- "type" : "list",
- "member" : {
- "shape" : "VpcConfig"
+ "__listOfVpcConfig": {
+ "type": "list",
+ "member": {
+ "shape": "VpcConfig"
}
},
"__listOfConfiguration": {
@@ -6622,16 +6824,16 @@
"shape": "VpcConnection"
}
},
- "__listOfUnprocessedScramSecret" : {
- "type" : "list",
- "member" : {
- "shape" : "UnprocessedScramSecret"
+ "__listOfUnprocessedScramSecret": {
+ "type": "list",
+ "member": {
+ "shape": "UnprocessedScramSecret"
}
},
- "__listOf__double" : {
- "type" : "list",
- "member" : {
- "shape" : "__double"
+ "__listOf__double": {
+ "type": "list",
+ "member": {
+ "shape": "__double"
}
},
"__listOf__string": {
@@ -6710,4 +6912,4 @@
}
},
"documentation": "\n The operations for managing an Amazon MSK cluster.
\n "
-}
+}
\ No newline at end of file
diff --git a/services/kafkaconnect/pom.xml b/services/kafkaconnect/pom.xml
index 44620f5cfb22..89a0a9155c52 100644
--- a/services/kafkaconnect/pom.xml
+++ b/services/kafkaconnect/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kafkaconnect
AWS Java SDK :: Services :: Kafka Connect
diff --git a/services/kendra/pom.xml b/services/kendra/pom.xml
index 88aabdb4ea59..52d701cb86ab 100644
--- a/services/kendra/pom.xml
+++ b/services/kendra/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kendra
AWS Java SDK :: Services :: Kendra
diff --git a/services/kendraranking/pom.xml b/services/kendraranking/pom.xml
index 3662de1bce68..64a1c97de00f 100644
--- a/services/kendraranking/pom.xml
+++ b/services/kendraranking/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kendraranking
AWS Java SDK :: Services :: Kendra Ranking
diff --git a/services/keyspaces/pom.xml b/services/keyspaces/pom.xml
index e181eab5f931..a00c7ec04ab3 100644
--- a/services/keyspaces/pom.xml
+++ b/services/keyspaces/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
keyspaces
AWS Java SDK :: Services :: Keyspaces
diff --git a/services/kinesis/pom.xml b/services/kinesis/pom.xml
index 4216f233bf84..a3f89f990438 100644
--- a/services/kinesis/pom.xml
+++ b/services/kinesis/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kinesis
AWS Java SDK :: Services :: Amazon Kinesis
diff --git a/services/kinesisanalytics/pom.xml b/services/kinesisanalytics/pom.xml
index a4209f7b8df6..838c8e7f3ef8 100644
--- a/services/kinesisanalytics/pom.xml
+++ b/services/kinesisanalytics/pom.xml
@@ -22,7 +22,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kinesisanalytics
AWS Java SDK :: Services :: Amazon Kinesis Analytics
diff --git a/services/kinesisanalyticsv2/pom.xml b/services/kinesisanalyticsv2/pom.xml
index 399939a949e2..6da04dc3fd21 100644
--- a/services/kinesisanalyticsv2/pom.xml
+++ b/services/kinesisanalyticsv2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kinesisanalyticsv2
AWS Java SDK :: Services :: Kinesis Analytics V2
diff --git a/services/kinesisvideo/pom.xml b/services/kinesisvideo/pom.xml
index e591f1f35a72..31696d6e43e0 100644
--- a/services/kinesisvideo/pom.xml
+++ b/services/kinesisvideo/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
kinesisvideo
diff --git a/services/kinesisvideoarchivedmedia/pom.xml b/services/kinesisvideoarchivedmedia/pom.xml
index bbc6f4ba0e5c..072c66dcbe0d 100644
--- a/services/kinesisvideoarchivedmedia/pom.xml
+++ b/services/kinesisvideoarchivedmedia/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kinesisvideoarchivedmedia
AWS Java SDK :: Services :: Kinesis Video Archived Media
diff --git a/services/kinesisvideomedia/pom.xml b/services/kinesisvideomedia/pom.xml
index 7c966d0cf7fb..a26aff106d17 100644
--- a/services/kinesisvideomedia/pom.xml
+++ b/services/kinesisvideomedia/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kinesisvideomedia
AWS Java SDK :: Services :: Kinesis Video Media
diff --git a/services/kinesisvideosignaling/pom.xml b/services/kinesisvideosignaling/pom.xml
index e2eddcde88d8..41a1f08ed6b4 100644
--- a/services/kinesisvideosignaling/pom.xml
+++ b/services/kinesisvideosignaling/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kinesisvideosignaling
AWS Java SDK :: Services :: Kinesis Video Signaling
diff --git a/services/kinesisvideowebrtcstorage/pom.xml b/services/kinesisvideowebrtcstorage/pom.xml
index bf71cf7dc38a..61e06fb00c9a 100644
--- a/services/kinesisvideowebrtcstorage/pom.xml
+++ b/services/kinesisvideowebrtcstorage/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kinesisvideowebrtcstorage
AWS Java SDK :: Services :: Kinesis Video Web RTC Storage
diff --git a/services/kms/pom.xml b/services/kms/pom.xml
index 76398e43b2a4..75e29138f140 100644
--- a/services/kms/pom.xml
+++ b/services/kms/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
kms
AWS Java SDK :: Services :: AWS KMS
diff --git a/services/lakeformation/pom.xml b/services/lakeformation/pom.xml
index 244469af05ec..4dadfffb3887 100644
--- a/services/lakeformation/pom.xml
+++ b/services/lakeformation/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
lakeformation
AWS Java SDK :: Services :: LakeFormation
diff --git a/services/lambda/pom.xml b/services/lambda/pom.xml
index c8098a0f4523..52d17e94f091 100644
--- a/services/lambda/pom.xml
+++ b/services/lambda/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
lambda
AWS Java SDK :: Services :: AWS Lambda
diff --git a/services/launchwizard/pom.xml b/services/launchwizard/pom.xml
index 09ff06f015f8..aff4245acd86 100644
--- a/services/launchwizard/pom.xml
+++ b/services/launchwizard/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
launchwizard
AWS Java SDK :: Services :: Launch Wizard
diff --git a/services/lexmodelbuilding/pom.xml b/services/lexmodelbuilding/pom.xml
index df5fb8a5e8f0..b138fcad8d37 100644
--- a/services/lexmodelbuilding/pom.xml
+++ b/services/lexmodelbuilding/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
lexmodelbuilding
AWS Java SDK :: Services :: Amazon Lex Model Building
diff --git a/services/lexmodelsv2/pom.xml b/services/lexmodelsv2/pom.xml
index 312577f52c12..de57d647d4ee 100644
--- a/services/lexmodelsv2/pom.xml
+++ b/services/lexmodelsv2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
lexmodelsv2
AWS Java SDK :: Services :: Lex Models V2
diff --git a/services/lexmodelsv2/src/main/resources/codegen-resources/service-2.json b/services/lexmodelsv2/src/main/resources/codegen-resources/service-2.json
index 90e0a1c303b5..5dc84d5dabed 100644
--- a/services/lexmodelsv2/src/main/resources/codegen-resources/service-2.json
+++ b/services/lexmodelsv2/src/main/resources/codegen-resources/service-2.json
@@ -14916,7 +14916,9 @@
"type":"string",
"enum":[
"standard",
- "neural"
+ "neural",
+ "long-form",
+ "generative"
]
},
"VoiceId":{"type":"string"},
@@ -14933,7 +14935,7 @@
"documentation":"Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
"
}
},
- "documentation":"Defines settings for using an Amazon Polly voice to communicate with a user.
"
+ "documentation":"Defines settings for using an Amazon Polly voice to communicate with a user.
Valid values include:
-
standard
-
neural
-
long-form
-
generative
"
},
"WaitAndContinueSpecification":{
"type":"structure",
diff --git a/services/lexruntime/pom.xml b/services/lexruntime/pom.xml
index 2a91f39887f8..c92f5efda939 100644
--- a/services/lexruntime/pom.xml
+++ b/services/lexruntime/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
lexruntime
AWS Java SDK :: Services :: Amazon Lex Runtime
diff --git a/services/lexruntimev2/pom.xml b/services/lexruntimev2/pom.xml
index 88291c6304c7..424ebc1a3928 100644
--- a/services/lexruntimev2/pom.xml
+++ b/services/lexruntimev2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
lexruntimev2
AWS Java SDK :: Services :: Lex Runtime V2
diff --git a/services/licensemanager/pom.xml b/services/licensemanager/pom.xml
index f17fa4f8c277..b44e9f047fd7 100644
--- a/services/licensemanager/pom.xml
+++ b/services/licensemanager/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
licensemanager
AWS Java SDK :: Services :: License Manager
diff --git a/services/licensemanagerlinuxsubscriptions/pom.xml b/services/licensemanagerlinuxsubscriptions/pom.xml
index 28b684036be9..bfaa45d88174 100644
--- a/services/licensemanagerlinuxsubscriptions/pom.xml
+++ b/services/licensemanagerlinuxsubscriptions/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
licensemanagerlinuxsubscriptions
AWS Java SDK :: Services :: License Manager Linux Subscriptions
diff --git a/services/licensemanagerusersubscriptions/pom.xml b/services/licensemanagerusersubscriptions/pom.xml
index 23d194ad4454..52b191819d78 100644
--- a/services/licensemanagerusersubscriptions/pom.xml
+++ b/services/licensemanagerusersubscriptions/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
licensemanagerusersubscriptions
AWS Java SDK :: Services :: License Manager User Subscriptions
diff --git a/services/lightsail/pom.xml b/services/lightsail/pom.xml
index f0a942e5ece0..0eb9b561ec10 100644
--- a/services/lightsail/pom.xml
+++ b/services/lightsail/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
lightsail
AWS Java SDK :: Services :: Amazon Lightsail
diff --git a/services/location/pom.xml b/services/location/pom.xml
index 0391ee76b3e4..576d3782ae3b 100644
--- a/services/location/pom.xml
+++ b/services/location/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
location
AWS Java SDK :: Services :: Location
diff --git a/services/lookoutequipment/pom.xml b/services/lookoutequipment/pom.xml
index 4aca7aee5cac..a3d1e22bdf8d 100644
--- a/services/lookoutequipment/pom.xml
+++ b/services/lookoutequipment/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
lookoutequipment
AWS Java SDK :: Services :: Lookout Equipment
diff --git a/services/lookoutmetrics/pom.xml b/services/lookoutmetrics/pom.xml
index 12e8ff9f770e..cae618f21b5b 100644
--- a/services/lookoutmetrics/pom.xml
+++ b/services/lookoutmetrics/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
lookoutmetrics
AWS Java SDK :: Services :: Lookout Metrics
diff --git a/services/lookoutvision/pom.xml b/services/lookoutvision/pom.xml
index 8b7bc7499418..fe22a1eabeb3 100644
--- a/services/lookoutvision/pom.xml
+++ b/services/lookoutvision/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
lookoutvision
AWS Java SDK :: Services :: Lookout Vision
diff --git a/services/m2/pom.xml b/services/m2/pom.xml
index 26d524dd32c2..6892b72933a9 100644
--- a/services/m2/pom.xml
+++ b/services/m2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
m2
AWS Java SDK :: Services :: M2
diff --git a/services/machinelearning/pom.xml b/services/machinelearning/pom.xml
index ee3a88f89be0..c538c4901a1f 100644
--- a/services/machinelearning/pom.xml
+++ b/services/machinelearning/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
machinelearning
AWS Java SDK :: Services :: Amazon Machine Learning
diff --git a/services/macie2/pom.xml b/services/macie2/pom.xml
index a83c67a925a6..6d2113570851 100644
--- a/services/macie2/pom.xml
+++ b/services/macie2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
macie2
AWS Java SDK :: Services :: Macie2
diff --git a/services/mailmanager/pom.xml b/services/mailmanager/pom.xml
index c4ccf56be653..fcc76e09a9c3 100644
--- a/services/mailmanager/pom.xml
+++ b/services/mailmanager/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
mailmanager
AWS Java SDK :: Services :: Mail Manager
diff --git a/services/managedblockchain/pom.xml b/services/managedblockchain/pom.xml
index 9c36ebe9e5e2..8c26a9679a61 100644
--- a/services/managedblockchain/pom.xml
+++ b/services/managedblockchain/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
managedblockchain
AWS Java SDK :: Services :: ManagedBlockchain
diff --git a/services/managedblockchainquery/pom.xml b/services/managedblockchainquery/pom.xml
index 0ced0b8fee17..daad02615147 100644
--- a/services/managedblockchainquery/pom.xml
+++ b/services/managedblockchainquery/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
managedblockchainquery
AWS Java SDK :: Services :: Managed Blockchain Query
diff --git a/services/marketplaceagreement/pom.xml b/services/marketplaceagreement/pom.xml
index 3d3ff367746a..07e1a81fe1a2 100644
--- a/services/marketplaceagreement/pom.xml
+++ b/services/marketplaceagreement/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
marketplaceagreement
AWS Java SDK :: Services :: Marketplace Agreement
diff --git a/services/marketplacecatalog/pom.xml b/services/marketplacecatalog/pom.xml
index 0eaf5a3aa04b..b35d292e598f 100644
--- a/services/marketplacecatalog/pom.xml
+++ b/services/marketplacecatalog/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
marketplacecatalog
AWS Java SDK :: Services :: Marketplace Catalog
diff --git a/services/marketplacecommerceanalytics/pom.xml b/services/marketplacecommerceanalytics/pom.xml
index 62d27cdf1374..de77c0be963f 100644
--- a/services/marketplacecommerceanalytics/pom.xml
+++ b/services/marketplacecommerceanalytics/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
marketplacecommerceanalytics
AWS Java SDK :: Services :: AWS Marketplace Commerce Analytics
diff --git a/services/marketplacedeployment/pom.xml b/services/marketplacedeployment/pom.xml
index 2156efe68979..e559924e98c5 100644
--- a/services/marketplacedeployment/pom.xml
+++ b/services/marketplacedeployment/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
marketplacedeployment
AWS Java SDK :: Services :: Marketplace Deployment
diff --git a/services/marketplaceentitlement/pom.xml b/services/marketplaceentitlement/pom.xml
index 537e96f22f38..34177d7bd962 100644
--- a/services/marketplaceentitlement/pom.xml
+++ b/services/marketplaceentitlement/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
marketplaceentitlement
AWS Java SDK :: Services :: AWS Marketplace Entitlement
diff --git a/services/marketplacemetering/pom.xml b/services/marketplacemetering/pom.xml
index 18a4405180c7..cc3b513d0569 100644
--- a/services/marketplacemetering/pom.xml
+++ b/services/marketplacemetering/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
marketplacemetering
AWS Java SDK :: Services :: AWS Marketplace Metering Service
diff --git a/services/mediaconnect/pom.xml b/services/mediaconnect/pom.xml
index 8dbbe1787081..2e237f4377e9 100644
--- a/services/mediaconnect/pom.xml
+++ b/services/mediaconnect/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
mediaconnect
AWS Java SDK :: Services :: MediaConnect
diff --git a/services/mediaconvert/pom.xml b/services/mediaconvert/pom.xml
index 2494be34c398..4105d46f5d58 100644
--- a/services/mediaconvert/pom.xml
+++ b/services/mediaconvert/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
mediaconvert
diff --git a/services/medialive/pom.xml b/services/medialive/pom.xml
index 40c956e4b38d..3c55627106f8 100644
--- a/services/medialive/pom.xml
+++ b/services/medialive/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
medialive
diff --git a/services/medialive/src/main/resources/codegen-resources/paginators-1.json b/services/medialive/src/main/resources/codegen-resources/paginators-1.json
index 2047b6faf6ee..ff4d731face4 100644
--- a/services/medialive/src/main/resources/codegen-resources/paginators-1.json
+++ b/services/medialive/src/main/resources/codegen-resources/paginators-1.json
@@ -89,6 +89,30 @@
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "EventBridgeRuleTemplateGroups"
+ },
+ "ListNodes": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "Nodes"
+ },
+ "ListClusters": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "Clusters"
+ },
+ "ListChannelPlacementGroups": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "ChannelPlacementGroups"
+ },
+ "ListNetworks": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "Networks"
}
}
}
diff --git a/services/medialive/src/main/resources/codegen-resources/service-2.json b/services/medialive/src/main/resources/codegen-resources/service-2.json
index acf600775b56..34f865e256ef 100644
--- a/services/medialive/src/main/resources/codegen-resources/service-2.json
+++ b/services/medialive/src/main/resources/codegen-resources/service-2.json
@@ -2810,7 +2810,7 @@
},
{
"shape": "NotFoundException",
- "documentation": "The input device you're requesting to does not exist. Check the ID."
+ "documentation": "The input device you're requesting to does not exist. Check the ID."
},
{
"shape": "GatewayTimeoutException",
@@ -4142,3181 +4142,2790 @@
}
],
"documentation": "Updates the specified eventbridge rule template group."
- }
- },
- "shapes": {
- "AacCodingMode": {
- "type": "string",
- "documentation": "Aac Coding Mode",
- "enum": [
- "AD_RECEIVER_MIX",
- "CODING_MODE_1_0",
- "CODING_MODE_1_1",
- "CODING_MODE_2_0",
- "CODING_MODE_5_1"
- ]
- },
- "AacInputType": {
- "type": "string",
- "documentation": "Aac Input Type",
- "enum": [
- "BROADCASTER_MIXED_AD",
- "NORMAL"
- ]
- },
- "AacProfile": {
- "type": "string",
- "documentation": "Aac Profile",
- "enum": [
- "HEV1",
- "HEV2",
- "LC"
- ]
- },
- "AacRateControlMode": {
- "type": "string",
- "documentation": "Aac Rate Control Mode",
- "enum": [
- "CBR",
- "VBR"
- ]
- },
- "AacRawFormat": {
- "type": "string",
- "documentation": "Aac Raw Format",
- "enum": [
- "LATM_LOAS",
- "NONE"
- ]
},
- "AacSettings": {
- "type": "structure",
- "members": {
- "Bitrate": {
- "shape": "__double",
- "locationName": "bitrate",
- "documentation": "Average bitrate in bits/second. Valid values depend on rate control mode and profile."
- },
- "CodingMode": {
- "shape": "AacCodingMode",
- "locationName": "codingMode",
- "documentation": "Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E."
- },
- "InputType": {
- "shape": "AacInputType",
- "locationName": "inputType",
- "documentation": "Set to \"broadcasterMixedAd\" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains \"broadcaster mixed AD\". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd.\n\nLeave set to \"normal\" when input does not contain pre-mixed audio + AD."
+ "CreateChannelPlacementGroup": {
+ "name": "CreateChannelPlacementGroup",
+ "http": {
+ "method": "POST",
+ "requestUri": "/prod/clusters/{clusterId}/channelplacementgroups",
+ "responseCode": 201
+ },
+ "input": {
+ "shape": "CreateChannelPlacementGroupRequest"
+ },
+ "output": {
+ "shape": "CreateChannelPlacementGroupResponse",
+ "documentation": "Successfully created the channel placement group."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "This request was invalid."
},
- "Profile": {
- "shape": "AacProfile",
- "locationName": "profile",
- "documentation": "AAC Profile."
+ {
+ "shape": "UnprocessableEntityException",
+ "documentation": "The channel placement group failed validation and could not be created."
},
- "RateControlMode": {
- "shape": "AacRateControlMode",
- "locationName": "rateControlMode",
- "documentation": "Rate Control Mode."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "RawFormat": {
- "shape": "AacRawFormat",
- "locationName": "rawFormat",
- "documentation": "Sets LATM / LOAS AAC output for raw containers."
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to create a channel placement group in this cluster."
},
- "SampleRate": {
- "shape": "__double",
- "locationName": "sampleRate",
- "documentation": "Sample rate in Hz. Valid values depend on rate control mode and profile."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "Spec": {
- "shape": "AacSpec",
- "locationName": "spec",
- "documentation": "Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers."
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
},
- "VbrQuality": {
- "shape": "AacVbrQuality",
- "locationName": "vbrQuality",
- "documentation": "VBR Quality Level - Only used if rateControlMode is VBR."
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded in createNode calls to the cluster service."
}
- },
- "documentation": "Aac Settings"
- },
- "AacSpec": {
- "type": "string",
- "documentation": "Aac Spec",
- "enum": [
- "MPEG2",
- "MPEG4"
- ]
- },
- "AacVbrQuality": {
- "type": "string",
- "documentation": "Aac Vbr Quality",
- "enum": [
- "HIGH",
- "LOW",
- "MEDIUM_HIGH",
- "MEDIUM_LOW"
- ]
- },
- "Ac3AttenuationControl": {
- "type": "string",
- "documentation": "Ac3 Attenuation Control",
- "enum": [
- "ATTENUATE_3_DB",
- "NONE"
- ]
- },
- "Ac3BitstreamMode": {
- "type": "string",
- "documentation": "Ac3 Bitstream Mode",
- "enum": [
- "COMMENTARY",
- "COMPLETE_MAIN",
- "DIALOGUE",
- "EMERGENCY",
- "HEARING_IMPAIRED",
- "MUSIC_AND_EFFECTS",
- "VISUALLY_IMPAIRED",
- "VOICE_OVER"
- ]
- },
- "Ac3CodingMode": {
- "type": "string",
- "documentation": "Ac3 Coding Mode",
- "enum": [
- "CODING_MODE_1_0",
- "CODING_MODE_1_1",
- "CODING_MODE_2_0",
- "CODING_MODE_3_2_LFE"
- ]
- },
- "Ac3DrcProfile": {
- "type": "string",
- "documentation": "Ac3 Drc Profile",
- "enum": [
- "FILM_STANDARD",
- "NONE"
- ]
- },
- "Ac3LfeFilter": {
- "type": "string",
- "documentation": "Ac3 Lfe Filter",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "Ac3MetadataControl": {
- "type": "string",
- "documentation": "Ac3 Metadata Control",
- "enum": [
- "FOLLOW_INPUT",
- "USE_CONFIGURED"
- ]
+ ],
+ "documentation": "Create a ChannelPlacementGroup in the specified Cluster. As part of the create operation, you specify the Nodes to attach the group to.After you create a ChannelPlacementGroup, you add Channels to the group (you do this by modifying the Channels to add them to a specific group). You now have an association of Channels to ChannelPlacementGroup, and ChannelPlacementGroup to Nodes. This association means that all the Channels in the group are able to run on any of the Nodes associated with the group."
},
- "Ac3Settings": {
- "type": "structure",
- "members": {
- "Bitrate": {
- "shape": "__double",
- "locationName": "bitrate",
- "documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode."
- },
- "BitstreamMode": {
- "shape": "Ac3BitstreamMode",
- "locationName": "bitstreamMode",
- "documentation": "Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values."
+ "CreateCluster": {
+ "name": "CreateCluster",
+ "http": {
+ "method": "POST",
+ "requestUri": "/prod/clusters",
+ "responseCode": 201
+ },
+ "input": {
+ "shape": "CreateClusterRequest"
+ },
+ "output": {
+ "shape": "CreateClusterResponse",
+ "documentation": "Creation of the Cluster is in progress."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "MediaLive can't process your request because of a problem in the request. Please check your request form and syntax."
},
- "CodingMode": {
- "shape": "Ac3CodingMode",
- "locationName": "codingMode",
- "documentation": "Dolby Digital coding mode. Determines number of channels."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "Dialnorm": {
- "shape": "__integerMin1Max31",
- "locationName": "dialnorm",
- "documentation": "Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through."
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to create the Cluster."
},
- "DrcProfile": {
- "shape": "Ac3DrcProfile",
- "locationName": "drcProfile",
- "documentation": "If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "LfeFilter": {
- "shape": "Ac3LfeFilter",
- "locationName": "lfeFilter",
- "documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode."
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
},
- "MetadataControl": {
- "shape": "Ac3MetadataControl",
- "locationName": "metadataControl",
- "documentation": "When set to \"followInput\", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used."
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on create Cluster calls to service."
},
- "AttenuationControl": {
- "shape": "Ac3AttenuationControl",
- "locationName": "attenuationControl",
- "documentation": "Applies a 3 dB attenuation to the surround channels. Applies only when the coding mode parameter is CODING_MODE_3_2_LFE."
+ {
+ "shape": "ConflictException",
+ "documentation": "The Cluster is unable to create due to an issue with cluster resources."
}
- },
- "documentation": "Ac3 Settings"
+ ],
+ "documentation": "Create a new Cluster."
},
- "AcceptInputDeviceTransferRequest": {
- "type": "structure",
- "members": {
- "InputDeviceId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputDeviceId",
- "documentation": "The unique ID of the input device to accept. For example, hd-123456789abcdef."
- }
+ "CreateNetwork": {
+ "name": "CreateNetwork",
+ "http": {
+ "method": "POST",
+ "requestUri": "/prod/networks",
+ "responseCode": 201
},
- "required": [
- "InputDeviceId"
- ],
- "documentation": "Placeholder documentation for AcceptInputDeviceTransferRequest"
- },
- "AcceptInputDeviceTransferResponse": {
- "type": "structure",
- "members": {
+ "input": {
+ "shape": "CreateNetworkRequest"
},
- "documentation": "Placeholder documentation for AcceptInputDeviceTransferResponse"
- },
- "AccessDenied": {
- "type": "structure",
- "members": {
- "Message": {
- "shape": "__string",
- "locationName": "message"
- }
+ "output": {
+ "shape": "CreateNetworkResponse",
+ "documentation": "Creation of the Network is in progress."
},
- "documentation": "Placeholder documentation for AccessDenied"
- },
- "AccessibilityType": {
- "type": "string",
- "documentation": "Accessibility Type",
- "enum": [
- "DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES",
- "IMPLEMENTS_ACCESSIBILITY_FEATURES"
- ]
- },
- "AccountConfiguration": {
- "type": "structure",
- "members": {
- "KmsKeyId": {
- "shape": "__string",
- "locationName": "kmsKeyId",
- "documentation": "Specifies the KMS key to use for all features that use key encryption. Specify the ARN of a KMS key that you have created. Or leave blank to use the key that MediaLive creates and manages for you."
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "MediaLive can't process your request because of a problem in the request. Please check your request form and syntax."
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to create the Network."
+ },
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
+ },
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on create Network calls to service."
+ },
+ {
+ "shape": "ConflictException",
+ "documentation": "The Network is unable to create due to an issue with network resources."
}
- },
- "documentation": "Placeholder documentation for AccountConfiguration"
- },
- "AfdSignaling": {
- "type": "string",
- "documentation": "Afd Signaling",
- "enum": [
- "AUTO",
- "FIXED",
- "NONE"
- ]
+ ],
+ "documentation": "Create as many Networks as you need. You will associate one or more Clusters with each Network.Each Network provides MediaLive Anywhere with required information about the network in your organization that you are using for video encoding using MediaLive."
},
- "AncillarySourceSettings": {
- "type": "structure",
- "members": {
- "SourceAncillaryChannelNumber": {
- "shape": "__integerMin1Max4",
- "locationName": "sourceAncillaryChannelNumber",
- "documentation": "Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field."
- }
+ "CreateNode": {
+ "name": "CreateNode",
+ "http": {
+ "method": "POST",
+ "requestUri": "/prod/clusters/{clusterId}/nodes",
+ "responseCode": 201
},
- "documentation": "Ancillary Source Settings"
- },
- "ArchiveCdnSettings": {
- "type": "structure",
- "members": {
- "ArchiveS3Settings": {
- "shape": "ArchiveS3Settings",
- "locationName": "archiveS3Settings"
- }
+ "input": {
+ "shape": "CreateNodeRequest"
},
- "documentation": "Archive Cdn Settings"
- },
- "ArchiveContainerSettings": {
- "type": "structure",
- "members": {
- "M2tsSettings": {
- "shape": "M2tsSettings",
- "locationName": "m2tsSettings"
- },
- "RawSettings": {
- "shape": "RawSettings",
- "locationName": "rawSettings"
- }
+ "output": {
+ "shape": "CreateNodeResponse",
+ "documentation": "A node create is in progress."
},
- "documentation": "Archive Container Settings"
- },
- "ArchiveGroupSettings": {
- "type": "structure",
- "members": {
- "ArchiveCdnSettings": {
- "shape": "ArchiveCdnSettings",
- "locationName": "archiveCdnSettings",
- "documentation": "Parameters that control interactions with the CDN."
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "This request was invalid."
},
- "Destination": {
- "shape": "OutputLocationRef",
- "locationName": "destination",
- "documentation": "A directory and base filename where archive files should be written."
+ {
+ "shape": "UnprocessableEntityException",
+ "documentation": "The node failed validation and could not be created."
},
- "RolloverInterval": {
- "shape": "__integerMin1",
- "locationName": "rolloverInterval",
- "documentation": "Number of seconds to write to archive file before closing and starting a new one."
- }
- },
- "documentation": "Archive Group Settings",
- "required": [
- "Destination"
- ]
- },
- "ArchiveOutputSettings": {
- "type": "structure",
- "members": {
- "ContainerSettings": {
- "shape": "ArchiveContainerSettings",
- "locationName": "containerSettings",
- "documentation": "Settings specific to the container type of the file."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "Extension": {
- "shape": "__string",
- "locationName": "extension",
- "documentation": "Output file extension. If excluded, this will be auto-selected from the container type."
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to create a node in this cluster."
},
- "NameModifier": {
- "shape": "__string",
- "locationName": "nameModifier",
- "documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
+ },
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded in createNode calls to the cluster service."
}
- },
- "documentation": "Archive Output Settings",
- "required": [
- "ContainerSettings"
- ]
- },
- "ArchiveS3LogUploads": {
- "type": "string",
- "documentation": "Archive S3 Log Uploads",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
+ ],
+ "documentation": "Create a Node in the specified Cluster. You can also create Nodes using the CreateNodeRegistrationScript. Note that you can't move a Node to another Cluster."
},
- "ArchiveS3Settings": {
- "type": "structure",
- "members": {
- "CannedAcl": {
- "shape": "S3CannedAcl",
- "locationName": "cannedAcl",
- "documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none."
- }
+ "CreateNodeRegistrationScript": {
+ "name": "CreateNodeRegistrationScript",
+ "http": {
+ "method": "POST",
+ "requestUri": "/prod/clusters/{clusterId}/nodeRegistrationScript",
+ "responseCode": 200
},
- "documentation": "Archive S3 Settings"
- },
- "AribDestinationSettings": {
- "type": "structure",
- "members": {
+ "input": {
+ "shape": "CreateNodeRegistrationScriptRequest"
},
- "documentation": "Arib Destination Settings"
- },
- "AribSourceSettings": {
- "type": "structure",
- "members": {
+ "output": {
+ "shape": "CreateNodeRegistrationScriptResponse",
+ "documentation": "A new node registration script has been completed."
},
- "documentation": "Arib Source Settings"
- },
- "AudioChannelMapping": {
- "type": "structure",
- "members": {
- "InputChannelLevels": {
- "shape": "__listOfInputChannelLevel",
- "locationName": "inputChannelLevels",
- "documentation": "Indices and gain values for each input channel that should be remixed into this output channel."
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "MediaLive can't process your request because of a problem in the request. Please check your request form and syntax."
},
- "OutputChannel": {
- "shape": "__integerMin0Max7",
- "locationName": "outputChannel",
- "documentation": "The index of the output channel being produced."
- }
- },
- "documentation": "Audio Channel Mapping",
- "required": [
- "OutputChannel",
- "InputChannelLevels"
- ]
- },
- "AudioCodecSettings": {
- "type": "structure",
- "members": {
- "AacSettings": {
- "shape": "AacSettings",
- "locationName": "aacSettings"
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "Ac3Settings": {
- "shape": "Ac3Settings",
- "locationName": "ac3Settings"
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to create a node registration script for this cluster."
},
- "Eac3AtmosSettings": {
- "shape": "Eac3AtmosSettings",
- "locationName": "eac3AtmosSettings"
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "Eac3Settings": {
- "shape": "Eac3Settings",
- "locationName": "eac3Settings"
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
},
- "Mp2Settings": {
- "shape": "Mp2Settings",
- "locationName": "mp2Settings"
- },
- "PassThroughSettings": {
- "shape": "PassThroughSettings",
- "locationName": "passThroughSettings"
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on create node registration script calls to service."
},
- "WavSettings": {
- "shape": "WavSettings",
- "locationName": "wavSettings"
+ {
+ "shape": "ConflictException",
+ "documentation": "The node registration script is unable to be created due to an issue with cluster resources."
}
- },
- "documentation": "Audio Codec Settings"
+ ],
+ "documentation": "Create the Register Node script for all the nodes intended for a specific Cluster. You will then run the script on each hardware unit that is intended for that Cluster. The script creates a Node in the specified Cluster. It then binds the Node to this hardware unit, and activates the node hardware for use with MediaLive Anywhere."
},
- "AudioDescription": {
- "type": "structure",
- "members": {
- "AudioNormalizationSettings": {
- "shape": "AudioNormalizationSettings",
- "locationName": "audioNormalizationSettings",
- "documentation": "Advanced audio normalization settings."
+ "DeleteChannelPlacementGroup": {
+ "name": "DeleteChannelPlacementGroup",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/prod/clusters/{clusterId}/channelplacementgroups/{channelPlacementGroupId}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DeleteChannelPlacementGroupRequest"
+ },
+ "output": {
+ "shape": "DeleteChannelPlacementGroupResponse",
+ "documentation": "Deletion of the channel placement group is successful."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "This request was invalid."
},
- "AudioSelectorName": {
- "shape": "__string",
- "locationName": "audioSelectorName",
- "documentation": "The name of the AudioSelector used as the source for this AudioDescription."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "AudioType": {
- "shape": "AudioType",
- "locationName": "audioType",
- "documentation": "Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1."
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to delete the channel placement group."
},
- "AudioTypeControl": {
- "shape": "AudioDescriptionAudioTypeControl",
- "locationName": "audioTypeControl",
- "documentation": "Determines how audio type is determined.\n followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output.\n useConfigured: The value in Audio Type is included in the output.\nNote that this field and audioType are both ignored if inputType is broadcasterMixedAd."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "AudioWatermarkingSettings": {
- "shape": "AudioWatermarkSettings",
- "locationName": "audioWatermarkingSettings",
- "documentation": "Settings to configure one or more solutions that insert audio watermarks in the audio encode"
+ {
+ "shape": "NotFoundException",
+ "documentation": "The channel placement group that you are trying to delete does not exist. Check the ID and try again."
},
- "CodecSettings": {
- "shape": "AudioCodecSettings",
- "locationName": "codecSettings",
- "documentation": "Audio codec settings."
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
},
- "LanguageCode": {
- "shape": "__stringMin1Max35",
- "locationName": "languageCode",
- "documentation": "RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input."
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on delete channel placement group calls to the cluster service."
},
- "LanguageCodeControl": {
- "shape": "AudioDescriptionLanguageCodeControl",
- "locationName": "languageCodeControl",
- "documentation": "Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input."
+ {
+ "shape": "ConflictException",
+ "documentation": "The channel placement group is unable to delete due to an issue with channel placement group resources."
+ }
+ ],
+ "documentation": "Delete the specified ChannelPlacementGroup that exists in the specified Cluster."
+ },
+ "DeleteCluster": {
+ "name": "DeleteCluster",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/prod/clusters/{clusterId}",
+ "responseCode": 202
+ },
+ "input": {
+ "shape": "DeleteClusterRequest"
+ },
+ "output": {
+ "shape": "DeleteClusterResponse",
+ "documentation": "Deletion of the cluster is in progress."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "This request was invalid."
},
- "Name": {
- "shape": "__stringMax255",
- "locationName": "name",
- "documentation": "The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "RemixSettings": {
- "shape": "RemixSettings",
- "locationName": "remixSettings",
- "documentation": "Settings that control how input audio channels are remixed into the output audio channels."
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to delete the cluster."
},
- "StreamName": {
- "shape": "__string",
- "locationName": "streamName",
- "documentation": "Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary)."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "AudioDashRoles": {
- "shape": "__listOfDashRoleAudio",
- "locationName": "audioDashRoles",
- "documentation": "Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling."
+ {
+ "shape": "NotFoundException",
+ "documentation": "The cluster that you are trying to delete doesn't exist. Check the ID and try again."
},
- "DvbDashAccessibility": {
- "shape": "DvbDashAccessibility",
- "locationName": "dvbDashAccessibility",
- "documentation": "Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers."
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on delete cluster calls to cluster service."
+ },
+ {
+ "shape": "ConflictException",
+ "documentation": "The cluster is unable to delete due to an issue with cluster resources."
}
- },
- "documentation": "Audio Description",
- "required": [
- "AudioSelectorName",
- "Name"
- ]
- },
- "AudioDescriptionAudioTypeControl": {
- "type": "string",
- "documentation": "Audio Description Audio Type Control",
- "enum": [
- "FOLLOW_INPUT",
- "USE_CONFIGURED"
- ]
- },
- "AudioDescriptionLanguageCodeControl": {
- "type": "string",
- "documentation": "Audio Description Language Code Control",
- "enum": [
- "FOLLOW_INPUT",
- "USE_CONFIGURED"
- ]
+ ],
+ "documentation": "Delete a Cluster. The Cluster must be idle."
},
- "AudioDolbyEDecode": {
- "type": "structure",
- "members": {
- "ProgramSelection": {
- "shape": "DolbyEProgramSelection",
- "locationName": "programSelection",
- "documentation": "Applies only to Dolby E. Enter the program ID (according to the metadata in the audio) of the Dolby E program to extract from the specified track. One program extracted per audio selector. To select multiple programs, create multiple selectors with the same Track and different Program numbers. “All channels” means to ignore the program IDs and include all the channels in this selector; useful if metadata is known to be incorrect."
- }
+ "DeleteNetwork": {
+ "name": "DeleteNetwork",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/prod/networks/{networkId}",
+ "responseCode": 202
},
- "documentation": "Audio Dolby EDecode",
- "required": [
- "ProgramSelection"
- ]
- },
- "AudioHlsRenditionSelection": {
- "type": "structure",
- "members": {
- "GroupId": {
- "shape": "__stringMin1",
- "locationName": "groupId",
- "documentation": "Specifies the GROUP-ID in the #EXT-X-MEDIA tag of the target HLS audio rendition."
+ "input": {
+ "shape": "DeleteNetworkRequest"
+ },
+ "output": {
+ "shape": "DeleteNetworkResponse",
+ "documentation": "Deletion of the network is in progress."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "This request was invalid."
},
- "Name": {
- "shape": "__stringMin1",
- "locationName": "name",
- "documentation": "Specifies the NAME in the #EXT-X-MEDIA tag of the target HLS audio rendition."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to delete the network."
+ },
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
+ },
+ {
+ "shape": "NotFoundException",
+ "documentation": "The network that you are trying to delete doesn’t exist. Check the ID and try again."
+ },
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on delete network calls to network service."
+ },
+ {
+ "shape": "ConflictException",
+ "documentation": "The network is unable to delete due to an issue with network resources."
}
- },
- "documentation": "Audio Hls Rendition Selection",
- "required": [
- "Name",
- "GroupId"
- ]
+ ],
+ "documentation": "Delete a Network. The Network must have no resources associated with it."
},
- "AudioLanguageSelection": {
- "type": "structure",
- "members": {
- "LanguageCode": {
- "shape": "__string",
- "locationName": "languageCode",
- "documentation": "Selects a specific three-letter language code from within an audio source."
+ "DeleteNode": {
+ "name": "DeleteNode",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/prod/clusters/{clusterId}/nodes/{nodeId}",
+ "responseCode": 202
+ },
+ "input": {
+ "shape": "DeleteNodeRequest"
+ },
+ "output": {
+ "shape": "DeleteNodeResponse",
+ "documentation": "Deletion of the node is in progress."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "This request was invalid."
},
- "LanguageSelectionPolicy": {
- "shape": "AudioLanguageSelectionPolicy",
- "locationName": "languageSelectionPolicy",
- "documentation": "When set to \"strict\", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If \"loose\", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to delete the node."
+ },
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
+ },
+ {
+ "shape": "NotFoundException",
+ "documentation": "The node that you are trying to delete doesn’t exist. Check the ID and try again."
+ },
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on delete node calls to the cluster service."
+ },
+ {
+ "shape": "ConflictException",
+ "documentation": "The node is unable to delete due to an issue with node resources."
}
- },
- "documentation": "Audio Language Selection",
- "required": [
- "LanguageCode"
- ]
- },
- "AudioLanguageSelectionPolicy": {
- "type": "string",
- "documentation": "Audio Language Selection Policy",
- "enum": [
- "LOOSE",
- "STRICT"
- ]
- },
- "AudioNormalizationAlgorithm": {
- "type": "string",
- "documentation": "Audio Normalization Algorithm",
- "enum": [
- "ITU_1770_1",
- "ITU_1770_2"
- ]
- },
- "AudioNormalizationAlgorithmControl": {
- "type": "string",
- "documentation": "Audio Normalization Algorithm Control",
- "enum": [
- "CORRECT_AUDIO"
- ]
+ ],
+ "documentation": "Delete a Node. The Node must be IDLE."
},
- "AudioNormalizationSettings": {
- "type": "structure",
- "members": {
- "Algorithm": {
- "shape": "AudioNormalizationAlgorithm",
- "locationName": "algorithm",
- "documentation": "Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification."
+ "DescribeChannelPlacementGroup": {
+ "name": "DescribeChannelPlacementGroup",
+ "http": {
+ "method": "GET",
+ "requestUri": "/prod/clusters/{clusterId}/channelplacementgroups/{channelPlacementGroupId}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DescribeChannelPlacementGroupRequest"
+ },
+ "output": {
+ "shape": "DescribeChannelPlacementGroupResponse",
+ "documentation": "Details for one channel placement group."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "This request was invalid."
},
- "AlgorithmControl": {
- "shape": "AudioNormalizationAlgorithmControl",
- "locationName": "algorithmControl",
- "documentation": "When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "TargetLkfs": {
- "shape": "__doubleMinNegative59Max0",
- "locationName": "targetLkfs",
- "documentation": "Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS."
- }
- },
- "documentation": "Audio Normalization Settings"
- },
- "AudioOnlyHlsSegmentType": {
- "type": "string",
- "documentation": "Audio Only Hls Segment Type",
- "enum": [
- "AAC",
- "FMP4"
- ]
- },
- "AudioOnlyHlsSettings": {
- "type": "structure",
- "members": {
- "AudioGroupId": {
- "shape": "__string",
- "locationName": "audioGroupId",
- "documentation": "Specifies the group to which the audio Rendition belongs."
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You do not have permission to describe the channel placement group."
},
- "AudioOnlyImage": {
- "shape": "InputLocation",
- "locationName": "audioOnlyImage",
- "documentation": "Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth.\n\nThe image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the \"ID3 tag version 2.4.0 - Native Frames\" standard."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "AudioTrackType": {
- "shape": "AudioOnlyHlsTrackType",
- "locationName": "audioTrackType",
- "documentation": "Four types of audio-only tracks are supported:\n\nAudio-Only Variant Stream\nThe client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest.\n\nAlternate Audio, Auto Select, Default\nAlternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES\n\nAlternate Audio, Auto Select, Not Default\nAlternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES\n\nAlternate Audio, not Auto Select\nAlternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO"
+ {
+ "shape": "NotFoundException",
+ "documentation": "The channel placement group that you are trying to describe does not exist. Check the ID and try again."
},
- "SegmentType": {
- "shape": "AudioOnlyHlsSegmentType",
- "locationName": "segmentType",
- "documentation": "Specifies the segment type."
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on describe channel placement group calls to the cluster service."
}
- },
- "documentation": "Audio Only Hls Settings"
- },
- "AudioOnlyHlsTrackType": {
- "type": "string",
- "documentation": "Audio Only Hls Track Type",
- "enum": [
- "ALTERNATE_AUDIO_AUTO_SELECT",
- "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT",
- "ALTERNATE_AUDIO_NOT_AUTO_SELECT",
- "AUDIO_ONLY_VARIANT_STREAM"
- ]
+ ],
+ "documentation": "Get details about a ChannelPlacementGroup."
},
- "AudioPidSelection": {
- "type": "structure",
- "members": {
- "Pid": {
- "shape": "__integerMin0Max8191",
- "locationName": "pid",
- "documentation": "Selects a specific PID from within a source."
- }
+ "DescribeCluster": {
+ "name": "DescribeCluster",
+ "http": {
+ "method": "GET",
+ "requestUri": "/prod/clusters/{clusterId}",
+ "responseCode": 200
},
- "documentation": "Audio Pid Selection",
- "required": [
- "Pid"
- ]
- },
- "AudioSelector": {
- "type": "structure",
- "members": {
- "Name": {
- "shape": "__stringMin1",
- "locationName": "name",
- "documentation": "The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input."
- },
- "SelectorSettings": {
- "shape": "AudioSelectorSettings",
- "locationName": "selectorSettings",
- "documentation": "The audio selector settings."
- }
+ "input": {
+ "shape": "DescribeClusterRequest"
},
- "documentation": "Audio Selector",
- "required": [
- "Name"
- ]
- },
- "AudioSelectorSettings": {
- "type": "structure",
- "members": {
- "AudioHlsRenditionSelection": {
- "shape": "AudioHlsRenditionSelection",
- "locationName": "audioHlsRenditionSelection"
+ "output": {
+ "shape": "DescribeClusterResponse",
+ "documentation": "Details for one cluster."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "This request was invalid."
},
- "AudioLanguageSelection": {
- "shape": "AudioLanguageSelection",
- "locationName": "audioLanguageSelection"
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "AudioPidSelection": {
- "shape": "AudioPidSelection",
- "locationName": "audioPidSelection"
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to describe the cluster."
},
- "AudioTrackSelection": {
- "shape": "AudioTrackSelection",
- "locationName": "audioTrackSelection"
- }
- },
- "documentation": "Audio Selector Settings"
- },
- "AudioSilenceFailoverSettings": {
- "type": "structure",
- "members": {
- "AudioSelectorName": {
- "shape": "__string",
- "locationName": "audioSelectorName",
- "documentation": "The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "AudioSilenceThresholdMsec": {
- "shape": "__integerMin1000",
- "locationName": "audioSilenceThresholdMsec",
- "documentation": "The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS."
+ {
+ "shape": "NotFoundException",
+ "documentation": "The cluster that you are trying to describe does not exist. Check the ID and try again."
+ },
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on describe cluster calls to cluster service."
}
- },
- "required": [
- "AudioSelectorName"
],
- "documentation": "Placeholder documentation for AudioSilenceFailoverSettings"
+ "documentation": "Get details about a Cluster."
},
- "AudioTrack": {
- "type": "structure",
- "members": {
- "Track": {
- "shape": "__integerMin1",
- "locationName": "track",
- "documentation": "1-based integer value that maps to a specific audio track"
- }
+ "DescribeNetwork": {
+ "name": "DescribeNetwork",
+ "http": {
+ "method": "GET",
+ "requestUri": "/prod/networks/{networkId}",
+ "responseCode": 200
},
- "documentation": "Audio Track",
- "required": [
- "Track"
- ]
- },
- "AudioTrackSelection": {
- "type": "structure",
- "members": {
- "Tracks": {
- "shape": "__listOfAudioTrack",
- "locationName": "tracks",
- "documentation": "Selects one or more unique audio tracks from within a source."
- },
- "DolbyEDecode": {
- "shape": "AudioDolbyEDecode",
- "locationName": "dolbyEDecode",
- "documentation": "Configure decoding options for Dolby E streams - these should be Dolby E frames carried in PCM streams tagged with SMPTE-337"
- }
+ "input": {
+ "shape": "DescribeNetworkRequest"
},
- "documentation": "Audio Track Selection",
- "required": [
- "Tracks"
- ]
- },
- "AudioType": {
- "type": "string",
- "documentation": "Audio Type",
- "enum": [
- "CLEAN_EFFECTS",
- "HEARING_IMPAIRED",
- "UNDEFINED",
- "VISUAL_IMPAIRED_COMMENTARY"
- ]
- },
- "AudioWatermarkSettings": {
- "type": "structure",
- "members": {
- "NielsenWatermarksSettings": {
- "shape": "NielsenWatermarksSettings",
- "locationName": "nielsenWatermarksSettings",
- "documentation": "Settings to configure Nielsen Watermarks in the audio encode"
- }
+ "output": {
+ "shape": "DescribeNetworkResponse",
+ "documentation": "Details for one network."
},
- "documentation": "Audio Watermark Settings"
- },
- "AuthenticationScheme": {
- "type": "string",
- "documentation": "Authentication Scheme",
- "enum": [
- "AKAMAI",
- "COMMON"
- ]
- },
- "AutomaticInputFailoverSettings": {
- "type": "structure",
- "members": {
- "ErrorClearTimeMsec": {
- "shape": "__integerMin1",
- "locationName": "errorClearTimeMsec",
- "documentation": "This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input."
- },
- "FailoverConditions": {
- "shape": "__listOfFailoverCondition",
- "locationName": "failoverConditions",
- "documentation": "A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input."
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "This request was invalid."
},
- "InputPreference": {
- "shape": "InputPreference",
- "locationName": "inputPreference",
- "documentation": "Input preference when deciding which input to make active when a previously failed input has recovered."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "SecondaryInputId": {
- "shape": "__string",
- "locationName": "secondaryInputId",
- "documentation": "The input ID of the secondary input in the automatic input failover pair."
- }
- },
- "documentation": "The settings for Automatic Input Failover.",
- "required": [
- "SecondaryInputId"
- ]
- },
- "AvailBlanking": {
- "type": "structure",
- "members": {
- "AvailBlankingImage": {
- "shape": "InputLocation",
- "locationName": "availBlankingImage",
- "documentation": "Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported."
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to describe the network."
},
- "State": {
- "shape": "AvailBlankingState",
- "locationName": "state",
- "documentation": "When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added."
- }
- },
- "documentation": "Avail Blanking"
- },
- "AvailBlankingState": {
- "type": "string",
- "documentation": "Avail Blanking State",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "AvailConfiguration": {
- "type": "structure",
- "members": {
- "AvailSettings": {
- "shape": "AvailSettings",
- "locationName": "availSettings",
- "documentation": "Controls how SCTE-35 messages create cues. Splice Insert mode treats all segmentation signals traditionally. With Time Signal APOS mode only Time Signal Placement Opportunity and Break messages create segment breaks. With ESAM mode, signals are forwarded to an ESAM server for possible update."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "Scte35SegmentationScope": {
- "shape": "Scte35SegmentationScope",
- "locationName": "scte35SegmentationScope",
- "documentation": "Configures whether SCTE 35 passthrough triggers segment breaks in all output groups that use segmented outputs. Insertion of a SCTE 35 message typically results in a segment break, in addition to the regular cadence of breaks. The segment breaks appear in video outputs, audio outputs, and captions outputs (if any).\n\nALL_OUTPUT_GROUPS: Default. Insert the segment break in in all output groups that have segmented outputs. This is the legacy behavior.\nSCTE35_ENABLED_OUTPUT_GROUPS: Insert the segment break only in output groups that have SCTE 35 passthrough enabled. This is the recommended value, because it reduces unnecessary segment breaks."
- }
- },
- "documentation": "Avail Configuration"
- },
- "AvailSettings": {
- "type": "structure",
- "members": {
- "Esam": {
- "shape": "Esam",
- "locationName": "esam"
+ {
+ "shape": "NotFoundException",
+ "documentation": "The network that you are trying to describe does not exist. Check the ID and try again."
},
- "Scte35SpliceInsert": {
- "shape": "Scte35SpliceInsert",
- "locationName": "scte35SpliceInsert"
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
},
- "Scte35TimeSignalApos": {
- "shape": "Scte35TimeSignalApos",
- "locationName": "scte35TimeSignalApos"
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on describe network calls to network service."
}
- },
- "documentation": "Avail Settings"
+ ],
+ "documentation": "Get details about a Network."
},
- "BadGatewayException": {
- "type": "structure",
- "members": {
- "Message": {
- "shape": "__string",
- "locationName": "message"
- }
- },
- "exception": true,
- "error": {
- "httpStatusCode": 502
+ "DescribeNode": {
+ "name": "DescribeNode",
+ "http": {
+ "method": "GET",
+ "requestUri": "/prod/clusters/{clusterId}/nodes/{nodeId}",
+ "responseCode": 200
},
- "documentation": "Placeholder documentation for BadGatewayException"
- },
- "BadRequestException": {
- "type": "structure",
- "members": {
- "Message": {
- "shape": "__string",
- "locationName": "message"
- }
+ "input": {
+ "shape": "DescribeNodeRequest"
},
- "exception": true,
- "error": {
- "httpStatusCode": 400
+ "output": {
+ "shape": "DescribeNodeResponse",
+ "documentation": "Details for one node."
},
- "documentation": "Placeholder documentation for BadRequestException"
- },
- "BatchDelete": {
- "type": "structure",
- "members": {
- "ChannelIds": {
- "shape": "__listOf__string",
- "locationName": "channelIds",
- "documentation": "List of channel IDs"
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "This request was invalid."
},
- "InputIds": {
- "shape": "__listOf__string",
- "locationName": "inputIds",
- "documentation": "List of input IDs"
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "InputSecurityGroupIds": {
- "shape": "__listOf__string",
- "locationName": "inputSecurityGroupIds",
- "documentation": "List of input security group IDs"
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to describe the node."
},
- "MultiplexIds": {
- "shape": "__listOf__string",
- "locationName": "multiplexIds",
- "documentation": "List of multiplex IDs"
- }
- },
- "documentation": "Batch delete resource request"
- },
- "BatchDeleteRequest": {
- "type": "structure",
- "members": {
- "ChannelIds": {
- "shape": "__listOf__string",
- "locationName": "channelIds",
- "documentation": "List of channel IDs"
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "InputIds": {
- "shape": "__listOf__string",
- "locationName": "inputIds",
- "documentation": "List of input IDs"
+ {
+ "shape": "NotFoundException",
+ "documentation": "The node that you are trying to describe doesn’t exist. Check the ID and try again."
},
- "InputSecurityGroupIds": {
- "shape": "__listOf__string",
- "locationName": "inputSecurityGroupIds",
- "documentation": "List of input security group IDs"
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
},
- "MultiplexIds": {
- "shape": "__listOf__string",
- "locationName": "multiplexIds",
- "documentation": "List of multiplex IDs"
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on describe node calls to the cluster service."
}
- },
- "documentation": "A request to delete resources"
+ ],
+ "documentation": "Get details about a Node in the specified Cluster."
},
- "BatchDeleteResponse": {
- "type": "structure",
- "members": {
- "Failed": {
- "shape": "__listOfBatchFailedResultModel",
- "locationName": "failed",
- "documentation": "List of failed operations"
- },
- "Successful": {
- "shape": "__listOfBatchSuccessfulResultModel",
- "locationName": "successful",
- "documentation": "List of successful operations"
- }
+ "ListChannelPlacementGroups": {
+ "name": "ListChannelPlacementGroups",
+ "http": {
+ "method": "GET",
+ "requestUri": "/prod/clusters/{clusterId}/channelplacementgroups",
+ "responseCode": 200
},
- "documentation": "Placeholder documentation for BatchDeleteResponse"
- },
- "BatchDeleteResultModel": {
- "type": "structure",
- "members": {
- "Failed": {
- "shape": "__listOfBatchFailedResultModel",
- "locationName": "failed",
- "documentation": "List of failed operations"
- },
- "Successful": {
- "shape": "__listOfBatchSuccessfulResultModel",
- "locationName": "successful",
- "documentation": "List of successful operations"
- }
+ "input": {
+ "shape": "ListChannelPlacementGroupsRequest"
},
- "documentation": "Batch delete resource results"
- },
- "BatchFailedResultModel": {
- "type": "structure",
- "members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "ARN of the resource"
+ "output": {
+ "shape": "ListChannelPlacementGroupsResponse",
+ "documentation": "An array of channel placement groups."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "MediaLive can't process your request because of a problem in the request. Please check your request form and syntax."
},
- "Code": {
- "shape": "__string",
- "locationName": "code",
- "documentation": "Error code for the failed operation"
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "ID of the resource"
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to list channel placement groups."
},
- "Message": {
- "shape": "__string",
- "locationName": "message",
- "documentation": "Error message for the failed operation"
- }
- },
- "documentation": "Details from a failed operation"
- },
- "BatchScheduleActionCreateRequest": {
- "type": "structure",
- "members": {
- "ScheduleActions": {
- "shape": "__listOfScheduleAction",
- "locationName": "scheduleActions",
- "documentation": "A list of schedule actions to create."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
+ },
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on list channel placement group calls to the cluster service."
}
- },
- "documentation": "A list of schedule actions to create (in a request) or that have been created (in a response).",
- "required": [
- "ScheduleActions"
- ]
+ ],
+ "documentation": "Retrieve the list of ChannelPlacementGroups in the specified Cluster."
},
- "BatchScheduleActionCreateResult": {
- "type": "structure",
- "members": {
- "ScheduleActions": {
- "shape": "__listOfScheduleAction",
- "locationName": "scheduleActions",
- "documentation": "List of actions that have been created in the schedule."
- }
+ "ListClusters": {
+ "name": "ListClusters",
+ "http": {
+ "method": "GET",
+ "requestUri": "/prod/clusters",
+ "responseCode": 200
},
- "documentation": "List of actions that have been created in the schedule.",
- "required": [
- "ScheduleActions"
- ]
- },
- "BatchScheduleActionDeleteRequest": {
- "type": "structure",
- "members": {
- "ActionNames": {
- "shape": "__listOf__string",
- "locationName": "actionNames",
- "documentation": "A list of schedule actions to delete."
- }
+ "input": {
+ "shape": "ListClustersRequest"
},
- "documentation": "A list of schedule actions to delete.",
- "required": [
- "ActionNames"
- ]
- },
- "BatchScheduleActionDeleteResult": {
- "type": "structure",
- "members": {
- "ScheduleActions": {
- "shape": "__listOfScheduleAction",
- "locationName": "scheduleActions",
- "documentation": "List of actions that have been deleted from the schedule."
- }
+ "output": {
+ "shape": "ListClustersResponse",
+ "documentation": "An array of clusters."
},
- "documentation": "List of actions that have been deleted from the schedule.",
- "required": [
- "ScheduleActions"
- ]
- },
- "BatchStart": {
- "type": "structure",
- "members": {
- "ChannelIds": {
- "shape": "__listOf__string",
- "locationName": "channelIds",
- "documentation": "List of channel IDs"
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "MediaLive can't process your request because of a problem in the request. Please check your request form and syntax."
},
- "MultiplexIds": {
- "shape": "__listOf__string",
- "locationName": "multiplexIds",
- "documentation": "List of multiplex IDs"
- }
- },
- "documentation": "Batch start resource request"
- },
- "BatchStartRequest": {
- "type": "structure",
- "members": {
- "ChannelIds": {
- "shape": "__listOf__string",
- "locationName": "channelIds",
- "documentation": "List of channel IDs"
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "MultiplexIds": {
- "shape": "__listOf__string",
- "locationName": "multiplexIds",
- "documentation": "List of multiplex IDs"
- }
- },
- "documentation": "A request to start resources"
- },
- "BatchStartResponse": {
- "type": "structure",
- "members": {
- "Failed": {
- "shape": "__listOfBatchFailedResultModel",
- "locationName": "failed",
- "documentation": "List of failed operations"
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to list clusters."
},
- "Successful": {
- "shape": "__listOfBatchSuccessfulResultModel",
- "locationName": "successful",
- "documentation": "List of successful operations"
- }
- },
- "documentation": "Placeholder documentation for BatchStartResponse"
- },
- "BatchStartResultModel": {
- "type": "structure",
- "members": {
- "Failed": {
- "shape": "__listOfBatchFailedResultModel",
- "locationName": "failed",
- "documentation": "List of failed operations"
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "Successful": {
- "shape": "__listOfBatchSuccessfulResultModel",
- "locationName": "successful",
- "documentation": "List of successful operations"
- }
- },
- "documentation": "Batch start resource results"
- },
- "BatchStop": {
- "type": "structure",
- "members": {
- "ChannelIds": {
- "shape": "__listOf__string",
- "locationName": "channelIds",
- "documentation": "List of channel IDs"
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
},
- "MultiplexIds": {
- "shape": "__listOf__string",
- "locationName": "multiplexIds",
- "documentation": "List of multiplex IDs"
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on list cluster calls to cluster service."
}
- },
- "documentation": "Batch stop resource request"
+ ],
+ "documentation": "Retrieve the list of Clusters."
},
- "BatchStopRequest": {
- "type": "structure",
- "members": {
- "ChannelIds": {
- "shape": "__listOf__string",
- "locationName": "channelIds",
- "documentation": "List of channel IDs"
- },
- "MultiplexIds": {
- "shape": "__listOf__string",
- "locationName": "multiplexIds",
- "documentation": "List of multiplex IDs"
- }
+ "ListNetworks": {
+ "name": "ListNetworks",
+ "http": {
+ "method": "GET",
+ "requestUri": "/prod/networks",
+ "responseCode": 200
},
- "documentation": "A request to stop resources"
- },
- "BatchStopResponse": {
- "type": "structure",
- "members": {
- "Failed": {
- "shape": "__listOfBatchFailedResultModel",
- "locationName": "failed",
- "documentation": "List of failed operations"
- },
- "Successful": {
- "shape": "__listOfBatchSuccessfulResultModel",
- "locationName": "successful",
- "documentation": "List of successful operations"
- }
+ "input": {
+ "shape": "ListNetworksRequest"
},
- "documentation": "Placeholder documentation for BatchStopResponse"
- },
- "BatchStopResultModel": {
- "type": "structure",
- "members": {
- "Failed": {
- "shape": "__listOfBatchFailedResultModel",
- "locationName": "failed",
- "documentation": "List of failed operations"
- },
- "Successful": {
- "shape": "__listOfBatchSuccessfulResultModel",
- "locationName": "successful",
- "documentation": "List of successful operations"
- }
+ "output": {
+ "shape": "ListNetworksResponse",
+ "documentation": "An array of networks."
},
- "documentation": "Batch stop resource results"
- },
- "BatchSuccessfulResultModel": {
- "type": "structure",
- "members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "ARN of the resource"
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "MediaLive can't process your request because of a problem in the request. Please check your request form and syntax."
},
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "ID of the resource"
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "State": {
- "shape": "__string",
- "locationName": "state",
- "documentation": "Current state of the resource"
- }
- },
- "documentation": "Details from a successful operation"
- },
- "BatchUpdateScheduleRequest": {
- "type": "structure",
- "members": {
- "ChannelId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "channelId",
- "documentation": "Id of the channel whose schedule is being updated."
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to list clusters."
},
- "Creates": {
- "shape": "BatchScheduleActionCreateRequest",
- "locationName": "creates",
- "documentation": "Schedule actions to create in the schedule."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "Deletes": {
- "shape": "BatchScheduleActionDeleteRequest",
- "locationName": "deletes",
- "documentation": "Schedule actions to delete from the schedule."
- }
- },
- "documentation": "List of actions to create and list of actions to delete.",
- "required": [
- "ChannelId"
- ]
- },
- "BatchUpdateScheduleResponse": {
- "type": "structure",
- "members": {
- "Creates": {
- "shape": "BatchScheduleActionCreateResult",
- "locationName": "creates",
- "documentation": "Schedule actions created in the schedule."
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
},
- "Deletes": {
- "shape": "BatchScheduleActionDeleteResult",
- "locationName": "deletes",
- "documentation": "Schedule actions deleted from the schedule."
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on list cluster calls to cluster service."
}
- },
- "documentation": "Placeholder documentation for BatchUpdateScheduleResponse"
+ ],
+ "documentation": "Retrieve the list of Networks."
},
- "BatchUpdateScheduleResult": {
- "type": "structure",
- "members": {
- "Creates": {
- "shape": "BatchScheduleActionCreateResult",
- "locationName": "creates",
- "documentation": "Schedule actions created in the schedule."
- },
- "Deletes": {
- "shape": "BatchScheduleActionDeleteResult",
- "locationName": "deletes",
- "documentation": "Schedule actions deleted from the schedule."
- }
+ "ListNodes": {
+ "name": "ListNodes",
+ "http": {
+ "method": "GET",
+ "requestUri": "/prod/clusters/{clusterId}/nodes",
+ "responseCode": 200
},
- "documentation": "Results of a batch schedule update."
- },
- "BlackoutSlate": {
- "type": "structure",
- "members": {
- "BlackoutSlateImage": {
- "shape": "InputLocation",
- "locationName": "blackoutSlateImage",
- "documentation": "Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported."
+ "input": {
+ "shape": "ListNodesRequest"
+ },
+ "output": {
+ "shape": "ListNodesResponse",
+ "documentation": "An array of nodes."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "MediaLive can't process your request because of a problem in the request. Please check your request form and syntax."
},
- "NetworkEndBlackout": {
- "shape": "BlackoutSlateNetworkEndBlackout",
- "locationName": "networkEndBlackout",
- "documentation": "Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the \"Network Blackout Image\" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in \"Network ID\"."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "NetworkEndBlackoutImage": {
- "shape": "InputLocation",
- "locationName": "networkEndBlackoutImage",
- "documentation": "Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster."
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to list nodes."
},
- "NetworkId": {
- "shape": "__stringMin34Max34",
- "locationName": "networkId",
- "documentation": "Provides Network ID that matches EIDR ID format (e.g., \"10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C\")."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "State": {
- "shape": "BlackoutSlateState",
- "locationName": "state",
- "documentation": "When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata."
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on list node calls to the cluster service."
}
- },
- "documentation": "Blackout Slate"
- },
- "BlackoutSlateNetworkEndBlackout": {
- "type": "string",
- "documentation": "Blackout Slate Network End Blackout",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "BlackoutSlateState": {
- "type": "string",
- "documentation": "Blackout Slate State",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "BurnInAlignment": {
- "type": "string",
- "documentation": "Burn In Alignment",
- "enum": [
- "CENTERED",
- "LEFT",
- "SMART"
- ]
- },
- "BurnInBackgroundColor": {
- "type": "string",
- "documentation": "Burn In Background Color",
- "enum": [
- "BLACK",
- "NONE",
- "WHITE"
- ]
+ ],
+ "documentation": "Retrieve the list of Nodes."
},
- "BurnInDestinationSettings": {
- "type": "structure",
- "members": {
- "Alignment": {
- "shape": "BurnInAlignment",
- "locationName": "alignment",
- "documentation": "If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting \"smart\" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match."
- },
- "BackgroundColor": {
- "shape": "BurnInBackgroundColor",
- "locationName": "backgroundColor",
- "documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match."
- },
- "BackgroundOpacity": {
- "shape": "__integerMin0Max255",
- "locationName": "backgroundOpacity",
- "documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
- },
- "Font": {
- "shape": "InputLocation",
- "locationName": "font",
- "documentation": "External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match."
+ "UpdateChannelPlacementGroup": {
+ "name": "UpdateChannelPlacementGroup",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/prod/clusters/{clusterId}/channelplacementgroups/{channelPlacementGroupId}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateChannelPlacementGroupRequest"
+ },
+ "output": {
+ "shape": "UpdateChannelPlacementGroupResponse",
+ "documentation": "The channel placement group has been successfully updated."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "This request was invalid"
},
- "FontColor": {
- "shape": "BurnInFontColor",
- "locationName": "fontColor",
- "documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "UnprocessableEntityException",
+ "documentation": "The channel placement group failed validation and could not be updated."
},
- "FontOpacity": {
- "shape": "__integerMin0Max255",
- "locationName": "fontOpacity",
- "documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "FontResolution": {
- "shape": "__integerMin96Max600",
- "locationName": "fontResolution",
- "documentation": "Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to update the channel placement group."
},
- "FontSize": {
- "shape": "__string",
- "locationName": "fontSize",
- "documentation": "When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "OutlineColor": {
- "shape": "BurnInOutlineColor",
- "locationName": "outlineColor",
- "documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
},
- "OutlineSize": {
- "shape": "__integerMin0Max10",
- "locationName": "outlineSize",
- "documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on update channel placement group calls to service."
},
- "ShadowColor": {
- "shape": "BurnInShadowColor",
- "locationName": "shadowColor",
- "documentation": "Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "ConflictException",
+ "documentation": "The channel placement group is unable to update due to an issue with channel placement group resources."
+ }
+ ],
+ "documentation": "Change the settings for a ChannelPlacementGroup."
+ },
+ "UpdateCluster": {
+ "name": "UpdateCluster",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/prod/clusters/{clusterId}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateClusterRequest"
+ },
+ "output": {
+ "shape": "UpdateClusterResponse",
+ "documentation": "The cluster has been successfully updated."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "MediaLive can't process your request because of a problem in the request. Please check your request form and syntax."
},
- "ShadowOpacity": {
- "shape": "__integerMin0Max255",
- "locationName": "shadowOpacity",
- "documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
},
- "ShadowXOffset": {
- "shape": "__integer",
- "locationName": "shadowXOffset",
- "documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to update the Cluster."
},
- "ShadowYOffset": {
- "shape": "__integer",
- "locationName": "shadowYOffset",
- "documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
},
- "TeletextGridControl": {
- "shape": "BurnInTeletextGridControl",
- "locationName": "teletextGridControl",
- "documentation": "Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs."
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
},
- "XPosition": {
- "shape": "__integerMin0",
- "locationName": "xPosition",
- "documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on update Cluster calls to service."
},
- "YPosition": {
- "shape": "__integerMin0",
- "locationName": "yPosition",
- "documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match."
+ {
+ "shape": "ConflictException",
+ "documentation": "The Cluster is unable to update due to an issue with cluster resources."
}
- },
- "documentation": "Burn In Destination Settings"
+ ],
+ "documentation": "Change the settings for a Cluster."
},
- "BurnInFontColor": {
- "type": "string",
- "documentation": "Burn In Font Color",
- "enum": [
- "BLACK",
- "BLUE",
- "GREEN",
- "RED",
- "WHITE",
- "YELLOW"
- ]
+ "UpdateNetwork": {
+ "name": "UpdateNetwork",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/prod/networks/{networkId}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateNetworkRequest"
+ },
+ "output": {
+ "shape": "UpdateNetworkResponse",
+ "documentation": "The network has been successfully updated."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "MediaLive can't process your request because of a problem in the request. Please check your request form and syntax."
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to update the Network."
+ },
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
+ },
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on update Network calls to service."
+ },
+ {
+ "shape": "ConflictException",
+ "documentation": "The Network is unable to update due to an issue with network resources."
+ }
+ ],
+ "documentation": "Change the settings for a Network."
},
- "BurnInOutlineColor": {
+ "UpdateNode": {
+ "name": "UpdateNode",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/prod/clusters/{clusterId}/nodes/{nodeId}",
+ "responseCode": 201
+ },
+ "input": {
+ "shape": "UpdateNodeRequest"
+ },
+ "output": {
+ "shape": "UpdateNodeResponse",
+ "documentation": "Update of the Node is in progress."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "MediaLive can't process your request because of a problem in the request. Please check your request form and syntax."
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to update the node."
+ },
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
+ },
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on update node calls to the service."
+ },
+ {
+ "shape": "ConflictException",
+ "documentation": "The node is unable to update due to an issue with node resources."
+ }
+ ],
+ "documentation": "Change the settings for a Node."
+ },
+ "UpdateNodeState": {
+ "name": "UpdateNodeState",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/prod/clusters/{clusterId}/nodes/{nodeId}/state",
+ "responseCode": 201
+ },
+ "input": {
+ "shape": "UpdateNodeStateRequest"
+ },
+ "output": {
+ "shape": "UpdateNodeStateResponse",
+ "documentation": "An update to node state is in progress."
+ },
+ "errors": [
+ {
+ "shape": "BadRequestException",
+ "documentation": "MediaLive can't process your request because of a problem in the request. Please check your request form and syntax."
+ },
+ {
+ "shape": "UnprocessableEntityException",
+ "documentation": "The node failed validation and the state could not be updated."
+ },
+ {
+ "shape": "InternalServerErrorException",
+ "documentation": "Internal Service Error."
+ },
+ {
+ "shape": "ForbiddenException",
+ "documentation": "You don't have permission to update the state of the node."
+ },
+ {
+ "shape": "BadGatewayException",
+ "documentation": "Bad Gateway Error."
+ },
+ {
+ "shape": "GatewayTimeoutException",
+ "documentation": "Gateway Timeout."
+ },
+ {
+ "shape": "TooManyRequestsException",
+ "documentation": "Request limit exceeded on node calls to service."
+ },
+ {
+ "shape": "ConflictException",
+ "documentation": "The node state is unable to updated due to an issue with node resources."
+ }
+ ],
+ "documentation": "Update the state of a node."
+ }
+ },
+ "shapes": {
+ "AacCodingMode": {
"type": "string",
- "documentation": "Burn In Outline Color",
+ "documentation": "Aac Coding Mode",
"enum": [
- "BLACK",
- "BLUE",
- "GREEN",
- "RED",
- "WHITE",
- "YELLOW"
+ "AD_RECEIVER_MIX",
+ "CODING_MODE_1_0",
+ "CODING_MODE_1_1",
+ "CODING_MODE_2_0",
+ "CODING_MODE_5_1"
]
},
- "BurnInShadowColor": {
+ "AacInputType": {
"type": "string",
- "documentation": "Burn In Shadow Color",
+ "documentation": "Aac Input Type",
"enum": [
- "BLACK",
- "NONE",
- "WHITE"
+ "BROADCASTER_MIXED_AD",
+ "NORMAL"
]
},
- "BurnInTeletextGridControl": {
+ "AacProfile": {
"type": "string",
- "documentation": "Burn In Teletext Grid Control",
+ "documentation": "Aac Profile",
"enum": [
- "FIXED",
- "SCALED"
+ "HEV1",
+ "HEV2",
+ "LC"
]
},
- "CancelInputDeviceTransferRequest": {
- "type": "structure",
- "members": {
- "InputDeviceId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputDeviceId",
- "documentation": "The unique ID of the input device to cancel. For example, hd-123456789abcdef."
- }
- },
- "required": [
- "InputDeviceId"
- ],
- "documentation": "Placeholder documentation for CancelInputDeviceTransferRequest"
+ "AacRateControlMode": {
+ "type": "string",
+ "documentation": "Aac Rate Control Mode",
+ "enum": [
+ "CBR",
+ "VBR"
+ ]
},
- "CancelInputDeviceTransferResponse": {
- "type": "structure",
- "members": {
- },
- "documentation": "Placeholder documentation for CancelInputDeviceTransferResponse"
+ "AacRawFormat": {
+ "type": "string",
+ "documentation": "Aac Raw Format",
+ "enum": [
+ "LATM_LOAS",
+ "NONE"
+ ]
},
- "CaptionDescription": {
+ "AacSettings": {
"type": "structure",
"members": {
- "Accessibility": {
- "shape": "AccessibilityType",
- "locationName": "accessibility",
- "documentation": "Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group."
+ "Bitrate": {
+ "shape": "__double",
+ "locationName": "bitrate",
+ "documentation": "Average bitrate in bits/second. Valid values depend on rate control mode and profile."
},
- "CaptionSelectorName": {
- "shape": "__string",
- "locationName": "captionSelectorName",
- "documentation": "Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name."
+ "CodingMode": {
+ "shape": "AacCodingMode",
+ "locationName": "codingMode",
+ "documentation": "Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E."
},
- "DestinationSettings": {
- "shape": "CaptionDestinationSettings",
- "locationName": "destinationSettings",
- "documentation": "Additional settings for captions destination that depend on the destination type."
+ "InputType": {
+ "shape": "AacInputType",
+ "locationName": "inputType",
+ "documentation": "Set to \"broadcasterMixedAd\" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains \"broadcaster mixed AD\". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd.\n\nLeave set to \"normal\" when input does not contain pre-mixed audio + AD."
},
- "LanguageCode": {
- "shape": "__string",
- "locationName": "languageCode",
- "documentation": "ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/"
+ "Profile": {
+ "shape": "AacProfile",
+ "locationName": "profile",
+ "documentation": "AAC Profile."
},
- "LanguageDescription": {
- "shape": "__string",
- "locationName": "languageDescription",
- "documentation": "Human readable information to indicate captions available for players (eg. English, or Spanish)."
+ "RateControlMode": {
+ "shape": "AacRateControlMode",
+ "locationName": "rateControlMode",
+ "documentation": "Rate Control Mode."
},
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event."
+ "RawFormat": {
+ "shape": "AacRawFormat",
+ "locationName": "rawFormat",
+ "documentation": "Sets LATM / LOAS AAC output for raw containers."
},
- "CaptionDashRoles": {
- "shape": "__listOfDashRoleCaption",
- "locationName": "captionDashRoles",
- "documentation": "Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling."
+ "SampleRate": {
+ "shape": "__double",
+ "locationName": "sampleRate",
+ "documentation": "Sample rate in Hz. Valid values depend on rate control mode and profile."
},
- "DvbDashAccessibility": {
- "shape": "DvbDashAccessibility",
- "locationName": "dvbDashAccessibility",
- "documentation": "Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers."
+ "Spec": {
+ "shape": "AacSpec",
+ "locationName": "spec",
+ "documentation": "Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers."
+ },
+ "VbrQuality": {
+ "shape": "AacVbrQuality",
+ "locationName": "vbrQuality",
+ "documentation": "VBR Quality Level - Only used if rateControlMode is VBR."
}
},
- "documentation": "Caption Description",
- "required": [
- "CaptionSelectorName",
- "Name"
- ]
+ "documentation": "Aac Settings"
},
- "CaptionDestinationSettings": {
- "type": "structure",
- "members": {
- "AribDestinationSettings": {
- "shape": "AribDestinationSettings",
- "locationName": "aribDestinationSettings"
- },
- "BurnInDestinationSettings": {
- "shape": "BurnInDestinationSettings",
- "locationName": "burnInDestinationSettings"
- },
- "DvbSubDestinationSettings": {
- "shape": "DvbSubDestinationSettings",
- "locationName": "dvbSubDestinationSettings"
- },
- "EbuTtDDestinationSettings": {
- "shape": "EbuTtDDestinationSettings",
- "locationName": "ebuTtDDestinationSettings"
- },
- "EmbeddedDestinationSettings": {
- "shape": "EmbeddedDestinationSettings",
- "locationName": "embeddedDestinationSettings"
- },
- "EmbeddedPlusScte20DestinationSettings": {
- "shape": "EmbeddedPlusScte20DestinationSettings",
- "locationName": "embeddedPlusScte20DestinationSettings"
+ "AacSpec": {
+ "type": "string",
+ "documentation": "Aac Spec",
+ "enum": [
+ "MPEG2",
+ "MPEG4"
+ ]
+ },
+ "AacVbrQuality": {
+ "type": "string",
+ "documentation": "Aac Vbr Quality",
+ "enum": [
+ "HIGH",
+ "LOW",
+ "MEDIUM_HIGH",
+ "MEDIUM_LOW"
+ ]
+ },
+ "Ac3AttenuationControl": {
+ "type": "string",
+ "documentation": "Ac3 Attenuation Control",
+ "enum": [
+ "ATTENUATE_3_DB",
+ "NONE"
+ ]
+ },
+ "Ac3BitstreamMode": {
+ "type": "string",
+ "documentation": "Ac3 Bitstream Mode",
+ "enum": [
+ "COMMENTARY",
+ "COMPLETE_MAIN",
+ "DIALOGUE",
+ "EMERGENCY",
+ "HEARING_IMPAIRED",
+ "MUSIC_AND_EFFECTS",
+ "VISUALLY_IMPAIRED",
+ "VOICE_OVER"
+ ]
+ },
+ "Ac3CodingMode": {
+ "type": "string",
+ "documentation": "Ac3 Coding Mode",
+ "enum": [
+ "CODING_MODE_1_0",
+ "CODING_MODE_1_1",
+ "CODING_MODE_2_0",
+ "CODING_MODE_3_2_LFE"
+ ]
+ },
+ "Ac3DrcProfile": {
+ "type": "string",
+ "documentation": "Ac3 Drc Profile",
+ "enum": [
+ "FILM_STANDARD",
+ "NONE"
+ ]
+ },
+ "Ac3LfeFilter": {
+ "type": "string",
+ "documentation": "Ac3 Lfe Filter",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
+ },
+ "Ac3MetadataControl": {
+ "type": "string",
+ "documentation": "Ac3 Metadata Control",
+ "enum": [
+ "FOLLOW_INPUT",
+ "USE_CONFIGURED"
+ ]
+ },
+ "Ac3Settings": {
+ "type": "structure",
+ "members": {
+ "Bitrate": {
+ "shape": "__double",
+ "locationName": "bitrate",
+ "documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode."
},
- "RtmpCaptionInfoDestinationSettings": {
- "shape": "RtmpCaptionInfoDestinationSettings",
- "locationName": "rtmpCaptionInfoDestinationSettings"
+ "BitstreamMode": {
+ "shape": "Ac3BitstreamMode",
+ "locationName": "bitstreamMode",
+ "documentation": "Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values."
},
- "Scte20PlusEmbeddedDestinationSettings": {
- "shape": "Scte20PlusEmbeddedDestinationSettings",
- "locationName": "scte20PlusEmbeddedDestinationSettings"
+ "CodingMode": {
+ "shape": "Ac3CodingMode",
+ "locationName": "codingMode",
+ "documentation": "Dolby Digital coding mode. Determines number of channels."
},
- "Scte27DestinationSettings": {
- "shape": "Scte27DestinationSettings",
- "locationName": "scte27DestinationSettings"
+ "Dialnorm": {
+ "shape": "__integerMin1Max31",
+ "locationName": "dialnorm",
+ "documentation": "Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through."
},
- "SmpteTtDestinationSettings": {
- "shape": "SmpteTtDestinationSettings",
- "locationName": "smpteTtDestinationSettings"
+ "DrcProfile": {
+ "shape": "Ac3DrcProfile",
+ "locationName": "drcProfile",
+ "documentation": "If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification."
},
- "TeletextDestinationSettings": {
- "shape": "TeletextDestinationSettings",
- "locationName": "teletextDestinationSettings"
+ "LfeFilter": {
+ "shape": "Ac3LfeFilter",
+ "locationName": "lfeFilter",
+ "documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode."
},
- "TtmlDestinationSettings": {
- "shape": "TtmlDestinationSettings",
- "locationName": "ttmlDestinationSettings"
+ "MetadataControl": {
+ "shape": "Ac3MetadataControl",
+ "locationName": "metadataControl",
+ "documentation": "When set to \"followInput\", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used."
},
- "WebvttDestinationSettings": {
- "shape": "WebvttDestinationSettings",
- "locationName": "webvttDestinationSettings"
+ "AttenuationControl": {
+ "shape": "Ac3AttenuationControl",
+ "locationName": "attenuationControl",
+ "documentation": "Applies a 3 dB attenuation to the surround channels. Applies only when the coding mode parameter is CODING_MODE_3_2_LFE."
}
},
- "documentation": "Caption Destination Settings"
+ "documentation": "Ac3 Settings"
},
- "CaptionLanguageMapping": {
+ "AcceptInputDeviceTransferRequest": {
"type": "structure",
"members": {
- "CaptionChannel": {
- "shape": "__integerMin1Max4",
- "locationName": "captionChannel",
- "documentation": "The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)"
- },
- "LanguageCode": {
- "shape": "__stringMin3Max3",
- "locationName": "languageCode",
- "documentation": "Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)"
- },
- "LanguageDescription": {
- "shape": "__stringMin1",
- "locationName": "languageDescription",
- "documentation": "Textual description of language"
+ "InputDeviceId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputDeviceId",
+ "documentation": "The unique ID of the input device to accept. For example, hd-123456789abcdef."
}
},
- "documentation": "Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.",
"required": [
- "LanguageCode",
- "LanguageDescription",
- "CaptionChannel"
- ]
+ "InputDeviceId"
+ ],
+ "documentation": "Placeholder documentation for AcceptInputDeviceTransferRequest"
},
- "CaptionRectangle": {
+ "AcceptInputDeviceTransferResponse": {
"type": "structure",
"members": {
- "Height": {
- "shape": "__doubleMin0Max100",
- "locationName": "height",
- "documentation": "See the description in leftOffset.\nFor height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \\\"80\\\" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less.\nThis field corresponds to tts:extent - Y in the TTML standard."
- },
- "LeftOffset": {
- "shape": "__doubleMin0Max100",
- "locationName": "leftOffset",
- "documentation": "Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages.\nIf you specify a value for one of these fields, you must specify a value for all of them.\nFor leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \\\"10\\\" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame.\nThis field corresponds to tts:origin - X in the TTML standard."
- },
- "TopOffset": {
- "shape": "__doubleMin0Max100",
- "locationName": "topOffset",
- "documentation": "See the description in leftOffset.\nFor topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \\\"10\\\" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame.\nThis field corresponds to tts:origin - Y in the TTML standard."
- },
- "Width": {
- "shape": "__doubleMin0Max100",
- "locationName": "width",
- "documentation": "See the description in leftOffset.\nFor width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \\\"80\\\" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less.\nThis field corresponds to tts:extent - X in the TTML standard."
- }
},
- "documentation": "Caption Rectangle",
- "required": [
- "TopOffset",
- "Height",
- "Width",
- "LeftOffset"
- ]
+ "documentation": "Placeholder documentation for AcceptInputDeviceTransferResponse"
},
- "CaptionSelector": {
+ "AccessDenied": {
"type": "structure",
"members": {
- "LanguageCode": {
+ "Message": {
"shape": "__string",
- "locationName": "languageCode",
- "documentation": "When specified this field indicates the three letter language code of the caption track to extract from the source."
- },
- "Name": {
- "shape": "__stringMin1",
- "locationName": "name",
- "documentation": "Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event."
- },
- "SelectorSettings": {
- "shape": "CaptionSelectorSettings",
- "locationName": "selectorSettings",
- "documentation": "Caption selector settings."
+ "locationName": "message"
}
},
- "documentation": "Caption Selector",
- "required": [
- "Name"
+ "documentation": "Placeholder documentation for AccessDenied"
+ },
+ "AccessibilityType": {
+ "type": "string",
+ "documentation": "Accessibility Type",
+ "enum": [
+ "DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES",
+ "IMPLEMENTS_ACCESSIBILITY_FEATURES"
]
},
- "CaptionSelectorSettings": {
+ "AccountConfiguration": {
"type": "structure",
"members": {
- "AncillarySourceSettings": {
- "shape": "AncillarySourceSettings",
- "locationName": "ancillarySourceSettings"
- },
- "AribSourceSettings": {
- "shape": "AribSourceSettings",
- "locationName": "aribSourceSettings"
- },
- "DvbSubSourceSettings": {
- "shape": "DvbSubSourceSettings",
- "locationName": "dvbSubSourceSettings"
- },
- "EmbeddedSourceSettings": {
- "shape": "EmbeddedSourceSettings",
- "locationName": "embeddedSourceSettings"
- },
- "Scte20SourceSettings": {
- "shape": "Scte20SourceSettings",
- "locationName": "scte20SourceSettings"
- },
- "Scte27SourceSettings": {
- "shape": "Scte27SourceSettings",
- "locationName": "scte27SourceSettings"
- },
- "TeletextSourceSettings": {
- "shape": "TeletextSourceSettings",
- "locationName": "teletextSourceSettings"
+ "KmsKeyId": {
+ "shape": "__string",
+ "locationName": "kmsKeyId",
+ "documentation": "Specifies the KMS key to use for all features that use key encryption. Specify the ARN of a KMS key that you have created. Or leave blank to use the key that MediaLive creates and manages for you."
}
},
- "documentation": "Caption Selector Settings"
+ "documentation": "Placeholder documentation for AccountConfiguration"
},
- "CdiInputResolution": {
+ "AfdSignaling": {
"type": "string",
- "documentation": "Maximum CDI input resolution; SD is 480i and 576i up to 30 frames-per-second (fps), HD is 720p up to 60 fps / 1080i up to 30 fps, FHD is 1080p up to 60 fps, UHD is 2160p up to 60 fps",
+ "documentation": "Afd Signaling",
"enum": [
- "SD",
- "HD",
- "FHD",
- "UHD"
+ "AUTO",
+ "FIXED",
+ "NONE"
]
},
- "CdiInputSpecification": {
+ "AncillarySourceSettings": {
"type": "structure",
"members": {
- "Resolution": {
- "shape": "CdiInputResolution",
- "locationName": "resolution",
- "documentation": "Maximum CDI input resolution"
+ "SourceAncillaryChannelNumber": {
+ "shape": "__integerMin1Max4",
+ "locationName": "sourceAncillaryChannelNumber",
+ "documentation": "Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field."
}
},
- "documentation": "Placeholder documentation for CdiInputSpecification"
+ "documentation": "Ancillary Source Settings"
},
- "Channel": {
+ "ArchiveCdnSettings": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique arn of the channel."
- },
- "CdiInputSpecification": {
- "shape": "CdiInputSpecification",
- "locationName": "cdiInputSpecification",
- "documentation": "Specification of CDI inputs for this channel"
- },
- "ChannelClass": {
- "shape": "ChannelClass",
- "locationName": "channelClass",
- "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
- },
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
- },
- "EgressEndpoints": {
- "shape": "__listOfChannelEgressEndpoint",
- "locationName": "egressEndpoints",
- "documentation": "The endpoints where outgoing connections initiate from"
- },
- "EncoderSettings": {
- "shape": "EncoderSettings",
- "locationName": "encoderSettings"
- },
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique id of the channel."
- },
- "InputAttachments": {
- "shape": "__listOfInputAttachment",
- "locationName": "inputAttachments",
- "documentation": "List of input attachments for channel."
+ "ArchiveS3Settings": {
+ "shape": "ArchiveS3Settings",
+ "locationName": "archiveS3Settings"
+ }
+ },
+ "documentation": "Archive Cdn Settings"
+ },
+ "ArchiveContainerSettings": {
+ "type": "structure",
+ "members": {
+ "M2tsSettings": {
+ "shape": "M2tsSettings",
+ "locationName": "m2tsSettings"
},
- "InputSpecification": {
- "shape": "InputSpecification",
- "locationName": "inputSpecification",
- "documentation": "Specification of network and file inputs for this channel"
+ "RawSettings": {
+ "shape": "RawSettings",
+ "locationName": "rawSettings"
+ }
+ },
+ "documentation": "Archive Container Settings"
+ },
+ "ArchiveGroupSettings": {
+ "type": "structure",
+ "members": {
+ "ArchiveCdnSettings": {
+ "shape": "ArchiveCdnSettings",
+ "locationName": "archiveCdnSettings",
+ "documentation": "Parameters that control interactions with the CDN."
},
- "LogLevel": {
- "shape": "LogLevel",
- "locationName": "logLevel",
- "documentation": "The log level being written to CloudWatch Logs."
+ "Destination": {
+ "shape": "OutputLocationRef",
+ "locationName": "destination",
+ "documentation": "A directory and base filename where archive files should be written."
},
- "Maintenance": {
- "shape": "MaintenanceStatus",
- "locationName": "maintenance",
- "documentation": "Maintenance settings for this channel."
+ "RolloverInterval": {
+ "shape": "__integerMin1",
+ "locationName": "rolloverInterval",
+ "documentation": "Number of seconds to write to archive file before closing and starting a new one."
+ }
+ },
+ "documentation": "Archive Group Settings",
+ "required": [
+ "Destination"
+ ]
+ },
+ "ArchiveOutputSettings": {
+ "type": "structure",
+ "members": {
+ "ContainerSettings": {
+ "shape": "ArchiveContainerSettings",
+ "locationName": "containerSettings",
+ "documentation": "Settings specific to the container type of the file."
},
- "Name": {
+ "Extension": {
"shape": "__string",
- "locationName": "name",
- "documentation": "The name of the channel. (user-mutable)"
- },
- "PipelineDetails": {
- "shape": "__listOfPipelineDetail",
- "locationName": "pipelineDetails",
- "documentation": "Runtime details for the pipelines of a running channel."
- },
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
+ "locationName": "extension",
+ "documentation": "Output file extension. If excluded, this will be auto-selected from the container type."
},
- "RoleArn": {
+ "NameModifier": {
"shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
- },
- "State": {
- "shape": "ChannelState",
- "locationName": "state"
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
- },
- "Vpc": {
- "shape": "VpcOutputSettingsDescription",
- "locationName": "vpc",
- "documentation": "Settings for VPC output"
+ "locationName": "nameModifier",
+ "documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type."
}
},
- "documentation": "Placeholder documentation for Channel"
+ "documentation": "Archive Output Settings",
+ "required": [
+ "ContainerSettings"
+ ]
},
- "ChannelClass": {
+ "ArchiveS3LogUploads": {
"type": "string",
- "documentation": "A standard channel has two encoding pipelines and a single pipeline channel only has one.",
+ "documentation": "Archive S3 Log Uploads",
"enum": [
- "STANDARD",
- "SINGLE_PIPELINE"
+ "DISABLED",
+ "ENABLED"
]
},
- "ChannelConfigurationValidationError": {
+ "ArchiveS3Settings": {
"type": "structure",
"members": {
- "Message": {
- "shape": "__string",
- "locationName": "message"
- },
- "ValidationErrors": {
- "shape": "__listOfValidationError",
- "locationName": "validationErrors",
- "documentation": "A collection of validation error responses."
+ "CannedAcl": {
+ "shape": "S3CannedAcl",
+ "locationName": "cannedAcl",
+ "documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none."
}
},
- "documentation": "Placeholder documentation for ChannelConfigurationValidationError"
+ "documentation": "Archive S3 Settings"
},
- "ChannelEgressEndpoint": {
+ "AribDestinationSettings": {
"type": "structure",
"members": {
- "SourceIp": {
- "shape": "__string",
- "locationName": "sourceIp",
- "documentation": "Public IP of where a channel's output comes from"
- }
},
- "documentation": "Placeholder documentation for ChannelEgressEndpoint"
+ "documentation": "Arib Destination Settings"
},
- "ChannelState": {
- "type": "string",
- "enum": [
- "CREATING",
- "CREATE_FAILED",
- "IDLE",
- "STARTING",
- "RUNNING",
- "RECOVERING",
- "STOPPING",
- "DELETING",
- "DELETED",
- "UPDATING",
- "UPDATE_FAILED"
- ],
- "documentation": "Placeholder documentation for ChannelState"
+ "AribSourceSettings": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Arib Source Settings"
},
- "ChannelSummary": {
+ "AudioChannelMapping": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique arn of the channel."
- },
- "CdiInputSpecification": {
- "shape": "CdiInputSpecification",
- "locationName": "cdiInputSpecification",
- "documentation": "Specification of CDI inputs for this channel"
+ "InputChannelLevels": {
+ "shape": "__listOfInputChannelLevel",
+ "locationName": "inputChannelLevels",
+ "documentation": "Indices and gain values for each input channel that should be remixed into this output channel."
},
- "ChannelClass": {
- "shape": "ChannelClass",
- "locationName": "channelClass",
- "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
+ "OutputChannel": {
+ "shape": "__integerMin0Max7",
+ "locationName": "outputChannel",
+ "documentation": "The index of the output channel being produced."
+ }
+ },
+ "documentation": "Audio Channel Mapping",
+ "required": [
+ "OutputChannel",
+ "InputChannelLevels"
+ ]
+ },
+ "AudioCodecSettings": {
+ "type": "structure",
+ "members": {
+ "AacSettings": {
+ "shape": "AacSettings",
+ "locationName": "aacSettings"
},
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
+ "Ac3Settings": {
+ "shape": "Ac3Settings",
+ "locationName": "ac3Settings"
},
- "EgressEndpoints": {
- "shape": "__listOfChannelEgressEndpoint",
- "locationName": "egressEndpoints",
- "documentation": "The endpoints where outgoing connections initiate from"
+ "Eac3AtmosSettings": {
+ "shape": "Eac3AtmosSettings",
+ "locationName": "eac3AtmosSettings"
},
- "Id": {
+ "Eac3Settings": {
+ "shape": "Eac3Settings",
+ "locationName": "eac3Settings"
+ },
+ "Mp2Settings": {
+ "shape": "Mp2Settings",
+ "locationName": "mp2Settings"
+ },
+ "PassThroughSettings": {
+ "shape": "PassThroughSettings",
+ "locationName": "passThroughSettings"
+ },
+ "WavSettings": {
+ "shape": "WavSettings",
+ "locationName": "wavSettings"
+ }
+ },
+ "documentation": "Audio Codec Settings"
+ },
+ "AudioDescription": {
+ "type": "structure",
+ "members": {
+ "AudioNormalizationSettings": {
+ "shape": "AudioNormalizationSettings",
+ "locationName": "audioNormalizationSettings",
+ "documentation": "Advanced audio normalization settings."
+ },
+ "AudioSelectorName": {
"shape": "__string",
- "locationName": "id",
- "documentation": "The unique id of the channel."
+ "locationName": "audioSelectorName",
+ "documentation": "The name of the AudioSelector used as the source for this AudioDescription."
},
- "InputAttachments": {
- "shape": "__listOfInputAttachment",
- "locationName": "inputAttachments",
- "documentation": "List of input attachments for channel."
+ "AudioType": {
+ "shape": "AudioType",
+ "locationName": "audioType",
+ "documentation": "Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1."
},
- "InputSpecification": {
- "shape": "InputSpecification",
- "locationName": "inputSpecification",
- "documentation": "Specification of network and file inputs for this channel"
+ "AudioTypeControl": {
+ "shape": "AudioDescriptionAudioTypeControl",
+ "locationName": "audioTypeControl",
+ "documentation": "Determines how audio type is determined.\n followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output.\n useConfigured: The value in Audio Type is included in the output.\nNote that this field and audioType are both ignored if inputType is broadcasterMixedAd."
},
- "LogLevel": {
- "shape": "LogLevel",
- "locationName": "logLevel",
- "documentation": "The log level being written to CloudWatch Logs."
+ "AudioWatermarkingSettings": {
+ "shape": "AudioWatermarkSettings",
+ "locationName": "audioWatermarkingSettings",
+ "documentation": "Settings to configure one or more solutions that insert audio watermarks in the audio encode"
},
- "Maintenance": {
- "shape": "MaintenanceStatus",
- "locationName": "maintenance",
- "documentation": "Maintenance settings for this channel."
+ "CodecSettings": {
+ "shape": "AudioCodecSettings",
+ "locationName": "codecSettings",
+ "documentation": "Audio codec settings."
+ },
+ "LanguageCode": {
+ "shape": "__stringMin1Max35",
+ "locationName": "languageCode",
+ "documentation": "RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input."
+ },
+ "LanguageCodeControl": {
+ "shape": "AudioDescriptionLanguageCodeControl",
+ "locationName": "languageCodeControl",
+ "documentation": "Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input."
},
"Name": {
- "shape": "__string",
+ "shape": "__stringMax255",
"locationName": "name",
- "documentation": "The name of the channel. (user-mutable)"
+ "documentation": "The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event."
},
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
+ "RemixSettings": {
+ "shape": "RemixSettings",
+ "locationName": "remixSettings",
+ "documentation": "Settings that control how input audio channels are remixed into the output audio channels."
},
- "RoleArn": {
+ "StreamName": {
"shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
- },
- "State": {
- "shape": "ChannelState",
- "locationName": "state"
+ "locationName": "streamName",
+ "documentation": "Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary)."
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "AudioDashRoles": {
+ "shape": "__listOfDashRoleAudio",
+ "locationName": "audioDashRoles",
+ "documentation": "Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling."
},
- "Vpc": {
- "shape": "VpcOutputSettingsDescription",
- "locationName": "vpc",
- "documentation": "Settings for any VPC outputs."
+ "DvbDashAccessibility": {
+ "shape": "DvbDashAccessibility",
+ "locationName": "dvbDashAccessibility",
+ "documentation": "Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers."
}
},
- "documentation": "Placeholder documentation for ChannelSummary"
+ "documentation": "Audio Description",
+ "required": [
+ "AudioSelectorName",
+ "Name"
+ ]
},
- "ClaimDeviceRequest": {
- "type": "structure",
- "members": {
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The id of the device you want to claim."
- }
- },
- "documentation": "A request to claim an AWS Elemental device that you have purchased from a third-party vendor."
+ "AudioDescriptionAudioTypeControl": {
+ "type": "string",
+ "documentation": "Audio Description Audio Type Control",
+ "enum": [
+ "FOLLOW_INPUT",
+ "USE_CONFIGURED"
+ ]
},
- "ClaimDeviceResponse": {
+ "AudioDescriptionLanguageCodeControl": {
+ "type": "string",
+ "documentation": "Audio Description Language Code Control",
+ "enum": [
+ "FOLLOW_INPUT",
+ "USE_CONFIGURED"
+ ]
+ },
+ "AudioDolbyEDecode": {
"type": "structure",
"members": {
+ "ProgramSelection": {
+ "shape": "DolbyEProgramSelection",
+ "locationName": "programSelection",
+ "documentation": "Applies only to Dolby E. Enter the program ID (according to the metadata in the audio) of the Dolby E program to extract from the specified track. One program extracted per audio selector. To select multiple programs, create multiple selectors with the same Track and different Program numbers. “All channels” means to ignore the program IDs and include all the channels in this selector; useful if metadata is known to be incorrect."
+ }
},
- "documentation": "Placeholder documentation for ClaimDeviceResponse"
+ "documentation": "Audio Dolby EDecode",
+ "required": [
+ "ProgramSelection"
+ ]
},
- "ColorCorrection": {
+ "AudioHlsRenditionSelection": {
"type": "structure",
"members": {
- "InputColorSpace": {
- "shape": "ColorSpace",
- "locationName": "inputColorSpace",
- "documentation": "The color space of the input."
- },
- "OutputColorSpace": {
- "shape": "ColorSpace",
- "locationName": "outputColorSpace",
- "documentation": "The color space of the output."
+ "GroupId": {
+ "shape": "__stringMin1",
+ "locationName": "groupId",
+ "documentation": "Specifies the GROUP-ID in the #EXT-X-MEDIA tag of the target HLS audio rendition."
},
- "Uri": {
- "shape": "__string",
- "locationName": "uri",
- "documentation": "The URI of the 3D LUT file. The protocol must be 's3:' or 's3ssl:':."
+ "Name": {
+ "shape": "__stringMin1",
+ "locationName": "name",
+ "documentation": "Specifies the NAME in the #EXT-X-MEDIA tag of the target HLS audio rendition."
}
},
- "documentation": "Property of ColorCorrectionSettings. Used for custom color space conversion. The object identifies one 3D LUT file and specifies the input/output color space combination that the file will be used for.",
+ "documentation": "Audio Hls Rendition Selection",
"required": [
- "OutputColorSpace",
- "InputColorSpace",
- "Uri"
+ "Name",
+ "GroupId"
]
},
- "ColorCorrectionSettings": {
+ "AudioLanguageSelection": {
"type": "structure",
"members": {
- "GlobalColorCorrections": {
- "shape": "__listOfColorCorrection",
- "locationName": "globalColorCorrections",
- "documentation": "An array of colorCorrections that applies when you are using 3D LUT files to perform color conversion on video. Each colorCorrection contains one 3D LUT file (that defines the color mapping for converting an input color space to an output color space), and the input/output combination that this 3D LUT file applies to. MediaLive reads the color space in the input metadata, determines the color space that you have specified for the output, and finds and uses the LUT file that applies to this combination."
+ "LanguageCode": {
+ "shape": "__string",
+ "locationName": "languageCode",
+ "documentation": "Selects a specific three-letter language code from within an audio source."
+ },
+ "LanguageSelectionPolicy": {
+ "shape": "AudioLanguageSelectionPolicy",
+ "locationName": "languageSelectionPolicy",
+ "documentation": "When set to \"strict\", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If \"loose\", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language."
}
},
- "documentation": "Property of encoderSettings. Controls color conversion when you are using 3D LUT files to perform color conversion on video.",
+ "documentation": "Audio Language Selection",
"required": [
- "GlobalColorCorrections"
+ "LanguageCode"
]
},
- "ColorSpace": {
+ "AudioLanguageSelectionPolicy": {
"type": "string",
- "documentation": "Property of colorCorrections. When you are using 3D LUT files to perform color conversion on video, these are the supported color spaces.",
+ "documentation": "Audio Language Selection Policy",
"enum": [
- "HDR10",
- "HLG_2020",
- "REC_601",
- "REC_709"
+ "LOOSE",
+ "STRICT"
]
},
- "ColorSpacePassthroughSettings": {
- "type": "structure",
- "members": {
- },
- "documentation": "Passthrough applies no color space conversion to the output"
- },
- "ConflictException": {
- "type": "structure",
- "members": {
- "Message": {
- "shape": "__string",
- "locationName": "message"
- }
- },
- "exception": true,
- "error": {
- "httpStatusCode": 409
- },
- "documentation": "Placeholder documentation for ConflictException"
+ "AudioNormalizationAlgorithm": {
+ "type": "string",
+ "documentation": "Audio Normalization Algorithm",
+ "enum": [
+ "ITU_1770_1",
+ "ITU_1770_2"
+ ]
},
- "CreateChannel": {
+ "AudioNormalizationAlgorithmControl": {
+ "type": "string",
+ "documentation": "Audio Normalization Algorithm Control",
+ "enum": [
+ "CORRECT_AUDIO"
+ ]
+ },
+ "AudioNormalizationSettings": {
"type": "structure",
"members": {
- "CdiInputSpecification": {
- "shape": "CdiInputSpecification",
- "locationName": "cdiInputSpecification",
- "documentation": "Specification of CDI inputs for this channel"
- },
- "ChannelClass": {
- "shape": "ChannelClass",
- "locationName": "channelClass",
- "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
- },
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations"
- },
- "EncoderSettings": {
- "shape": "EncoderSettings",
- "locationName": "encoderSettings"
- },
- "InputAttachments": {
- "shape": "__listOfInputAttachment",
- "locationName": "inputAttachments",
- "documentation": "List of input attachments for channel."
- },
- "InputSpecification": {
- "shape": "InputSpecification",
- "locationName": "inputSpecification",
- "documentation": "Specification of network and file inputs for this channel"
- },
- "LogLevel": {
- "shape": "LogLevel",
- "locationName": "logLevel",
- "documentation": "The log level to write to CloudWatch Logs."
- },
- "Maintenance": {
- "shape": "MaintenanceCreateSettings",
- "locationName": "maintenance",
- "documentation": "Maintenance settings for this channel."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of channel."
- },
- "RequestId": {
- "shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique request ID to be specified. This is needed to prevent retries from\ncreating multiple resources.",
- "idempotencyToken": true
- },
- "Reserved": {
- "shape": "__string",
- "locationName": "reserved",
- "documentation": "Deprecated field that's only usable by whitelisted customers.",
- "deprecated": true
- },
- "RoleArn": {
- "shape": "__string",
- "locationName": "roleArn",
- "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel."
+ "Algorithm": {
+ "shape": "AudioNormalizationAlgorithm",
+ "locationName": "algorithm",
+ "documentation": "Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification."
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "AlgorithmControl": {
+ "shape": "AudioNormalizationAlgorithmControl",
+ "locationName": "algorithmControl",
+ "documentation": "When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted."
},
- "Vpc": {
- "shape": "VpcOutputSettings",
- "locationName": "vpc",
- "documentation": "Settings for the VPC outputs"
+ "TargetLkfs": {
+ "shape": "__doubleMinNegative59Max0",
+ "locationName": "targetLkfs",
+ "documentation": "Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS."
}
},
- "documentation": "Placeholder documentation for CreateChannel"
+ "documentation": "Audio Normalization Settings"
},
- "CreateChannelRequest": {
+ "AudioOnlyHlsSegmentType": {
+ "type": "string",
+ "documentation": "Audio Only Hls Segment Type",
+ "enum": [
+ "AAC",
+ "FMP4"
+ ]
+ },
+ "AudioOnlyHlsSettings": {
"type": "structure",
"members": {
- "CdiInputSpecification": {
- "shape": "CdiInputSpecification",
- "locationName": "cdiInputSpecification",
- "documentation": "Specification of CDI inputs for this channel"
- },
- "ChannelClass": {
- "shape": "ChannelClass",
- "locationName": "channelClass",
- "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
- },
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations"
- },
- "EncoderSettings": {
- "shape": "EncoderSettings",
- "locationName": "encoderSettings"
- },
- "InputAttachments": {
- "shape": "__listOfInputAttachment",
- "locationName": "inputAttachments",
- "documentation": "List of input attachments for channel."
- },
- "InputSpecification": {
- "shape": "InputSpecification",
- "locationName": "inputSpecification",
- "documentation": "Specification of network and file inputs for this channel"
- },
- "LogLevel": {
- "shape": "LogLevel",
- "locationName": "logLevel",
- "documentation": "The log level to write to CloudWatch Logs."
- },
- "Maintenance": {
- "shape": "MaintenanceCreateSettings",
- "locationName": "maintenance",
- "documentation": "Maintenance settings for this channel."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of channel."
- },
- "RequestId": {
- "shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique request ID to be specified. This is needed to prevent retries from\ncreating multiple resources.",
- "idempotencyToken": true
- },
- "Reserved": {
+ "AudioGroupId": {
"shape": "__string",
- "locationName": "reserved",
- "documentation": "Deprecated field that's only usable by whitelisted customers.",
- "deprecated": true
+ "locationName": "audioGroupId",
+ "documentation": "Specifies the group to which the audio Rendition belongs."
},
- "RoleArn": {
- "shape": "__string",
- "locationName": "roleArn",
- "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel."
+ "AudioOnlyImage": {
+ "shape": "InputLocation",
+ "locationName": "audioOnlyImage",
+ "documentation": "Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth.\n\nThe image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the \"ID3 tag version 2.4.0 - Native Frames\" standard."
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "AudioTrackType": {
+ "shape": "AudioOnlyHlsTrackType",
+ "locationName": "audioTrackType",
+ "documentation": "Four types of audio-only tracks are supported:\n\nAudio-Only Variant Stream\nThe client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest.\n\nAlternate Audio, Auto Select, Default\nAlternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES\n\nAlternate Audio, Auto Select, Not Default\nAlternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES\n\nAlternate Audio, not Auto Select\nAlternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO"
},
- "Vpc": {
- "shape": "VpcOutputSettings",
- "locationName": "vpc",
- "documentation": "Settings for the VPC outputs"
+ "SegmentType": {
+ "shape": "AudioOnlyHlsSegmentType",
+ "locationName": "segmentType",
+ "documentation": "Specifies the segment type."
}
},
- "documentation": "A request to create a channel"
+ "documentation": "Audio Only Hls Settings"
},
- "CreateChannelResponse": {
+ "AudioOnlyHlsTrackType": {
+ "type": "string",
+ "documentation": "Audio Only Hls Track Type",
+ "enum": [
+ "ALTERNATE_AUDIO_AUTO_SELECT",
+ "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT",
+ "ALTERNATE_AUDIO_NOT_AUTO_SELECT",
+ "AUDIO_ONLY_VARIANT_STREAM"
+ ]
+ },
+ "AudioPidSelection": {
"type": "structure",
"members": {
- "Channel": {
- "shape": "Channel",
- "locationName": "channel"
+ "Pid": {
+ "shape": "__integerMin0Max8191",
+ "locationName": "pid",
+ "documentation": "Selects a specific PID from within a source."
}
},
- "documentation": "Placeholder documentation for CreateChannelResponse"
+ "documentation": "Audio Pid Selection",
+ "required": [
+ "Pid"
+ ]
},
- "CreateChannelResultModel": {
+ "AudioSelector": {
"type": "structure",
"members": {
- "Channel": {
- "shape": "Channel",
- "locationName": "channel"
+ "Name": {
+ "shape": "__stringMin1",
+ "locationName": "name",
+ "documentation": "The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input."
+ },
+ "SelectorSettings": {
+ "shape": "AudioSelectorSettings",
+ "locationName": "selectorSettings",
+ "documentation": "The audio selector settings."
}
},
- "documentation": "Placeholder documentation for CreateChannelResultModel"
+ "documentation": "Audio Selector",
+ "required": [
+ "Name"
+ ]
},
- "CreateInput": {
+ "AudioSelectorSettings": {
"type": "structure",
"members": {
- "Destinations": {
- "shape": "__listOfInputDestinationRequest",
- "locationName": "destinations",
- "documentation": "Destination settings for PUSH type inputs."
+ "AudioHlsRenditionSelection": {
+ "shape": "AudioHlsRenditionSelection",
+ "locationName": "audioHlsRenditionSelection"
},
- "InputDevices": {
- "shape": "__listOfInputDeviceSettings",
- "locationName": "inputDevices",
- "documentation": "Settings for the devices."
- },
- "InputSecurityGroups": {
- "shape": "__listOf__string",
- "locationName": "inputSecurityGroups",
- "documentation": "A list of security groups referenced by IDs to attach to the input."
- },
- "MediaConnectFlows": {
- "shape": "__listOfMediaConnectFlowRequest",
- "locationName": "mediaConnectFlows",
- "documentation": "A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of the input."
- },
- "RequestId": {
- "shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.",
- "idempotencyToken": true
- },
- "RoleArn": {
- "shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
- },
- "Sources": {
- "shape": "__listOfInputSourceRequest",
- "locationName": "sources",
- "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty."
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
- },
- "Type": {
- "shape": "InputType",
- "locationName": "type"
+ "AudioLanguageSelection": {
+ "shape": "AudioLanguageSelection",
+ "locationName": "audioLanguageSelection"
},
- "Vpc": {
- "shape": "InputVpcRequest",
- "locationName": "vpc"
+ "AudioPidSelection": {
+ "shape": "AudioPidSelection",
+ "locationName": "audioPidSelection"
},
- "SrtSettings": {
- "shape": "SrtSettingsRequest",
- "locationName": "srtSettings",
- "documentation": "The settings associated with an SRT input."
+ "AudioTrackSelection": {
+ "shape": "AudioTrackSelection",
+ "locationName": "audioTrackSelection"
}
},
- "documentation": "Placeholder documentation for CreateInput"
+ "documentation": "Audio Selector Settings"
},
- "CreateInputRequest": {
+ "AudioSilenceFailoverSettings": {
"type": "structure",
"members": {
- "Destinations": {
- "shape": "__listOfInputDestinationRequest",
- "locationName": "destinations",
- "documentation": "Destination settings for PUSH type inputs."
- },
- "InputDevices": {
- "shape": "__listOfInputDeviceSettings",
- "locationName": "inputDevices",
- "documentation": "Settings for the devices."
- },
- "InputSecurityGroups": {
- "shape": "__listOf__string",
- "locationName": "inputSecurityGroups",
- "documentation": "A list of security groups referenced by IDs to attach to the input."
- },
- "MediaConnectFlows": {
- "shape": "__listOfMediaConnectFlowRequest",
- "locationName": "mediaConnectFlows",
- "documentation": "A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of the input."
- },
- "RequestId": {
- "shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.",
- "idempotencyToken": true
- },
- "RoleArn": {
+ "AudioSelectorName": {
"shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
- },
- "Sources": {
- "shape": "__listOfInputSourceRequest",
- "locationName": "sources",
- "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty."
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
- },
- "Type": {
- "shape": "InputType",
- "locationName": "type"
- },
- "Vpc": {
- "shape": "InputVpcRequest",
- "locationName": "vpc"
+ "locationName": "audioSelectorName",
+ "documentation": "The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank."
},
- "SrtSettings": {
- "shape": "SrtSettingsRequest",
- "locationName": "srtSettings",
- "documentation": "The settings associated with an SRT input."
+ "AudioSilenceThresholdMsec": {
+ "shape": "__integerMin1000",
+ "locationName": "audioSilenceThresholdMsec",
+ "documentation": "The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS."
}
},
- "documentation": "The name of the input"
+ "required": [
+ "AudioSelectorName"
+ ],
+ "documentation": "Placeholder documentation for AudioSilenceFailoverSettings"
},
- "CreateInputResponse": {
+ "AudioTrack": {
"type": "structure",
"members": {
- "Input": {
- "shape": "Input",
- "locationName": "input"
+ "Track": {
+ "shape": "__integerMin1",
+ "locationName": "track",
+ "documentation": "1-based integer value that maps to a specific audio track"
}
},
- "documentation": "Placeholder documentation for CreateInputResponse"
+ "documentation": "Audio Track",
+ "required": [
+ "Track"
+ ]
},
- "CreateInputResultModel": {
+ "AudioTrackSelection": {
"type": "structure",
"members": {
- "Input": {
- "shape": "Input",
- "locationName": "input"
+ "Tracks": {
+ "shape": "__listOfAudioTrack",
+ "locationName": "tracks",
+ "documentation": "Selects one or more unique audio tracks from within a source."
+ },
+ "DolbyEDecode": {
+ "shape": "AudioDolbyEDecode",
+ "locationName": "dolbyEDecode",
+ "documentation": "Configure decoding options for Dolby E streams - these should be Dolby E frames carried in PCM streams tagged with SMPTE-337"
}
},
- "documentation": "Placeholder documentation for CreateInputResultModel"
+ "documentation": "Audio Track Selection",
+ "required": [
+ "Tracks"
+ ]
},
- "CreateInputSecurityGroupRequest": {
+ "AudioType": {
+ "type": "string",
+ "documentation": "Audio Type",
+ "enum": [
+ "CLEAN_EFFECTS",
+ "HEARING_IMPAIRED",
+ "UNDEFINED",
+ "VISUAL_IMPAIRED_COMMENTARY"
+ ]
+ },
+ "AudioWatermarkSettings": {
"type": "structure",
"members": {
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
- },
- "WhitelistRules": {
- "shape": "__listOfInputWhitelistRuleCidr",
- "locationName": "whitelistRules",
- "documentation": "List of IPv4 CIDR addresses to whitelist"
+ "NielsenWatermarksSettings": {
+ "shape": "NielsenWatermarksSettings",
+ "locationName": "nielsenWatermarksSettings",
+ "documentation": "Settings to configure Nielsen Watermarks in the audio encode"
}
},
- "documentation": "The IPv4 CIDRs to whitelist for this Input Security Group"
+ "documentation": "Audio Watermark Settings"
},
- "CreateInputSecurityGroupResponse": {
+ "AuthenticationScheme": {
+ "type": "string",
+ "documentation": "Authentication Scheme",
+ "enum": [
+ "AKAMAI",
+ "COMMON"
+ ]
+ },
+ "AutomaticInputFailoverSettings": {
"type": "structure",
"members": {
- "SecurityGroup": {
- "shape": "InputSecurityGroup",
- "locationName": "securityGroup"
+ "ErrorClearTimeMsec": {
+ "shape": "__integerMin1",
+ "locationName": "errorClearTimeMsec",
+ "documentation": "This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input."
+ },
+ "FailoverConditions": {
+ "shape": "__listOfFailoverCondition",
+ "locationName": "failoverConditions",
+ "documentation": "A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input."
+ },
+ "InputPreference": {
+ "shape": "InputPreference",
+ "locationName": "inputPreference",
+ "documentation": "Input preference when deciding which input to make active when a previously failed input has recovered."
+ },
+ "SecondaryInputId": {
+ "shape": "__string",
+ "locationName": "secondaryInputId",
+ "documentation": "The input ID of the secondary input in the automatic input failover pair."
}
},
- "documentation": "Placeholder documentation for CreateInputSecurityGroupResponse"
+ "documentation": "The settings for Automatic Input Failover.",
+ "required": [
+ "SecondaryInputId"
+ ]
},
- "CreateInputSecurityGroupResultModel": {
+ "AvailBlanking": {
"type": "structure",
"members": {
- "SecurityGroup": {
- "shape": "InputSecurityGroup",
- "locationName": "securityGroup"
+ "AvailBlankingImage": {
+ "shape": "InputLocation",
+ "locationName": "availBlankingImage",
+ "documentation": "Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported."
+ },
+ "State": {
+ "shape": "AvailBlankingState",
+ "locationName": "state",
+ "documentation": "When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added."
}
},
- "documentation": "Placeholder documentation for CreateInputSecurityGroupResultModel"
+ "documentation": "Avail Blanking"
},
- "CreateMultiplex": {
+ "AvailBlankingState": {
+ "type": "string",
+ "documentation": "Avail Blanking State",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
+ },
+ "AvailConfiguration": {
"type": "structure",
"members": {
- "AvailabilityZones": {
- "shape": "__listOf__string",
- "locationName": "availabilityZones",
- "documentation": "A list of availability zones for the multiplex. You must specify exactly two."
- },
- "MultiplexSettings": {
- "shape": "MultiplexSettings",
- "locationName": "multiplexSettings",
- "documentation": "Configuration for a multiplex event."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of multiplex."
- },
- "RequestId": {
- "shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique request ID. This prevents retries from creating multiple\nresources.",
- "idempotencyToken": true
+ "AvailSettings": {
+ "shape": "AvailSettings",
+ "locationName": "availSettings",
+ "documentation": "Controls how SCTE-35 messages create cues. Splice Insert mode treats all segmentation signals traditionally. With Time Signal APOS mode only Time Signal Placement Opportunity and Break messages create segment breaks. With ESAM mode, signals are forwarded to an ESAM server for possible update."
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "Scte35SegmentationScope": {
+ "shape": "Scte35SegmentationScope",
+ "locationName": "scte35SegmentationScope",
+ "documentation": "Configures whether SCTE 35 passthrough triggers segment breaks in all output groups that use segmented outputs. Insertion of a SCTE 35 message typically results in a segment break, in addition to the regular cadence of breaks. The segment breaks appear in video outputs, audio outputs, and captions outputs (if any).\n\nALL_OUTPUT_GROUPS: Default. Insert the segment break in in all output groups that have segmented outputs. This is the legacy behavior.\nSCTE35_ENABLED_OUTPUT_GROUPS: Insert the segment break only in output groups that have SCTE 35 passthrough enabled. This is the recommended value, because it reduces unnecessary segment breaks."
}
},
- "required": [
- "RequestId",
- "MultiplexSettings",
- "AvailabilityZones",
- "Name"
- ],
- "documentation": "Placeholder documentation for CreateMultiplex"
+ "documentation": "Avail Configuration"
},
- "CreateMultiplexProgram": {
+ "AvailSettings": {
"type": "structure",
"members": {
- "MultiplexProgramSettings": {
- "shape": "MultiplexProgramSettings",
- "locationName": "multiplexProgramSettings",
- "documentation": "The settings for this multiplex program."
+ "Esam": {
+ "shape": "Esam",
+ "locationName": "esam"
},
- "ProgramName": {
- "shape": "__string",
- "locationName": "programName",
- "documentation": "Name of multiplex program."
+ "Scte35SpliceInsert": {
+ "shape": "Scte35SpliceInsert",
+ "locationName": "scte35SpliceInsert"
},
- "RequestId": {
- "shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique request ID. This prevents retries from creating multiple\nresources.",
- "idempotencyToken": true
+ "Scte35TimeSignalApos": {
+ "shape": "Scte35TimeSignalApos",
+ "locationName": "scte35TimeSignalApos"
}
},
- "required": [
- "RequestId",
- "MultiplexProgramSettings",
- "ProgramName"
- ],
- "documentation": "Placeholder documentation for CreateMultiplexProgram"
+ "documentation": "Avail Settings"
},
- "CreateMultiplexProgramRequest": {
+ "BadGatewayException": {
"type": "structure",
"members": {
- "MultiplexId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "multiplexId",
- "documentation": "ID of the multiplex where the program is to be created."
- },
- "MultiplexProgramSettings": {
- "shape": "MultiplexProgramSettings",
- "locationName": "multiplexProgramSettings",
- "documentation": "The settings for this multiplex program."
- },
- "ProgramName": {
- "shape": "__string",
- "locationName": "programName",
- "documentation": "Name of multiplex program."
- },
- "RequestId": {
+ "Message": {
"shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique request ID. This prevents retries from creating multiple\nresources.",
- "idempotencyToken": true
+ "locationName": "message"
}
},
- "documentation": "A request to create a program in a multiplex.",
- "required": [
- "MultiplexId",
- "RequestId",
- "MultiplexProgramSettings",
- "ProgramName"
- ]
+ "exception": true,
+ "error": {
+ "httpStatusCode": 502
+ },
+ "documentation": "Placeholder documentation for BadGatewayException"
},
- "CreateMultiplexProgramResponse": {
+ "BadRequestException": {
"type": "structure",
"members": {
- "MultiplexProgram": {
- "shape": "MultiplexProgram",
- "locationName": "multiplexProgram",
- "documentation": "The newly created multiplex program."
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
}
},
- "documentation": "Placeholder documentation for CreateMultiplexProgramResponse"
+ "exception": true,
+ "error": {
+ "httpStatusCode": 400
+ },
+ "documentation": "Placeholder documentation for BadRequestException"
},
- "CreateMultiplexProgramResultModel": {
+ "BatchDelete": {
"type": "structure",
"members": {
- "MultiplexProgram": {
- "shape": "MultiplexProgram",
- "locationName": "multiplexProgram",
- "documentation": "The newly created multiplex program."
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds",
+ "documentation": "List of channel IDs"
+ },
+ "InputIds": {
+ "shape": "__listOf__string",
+ "locationName": "inputIds",
+ "documentation": "List of input IDs"
+ },
+ "InputSecurityGroupIds": {
+ "shape": "__listOf__string",
+ "locationName": "inputSecurityGroupIds",
+ "documentation": "List of input security group IDs"
+ },
+ "MultiplexIds": {
+ "shape": "__listOf__string",
+ "locationName": "multiplexIds",
+ "documentation": "List of multiplex IDs"
}
},
- "documentation": "Placeholder documentation for CreateMultiplexProgramResultModel"
+ "documentation": "Batch delete resource request"
},
- "CreateMultiplexRequest": {
+ "BatchDeleteRequest": {
"type": "structure",
"members": {
- "AvailabilityZones": {
+ "ChannelIds": {
"shape": "__listOf__string",
- "locationName": "availabilityZones",
- "documentation": "A list of availability zones for the multiplex. You must specify exactly two."
- },
- "MultiplexSettings": {
- "shape": "MultiplexSettings",
- "locationName": "multiplexSettings",
- "documentation": "Configuration for a multiplex event."
+ "locationName": "channelIds",
+ "documentation": "List of channel IDs"
},
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of multiplex."
+ "InputIds": {
+ "shape": "__listOf__string",
+ "locationName": "inputIds",
+ "documentation": "List of input IDs"
},
- "RequestId": {
- "shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique request ID. This prevents retries from creating multiple\nresources.",
- "idempotencyToken": true
+ "InputSecurityGroupIds": {
+ "shape": "__listOf__string",
+ "locationName": "inputSecurityGroupIds",
+ "documentation": "List of input security group IDs"
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "MultiplexIds": {
+ "shape": "__listOf__string",
+ "locationName": "multiplexIds",
+ "documentation": "List of multiplex IDs"
}
},
- "documentation": "A request to create a multiplex.",
- "required": [
- "RequestId",
- "MultiplexSettings",
- "AvailabilityZones",
- "Name"
- ]
+ "documentation": "A request to delete resources"
},
- "CreateMultiplexResponse": {
+ "BatchDeleteResponse": {
"type": "structure",
"members": {
- "Multiplex": {
- "shape": "Multiplex",
- "locationName": "multiplex",
- "documentation": "The newly created multiplex."
+ "Failed": {
+ "shape": "__listOfBatchFailedResultModel",
+ "locationName": "failed",
+ "documentation": "List of failed operations"
+ },
+ "Successful": {
+ "shape": "__listOfBatchSuccessfulResultModel",
+ "locationName": "successful",
+ "documentation": "List of successful operations"
}
},
- "documentation": "Placeholder documentation for CreateMultiplexResponse"
+ "documentation": "Placeholder documentation for BatchDeleteResponse"
},
- "CreateMultiplexResultModel": {
+ "BatchDeleteResultModel": {
"type": "structure",
"members": {
- "Multiplex": {
- "shape": "Multiplex",
- "locationName": "multiplex",
- "documentation": "The newly created multiplex."
+ "Failed": {
+ "shape": "__listOfBatchFailedResultModel",
+ "locationName": "failed",
+ "documentation": "List of failed operations"
+ },
+ "Successful": {
+ "shape": "__listOfBatchSuccessfulResultModel",
+ "locationName": "successful",
+ "documentation": "List of successful operations"
}
},
- "documentation": "Placeholder documentation for CreateMultiplexResultModel"
+ "documentation": "Batch delete resource results"
},
- "CreatePartnerInput": {
+ "BatchFailedResultModel": {
"type": "structure",
"members": {
- "RequestId": {
+ "Arn": {
"shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.",
- "idempotencyToken": true
+ "locationName": "arn",
+ "documentation": "ARN of the resource"
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "Code": {
+ "shape": "__string",
+ "locationName": "code",
+ "documentation": "Error code for the failed operation"
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "ID of the resource"
+ },
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "Error message for the failed operation"
}
},
- "documentation": "Placeholder documentation for CreatePartnerInput"
+ "documentation": "Details from a failed operation"
},
- "CreatePartnerInputRequest": {
+ "BatchScheduleActionCreateRequest": {
"type": "structure",
"members": {
- "InputId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputId",
- "documentation": "Unique ID of the input."
- },
- "RequestId": {
- "shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.",
- "idempotencyToken": true
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "ScheduleActions": {
+ "shape": "__listOfScheduleAction",
+ "locationName": "scheduleActions",
+ "documentation": "A list of schedule actions to create."
}
},
- "documentation": "A request to create a partner input",
+ "documentation": "A list of schedule actions to create (in a request) or that have been created (in a response).",
"required": [
- "InputId"
+ "ScheduleActions"
]
},
- "CreatePartnerInputResponse": {
- "type": "structure",
- "members": {
- "Input": {
- "shape": "Input",
- "locationName": "input"
- }
- },
- "documentation": "Placeholder documentation for CreatePartnerInputResponse"
- },
- "CreatePartnerInputResultModel": {
+ "BatchScheduleActionCreateResult": {
"type": "structure",
"members": {
- "Input": {
- "shape": "Input",
- "locationName": "input"
+ "ScheduleActions": {
+ "shape": "__listOfScheduleAction",
+ "locationName": "scheduleActions",
+ "documentation": "List of actions that have been created in the schedule."
}
},
- "documentation": "Placeholder documentation for CreatePartnerInputResultModel"
+ "documentation": "List of actions that have been created in the schedule.",
+ "required": [
+ "ScheduleActions"
+ ]
},
- "CreateTagsRequest": {
+ "BatchScheduleActionDeleteRequest": {
"type": "structure",
"members": {
- "ResourceArn": {
- "shape": "__string",
- "location": "uri",
- "locationName": "resource-arn"
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags"
+ "ActionNames": {
+ "shape": "__listOf__string",
+ "locationName": "actionNames",
+ "documentation": "A list of schedule actions to delete."
}
},
+ "documentation": "A list of schedule actions to delete.",
"required": [
- "ResourceArn"
- ],
- "documentation": "Placeholder documentation for CreateTagsRequest"
+ "ActionNames"
+ ]
},
- "DeleteChannelRequest": {
+ "BatchScheduleActionDeleteResult": {
"type": "structure",
"members": {
- "ChannelId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "channelId",
- "documentation": "Unique ID of the channel."
+ "ScheduleActions": {
+ "shape": "__listOfScheduleAction",
+ "locationName": "scheduleActions",
+ "documentation": "List of actions that have been deleted from the schedule."
}
},
+ "documentation": "List of actions that have been deleted from the schedule.",
"required": [
- "ChannelId"
- ],
- "documentation": "Placeholder documentation for DeleteChannelRequest"
+ "ScheduleActions"
+ ]
},
- "DeleteChannelResponse": {
+ "BatchStart": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique arn of the channel."
- },
- "CdiInputSpecification": {
- "shape": "CdiInputSpecification",
- "locationName": "cdiInputSpecification",
- "documentation": "Specification of CDI inputs for this channel"
- },
- "ChannelClass": {
- "shape": "ChannelClass",
- "locationName": "channelClass",
- "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
- },
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
- },
- "EgressEndpoints": {
- "shape": "__listOfChannelEgressEndpoint",
- "locationName": "egressEndpoints",
- "documentation": "The endpoints where outgoing connections initiate from"
- },
- "EncoderSettings": {
- "shape": "EncoderSettings",
- "locationName": "encoderSettings"
- },
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique id of the channel."
- },
- "InputAttachments": {
- "shape": "__listOfInputAttachment",
- "locationName": "inputAttachments",
- "documentation": "List of input attachments for channel."
- },
- "InputSpecification": {
- "shape": "InputSpecification",
- "locationName": "inputSpecification",
- "documentation": "Specification of network and file inputs for this channel"
- },
- "LogLevel": {
- "shape": "LogLevel",
- "locationName": "logLevel",
- "documentation": "The log level being written to CloudWatch Logs."
- },
- "Maintenance": {
- "shape": "MaintenanceStatus",
- "locationName": "maintenance",
- "documentation": "Maintenance settings for this channel."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "The name of the channel. (user-mutable)"
- },
- "PipelineDetails": {
- "shape": "__listOfPipelineDetail",
- "locationName": "pipelineDetails",
- "documentation": "Runtime details for the pipelines of a running channel."
- },
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
- },
- "RoleArn": {
- "shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
- },
- "State": {
- "shape": "ChannelState",
- "locationName": "state"
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds",
+ "documentation": "List of channel IDs"
},
- "Vpc": {
- "shape": "VpcOutputSettingsDescription",
- "locationName": "vpc",
- "documentation": "Settings for VPC output"
+ "MultiplexIds": {
+ "shape": "__listOf__string",
+ "locationName": "multiplexIds",
+ "documentation": "List of multiplex IDs"
}
},
- "documentation": "Placeholder documentation for DeleteChannelResponse"
+ "documentation": "Batch start resource request"
},
- "DeleteInputRequest": {
+ "BatchStartRequest": {
"type": "structure",
"members": {
- "InputId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputId",
- "documentation": "Unique ID of the input"
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds",
+ "documentation": "List of channel IDs"
+ },
+ "MultiplexIds": {
+ "shape": "__listOf__string",
+ "locationName": "multiplexIds",
+ "documentation": "List of multiplex IDs"
}
},
- "required": [
- "InputId"
- ],
- "documentation": "Placeholder documentation for DeleteInputRequest"
+ "documentation": "A request to start resources"
},
- "DeleteInputResponse": {
+ "BatchStartResponse": {
"type": "structure",
"members": {
+ "Failed": {
+ "shape": "__listOfBatchFailedResultModel",
+ "locationName": "failed",
+ "documentation": "List of failed operations"
+ },
+ "Successful": {
+ "shape": "__listOfBatchSuccessfulResultModel",
+ "locationName": "successful",
+ "documentation": "List of successful operations"
+ }
},
- "documentation": "Placeholder documentation for DeleteInputResponse"
+ "documentation": "Placeholder documentation for BatchStartResponse"
},
- "DeleteInputSecurityGroupRequest": {
+ "BatchStartResultModel": {
"type": "structure",
"members": {
- "InputSecurityGroupId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputSecurityGroupId",
- "documentation": "The Input Security Group to delete"
+ "Failed": {
+ "shape": "__listOfBatchFailedResultModel",
+ "locationName": "failed",
+ "documentation": "List of failed operations"
+ },
+ "Successful": {
+ "shape": "__listOfBatchSuccessfulResultModel",
+ "locationName": "successful",
+ "documentation": "List of successful operations"
}
},
- "required": [
- "InputSecurityGroupId"
- ],
- "documentation": "Placeholder documentation for DeleteInputSecurityGroupRequest"
+ "documentation": "Batch start resource results"
},
- "DeleteInputSecurityGroupResponse": {
+ "BatchStop": {
"type": "structure",
"members": {
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds",
+ "documentation": "List of channel IDs"
+ },
+ "MultiplexIds": {
+ "shape": "__listOf__string",
+ "locationName": "multiplexIds",
+ "documentation": "List of multiplex IDs"
+ }
},
- "documentation": "Placeholder documentation for DeleteInputSecurityGroupResponse"
+ "documentation": "Batch stop resource request"
},
- "DeleteMultiplexProgramRequest": {
+ "BatchStopRequest": {
"type": "structure",
"members": {
- "MultiplexId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "multiplexId",
- "documentation": "The ID of the multiplex that the program belongs to."
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds",
+ "documentation": "List of channel IDs"
},
- "ProgramName": {
- "shape": "__string",
- "location": "uri",
- "locationName": "programName",
- "documentation": "The multiplex program name."
+ "MultiplexIds": {
+ "shape": "__listOf__string",
+ "locationName": "multiplexIds",
+ "documentation": "List of multiplex IDs"
}
},
- "required": [
- "MultiplexId",
- "ProgramName"
- ],
- "documentation": "Placeholder documentation for DeleteMultiplexProgramRequest"
+ "documentation": "A request to stop resources"
},
- "DeleteMultiplexProgramResponse": {
+ "BatchStopResponse": {
"type": "structure",
"members": {
- "ChannelId": {
- "shape": "__string",
- "locationName": "channelId",
- "documentation": "The MediaLive channel associated with the program."
- },
- "MultiplexProgramSettings": {
- "shape": "MultiplexProgramSettings",
- "locationName": "multiplexProgramSettings",
- "documentation": "The settings for this multiplex program."
- },
- "PacketIdentifiersMap": {
- "shape": "MultiplexProgramPacketIdentifiersMap",
- "locationName": "packetIdentifiersMap",
- "documentation": "The packet identifier map for this multiplex program."
- },
- "PipelineDetails": {
- "shape": "__listOfMultiplexProgramPipelineDetail",
- "locationName": "pipelineDetails",
- "documentation": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time."
+ "Failed": {
+ "shape": "__listOfBatchFailedResultModel",
+ "locationName": "failed",
+ "documentation": "List of failed operations"
},
- "ProgramName": {
- "shape": "__string",
- "locationName": "programName",
- "documentation": "The name of the multiplex program."
+ "Successful": {
+ "shape": "__listOfBatchSuccessfulResultModel",
+ "locationName": "successful",
+ "documentation": "List of successful operations"
}
},
- "documentation": "Placeholder documentation for DeleteMultiplexProgramResponse"
+ "documentation": "Placeholder documentation for BatchStopResponse"
},
- "DeleteMultiplexRequest": {
+ "BatchStopResultModel": {
"type": "structure",
"members": {
- "MultiplexId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "multiplexId",
- "documentation": "The ID of the multiplex."
+ "Failed": {
+ "shape": "__listOfBatchFailedResultModel",
+ "locationName": "failed",
+ "documentation": "List of failed operations"
+ },
+ "Successful": {
+ "shape": "__listOfBatchSuccessfulResultModel",
+ "locationName": "successful",
+ "documentation": "List of successful operations"
}
},
- "required": [
- "MultiplexId"
- ],
- "documentation": "Placeholder documentation for DeleteMultiplexRequest"
+ "documentation": "Batch stop resource results"
},
- "DeleteMultiplexResponse": {
+ "BatchSuccessfulResultModel": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
- "documentation": "The unique arn of the multiplex."
- },
- "AvailabilityZones": {
- "shape": "__listOf__string",
- "locationName": "availabilityZones",
- "documentation": "A list of availability zones for the multiplex."
- },
- "Destinations": {
- "shape": "__listOfMultiplexOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of the multiplex output destinations."
+ "documentation": "ARN of the resource"
},
"Id": {
"shape": "__string",
"locationName": "id",
- "documentation": "The unique id of the multiplex."
- },
- "MultiplexSettings": {
- "shape": "MultiplexSettings",
- "locationName": "multiplexSettings",
- "documentation": "Configuration for a multiplex event."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "The name of the multiplex."
- },
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
- },
- "ProgramCount": {
- "shape": "__integer",
- "locationName": "programCount",
- "documentation": "The number of programs in the multiplex."
+ "documentation": "ID of the resource"
},
"State": {
- "shape": "MultiplexState",
+ "shape": "__string",
"locationName": "state",
- "documentation": "The current state of the multiplex."
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "documentation": "Current state of the resource"
}
},
- "documentation": "Placeholder documentation for DeleteMultiplexResponse"
+ "documentation": "Details from a successful operation"
},
- "DeleteReservationRequest": {
+ "BatchUpdateScheduleRequest": {
"type": "structure",
"members": {
- "ReservationId": {
+ "ChannelId": {
"shape": "__string",
"location": "uri",
- "locationName": "reservationId",
- "documentation": "Unique reservation ID, e.g. '1234567'"
+ "locationName": "channelId",
+ "documentation": "Id of the channel whose schedule is being updated."
+ },
+ "Creates": {
+ "shape": "BatchScheduleActionCreateRequest",
+ "locationName": "creates",
+ "documentation": "Schedule actions to create in the schedule."
+ },
+ "Deletes": {
+ "shape": "BatchScheduleActionDeleteRequest",
+ "locationName": "deletes",
+ "documentation": "Schedule actions to delete from the schedule."
}
},
+ "documentation": "List of actions to create and list of actions to delete.",
"required": [
- "ReservationId"
- ],
- "documentation": "Placeholder documentation for DeleteReservationRequest"
+ "ChannelId"
+ ]
},
- "DeleteReservationResponse": {
+ "BatchUpdateScheduleResponse": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'"
- },
- "Count": {
- "shape": "__integer",
- "locationName": "count",
- "documentation": "Number of reserved resources"
- },
- "CurrencyCode": {
- "shape": "__string",
- "locationName": "currencyCode",
- "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
- },
- "Duration": {
- "shape": "__integer",
- "locationName": "duration",
- "documentation": "Lease duration, e.g. '12'"
- },
- "DurationUnits": {
- "shape": "OfferingDurationUnits",
- "locationName": "durationUnits",
- "documentation": "Units for duration, e.g. 'MONTHS'"
- },
- "End": {
- "shape": "__string",
- "locationName": "end",
- "documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'"
- },
- "FixedPrice": {
- "shape": "__double",
- "locationName": "fixedPrice",
- "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
+ "Creates": {
+ "shape": "BatchScheduleActionCreateResult",
+ "locationName": "creates",
+ "documentation": "Schedule actions created in the schedule."
},
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "User specified reservation name"
+ "Deletes": {
+ "shape": "BatchScheduleActionDeleteResult",
+ "locationName": "deletes",
+ "documentation": "Schedule actions deleted from the schedule."
+ }
+ },
+ "documentation": "Placeholder documentation for BatchUpdateScheduleResponse"
+ },
+ "BatchUpdateScheduleResult": {
+ "type": "structure",
+ "members": {
+ "Creates": {
+ "shape": "BatchScheduleActionCreateResult",
+ "locationName": "creates",
+ "documentation": "Schedule actions created in the schedule."
},
- "OfferingDescription": {
- "shape": "__string",
- "locationName": "offeringDescription",
- "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
+ "Deletes": {
+ "shape": "BatchScheduleActionDeleteResult",
+ "locationName": "deletes",
+ "documentation": "Schedule actions deleted from the schedule."
+ }
+ },
+ "documentation": "Results of a batch schedule update."
+ },
+ "BlackoutSlate": {
+ "type": "structure",
+ "members": {
+ "BlackoutSlateImage": {
+ "shape": "InputLocation",
+ "locationName": "blackoutSlateImage",
+ "documentation": "Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported."
},
- "OfferingId": {
- "shape": "__string",
- "locationName": "offeringId",
- "documentation": "Unique offering ID, e.g. '87654321'"
+ "NetworkEndBlackout": {
+ "shape": "BlackoutSlateNetworkEndBlackout",
+ "locationName": "networkEndBlackout",
+ "documentation": "Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the \"Network Blackout Image\" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in \"Network ID\"."
},
- "OfferingType": {
- "shape": "OfferingType",
- "locationName": "offeringType",
- "documentation": "Offering type, e.g. 'NO_UPFRONT'"
+ "NetworkEndBlackoutImage": {
+ "shape": "InputLocation",
+ "locationName": "networkEndBlackoutImage",
+ "documentation": "Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster."
},
- "Region": {
- "shape": "__string",
- "locationName": "region",
- "documentation": "AWS region, e.g. 'us-west-2'"
+ "NetworkId": {
+ "shape": "__stringMin34Max34",
+ "locationName": "networkId",
+ "documentation": "Provides Network ID that matches EIDR ID format (e.g., \"10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C\")."
},
- "RenewalSettings": {
- "shape": "RenewalSettings",
- "locationName": "renewalSettings",
- "documentation": "Renewal settings for the reservation"
+ "State": {
+ "shape": "BlackoutSlateState",
+ "locationName": "state",
+ "documentation": "When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata."
+ }
+ },
+ "documentation": "Blackout Slate"
+ },
+ "BlackoutSlateNetworkEndBlackout": {
+ "type": "string",
+ "documentation": "Blackout Slate Network End Blackout",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
+ },
+ "BlackoutSlateState": {
+ "type": "string",
+ "documentation": "Blackout Slate State",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
+ },
+ "BurnInAlignment": {
+ "type": "string",
+ "documentation": "Burn In Alignment",
+ "enum": [
+ "CENTERED",
+ "LEFT",
+ "SMART"
+ ]
+ },
+ "BurnInBackgroundColor": {
+ "type": "string",
+ "documentation": "Burn In Background Color",
+ "enum": [
+ "BLACK",
+ "NONE",
+ "WHITE"
+ ]
+ },
+ "BurnInDestinationSettings": {
+ "type": "structure",
+ "members": {
+ "Alignment": {
+ "shape": "BurnInAlignment",
+ "locationName": "alignment",
+ "documentation": "If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting \"smart\" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match."
},
- "ReservationId": {
- "shape": "__string",
- "locationName": "reservationId",
- "documentation": "Unique reservation ID, e.g. '1234567'"
+ "BackgroundColor": {
+ "shape": "BurnInBackgroundColor",
+ "locationName": "backgroundColor",
+ "documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match."
},
- "ResourceSpecification": {
- "shape": "ReservationResourceSpecification",
- "locationName": "resourceSpecification",
- "documentation": "Resource configuration details"
+ "BackgroundOpacity": {
+ "shape": "__integerMin0Max255",
+ "locationName": "backgroundOpacity",
+ "documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
},
- "Start": {
+ "Font": {
+ "shape": "InputLocation",
+ "locationName": "font",
+ "documentation": "External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match."
+ },
+ "FontColor": {
+ "shape": "BurnInFontColor",
+ "locationName": "fontColor",
+ "documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ },
+ "FontOpacity": {
+ "shape": "__integerMin0Max255",
+ "locationName": "fontOpacity",
+ "documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match."
+ },
+ "FontResolution": {
+ "shape": "__integerMin96Max600",
+ "locationName": "fontResolution",
+ "documentation": "Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match."
+ },
+ "FontSize": {
"shape": "__string",
- "locationName": "start",
- "documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'"
+ "locationName": "fontSize",
+ "documentation": "When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match."
},
- "State": {
- "shape": "ReservationState",
- "locationName": "state",
- "documentation": "Current state of reservation, e.g. 'ACTIVE'"
+ "OutlineColor": {
+ "shape": "BurnInOutlineColor",
+ "locationName": "outlineColor",
+ "documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs"
+ "OutlineSize": {
+ "shape": "__integerMin0Max10",
+ "locationName": "outlineSize",
+ "documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
},
- "UsagePrice": {
- "shape": "__double",
- "locationName": "usagePrice",
- "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
+ "ShadowColor": {
+ "shape": "BurnInShadowColor",
+ "locationName": "shadowColor",
+ "documentation": "Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match."
+ },
+ "ShadowOpacity": {
+ "shape": "__integerMin0Max255",
+ "locationName": "shadowOpacity",
+ "documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
+ },
+ "ShadowXOffset": {
+ "shape": "__integer",
+ "locationName": "shadowXOffset",
+ "documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match."
+ },
+ "ShadowYOffset": {
+ "shape": "__integer",
+ "locationName": "shadowYOffset",
+ "documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match."
+ },
+ "TeletextGridControl": {
+ "shape": "BurnInTeletextGridControl",
+ "locationName": "teletextGridControl",
+ "documentation": "Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs."
+ },
+ "XPosition": {
+ "shape": "__integerMin0",
+ "locationName": "xPosition",
+ "documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match."
+ },
+ "YPosition": {
+ "shape": "__integerMin0",
+ "locationName": "yPosition",
+ "documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match."
}
},
- "documentation": "Placeholder documentation for DeleteReservationResponse"
+ "documentation": "Burn In Destination Settings"
},
- "DeleteScheduleRequest": {
+ "BurnInFontColor": {
+ "type": "string",
+ "documentation": "Burn In Font Color",
+ "enum": [
+ "BLACK",
+ "BLUE",
+ "GREEN",
+ "RED",
+ "WHITE",
+ "YELLOW"
+ ]
+ },
+ "BurnInOutlineColor": {
+ "type": "string",
+ "documentation": "Burn In Outline Color",
+ "enum": [
+ "BLACK",
+ "BLUE",
+ "GREEN",
+ "RED",
+ "WHITE",
+ "YELLOW"
+ ]
+ },
+ "BurnInShadowColor": {
+ "type": "string",
+ "documentation": "Burn In Shadow Color",
+ "enum": [
+ "BLACK",
+ "NONE",
+ "WHITE"
+ ]
+ },
+ "BurnInTeletextGridControl": {
+ "type": "string",
+ "documentation": "Burn In Teletext Grid Control",
+ "enum": [
+ "FIXED",
+ "SCALED"
+ ]
+ },
+ "CancelInputDeviceTransferRequest": {
"type": "structure",
"members": {
- "ChannelId": {
+ "InputDeviceId": {
"shape": "__string",
"location": "uri",
- "locationName": "channelId",
- "documentation": "Id of the channel whose schedule is being deleted."
+ "locationName": "inputDeviceId",
+ "documentation": "The unique ID of the input device to cancel. For example, hd-123456789abcdef."
}
},
"required": [
- "ChannelId"
+ "InputDeviceId"
],
- "documentation": "Placeholder documentation for DeleteScheduleRequest"
+ "documentation": "Placeholder documentation for CancelInputDeviceTransferRequest"
},
- "DeleteScheduleResponse": {
+ "CancelInputDeviceTransferResponse": {
"type": "structure",
"members": {
},
- "documentation": "Placeholder documentation for DeleteScheduleResponse"
+ "documentation": "Placeholder documentation for CancelInputDeviceTransferResponse"
},
- "DeleteTagsRequest": {
+ "CaptionDescription": {
"type": "structure",
"members": {
- "ResourceArn": {
+ "Accessibility": {
+ "shape": "AccessibilityType",
+ "locationName": "accessibility",
+ "documentation": "Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group."
+ },
+ "CaptionSelectorName": {
"shape": "__string",
- "location": "uri",
- "locationName": "resource-arn"
+ "locationName": "captionSelectorName",
+ "documentation": "Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name."
},
- "TagKeys": {
- "shape": "__listOf__string",
- "location": "querystring",
- "locationName": "tagKeys",
- "documentation": "An array of tag keys to delete"
+ "DestinationSettings": {
+ "shape": "CaptionDestinationSettings",
+ "locationName": "destinationSettings",
+ "documentation": "Additional settings for captions destination that depend on the destination type."
+ },
+ "LanguageCode": {
+ "shape": "__string",
+ "locationName": "languageCode",
+ "documentation": "ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/"
+ },
+ "LanguageDescription": {
+ "shape": "__string",
+ "locationName": "languageDescription",
+ "documentation": "Human readable information to indicate captions available for players (eg. English, or Spanish)."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event."
+ },
+ "CaptionDashRoles": {
+ "shape": "__listOfDashRoleCaption",
+ "locationName": "captionDashRoles",
+ "documentation": "Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling."
+ },
+ "DvbDashAccessibility": {
+ "shape": "DvbDashAccessibility",
+ "locationName": "dvbDashAccessibility",
+ "documentation": "Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers."
}
},
+ "documentation": "Caption Description",
"required": [
- "TagKeys",
- "ResourceArn"
- ],
- "documentation": "Placeholder documentation for DeleteTagsRequest"
+ "CaptionSelectorName",
+ "Name"
+ ]
},
- "DescribeAccountConfigurationRequest": {
+ "CaptionDestinationSettings": {
"type": "structure",
"members": {
+ "AribDestinationSettings": {
+ "shape": "AribDestinationSettings",
+ "locationName": "aribDestinationSettings"
+ },
+ "BurnInDestinationSettings": {
+ "shape": "BurnInDestinationSettings",
+ "locationName": "burnInDestinationSettings"
+ },
+ "DvbSubDestinationSettings": {
+ "shape": "DvbSubDestinationSettings",
+ "locationName": "dvbSubDestinationSettings"
+ },
+ "EbuTtDDestinationSettings": {
+ "shape": "EbuTtDDestinationSettings",
+ "locationName": "ebuTtDDestinationSettings"
+ },
+ "EmbeddedDestinationSettings": {
+ "shape": "EmbeddedDestinationSettings",
+ "locationName": "embeddedDestinationSettings"
+ },
+ "EmbeddedPlusScte20DestinationSettings": {
+ "shape": "EmbeddedPlusScte20DestinationSettings",
+ "locationName": "embeddedPlusScte20DestinationSettings"
+ },
+ "RtmpCaptionInfoDestinationSettings": {
+ "shape": "RtmpCaptionInfoDestinationSettings",
+ "locationName": "rtmpCaptionInfoDestinationSettings"
+ },
+ "Scte20PlusEmbeddedDestinationSettings": {
+ "shape": "Scte20PlusEmbeddedDestinationSettings",
+ "locationName": "scte20PlusEmbeddedDestinationSettings"
+ },
+ "Scte27DestinationSettings": {
+ "shape": "Scte27DestinationSettings",
+ "locationName": "scte27DestinationSettings"
+ },
+ "SmpteTtDestinationSettings": {
+ "shape": "SmpteTtDestinationSettings",
+ "locationName": "smpteTtDestinationSettings"
+ },
+ "TeletextDestinationSettings": {
+ "shape": "TeletextDestinationSettings",
+ "locationName": "teletextDestinationSettings"
+ },
+ "TtmlDestinationSettings": {
+ "shape": "TtmlDestinationSettings",
+ "locationName": "ttmlDestinationSettings"
+ },
+ "WebvttDestinationSettings": {
+ "shape": "WebvttDestinationSettings",
+ "locationName": "webvttDestinationSettings"
+ }
},
- "documentation": "Placeholder documentation for DescribeAccountConfigurationRequest"
+ "documentation": "Caption Destination Settings"
},
- "DescribeAccountConfigurationResponse": {
+ "CaptionLanguageMapping": {
"type": "structure",
"members": {
- "AccountConfiguration": {
- "shape": "AccountConfiguration",
- "locationName": "accountConfiguration"
+ "CaptionChannel": {
+ "shape": "__integerMin1Max4",
+ "locationName": "captionChannel",
+ "documentation": "The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)"
+ },
+ "LanguageCode": {
+ "shape": "__stringMin3Max3",
+ "locationName": "languageCode",
+ "documentation": "Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)"
+ },
+ "LanguageDescription": {
+ "shape": "__stringMin1",
+ "locationName": "languageDescription",
+ "documentation": "Textual description of language"
}
},
- "documentation": "Placeholder documentation for DescribeAccountConfigurationResponse"
+ "documentation": "Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.",
+ "required": [
+ "LanguageCode",
+ "LanguageDescription",
+ "CaptionChannel"
+ ]
},
- "DescribeAccountConfigurationResultModel": {
+ "CaptionRectangle": {
"type": "structure",
"members": {
- "AccountConfiguration": {
- "shape": "AccountConfiguration",
- "locationName": "accountConfiguration"
+ "Height": {
+ "shape": "__doubleMin0Max100",
+ "locationName": "height",
+ "documentation": "See the description in leftOffset.\nFor height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \\\"80\\\" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less.\nThis field corresponds to tts:extent - Y in the TTML standard."
+ },
+ "LeftOffset": {
+ "shape": "__doubleMin0Max100",
+ "locationName": "leftOffset",
+ "documentation": "Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages.\nIf you specify a value for one of these fields, you must specify a value for all of them.\nFor leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \\\"10\\\" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame.\nThis field corresponds to tts:origin - X in the TTML standard."
+ },
+ "TopOffset": {
+ "shape": "__doubleMin0Max100",
+ "locationName": "topOffset",
+ "documentation": "See the description in leftOffset.\nFor topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \\\"10\\\" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame.\nThis field corresponds to tts:origin - Y in the TTML standard."
+ },
+ "Width": {
+ "shape": "__doubleMin0Max100",
+ "locationName": "width",
+ "documentation": "See the description in leftOffset.\nFor width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \\\"80\\\" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less.\nThis field corresponds to tts:extent - X in the TTML standard."
}
},
- "documentation": "The account's configuration."
+ "documentation": "Caption Rectangle",
+ "required": [
+ "TopOffset",
+ "Height",
+ "Width",
+ "LeftOffset"
+ ]
},
- "DescribeChannelRequest": {
+ "CaptionSelector": {
"type": "structure",
"members": {
- "ChannelId": {
+ "LanguageCode": {
"shape": "__string",
- "location": "uri",
- "locationName": "channelId",
- "documentation": "channel ID"
+ "locationName": "languageCode",
+ "documentation": "When specified this field indicates the three letter language code of the caption track to extract from the source."
+ },
+ "Name": {
+ "shape": "__stringMin1",
+ "locationName": "name",
+ "documentation": "Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event."
+ },
+ "SelectorSettings": {
+ "shape": "CaptionSelectorSettings",
+ "locationName": "selectorSettings",
+ "documentation": "Caption selector settings."
}
},
+ "documentation": "Caption Selector",
"required": [
- "ChannelId"
- ],
- "documentation": "Placeholder documentation for DescribeChannelRequest"
+ "Name"
+ ]
},
- "DescribeChannelResponse": {
+ "CaptionSelectorSettings": {
+ "type": "structure",
+ "members": {
+ "AncillarySourceSettings": {
+ "shape": "AncillarySourceSettings",
+ "locationName": "ancillarySourceSettings"
+ },
+ "AribSourceSettings": {
+ "shape": "AribSourceSettings",
+ "locationName": "aribSourceSettings"
+ },
+ "DvbSubSourceSettings": {
+ "shape": "DvbSubSourceSettings",
+ "locationName": "dvbSubSourceSettings"
+ },
+ "EmbeddedSourceSettings": {
+ "shape": "EmbeddedSourceSettings",
+ "locationName": "embeddedSourceSettings"
+ },
+ "Scte20SourceSettings": {
+ "shape": "Scte20SourceSettings",
+ "locationName": "scte20SourceSettings"
+ },
+ "Scte27SourceSettings": {
+ "shape": "Scte27SourceSettings",
+ "locationName": "scte27SourceSettings"
+ },
+ "TeletextSourceSettings": {
+ "shape": "TeletextSourceSettings",
+ "locationName": "teletextSourceSettings"
+ }
+ },
+ "documentation": "Caption Selector Settings"
+ },
+ "CdiInputResolution": {
+ "type": "string",
+ "documentation": "Maximum CDI input resolution; SD is 480i and 576i up to 30 frames-per-second (fps), HD is 720p up to 60 fps / 1080i up to 30 fps, FHD is 1080p up to 60 fps, UHD is 2160p up to 60 fps",
+ "enum": [
+ "SD",
+ "HD",
+ "FHD",
+ "UHD"
+ ]
+ },
+ "CdiInputSpecification": {
+ "type": "structure",
+ "members": {
+ "Resolution": {
+ "shape": "CdiInputResolution",
+ "locationName": "resolution",
+ "documentation": "Maximum CDI input resolution"
+ }
+ },
+ "documentation": "Placeholder documentation for CdiInputSpecification"
+ },
+ "Channel": {
"type": "structure",
"members": {
"Arn": {
@@ -7406,9611 +7015,9479 @@
"shape": "VpcOutputSettingsDescription",
"locationName": "vpc",
"documentation": "Settings for VPC output"
+ },
+ "AnywhereSettings": {
+ "shape": "DescribeAnywhereSettings",
+ "locationName": "anywhereSettings",
+ "documentation": "Anywhere settings for this channel."
}
},
- "documentation": "Placeholder documentation for DescribeChannelResponse"
+ "documentation": "Placeholder documentation for Channel"
},
- "DescribeInputDeviceRequest": {
+ "ChannelClass": {
+ "type": "string",
+ "documentation": "A standard channel has two encoding pipelines and a single pipeline channel only has one.",
+ "enum": [
+ "STANDARD",
+ "SINGLE_PIPELINE"
+ ]
+ },
+ "ChannelConfigurationValidationError": {
"type": "structure",
"members": {
- "InputDeviceId": {
+ "Message": {
"shape": "__string",
- "location": "uri",
- "locationName": "inputDeviceId",
- "documentation": "The unique ID of this input device. For example, hd-123456789abcdef."
+ "locationName": "message"
+ },
+ "ValidationErrors": {
+ "shape": "__listOfValidationError",
+ "locationName": "validationErrors",
+ "documentation": "A collection of validation error responses."
}
},
- "required": [
- "InputDeviceId"
+ "documentation": "Placeholder documentation for ChannelConfigurationValidationError"
+ },
+ "ChannelEgressEndpoint": {
+ "type": "structure",
+ "members": {
+ "SourceIp": {
+ "shape": "__string",
+ "locationName": "sourceIp",
+ "documentation": "Public IP of where a channel's output comes from"
+ }
+ },
+ "documentation": "Placeholder documentation for ChannelEgressEndpoint"
+ },
+ "ChannelState": {
+ "type": "string",
+ "enum": [
+ "CREATING",
+ "CREATE_FAILED",
+ "IDLE",
+ "STARTING",
+ "RUNNING",
+ "RECOVERING",
+ "STOPPING",
+ "DELETING",
+ "DELETED",
+ "UPDATING",
+ "UPDATE_FAILED"
],
- "documentation": "Placeholder documentation for DescribeInputDeviceRequest"
+ "documentation": "Placeholder documentation for ChannelState"
},
- "DescribeInputDeviceResponse": {
+ "ChannelSummary": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
- "documentation": "The unique ARN of the input device."
+ "documentation": "The unique arn of the channel."
},
- "ConnectionState": {
- "shape": "InputDeviceConnectionState",
- "locationName": "connectionState",
- "documentation": "The state of the connection between the input device and AWS."
+ "CdiInputSpecification": {
+ "shape": "CdiInputSpecification",
+ "locationName": "cdiInputSpecification",
+ "documentation": "Specification of CDI inputs for this channel"
},
- "DeviceSettingsSyncState": {
- "shape": "DeviceSettingsSyncState",
- "locationName": "deviceSettingsSyncState",
- "documentation": "The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration."
+ "ChannelClass": {
+ "shape": "ChannelClass",
+ "locationName": "channelClass",
+ "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
},
- "DeviceUpdateStatus": {
- "shape": "DeviceUpdateStatus",
- "locationName": "deviceUpdateStatus",
- "documentation": "The status of software on the input device."
+ "Destinations": {
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
},
- "HdDeviceSettings": {
- "shape": "InputDeviceHdSettings",
- "locationName": "hdDeviceSettings",
- "documentation": "Settings that describe an input device that is type HD."
+ "EgressEndpoints": {
+ "shape": "__listOfChannelEgressEndpoint",
+ "locationName": "egressEndpoints",
+ "documentation": "The endpoints where outgoing connections initiate from"
},
"Id": {
"shape": "__string",
"locationName": "id",
- "documentation": "The unique ID of the input device."
+ "documentation": "The unique id of the channel."
},
- "MacAddress": {
- "shape": "__string",
- "locationName": "macAddress",
- "documentation": "The network MAC address of the input device."
+ "InputAttachments": {
+ "shape": "__listOfInputAttachment",
+ "locationName": "inputAttachments",
+ "documentation": "List of input attachments for channel."
+ },
+ "InputSpecification": {
+ "shape": "InputSpecification",
+ "locationName": "inputSpecification",
+ "documentation": "Specification of network and file inputs for this channel"
+ },
+ "LogLevel": {
+ "shape": "LogLevel",
+ "locationName": "logLevel",
+ "documentation": "The log level being written to CloudWatch Logs."
+ },
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
},
"Name": {
"shape": "__string",
"locationName": "name",
- "documentation": "A name that you specify for the input device."
+ "documentation": "The name of the channel. (user-mutable)"
},
- "NetworkSettings": {
- "shape": "InputDeviceNetworkSettings",
- "locationName": "networkSettings",
- "documentation": "The network settings for the input device."
+ "PipelinesRunningCount": {
+ "shape": "__integer",
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
},
- "SerialNumber": {
+ "RoleArn": {
"shape": "__string",
- "locationName": "serialNumber",
- "documentation": "The unique serial number of the input device."
- },
- "Type": {
- "shape": "InputDeviceType",
- "locationName": "type",
- "documentation": "The type of the input device."
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
},
- "UhdDeviceSettings": {
- "shape": "InputDeviceUhdSettings",
- "locationName": "uhdDeviceSettings",
- "documentation": "Settings that describe an input device that is type UHD."
+ "State": {
+ "shape": "ChannelState",
+ "locationName": "state"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
},
- "AvailabilityZone": {
- "shape": "__string",
- "locationName": "availabilityZone",
- "documentation": "The Availability Zone associated with this input device."
- },
- "MedialiveInputArns": {
- "shape": "__listOf__string",
- "locationName": "medialiveInputArns",
- "documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT."
+ "Vpc": {
+ "shape": "VpcOutputSettingsDescription",
+ "locationName": "vpc",
+ "documentation": "Settings for any VPC outputs."
},
- "OutputType": {
- "shape": "InputDeviceOutputType",
- "locationName": "outputType",
- "documentation": "The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input."
+ "AnywhereSettings": {
+ "shape": "DescribeAnywhereSettings",
+ "locationName": "anywhereSettings",
+ "documentation": "AnywhereSettings settings for this channel."
}
},
- "documentation": "Placeholder documentation for DescribeInputDeviceResponse"
+ "documentation": "Placeholder documentation for ChannelSummary"
},
- "DescribeInputDeviceThumbnailRequest": {
+ "ClaimDeviceRequest": {
"type": "structure",
"members": {
- "InputDeviceId": {
+ "Id": {
"shape": "__string",
- "location": "uri",
- "locationName": "inputDeviceId",
- "documentation": "The unique ID of this input device. For example, hd-123456789abcdef."
- },
- "Accept": {
- "shape": "AcceptHeader",
- "location": "header",
- "locationName": "accept",
- "documentation": "The HTTP Accept header. Indicates the requested type for the thumbnail."
+ "locationName": "id",
+ "documentation": "The id of the device you want to claim."
}
},
- "required": [
- "InputDeviceId",
- "Accept"
- ],
- "documentation": "Placeholder documentation for DescribeInputDeviceThumbnailRequest"
+ "documentation": "A request to claim an AWS Elemental device that you have purchased from a third-party vendor."
},
- "DescribeInputDeviceThumbnailResponse": {
+ "ClaimDeviceResponse": {
"type": "structure",
"members": {
- "Body": {
- "shape": "InputDeviceThumbnail",
- "locationName": "body",
- "documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive."
- },
- "ContentType": {
- "shape": "ContentType",
- "location": "header",
- "locationName": "Content-Type",
- "documentation": "Specifies the media type of the thumbnail."
+ },
+ "documentation": "Placeholder documentation for ClaimDeviceResponse"
+ },
+ "ColorCorrection": {
+ "type": "structure",
+ "members": {
+ "InputColorSpace": {
+ "shape": "ColorSpace",
+ "locationName": "inputColorSpace",
+ "documentation": "The color space of the input."
},
- "ContentLength": {
- "shape": "__long",
- "location": "header",
- "locationName": "Content-Length",
- "documentation": "The length of the content."
+ "OutputColorSpace": {
+ "shape": "ColorSpace",
+ "locationName": "outputColorSpace",
+ "documentation": "The color space of the output."
},
- "ETag": {
+ "Uri": {
"shape": "__string",
- "location": "header",
- "locationName": "ETag",
- "documentation": "The unique, cacheable version of this thumbnail."
- },
- "LastModified": {
- "shape": "__timestamp",
- "location": "header",
- "locationName": "Last-Modified",
- "documentation": "The date and time the thumbnail was last updated at the device."
+ "locationName": "uri",
+ "documentation": "The URI of the 3D LUT file. The protocol must be 's3:' or 's3ssl:':."
}
},
- "documentation": "Placeholder documentation for DescribeInputDeviceThumbnailResponse",
- "payload": "Body"
+ "documentation": "Property of ColorCorrectionSettings. Used for custom color space conversion. The object identifies one 3D LUT file and specifies the input/output color space combination that the file will be used for.",
+ "required": [
+ "OutputColorSpace",
+ "InputColorSpace",
+ "Uri"
+ ]
},
- "DescribeInputRequest": {
+ "ColorCorrectionSettings": {
"type": "structure",
"members": {
- "InputId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputId",
- "documentation": "Unique ID of the input"
+ "GlobalColorCorrections": {
+ "shape": "__listOfColorCorrection",
+ "locationName": "globalColorCorrections",
+ "documentation": "An array of colorCorrections that applies when you are using 3D LUT files to perform color conversion on video. Each colorCorrection contains one 3D LUT file (that defines the color mapping for converting an input color space to an output color space), and the input/output combination that this 3D LUT file applies to. MediaLive reads the color space in the input metadata, determines the color space that you have specified for the output, and finds and uses the LUT file that applies to this combination."
}
},
+ "documentation": "Property of encoderSettings. Controls color conversion when you are using 3D LUT files to perform color conversion on video.",
"required": [
- "InputId"
- ],
- "documentation": "Placeholder documentation for DescribeInputRequest"
+ "GlobalColorCorrections"
+ ]
},
- "DescribeInputResponse": {
+ "ColorSpace": {
+ "type": "string",
+ "documentation": "Property of colorCorrections. When you are using 3D LUT files to perform color conversion on video, these are the supported color spaces.",
+ "enum": [
+ "HDR10",
+ "HLG_2020",
+ "REC_601",
+ "REC_709"
+ ]
+ },
+ "ColorSpacePassthroughSettings": {
"type": "structure",
"members": {
- "Arn": {
+ },
+ "documentation": "Passthrough applies no color space conversion to the output"
+ },
+ "ConflictException": {
+ "type": "structure",
+ "members": {
+ "Message": {
"shape": "__string",
- "locationName": "arn",
- "documentation": "The Unique ARN of the input (generated, immutable)."
+ "locationName": "message"
+ }
+ },
+ "exception": true,
+ "error": {
+ "httpStatusCode": 409
+ },
+ "documentation": "Placeholder documentation for ConflictException"
+ },
+ "CreateChannel": {
+ "type": "structure",
+ "members": {
+ "CdiInputSpecification": {
+ "shape": "CdiInputSpecification",
+ "locationName": "cdiInputSpecification",
+ "documentation": "Specification of CDI inputs for this channel"
},
- "AttachedChannels": {
- "shape": "__listOf__string",
- "locationName": "attachedChannels",
- "documentation": "A list of channel IDs that that input is attached to (currently an input can only be attached to one channel)."
+ "ChannelClass": {
+ "shape": "ChannelClass",
+ "locationName": "channelClass",
+ "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
},
"Destinations": {
- "shape": "__listOfInputDestination",
- "locationName": "destinations",
- "documentation": "A list of the destinations of the input (PUSH-type)."
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations"
},
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The generated ID of the input (unique for user account, immutable)."
+ "EncoderSettings": {
+ "shape": "EncoderSettings",
+ "locationName": "encoderSettings"
},
- "InputClass": {
- "shape": "InputClass",
- "locationName": "inputClass",
- "documentation": "STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.\nSINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input."
- },
- "InputDevices": {
- "shape": "__listOfInputDeviceSettings",
- "locationName": "inputDevices",
- "documentation": "Settings for the input devices."
+ "InputAttachments": {
+ "shape": "__listOfInputAttachment",
+ "locationName": "inputAttachments",
+ "documentation": "List of input attachments for channel."
},
- "InputPartnerIds": {
- "shape": "__listOf__string",
- "locationName": "inputPartnerIds",
- "documentation": "A list of IDs for all Inputs which are partners of this one."
+ "InputSpecification": {
+ "shape": "InputSpecification",
+ "locationName": "inputSpecification",
+ "documentation": "Specification of network and file inputs for this channel"
},
- "InputSourceType": {
- "shape": "InputSourceType",
- "locationName": "inputSourceType",
- "documentation": "Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes\nduring input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs."
+ "LogLevel": {
+ "shape": "LogLevel",
+ "locationName": "logLevel",
+ "documentation": "The log level to write to CloudWatch Logs."
},
- "MediaConnectFlows": {
- "shape": "__listOfMediaConnectFlow",
- "locationName": "mediaConnectFlows",
- "documentation": "A list of MediaConnect Flows for this input."
+ "Maintenance": {
+ "shape": "MaintenanceCreateSettings",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
},
"Name": {
"shape": "__string",
"locationName": "name",
- "documentation": "The user-assigned name (This is a mutable value)."
+ "documentation": "Name of channel."
},
- "RoleArn": {
+ "RequestId": {
"shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
- },
- "SecurityGroups": {
- "shape": "__listOf__string",
- "locationName": "securityGroups",
- "documentation": "A list of IDs for all the Input Security Groups attached to the input."
+ "locationName": "requestId",
+ "documentation": "Unique request ID to be specified. This is needed to prevent retries from\ncreating multiple resources.",
+ "idempotencyToken": true
},
- "Sources": {
- "shape": "__listOfInputSource",
- "locationName": "sources",
- "documentation": "A list of the sources of the input (PULL-type)."
+ "Reserved": {
+ "shape": "__string",
+ "locationName": "reserved",
+ "documentation": "Deprecated field that's only usable by whitelisted customers.",
+ "deprecated": true
},
- "State": {
- "shape": "InputState",
- "locationName": "state"
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel."
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
},
- "Type": {
- "shape": "InputType",
- "locationName": "type"
+ "Vpc": {
+ "shape": "VpcOutputSettings",
+ "locationName": "vpc",
+ "documentation": "Settings for the VPC outputs"
},
- "SrtSettings": {
- "shape": "SrtSettings",
- "locationName": "srtSettings",
- "documentation": "The settings associated with an SRT input."
- }
- },
- "documentation": "Placeholder documentation for DescribeInputResponse"
- },
- "DescribeInputSecurityGroupRequest": {
- "type": "structure",
- "members": {
- "InputSecurityGroupId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputSecurityGroupId",
- "documentation": "The id of the Input Security Group to describe"
+ "AnywhereSettings": {
+ "shape": "AnywhereSettings",
+ "locationName": "anywhereSettings",
+ "documentation": "The Elemental Anywhere settings for this channel."
}
},
- "required": [
- "InputSecurityGroupId"
- ],
- "documentation": "Placeholder documentation for DescribeInputSecurityGroupRequest"
+ "documentation": "Placeholder documentation for CreateChannel"
},
- "DescribeInputSecurityGroupResponse": {
+ "CreateChannelRequest": {
"type": "structure",
"members": {
- "Arn": {
+ "CdiInputSpecification": {
+ "shape": "CdiInputSpecification",
+ "locationName": "cdiInputSpecification",
+ "documentation": "Specification of CDI inputs for this channel"
+ },
+ "ChannelClass": {
+ "shape": "ChannelClass",
+ "locationName": "channelClass",
+ "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
+ },
+ "Destinations": {
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations"
+ },
+ "EncoderSettings": {
+ "shape": "EncoderSettings",
+ "locationName": "encoderSettings"
+ },
+ "InputAttachments": {
+ "shape": "__listOfInputAttachment",
+ "locationName": "inputAttachments",
+ "documentation": "List of input attachments for channel."
+ },
+ "InputSpecification": {
+ "shape": "InputSpecification",
+ "locationName": "inputSpecification",
+ "documentation": "Specification of network and file inputs for this channel"
+ },
+ "LogLevel": {
+ "shape": "LogLevel",
+ "locationName": "logLevel",
+ "documentation": "The log level to write to CloudWatch Logs."
+ },
+ "Maintenance": {
+ "shape": "MaintenanceCreateSettings",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
+ "Name": {
"shape": "__string",
- "locationName": "arn",
- "documentation": "Unique ARN of Input Security Group"
+ "locationName": "name",
+ "documentation": "Name of channel."
},
- "Id": {
+ "RequestId": {
"shape": "__string",
- "locationName": "id",
- "documentation": "The Id of the Input Security Group"
+ "locationName": "requestId",
+ "documentation": "Unique request ID to be specified. This is needed to prevent retries from\ncreating multiple resources.",
+ "idempotencyToken": true
},
- "Inputs": {
- "shape": "__listOf__string",
- "locationName": "inputs",
- "documentation": "The list of inputs currently using this Input Security Group."
+ "Reserved": {
+ "shape": "__string",
+ "locationName": "reserved",
+ "documentation": "Deprecated field that's only usable by whitelisted customers.",
+ "deprecated": true
},
- "State": {
- "shape": "InputSecurityGroupState",
- "locationName": "state",
- "documentation": "The current state of the Input Security Group."
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel."
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
},
- "WhitelistRules": {
- "shape": "__listOfInputWhitelistRule",
- "locationName": "whitelistRules",
- "documentation": "Whitelist rules and their sync status"
- }
- },
- "documentation": "Placeholder documentation for DescribeInputSecurityGroupResponse"
- },
- "DescribeMultiplexProgramRequest": {
- "type": "structure",
- "members": {
- "MultiplexId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "multiplexId",
- "documentation": "The ID of the multiplex that the program belongs to."
+ "Vpc": {
+ "shape": "VpcOutputSettings",
+ "locationName": "vpc",
+ "documentation": "Settings for the VPC outputs"
},
- "ProgramName": {
- "shape": "__string",
- "location": "uri",
- "locationName": "programName",
- "documentation": "The name of the program."
+ "AnywhereSettings": {
+ "shape": "AnywhereSettings",
+ "locationName": "anywhereSettings",
+ "documentation": "The Elemental Anywhere settings for this channel."
}
},
- "required": [
- "MultiplexId",
- "ProgramName"
- ],
- "documentation": "Placeholder documentation for DescribeMultiplexProgramRequest"
+ "documentation": "A request to create a channel"
},
- "DescribeMultiplexProgramResponse": {
+ "CreateChannelResponse": {
"type": "structure",
"members": {
- "ChannelId": {
- "shape": "__string",
- "locationName": "channelId",
- "documentation": "The MediaLive channel associated with the program."
- },
- "MultiplexProgramSettings": {
- "shape": "MultiplexProgramSettings",
- "locationName": "multiplexProgramSettings",
- "documentation": "The settings for this multiplex program."
- },
- "PacketIdentifiersMap": {
- "shape": "MultiplexProgramPacketIdentifiersMap",
- "locationName": "packetIdentifiersMap",
- "documentation": "The packet identifier map for this multiplex program."
- },
- "PipelineDetails": {
- "shape": "__listOfMultiplexProgramPipelineDetail",
- "locationName": "pipelineDetails",
- "documentation": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time."
- },
- "ProgramName": {
- "shape": "__string",
- "locationName": "programName",
- "documentation": "The name of the multiplex program."
+ "Channel": {
+ "shape": "Channel",
+ "locationName": "channel"
}
},
- "documentation": "Placeholder documentation for DescribeMultiplexProgramResponse"
+ "documentation": "Placeholder documentation for CreateChannelResponse"
},
- "DescribeMultiplexRequest": {
+ "CreateChannelResultModel": {
"type": "structure",
"members": {
- "MultiplexId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "multiplexId",
- "documentation": "The ID of the multiplex."
+ "Channel": {
+ "shape": "Channel",
+ "locationName": "channel"
}
},
- "required": [
- "MultiplexId"
- ],
- "documentation": "Placeholder documentation for DescribeMultiplexRequest"
+ "documentation": "Placeholder documentation for CreateChannelResultModel"
},
- "DescribeMultiplexResponse": {
+ "CreateInput": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique arn of the multiplex."
- },
- "AvailabilityZones": {
- "shape": "__listOf__string",
- "locationName": "availabilityZones",
- "documentation": "A list of availability zones for the multiplex."
- },
"Destinations": {
- "shape": "__listOfMultiplexOutputDestination",
+ "shape": "__listOfInputDestinationRequest",
"locationName": "destinations",
- "documentation": "A list of the multiplex output destinations."
+ "documentation": "Destination settings for PUSH type inputs."
},
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique id of the multiplex."
+ "InputDevices": {
+ "shape": "__listOfInputDeviceSettings",
+ "locationName": "inputDevices",
+ "documentation": "Settings for the devices."
},
- "MultiplexSettings": {
- "shape": "MultiplexSettings",
- "locationName": "multiplexSettings",
- "documentation": "Configuration for a multiplex event."
+ "InputSecurityGroups": {
+ "shape": "__listOf__string",
+ "locationName": "inputSecurityGroups",
+ "documentation": "A list of security groups referenced by IDs to attach to the input."
+ },
+ "MediaConnectFlows": {
+ "shape": "__listOfMediaConnectFlowRequest",
+ "locationName": "mediaConnectFlows",
+ "documentation": "A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues."
},
"Name": {
"shape": "__string",
"locationName": "name",
- "documentation": "The name of the multiplex."
+ "documentation": "Name of the input."
},
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
+ "RequestId": {
+ "shape": "__string",
+ "locationName": "requestId",
+ "documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.",
+ "idempotencyToken": true
},
- "ProgramCount": {
- "shape": "__integer",
- "locationName": "programCount",
- "documentation": "The number of programs in the multiplex."
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
},
- "State": {
- "shape": "MultiplexState",
- "locationName": "state",
- "documentation": "The current state of the multiplex."
+ "Sources": {
+ "shape": "__listOfInputSourceRequest",
+ "locationName": "sources",
+ "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty."
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
+ },
+ "Type": {
+ "shape": "InputType",
+ "locationName": "type"
+ },
+ "Vpc": {
+ "shape": "InputVpcRequest",
+ "locationName": "vpc"
+ },
+ "SrtSettings": {
+ "shape": "SrtSettingsRequest",
+ "locationName": "srtSettings",
+ "documentation": "The settings associated with an SRT input."
+ },
+ "InputNetworkLocation": {
+ "shape": "InputNetworkLocation",
+ "locationName": "inputNetworkLocation",
+ "documentation": "The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for\nan input in a customer network."
+ },
+ "MulticastSettings": {
+ "shape": "MulticastSettingsCreateRequest",
+ "locationName": "multicastSettings",
+ "documentation": "Multicast Input settings."
}
},
- "documentation": "Placeholder documentation for DescribeMultiplexResponse"
- },
- "DescribeOfferingRequest": {
- "type": "structure",
- "members": {
- "OfferingId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "offeringId",
- "documentation": "Unique offering ID, e.g. '87654321'"
- }
- },
- "required": [
- "OfferingId"
- ],
- "documentation": "Placeholder documentation for DescribeOfferingRequest"
+ "documentation": "Placeholder documentation for CreateInput"
},
- "DescribeOfferingResponse": {
+ "CreateInputRequest": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'"
+ "Destinations": {
+ "shape": "__listOfInputDestinationRequest",
+ "locationName": "destinations",
+ "documentation": "Destination settings for PUSH type inputs."
},
- "CurrencyCode": {
- "shape": "__string",
- "locationName": "currencyCode",
- "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
+ "InputDevices": {
+ "shape": "__listOfInputDeviceSettings",
+ "locationName": "inputDevices",
+ "documentation": "Settings for the devices."
},
- "Duration": {
- "shape": "__integer",
- "locationName": "duration",
- "documentation": "Lease duration, e.g. '12'"
+ "InputSecurityGroups": {
+ "shape": "__listOf__string",
+ "locationName": "inputSecurityGroups",
+ "documentation": "A list of security groups referenced by IDs to attach to the input."
},
- "DurationUnits": {
- "shape": "OfferingDurationUnits",
- "locationName": "durationUnits",
- "documentation": "Units for duration, e.g. 'MONTHS'"
+ "MediaConnectFlows": {
+ "shape": "__listOfMediaConnectFlowRequest",
+ "locationName": "mediaConnectFlows",
+ "documentation": "A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues."
},
- "FixedPrice": {
- "shape": "__double",
- "locationName": "fixedPrice",
- "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "Name of the input."
},
- "OfferingDescription": {
+ "RequestId": {
"shape": "__string",
- "locationName": "offeringDescription",
- "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
+ "locationName": "requestId",
+ "documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.",
+ "idempotencyToken": true
},
- "OfferingId": {
+ "RoleArn": {
"shape": "__string",
- "locationName": "offeringId",
- "documentation": "Unique offering ID, e.g. '87654321'"
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
},
- "OfferingType": {
- "shape": "OfferingType",
- "locationName": "offeringType",
- "documentation": "Offering type, e.g. 'NO_UPFRONT'"
+ "Sources": {
+ "shape": "__listOfInputSourceRequest",
+ "locationName": "sources",
+ "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty."
},
- "Region": {
- "shape": "__string",
- "locationName": "region",
- "documentation": "AWS region, e.g. 'us-west-2'"
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
},
- "ResourceSpecification": {
- "shape": "ReservationResourceSpecification",
- "locationName": "resourceSpecification",
- "documentation": "Resource configuration details"
+ "Type": {
+ "shape": "InputType",
+ "locationName": "type"
},
- "UsagePrice": {
- "shape": "__double",
- "locationName": "usagePrice",
- "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
+ "Vpc": {
+ "shape": "InputVpcRequest",
+ "locationName": "vpc"
+ },
+ "SrtSettings": {
+ "shape": "SrtSettingsRequest",
+ "locationName": "srtSettings",
+ "documentation": "The settings associated with an SRT input."
+ },
+ "InputNetworkLocation": {
+ "shape": "InputNetworkLocation",
+ "locationName": "inputNetworkLocation",
+ "documentation": "The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for\nan input in a customer network."
+ },
+ "MulticastSettings": {
+ "shape": "MulticastSettingsCreateRequest",
+ "locationName": "multicastSettings",
+ "documentation": "Multicast Input settings."
}
},
- "documentation": "Placeholder documentation for DescribeOfferingResponse"
+ "documentation": "The name of the input"
},
- "DescribeReservationRequest": {
+ "CreateInputResponse": {
"type": "structure",
"members": {
- "ReservationId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "reservationId",
- "documentation": "Unique reservation ID, e.g. '1234567'"
+ "Input": {
+ "shape": "Input",
+ "locationName": "input"
}
},
- "required": [
- "ReservationId"
- ],
- "documentation": "Placeholder documentation for DescribeReservationRequest"
+ "documentation": "Placeholder documentation for CreateInputResponse"
},
- "DescribeReservationResponse": {
+ "CreateInputResultModel": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'"
+ "Input": {
+ "shape": "Input",
+ "locationName": "input"
+ }
+ },
+ "documentation": "Placeholder documentation for CreateInputResultModel"
+ },
+ "CreateInputSecurityGroupRequest": {
+ "type": "structure",
+ "members": {
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
},
- "Count": {
- "shape": "__integer",
- "locationName": "count",
- "documentation": "Number of reserved resources"
+ "WhitelistRules": {
+ "shape": "__listOfInputWhitelistRuleCidr",
+ "locationName": "whitelistRules",
+ "documentation": "List of IPv4 CIDR addresses to whitelist"
+ }
+ },
+ "documentation": "The IPv4 CIDRs to whitelist for this Input Security Group"
+ },
+ "CreateInputSecurityGroupResponse": {
+ "type": "structure",
+ "members": {
+ "SecurityGroup": {
+ "shape": "InputSecurityGroup",
+ "locationName": "securityGroup"
+ }
+ },
+ "documentation": "Placeholder documentation for CreateInputSecurityGroupResponse"
+ },
+ "CreateInputSecurityGroupResultModel": {
+ "type": "structure",
+ "members": {
+ "SecurityGroup": {
+ "shape": "InputSecurityGroup",
+ "locationName": "securityGroup"
+ }
+ },
+ "documentation": "Placeholder documentation for CreateInputSecurityGroupResultModel"
+ },
+ "CreateMultiplex": {
+ "type": "structure",
+ "members": {
+ "AvailabilityZones": {
+ "shape": "__listOf__string",
+ "locationName": "availabilityZones",
+ "documentation": "A list of availability zones for the multiplex. You must specify exactly two."
},
- "CurrencyCode": {
- "shape": "__string",
- "locationName": "currencyCode",
- "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
- },
- "Duration": {
- "shape": "__integer",
- "locationName": "duration",
- "documentation": "Lease duration, e.g. '12'"
- },
- "DurationUnits": {
- "shape": "OfferingDurationUnits",
- "locationName": "durationUnits",
- "documentation": "Units for duration, e.g. 'MONTHS'"
- },
- "End": {
- "shape": "__string",
- "locationName": "end",
- "documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'"
- },
- "FixedPrice": {
- "shape": "__double",
- "locationName": "fixedPrice",
- "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
+ "MultiplexSettings": {
+ "shape": "MultiplexSettings",
+ "locationName": "multiplexSettings",
+ "documentation": "Configuration for a multiplex event."
},
"Name": {
"shape": "__string",
"locationName": "name",
- "documentation": "User specified reservation name"
- },
- "OfferingDescription": {
- "shape": "__string",
- "locationName": "offeringDescription",
- "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
- },
- "OfferingId": {
- "shape": "__string",
- "locationName": "offeringId",
- "documentation": "Unique offering ID, e.g. '87654321'"
- },
- "OfferingType": {
- "shape": "OfferingType",
- "locationName": "offeringType",
- "documentation": "Offering type, e.g. 'NO_UPFRONT'"
- },
- "Region": {
- "shape": "__string",
- "locationName": "region",
- "documentation": "AWS region, e.g. 'us-west-2'"
- },
- "RenewalSettings": {
- "shape": "RenewalSettings",
- "locationName": "renewalSettings",
- "documentation": "Renewal settings for the reservation"
- },
- "ReservationId": {
- "shape": "__string",
- "locationName": "reservationId",
- "documentation": "Unique reservation ID, e.g. '1234567'"
- },
- "ResourceSpecification": {
- "shape": "ReservationResourceSpecification",
- "locationName": "resourceSpecification",
- "documentation": "Resource configuration details"
+ "documentation": "Name of multiplex."
},
- "Start": {
+ "RequestId": {
"shape": "__string",
- "locationName": "start",
- "documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'"
- },
- "State": {
- "shape": "ReservationState",
- "locationName": "state",
- "documentation": "Current state of reservation, e.g. 'ACTIVE'"
+ "locationName": "requestId",
+ "documentation": "Unique request ID. This prevents retries from creating multiple\nresources.",
+ "idempotencyToken": true
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
- "documentation": "A collection of key-value pairs"
- },
- "UsagePrice": {
- "shape": "__double",
- "locationName": "usagePrice",
- "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
+ "documentation": "A collection of key-value pairs."
}
},
- "documentation": "Placeholder documentation for DescribeReservationResponse"
+ "required": [
+ "RequestId",
+ "MultiplexSettings",
+ "AvailabilityZones",
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for CreateMultiplex"
},
- "DescribeScheduleRequest": {
+ "CreateMultiplexProgram": {
"type": "structure",
"members": {
- "ChannelId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "channelId",
- "documentation": "Id of the channel whose schedule is being updated."
+ "MultiplexProgramSettings": {
+ "shape": "MultiplexProgramSettings",
+ "locationName": "multiplexProgramSettings",
+ "documentation": "The settings for this multiplex program."
},
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
+ "ProgramName": {
+ "shape": "__string",
+ "locationName": "programName",
+ "documentation": "Name of multiplex program."
},
- "NextToken": {
+ "RequestId": {
"shape": "__string",
- "location": "querystring",
- "locationName": "nextToken"
+ "locationName": "requestId",
+ "documentation": "Unique request ID. This prevents retries from creating multiple\nresources.",
+ "idempotencyToken": true
}
},
"required": [
- "ChannelId"
+ "RequestId",
+ "MultiplexProgramSettings",
+ "ProgramName"
],
- "documentation": "Placeholder documentation for DescribeScheduleRequest"
+ "documentation": "Placeholder documentation for CreateMultiplexProgram"
},
- "DescribeScheduleResponse": {
+ "CreateMultiplexProgramRequest": {
"type": "structure",
"members": {
- "NextToken": {
+ "MultiplexId": {
"shape": "__string",
- "locationName": "nextToken",
- "documentation": "The next token; for use in pagination."
+ "location": "uri",
+ "locationName": "multiplexId",
+ "documentation": "ID of the multiplex where the program is to be created."
},
- "ScheduleActions": {
- "shape": "__listOfScheduleAction",
- "locationName": "scheduleActions",
- "documentation": "The list of actions in the schedule."
+ "MultiplexProgramSettings": {
+ "shape": "MultiplexProgramSettings",
+ "locationName": "multiplexProgramSettings",
+ "documentation": "The settings for this multiplex program."
+ },
+ "ProgramName": {
+ "shape": "__string",
+ "locationName": "programName",
+ "documentation": "Name of multiplex program."
+ },
+ "RequestId": {
+ "shape": "__string",
+ "locationName": "requestId",
+ "documentation": "Unique request ID. This prevents retries from creating multiple\nresources.",
+ "idempotencyToken": true
}
},
- "documentation": "Placeholder documentation for DescribeScheduleResponse"
+ "documentation": "A request to create a program in a multiplex.",
+ "required": [
+ "MultiplexId",
+ "RequestId",
+ "MultiplexProgramSettings",
+ "ProgramName"
+ ]
},
- "DescribeThumbnailsRequest": {
+ "CreateMultiplexProgramResponse": {
"type": "structure",
"members": {
- "ChannelId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "channelId",
- "documentation": "Unique ID of the channel"
+ "MultiplexProgram": {
+ "shape": "MultiplexProgram",
+ "locationName": "multiplexProgram",
+ "documentation": "The newly created multiplex program."
+ }
+ },
+ "documentation": "Placeholder documentation for CreateMultiplexProgramResponse"
+ },
+ "CreateMultiplexProgramResultModel": {
+ "type": "structure",
+ "members": {
+ "MultiplexProgram": {
+ "shape": "MultiplexProgram",
+ "locationName": "multiplexProgram",
+ "documentation": "The newly created multiplex program."
+ }
+ },
+ "documentation": "Placeholder documentation for CreateMultiplexProgramResultModel"
+ },
+ "CreateMultiplexRequest": {
+ "type": "structure",
+ "members": {
+ "AvailabilityZones": {
+ "shape": "__listOf__string",
+ "locationName": "availabilityZones",
+ "documentation": "A list of availability zones for the multiplex. You must specify exactly two."
},
- "PipelineId": {
+ "MultiplexSettings": {
+ "shape": "MultiplexSettings",
+ "locationName": "multiplexSettings",
+ "documentation": "Configuration for a multiplex event."
+ },
+ "Name": {
"shape": "__string",
- "location": "querystring",
- "locationName": "pipelineId",
- "documentation": "Pipeline ID (\"0\" or \"1\")"
+ "locationName": "name",
+ "documentation": "Name of multiplex."
},
- "ThumbnailType": {
+ "RequestId": {
"shape": "__string",
- "location": "querystring",
- "locationName": "thumbnailType",
- "documentation": "thumbnail type"
+ "locationName": "requestId",
+ "documentation": "Unique request ID. This prevents retries from creating multiple\nresources.",
+ "idempotencyToken": true
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
}
},
+ "documentation": "A request to create a multiplex.",
"required": [
- "ThumbnailType",
- "PipelineId",
- "ChannelId"
- ],
- "documentation": "Placeholder documentation for DescribeThumbnailsRequest"
+ "RequestId",
+ "MultiplexSettings",
+ "AvailabilityZones",
+ "Name"
+ ]
},
- "DescribeThumbnailsResponse": {
+ "CreateMultiplexResponse": {
"type": "structure",
"members": {
- "ThumbnailDetails": {
- "shape": "__listOfThumbnailDetail",
- "locationName": "thumbnailDetails"
+ "Multiplex": {
+ "shape": "Multiplex",
+ "locationName": "multiplex",
+ "documentation": "The newly created multiplex."
}
},
- "documentation": "Placeholder documentation for DescribeThumbnailsResponse"
+ "documentation": "Placeholder documentation for CreateMultiplexResponse"
},
- "DescribeThumbnailsResultModel": {
+ "CreateMultiplexResultModel": {
"type": "structure",
"members": {
- "ThumbnailDetails": {
- "shape": "__listOfThumbnailDetail",
- "locationName": "thumbnailDetails"
+ "Multiplex": {
+ "shape": "Multiplex",
+ "locationName": "multiplex",
+ "documentation": "The newly created multiplex."
}
},
- "documentation": "Thumbnail details for all the pipelines of a running channel."
- },
- "DeviceSettingsSyncState": {
- "type": "string",
- "documentation": "The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.",
- "enum": [
- "SYNCED",
- "SYNCING"
- ]
+ "documentation": "Placeholder documentation for CreateMultiplexResultModel"
},
- "DeviceUpdateStatus": {
- "type": "string",
- "documentation": "The status of software on the input device.",
- "enum": [
- "UP_TO_DATE",
- "NOT_UP_TO_DATE",
- "UPDATING"
- ]
- },
- "DolbyEProgramSelection": {
- "type": "string",
- "documentation": "Dolby EProgram Selection",
- "enum": [
- "ALL_CHANNELS",
- "PROGRAM_1",
- "PROGRAM_2",
- "PROGRAM_3",
- "PROGRAM_4",
- "PROGRAM_5",
- "PROGRAM_6",
- "PROGRAM_7",
- "PROGRAM_8"
- ]
- },
- "DolbyVision81Settings": {
+ "CreatePartnerInput": {
"type": "structure",
"members": {
+ "RequestId": {
+ "shape": "__string",
+ "locationName": "requestId",
+ "documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.",
+ "idempotencyToken": true
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ }
},
- "documentation": "Dolby Vision81 Settings"
+ "documentation": "Placeholder documentation for CreatePartnerInput"
},
- "DvbNitSettings": {
+ "CreatePartnerInputRequest": {
"type": "structure",
"members": {
- "NetworkId": {
- "shape": "__integerMin0Max65536",
- "locationName": "networkId",
- "documentation": "The numeric value placed in the Network Information Table (NIT)."
+ "InputId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputId",
+ "documentation": "Unique ID of the input."
},
- "NetworkName": {
- "shape": "__stringMin1Max256",
- "locationName": "networkName",
- "documentation": "The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters."
+ "RequestId": {
+ "shape": "__string",
+ "locationName": "requestId",
+ "documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.",
+ "idempotencyToken": true
},
- "RepInterval": {
- "shape": "__integerMin25Max10000",
- "locationName": "repInterval",
- "documentation": "The number of milliseconds between instances of this table in the output transport stream."
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
}
},
- "documentation": "DVB Network Information Table (NIT)",
+ "documentation": "A request to create a partner input",
"required": [
- "NetworkName",
- "NetworkId"
- ]
- },
- "DvbSdtOutputSdt": {
- "type": "string",
- "documentation": "Dvb Sdt Output Sdt",
- "enum": [
- "SDT_FOLLOW",
- "SDT_FOLLOW_IF_PRESENT",
- "SDT_MANUAL",
- "SDT_NONE"
+ "InputId"
]
},
- "DvbSdtSettings": {
+ "CreatePartnerInputResponse": {
"type": "structure",
"members": {
- "OutputSdt": {
- "shape": "DvbSdtOutputSdt",
- "locationName": "outputSdt",
- "documentation": "Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information."
- },
- "RepInterval": {
- "shape": "__integerMin25Max2000",
- "locationName": "repInterval",
- "documentation": "The number of milliseconds between instances of this table in the output transport stream."
- },
- "ServiceName": {
- "shape": "__stringMin1Max256",
- "locationName": "serviceName",
- "documentation": "The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters."
- },
- "ServiceProviderName": {
- "shape": "__stringMin1Max256",
- "locationName": "serviceProviderName",
- "documentation": "The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters."
+ "Input": {
+ "shape": "Input",
+ "locationName": "input"
}
},
- "documentation": "DVB Service Description Table (SDT)"
- },
- "DvbSubDestinationAlignment": {
- "type": "string",
- "documentation": "Dvb Sub Destination Alignment",
- "enum": [
- "CENTERED",
- "LEFT",
- "SMART"
- ]
+ "documentation": "Placeholder documentation for CreatePartnerInputResponse"
},
- "DvbSubDestinationBackgroundColor": {
- "type": "string",
- "documentation": "Dvb Sub Destination Background Color",
- "enum": [
- "BLACK",
- "NONE",
- "WHITE"
- ]
+ "CreatePartnerInputResultModel": {
+ "type": "structure",
+ "members": {
+ "Input": {
+ "shape": "Input",
+ "locationName": "input"
+ }
+ },
+ "documentation": "Placeholder documentation for CreatePartnerInputResultModel"
},
- "DvbSubDestinationFontColor": {
- "type": "string",
- "documentation": "Dvb Sub Destination Font Color",
- "enum": [
- "BLACK",
- "BLUE",
- "GREEN",
- "RED",
- "WHITE",
- "YELLOW"
- ]
+ "CreateTagsRequest": {
+ "type": "structure",
+ "members": {
+ "ResourceArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "resource-arn"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "ResourceArn"
+ ],
+ "documentation": "Placeholder documentation for CreateTagsRequest"
},
- "DvbSubDestinationOutlineColor": {
- "type": "string",
- "documentation": "Dvb Sub Destination Outline Color",
- "enum": [
- "BLACK",
- "BLUE",
- "GREEN",
- "RED",
- "WHITE",
- "YELLOW"
- ]
+ "DeleteChannelRequest": {
+ "type": "structure",
+ "members": {
+ "ChannelId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelId",
+ "documentation": "Unique ID of the channel."
+ }
+ },
+ "required": [
+ "ChannelId"
+ ],
+ "documentation": "Placeholder documentation for DeleteChannelRequest"
},
- "DvbSubDestinationSettings": {
+ "DeleteChannelResponse": {
"type": "structure",
"members": {
- "Alignment": {
- "shape": "DvbSubDestinationAlignment",
- "locationName": "alignment",
- "documentation": "If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting \"smart\" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
- },
- "BackgroundColor": {
- "shape": "DvbSubDestinationBackgroundColor",
- "locationName": "backgroundColor",
- "documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match."
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The unique arn of the channel."
},
- "BackgroundOpacity": {
- "shape": "__integerMin0Max255",
- "locationName": "backgroundOpacity",
- "documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
+ "CdiInputSpecification": {
+ "shape": "CdiInputSpecification",
+ "locationName": "cdiInputSpecification",
+ "documentation": "Specification of CDI inputs for this channel"
},
- "Font": {
- "shape": "InputLocation",
- "locationName": "font",
- "documentation": "External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match."
+ "ChannelClass": {
+ "shape": "ChannelClass",
+ "locationName": "channelClass",
+ "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
},
- "FontColor": {
- "shape": "DvbSubDestinationFontColor",
- "locationName": "fontColor",
- "documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ "Destinations": {
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
},
- "FontOpacity": {
- "shape": "__integerMin0Max255",
- "locationName": "fontOpacity",
- "documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match."
+ "EgressEndpoints": {
+ "shape": "__listOfChannelEgressEndpoint",
+ "locationName": "egressEndpoints",
+ "documentation": "The endpoints where outgoing connections initiate from"
},
- "FontResolution": {
- "shape": "__integerMin96Max600",
- "locationName": "fontResolution",
- "documentation": "Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match."
+ "EncoderSettings": {
+ "shape": "EncoderSettings",
+ "locationName": "encoderSettings"
},
- "FontSize": {
+ "Id": {
"shape": "__string",
- "locationName": "fontSize",
- "documentation": "When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match."
- },
- "OutlineColor": {
- "shape": "DvbSubDestinationOutlineColor",
- "locationName": "outlineColor",
- "documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ "locationName": "id",
+ "documentation": "The unique id of the channel."
},
- "OutlineSize": {
- "shape": "__integerMin0Max10",
- "locationName": "outlineSize",
- "documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ "InputAttachments": {
+ "shape": "__listOfInputAttachment",
+ "locationName": "inputAttachments",
+ "documentation": "List of input attachments for channel."
},
- "ShadowColor": {
- "shape": "DvbSubDestinationShadowColor",
- "locationName": "shadowColor",
- "documentation": "Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match."
+ "InputSpecification": {
+ "shape": "InputSpecification",
+ "locationName": "inputSpecification",
+ "documentation": "Specification of network and file inputs for this channel"
},
- "ShadowOpacity": {
- "shape": "__integerMin0Max255",
- "locationName": "shadowOpacity",
- "documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
+ "LogLevel": {
+ "shape": "LogLevel",
+ "locationName": "logLevel",
+ "documentation": "The log level being written to CloudWatch Logs."
},
- "ShadowXOffset": {
- "shape": "__integer",
- "locationName": "shadowXOffset",
- "documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match."
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
},
- "ShadowYOffset": {
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the channel. (user-mutable)"
+ },
+ "PipelineDetails": {
+ "shape": "__listOfPipelineDetail",
+ "locationName": "pipelineDetails",
+ "documentation": "Runtime details for the pipelines of a running channel."
+ },
+ "PipelinesRunningCount": {
"shape": "__integer",
- "locationName": "shadowYOffset",
- "documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match."
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
},
- "TeletextGridControl": {
- "shape": "DvbSubDestinationTeletextGridControl",
- "locationName": "teletextGridControl",
- "documentation": "Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs."
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
},
- "XPosition": {
- "shape": "__integerMin0",
- "locationName": "xPosition",
- "documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ "State": {
+ "shape": "ChannelState",
+ "locationName": "state"
},
- "YPosition": {
- "shape": "__integerMin0",
- "locationName": "yPosition",
- "documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "Vpc": {
+ "shape": "VpcOutputSettingsDescription",
+ "locationName": "vpc",
+ "documentation": "Settings for VPC output"
+ },
+ "AnywhereSettings": {
+ "shape": "DescribeAnywhereSettings",
+ "locationName": "anywhereSettings",
+ "documentation": "Anywhere settings for this channel."
}
},
- "documentation": "Dvb Sub Destination Settings"
- },
- "DvbSubDestinationShadowColor": {
- "type": "string",
- "documentation": "Dvb Sub Destination Shadow Color",
- "enum": [
- "BLACK",
- "NONE",
- "WHITE"
- ]
- },
- "DvbSubDestinationTeletextGridControl": {
- "type": "string",
- "documentation": "Dvb Sub Destination Teletext Grid Control",
- "enum": [
- "FIXED",
- "SCALED"
- ]
- },
- "DvbSubOcrLanguage": {
- "type": "string",
- "documentation": "Dvb Sub Ocr Language",
- "enum": [
- "DEU",
- "ENG",
- "FRA",
- "NLD",
- "POR",
- "SPA"
- ]
+ "documentation": "Placeholder documentation for DeleteChannelResponse"
},
- "DvbSubSourceSettings": {
+ "DeleteInputRequest": {
"type": "structure",
"members": {
- "OcrLanguage": {
- "shape": "DvbSubOcrLanguage",
- "locationName": "ocrLanguage",
- "documentation": "If you will configure a WebVTT caption description that references this caption selector, use this field to\nprovide the language to consider when translating the image-based source to text."
- },
- "Pid": {
- "shape": "__integerMin1",
- "locationName": "pid",
- "documentation": "When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors."
+ "InputId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputId",
+ "documentation": "Unique ID of the input"
}
},
- "documentation": "Dvb Sub Source Settings"
+ "required": [
+ "InputId"
+ ],
+ "documentation": "Placeholder documentation for DeleteInputRequest"
},
- "DvbTdtSettings": {
+ "DeleteInputResponse": {
"type": "structure",
"members": {
- "RepInterval": {
- "shape": "__integerMin1000Max30000",
- "locationName": "repInterval",
- "documentation": "The number of milliseconds between instances of this table in the output transport stream."
- }
},
- "documentation": "DVB Time and Date Table (SDT)"
- },
- "Eac3AtmosCodingMode": {
- "type": "string",
- "documentation": "Eac3 Atmos Coding Mode",
- "enum": [
- "CODING_MODE_5_1_4",
- "CODING_MODE_7_1_4",
- "CODING_MODE_9_1_6"
- ]
+ "documentation": "Placeholder documentation for DeleteInputResponse"
},
- "Eac3AtmosDrcLine": {
- "type": "string",
- "documentation": "Eac3 Atmos Drc Line",
- "enum": [
- "FILM_LIGHT",
- "FILM_STANDARD",
- "MUSIC_LIGHT",
- "MUSIC_STANDARD",
- "NONE",
- "SPEECH"
- ]
+ "DeleteInputSecurityGroupRequest": {
+ "type": "structure",
+ "members": {
+ "InputSecurityGroupId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputSecurityGroupId",
+ "documentation": "The Input Security Group to delete"
+ }
+ },
+ "required": [
+ "InputSecurityGroupId"
+ ],
+ "documentation": "Placeholder documentation for DeleteInputSecurityGroupRequest"
},
- "Eac3AtmosDrcRf": {
- "type": "string",
- "documentation": "Eac3 Atmos Drc Rf",
- "enum": [
- "FILM_LIGHT",
- "FILM_STANDARD",
- "MUSIC_LIGHT",
- "MUSIC_STANDARD",
- "NONE",
- "SPEECH"
- ]
+ "DeleteInputSecurityGroupResponse": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Placeholder documentation for DeleteInputSecurityGroupResponse"
},
- "Eac3AtmosSettings": {
+ "DeleteMultiplexProgramRequest": {
"type": "structure",
"members": {
- "Bitrate": {
- "shape": "__double",
- "locationName": "bitrate",
- "documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode."
- },
- "CodingMode": {
- "shape": "Eac3AtmosCodingMode",
- "locationName": "codingMode",
- "documentation": "Dolby Digital Plus with Dolby Atmos coding mode. Determines number of channels."
+ "MultiplexId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "multiplexId",
+ "documentation": "The ID of the multiplex that the program belongs to."
},
- "Dialnorm": {
- "shape": "__integerMin1Max31",
- "locationName": "dialnorm",
- "documentation": "Sets the dialnorm for the output. Default 23."
+ "ProgramName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "programName",
+ "documentation": "The multiplex program name."
+ }
+ },
+ "required": [
+ "MultiplexId",
+ "ProgramName"
+ ],
+ "documentation": "Placeholder documentation for DeleteMultiplexProgramRequest"
+ },
+ "DeleteMultiplexProgramResponse": {
+ "type": "structure",
+ "members": {
+ "ChannelId": {
+ "shape": "__string",
+ "locationName": "channelId",
+ "documentation": "The MediaLive channel associated with the program."
},
- "DrcLine": {
- "shape": "Eac3AtmosDrcLine",
- "locationName": "drcLine",
- "documentation": "Sets the Dolby dynamic range compression profile."
+ "MultiplexProgramSettings": {
+ "shape": "MultiplexProgramSettings",
+ "locationName": "multiplexProgramSettings",
+ "documentation": "The settings for this multiplex program."
},
- "DrcRf": {
- "shape": "Eac3AtmosDrcRf",
- "locationName": "drcRf",
- "documentation": "Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels."
+ "PacketIdentifiersMap": {
+ "shape": "MultiplexProgramPacketIdentifiersMap",
+ "locationName": "packetIdentifiersMap",
+ "documentation": "The packet identifier map for this multiplex program."
},
- "HeightTrim": {
- "shape": "__double",
- "locationName": "heightTrim",
- "documentation": "Height dimensional trim. Sets the maximum amount to attenuate the height channels when the downstream player isn??t configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels."
+ "PipelineDetails": {
+ "shape": "__listOfMultiplexProgramPipelineDetail",
+ "locationName": "pipelineDetails",
+ "documentation": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time."
},
- "SurroundTrim": {
- "shape": "__double",
- "locationName": "surroundTrim",
- "documentation": "Surround dimensional trim. Sets the maximum amount to attenuate the surround channels when the downstream player isn't configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels."
+ "ProgramName": {
+ "shape": "__string",
+ "locationName": "programName",
+ "documentation": "The name of the multiplex program."
}
},
- "documentation": "Eac3 Atmos Settings"
+ "documentation": "Placeholder documentation for DeleteMultiplexProgramResponse"
},
- "Eac3AttenuationControl": {
- "type": "string",
- "documentation": "Eac3 Attenuation Control",
- "enum": [
- "ATTENUATE_3_DB",
- "NONE"
- ]
- },
- "Eac3BitstreamMode": {
- "type": "string",
- "documentation": "Eac3 Bitstream Mode",
- "enum": [
- "COMMENTARY",
- "COMPLETE_MAIN",
- "EMERGENCY",
- "HEARING_IMPAIRED",
- "VISUALLY_IMPAIRED"
- ]
- },
- "Eac3CodingMode": {
- "type": "string",
- "documentation": "Eac3 Coding Mode",
- "enum": [
- "CODING_MODE_1_0",
- "CODING_MODE_2_0",
- "CODING_MODE_3_2"
- ]
- },
- "Eac3DcFilter": {
- "type": "string",
- "documentation": "Eac3 Dc Filter",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "Eac3DrcLine": {
- "type": "string",
- "documentation": "Eac3 Drc Line",
- "enum": [
- "FILM_LIGHT",
- "FILM_STANDARD",
- "MUSIC_LIGHT",
- "MUSIC_STANDARD",
- "NONE",
- "SPEECH"
- ]
- },
- "Eac3DrcRf": {
- "type": "string",
- "documentation": "Eac3 Drc Rf",
- "enum": [
- "FILM_LIGHT",
- "FILM_STANDARD",
- "MUSIC_LIGHT",
- "MUSIC_STANDARD",
- "NONE",
- "SPEECH"
- ]
- },
- "Eac3LfeControl": {
- "type": "string",
- "documentation": "Eac3 Lfe Control",
- "enum": [
- "LFE",
- "NO_LFE"
- ]
- },
- "Eac3LfeFilter": {
- "type": "string",
- "documentation": "Eac3 Lfe Filter",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "Eac3MetadataControl": {
- "type": "string",
- "documentation": "Eac3 Metadata Control",
- "enum": [
- "FOLLOW_INPUT",
- "USE_CONFIGURED"
- ]
- },
- "Eac3PassthroughControl": {
- "type": "string",
- "documentation": "Eac3 Passthrough Control",
- "enum": [
- "NO_PASSTHROUGH",
- "WHEN_POSSIBLE"
- ]
- },
- "Eac3PhaseControl": {
- "type": "string",
- "documentation": "Eac3 Phase Control",
- "enum": [
- "NO_SHIFT",
- "SHIFT_90_DEGREES"
- ]
+ "DeleteMultiplexRequest": {
+ "type": "structure",
+ "members": {
+ "MultiplexId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "multiplexId",
+ "documentation": "The ID of the multiplex."
+ }
+ },
+ "required": [
+ "MultiplexId"
+ ],
+ "documentation": "Placeholder documentation for DeleteMultiplexRequest"
},
- "Eac3Settings": {
+ "DeleteMultiplexResponse": {
"type": "structure",
"members": {
- "AttenuationControl": {
- "shape": "Eac3AttenuationControl",
- "locationName": "attenuationControl",
- "documentation": "When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode."
- },
- "Bitrate": {
- "shape": "__double",
- "locationName": "bitrate",
- "documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode."
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The unique arn of the multiplex."
},
- "BitstreamMode": {
- "shape": "Eac3BitstreamMode",
- "locationName": "bitstreamMode",
- "documentation": "Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values."
+ "AvailabilityZones": {
+ "shape": "__listOf__string",
+ "locationName": "availabilityZones",
+ "documentation": "A list of availability zones for the multiplex."
},
- "CodingMode": {
- "shape": "Eac3CodingMode",
- "locationName": "codingMode",
- "documentation": "Dolby Digital Plus coding mode. Determines number of channels."
+ "Destinations": {
+ "shape": "__listOfMultiplexOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of the multiplex output destinations."
},
- "DcFilter": {
- "shape": "Eac3DcFilter",
- "locationName": "dcFilter",
- "documentation": "When set to enabled, activates a DC highpass filter for all input channels."
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique id of the multiplex."
},
- "Dialnorm": {
- "shape": "__integerMin1Max31",
- "locationName": "dialnorm",
- "documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through."
+ "MultiplexSettings": {
+ "shape": "MultiplexSettings",
+ "locationName": "multiplexSettings",
+ "documentation": "Configuration for a multiplex event."
},
- "DrcLine": {
- "shape": "Eac3DrcLine",
- "locationName": "drcLine",
- "documentation": "Sets the Dolby dynamic range compression profile."
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the multiplex."
},
- "DrcRf": {
- "shape": "Eac3DrcRf",
- "locationName": "drcRf",
- "documentation": "Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels."
+ "PipelinesRunningCount": {
+ "shape": "__integer",
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
},
- "LfeControl": {
- "shape": "Eac3LfeControl",
- "locationName": "lfeControl",
- "documentation": "When encoding 3/2 audio, setting to lfe enables the LFE channel"
+ "ProgramCount": {
+ "shape": "__integer",
+ "locationName": "programCount",
+ "documentation": "The number of programs in the multiplex."
},
- "LfeFilter": {
- "shape": "Eac3LfeFilter",
- "locationName": "lfeFilter",
- "documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode."
+ "State": {
+ "shape": "MultiplexState",
+ "locationName": "state",
+ "documentation": "The current state of the multiplex."
},
- "LoRoCenterMixLevel": {
- "shape": "__double",
- "locationName": "loRoCenterMixLevel",
- "documentation": "Left only/Right only center mix level. Only used for 3/2 coding mode."
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ }
+ },
+ "documentation": "Placeholder documentation for DeleteMultiplexResponse"
+ },
+ "DeleteReservationRequest": {
+ "type": "structure",
+ "members": {
+ "ReservationId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "reservationId",
+ "documentation": "Unique reservation ID, e.g. '1234567'"
+ }
+ },
+ "required": [
+ "ReservationId"
+ ],
+ "documentation": "Placeholder documentation for DeleteReservationRequest"
+ },
+ "DeleteReservationResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'"
},
- "LoRoSurroundMixLevel": {
- "shape": "__double",
- "locationName": "loRoSurroundMixLevel",
- "documentation": "Left only/Right only surround mix level. Only used for 3/2 coding mode."
+ "Count": {
+ "shape": "__integer",
+ "locationName": "count",
+ "documentation": "Number of reserved resources"
},
- "LtRtCenterMixLevel": {
- "shape": "__double",
- "locationName": "ltRtCenterMixLevel",
- "documentation": "Left total/Right total center mix level. Only used for 3/2 coding mode."
+ "CurrencyCode": {
+ "shape": "__string",
+ "locationName": "currencyCode",
+ "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
},
- "LtRtSurroundMixLevel": {
- "shape": "__double",
- "locationName": "ltRtSurroundMixLevel",
- "documentation": "Left total/Right total surround mix level. Only used for 3/2 coding mode."
+ "Duration": {
+ "shape": "__integer",
+ "locationName": "duration",
+ "documentation": "Lease duration, e.g. '12'"
},
- "MetadataControl": {
- "shape": "Eac3MetadataControl",
- "locationName": "metadataControl",
- "documentation": "When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used."
+ "DurationUnits": {
+ "shape": "OfferingDurationUnits",
+ "locationName": "durationUnits",
+ "documentation": "Units for duration, e.g. 'MONTHS'"
},
- "PassthroughControl": {
- "shape": "Eac3PassthroughControl",
- "locationName": "passthroughControl",
- "documentation": "When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding."
+ "End": {
+ "shape": "__string",
+ "locationName": "end",
+ "documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'"
},
- "PhaseControl": {
- "shape": "Eac3PhaseControl",
- "locationName": "phaseControl",
- "documentation": "When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode."
+ "FixedPrice": {
+ "shape": "__double",
+ "locationName": "fixedPrice",
+ "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
},
- "StereoDownmix": {
- "shape": "Eac3StereoDownmix",
- "locationName": "stereoDownmix",
- "documentation": "Stereo downmix preference. Only used for 3/2 coding mode."
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "User specified reservation name"
},
- "SurroundExMode": {
- "shape": "Eac3SurroundExMode",
- "locationName": "surroundExMode",
- "documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels."
+ "OfferingDescription": {
+ "shape": "__string",
+ "locationName": "offeringDescription",
+ "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
},
- "SurroundMode": {
- "shape": "Eac3SurroundMode",
- "locationName": "surroundMode",
- "documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels."
+ "OfferingId": {
+ "shape": "__string",
+ "locationName": "offeringId",
+ "documentation": "Unique offering ID, e.g. '87654321'"
+ },
+ "OfferingType": {
+ "shape": "OfferingType",
+ "locationName": "offeringType",
+ "documentation": "Offering type, e.g. 'NO_UPFRONT'"
+ },
+ "Region": {
+ "shape": "__string",
+ "locationName": "region",
+ "documentation": "AWS region, e.g. 'us-west-2'"
+ },
+ "RenewalSettings": {
+ "shape": "RenewalSettings",
+ "locationName": "renewalSettings",
+ "documentation": "Renewal settings for the reservation"
+ },
+ "ReservationId": {
+ "shape": "__string",
+ "locationName": "reservationId",
+ "documentation": "Unique reservation ID, e.g. '1234567'"
+ },
+ "ResourceSpecification": {
+ "shape": "ReservationResourceSpecification",
+ "locationName": "resourceSpecification",
+ "documentation": "Resource configuration details"
+ },
+ "Start": {
+ "shape": "__string",
+ "locationName": "start",
+ "documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'"
+ },
+ "State": {
+ "shape": "ReservationState",
+ "locationName": "state",
+ "documentation": "Current state of reservation, e.g. 'ACTIVE'"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs"
+ },
+ "UsagePrice": {
+ "shape": "__double",
+ "locationName": "usagePrice",
+ "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
}
},
- "documentation": "Eac3 Settings"
- },
- "Eac3StereoDownmix": {
- "type": "string",
- "documentation": "Eac3 Stereo Downmix",
- "enum": [
- "DPL2",
- "LO_RO",
- "LT_RT",
- "NOT_INDICATED"
- ]
+ "documentation": "Placeholder documentation for DeleteReservationResponse"
},
- "Eac3SurroundExMode": {
- "type": "string",
- "documentation": "Eac3 Surround Ex Mode",
- "enum": [
- "DISABLED",
- "ENABLED",
- "NOT_INDICATED"
- ]
+ "DeleteScheduleRequest": {
+ "type": "structure",
+ "members": {
+ "ChannelId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelId",
+ "documentation": "Id of the channel whose schedule is being deleted."
+ }
+ },
+ "required": [
+ "ChannelId"
+ ],
+ "documentation": "Placeholder documentation for DeleteScheduleRequest"
},
- "Eac3SurroundMode": {
- "type": "string",
- "documentation": "Eac3 Surround Mode",
- "enum": [
- "DISABLED",
- "ENABLED",
- "NOT_INDICATED"
- ]
+ "DeleteScheduleResponse": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Placeholder documentation for DeleteScheduleResponse"
},
- "EbuTtDDestinationSettings": {
+ "DeleteTagsRequest": {
"type": "structure",
"members": {
- "CopyrightHolder": {
- "shape": "__stringMax1000",
- "locationName": "copyrightHolder",
- "documentation": "Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata."
- },
- "FillLineGap": {
- "shape": "EbuTtDFillLineGapControl",
- "locationName": "fillLineGap",
- "documentation": "Specifies how to handle the gap between the lines (in multi-line captions).\n\n- enabled: Fill with the captions background color (as specified in the input captions).\n- disabled: Leave the gap unfilled."
- },
- "FontFamily": {
+ "ResourceArn": {
"shape": "__string",
- "locationName": "fontFamily",
- "documentation": "Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to \"monospaced\". (If styleControl is set to exclude, the font family is always set to \"monospaced\".)\n\nYou specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size.\n\n- Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font).\n- Leave blank to set the family to “monospace”."
+ "location": "uri",
+ "locationName": "resource-arn"
},
- "StyleControl": {
- "shape": "EbuTtDDestinationStyleControl",
- "locationName": "styleControl",
- "documentation": "Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions.\n\n- include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext.\n- exclude: In the font data attached to the EBU-TT captions, set the font family to \"monospaced\". Do not include any other style information."
+ "TagKeys": {
+ "shape": "__listOf__string",
+ "location": "querystring",
+ "locationName": "tagKeys",
+ "documentation": "An array of tag keys to delete"
}
},
- "documentation": "Ebu Tt DDestination Settings"
- },
- "EbuTtDDestinationStyleControl": {
- "type": "string",
- "documentation": "Ebu Tt DDestination Style Control",
- "enum": [
- "EXCLUDE",
- "INCLUDE"
- ]
- },
- "EbuTtDFillLineGapControl": {
- "type": "string",
- "documentation": "Ebu Tt DFill Line Gap Control",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "EmbeddedConvert608To708": {
- "type": "string",
- "documentation": "Embedded Convert608 To708",
- "enum": [
- "DISABLED",
- "UPCONVERT"
- ]
+ "required": [
+ "TagKeys",
+ "ResourceArn"
+ ],
+ "documentation": "Placeholder documentation for DeleteTagsRequest"
},
- "EmbeddedDestinationSettings": {
+ "DescribeAccountConfigurationRequest": {
"type": "structure",
"members": {
},
- "documentation": "Embedded Destination Settings"
+ "documentation": "Placeholder documentation for DescribeAccountConfigurationRequest"
},
- "EmbeddedPlusScte20DestinationSettings": {
+ "DescribeAccountConfigurationResponse": {
"type": "structure",
"members": {
+ "AccountConfiguration": {
+ "shape": "AccountConfiguration",
+ "locationName": "accountConfiguration"
+ }
},
- "documentation": "Embedded Plus Scte20 Destination Settings"
- },
- "EmbeddedScte20Detection": {
- "type": "string",
- "documentation": "Embedded Scte20 Detection",
- "enum": [
- "AUTO",
- "OFF"
- ]
+ "documentation": "Placeholder documentation for DescribeAccountConfigurationResponse"
},
- "EmbeddedSourceSettings": {
+ "DescribeAccountConfigurationResultModel": {
"type": "structure",
"members": {
- "Convert608To708": {
- "shape": "EmbeddedConvert608To708",
- "locationName": "convert608To708",
- "documentation": "If upconvert, 608 data is both passed through via the \"608 compatibility bytes\" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded."
- },
- "Scte20Detection": {
- "shape": "EmbeddedScte20Detection",
- "locationName": "scte20Detection",
- "documentation": "Set to \"auto\" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions."
- },
- "Source608ChannelNumber": {
- "shape": "__integerMin1Max4",
- "locationName": "source608ChannelNumber",
- "documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough."
- },
- "Source608TrackNumber": {
- "shape": "__integerMin1Max5",
- "locationName": "source608TrackNumber",
- "documentation": "This field is unused and deprecated."
+ "AccountConfiguration": {
+ "shape": "AccountConfiguration",
+ "locationName": "accountConfiguration"
}
},
- "documentation": "Embedded Source Settings"
+ "documentation": "The account's configuration."
},
- "Empty": {
+ "DescribeChannelRequest": {
"type": "structure",
"members": {
+ "ChannelId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelId",
+ "documentation": "channel ID"
+ }
},
- "documentation": "Placeholder documentation for Empty"
+ "required": [
+ "ChannelId"
+ ],
+ "documentation": "Placeholder documentation for DescribeChannelRequest"
},
- "EncoderSettings": {
+ "DescribeChannelResponse": {
"type": "structure",
"members": {
- "AudioDescriptions": {
- "shape": "__listOfAudioDescription",
- "locationName": "audioDescriptions"
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The unique arn of the channel."
},
- "AvailBlanking": {
- "shape": "AvailBlanking",
- "locationName": "availBlanking",
- "documentation": "Settings for ad avail blanking."
+ "CdiInputSpecification": {
+ "shape": "CdiInputSpecification",
+ "locationName": "cdiInputSpecification",
+ "documentation": "Specification of CDI inputs for this channel"
},
- "AvailConfiguration": {
- "shape": "AvailConfiguration",
- "locationName": "availConfiguration",
- "documentation": "Event-wide configuration settings for ad avail insertion."
+ "ChannelClass": {
+ "shape": "ChannelClass",
+ "locationName": "channelClass",
+ "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
},
- "BlackoutSlate": {
- "shape": "BlackoutSlate",
- "locationName": "blackoutSlate",
- "documentation": "Settings for blackout slate."
+ "Destinations": {
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
},
- "CaptionDescriptions": {
- "shape": "__listOfCaptionDescription",
- "locationName": "captionDescriptions",
- "documentation": "Settings for caption decriptions"
+ "EgressEndpoints": {
+ "shape": "__listOfChannelEgressEndpoint",
+ "locationName": "egressEndpoints",
+ "documentation": "The endpoints where outgoing connections initiate from"
},
- "FeatureActivations": {
- "shape": "FeatureActivations",
- "locationName": "featureActivations",
- "documentation": "Feature Activations"
+ "EncoderSettings": {
+ "shape": "EncoderSettings",
+ "locationName": "encoderSettings"
},
- "GlobalConfiguration": {
- "shape": "GlobalConfiguration",
- "locationName": "globalConfiguration",
- "documentation": "Configuration settings that apply to the event as a whole."
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique id of the channel."
},
- "MotionGraphicsConfiguration": {
- "shape": "MotionGraphicsConfiguration",
- "locationName": "motionGraphicsConfiguration",
- "documentation": "Settings for motion graphics."
+ "InputAttachments": {
+ "shape": "__listOfInputAttachment",
+ "locationName": "inputAttachments",
+ "documentation": "List of input attachments for channel."
},
- "NielsenConfiguration": {
- "shape": "NielsenConfiguration",
- "locationName": "nielsenConfiguration",
- "documentation": "Nielsen configuration settings."
+ "InputSpecification": {
+ "shape": "InputSpecification",
+ "locationName": "inputSpecification",
+ "documentation": "Specification of network and file inputs for this channel"
},
- "OutputGroups": {
- "shape": "__listOfOutputGroup",
- "locationName": "outputGroups"
+ "LogLevel": {
+ "shape": "LogLevel",
+ "locationName": "logLevel",
+ "documentation": "The log level being written to CloudWatch Logs."
},
- "TimecodeConfig": {
- "shape": "TimecodeConfig",
- "locationName": "timecodeConfig",
- "documentation": "Contains settings used to acquire and adjust timecode information from inputs."
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
},
- "VideoDescriptions": {
- "shape": "__listOfVideoDescription",
- "locationName": "videoDescriptions"
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the channel. (user-mutable)"
},
- "ThumbnailConfiguration": {
- "shape": "ThumbnailConfiguration",
- "locationName": "thumbnailConfiguration",
- "documentation": "Thumbnail configuration settings."
+ "PipelineDetails": {
+ "shape": "__listOfPipelineDetail",
+ "locationName": "pipelineDetails",
+ "documentation": "Runtime details for the pipelines of a running channel."
},
- "ColorCorrectionSettings": {
- "shape": "ColorCorrectionSettings",
- "locationName": "colorCorrectionSettings",
- "documentation": "Color Correction Settings"
+ "PipelinesRunningCount": {
+ "shape": "__integer",
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
+ },
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
+ },
+ "State": {
+ "shape": "ChannelState",
+ "locationName": "state"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "Vpc": {
+ "shape": "VpcOutputSettingsDescription",
+ "locationName": "vpc",
+ "documentation": "Settings for VPC output"
+ },
+ "AnywhereSettings": {
+ "shape": "DescribeAnywhereSettings",
+ "locationName": "anywhereSettings",
+ "documentation": "Anywhere settings for this channel."
}
},
- "documentation": "Encoder Settings",
- "required": [
- "VideoDescriptions",
- "AudioDescriptions",
- "OutputGroups",
- "TimecodeConfig"
- ]
+ "documentation": "Placeholder documentation for DescribeChannelResponse"
},
- "EpochLockingSettings": {
+ "DescribeInputDeviceRequest": {
"type": "structure",
"members": {
- "CustomEpoch": {
- "shape": "__string",
- "locationName": "customEpoch",
- "documentation": "Optional. Enter a value here to use a custom epoch, instead of the standard epoch (which started at 1970-01-01T00:00:00 UTC). Specify the start time of the custom epoch, in YYYY-MM-DDTHH:MM:SS in UTC. The time must be 2000-01-01T00:00:00 or later. Always set the MM:SS portion to 00:00."
- },
- "JamSyncTime": {
+ "InputDeviceId": {
"shape": "__string",
- "locationName": "jamSyncTime",
- "documentation": "Optional. Enter a time for the jam sync. The default is midnight UTC. When epoch locking is enabled, MediaLive performs a daily jam sync on every output encode to ensure timecodes don’t diverge from the wall clock. The jam sync applies only to encodes with frame rate of 29.97 or 59.94 FPS. To override, enter a time in HH:MM:SS in UTC. Always set the MM:SS portion to 00:00."
+ "location": "uri",
+ "locationName": "inputDeviceId",
+ "documentation": "The unique ID of this input device. For example, hd-123456789abcdef."
}
},
- "documentation": "Epoch Locking Settings"
+ "required": [
+ "InputDeviceId"
+ ],
+ "documentation": "Placeholder documentation for DescribeInputDeviceRequest"
},
- "Esam": {
+ "DescribeInputDeviceResponse": {
"type": "structure",
"members": {
- "AcquisitionPointId": {
- "shape": "__stringMax256",
- "locationName": "acquisitionPointId",
- "documentation": "Sent as acquisitionPointIdentity to identify the MediaLive channel to the POIS."
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The unique ARN of the input device."
},
- "AdAvailOffset": {
- "shape": "__integerMinNegative1000Max1000",
- "locationName": "adAvailOffset",
- "documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages."
+ "ConnectionState": {
+ "shape": "InputDeviceConnectionState",
+ "locationName": "connectionState",
+ "documentation": "The state of the connection between the input device and AWS."
},
- "PasswordParam": {
+ "DeviceSettingsSyncState": {
+ "shape": "DeviceSettingsSyncState",
+ "locationName": "deviceSettingsSyncState",
+ "documentation": "The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration."
+ },
+ "DeviceUpdateStatus": {
+ "shape": "DeviceUpdateStatus",
+ "locationName": "deviceUpdateStatus",
+ "documentation": "The status of software on the input device."
+ },
+ "HdDeviceSettings": {
+ "shape": "InputDeviceHdSettings",
+ "locationName": "hdDeviceSettings",
+ "documentation": "Settings that describe an input device that is type HD."
+ },
+ "Id": {
"shape": "__string",
- "locationName": "passwordParam",
- "documentation": "Documentation update needed"
+ "locationName": "id",
+ "documentation": "The unique ID of the input device."
},
- "PoisEndpoint": {
- "shape": "__stringMax2048",
- "locationName": "poisEndpoint",
- "documentation": "The URL of the signal conditioner endpoint on the Placement Opportunity Information System (POIS). MediaLive sends SignalProcessingEvents here when SCTE-35 messages are read."
+ "MacAddress": {
+ "shape": "__string",
+ "locationName": "macAddress",
+ "documentation": "The network MAC address of the input device."
},
- "Username": {
+ "Name": {
"shape": "__string",
- "locationName": "username",
- "documentation": "Documentation update needed"
+ "locationName": "name",
+ "documentation": "A name that you specify for the input device."
},
- "ZoneIdentity": {
- "shape": "__stringMax256",
- "locationName": "zoneIdentity",
- "documentation": "Optional data sent as zoneIdentity to identify the MediaLive channel to the POIS."
+ "NetworkSettings": {
+ "shape": "InputDeviceNetworkSettings",
+ "locationName": "networkSettings",
+ "documentation": "The network settings for the input device."
+ },
+ "SerialNumber": {
+ "shape": "__string",
+ "locationName": "serialNumber",
+ "documentation": "The unique serial number of the input device."
+ },
+ "Type": {
+ "shape": "InputDeviceType",
+ "locationName": "type",
+ "documentation": "The type of the input device."
+ },
+ "UhdDeviceSettings": {
+ "shape": "InputDeviceUhdSettings",
+ "locationName": "uhdDeviceSettings",
+ "documentation": "Settings that describe an input device that is type UHD."
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "AvailabilityZone": {
+ "shape": "__string",
+ "locationName": "availabilityZone",
+ "documentation": "The Availability Zone associated with this input device."
+ },
+ "MedialiveInputArns": {
+ "shape": "__listOf__string",
+ "locationName": "medialiveInputArns",
+ "documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT."
+ },
+ "OutputType": {
+ "shape": "InputDeviceOutputType",
+ "locationName": "outputType",
+ "documentation": "The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input."
}
},
- "documentation": "Esam",
- "required": [
- "AcquisitionPointId",
- "PoisEndpoint"
- ]
+ "documentation": "Placeholder documentation for DescribeInputDeviceResponse"
},
- "FailoverCondition": {
+ "DescribeInputDeviceThumbnailRequest": {
"type": "structure",
"members": {
- "FailoverConditionSettings": {
- "shape": "FailoverConditionSettings",
- "locationName": "failoverConditionSettings",
- "documentation": "Failover condition type-specific settings."
- }
+ "InputDeviceId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputDeviceId",
+ "documentation": "The unique ID of this input device. For example, hd-123456789abcdef."
+ },
+ "Accept": {
+ "shape": "AcceptHeader",
+ "location": "header",
+ "locationName": "accept",
+ "documentation": "The HTTP Accept header. Indicates the requested type for the thumbnail."
+ }
},
- "documentation": "Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings."
+ "required": [
+ "InputDeviceId",
+ "Accept"
+ ],
+ "documentation": "Placeholder documentation for DescribeInputDeviceThumbnailRequest"
},
- "FailoverConditionSettings": {
+ "DescribeInputDeviceThumbnailResponse": {
"type": "structure",
"members": {
- "AudioSilenceSettings": {
- "shape": "AudioSilenceFailoverSettings",
- "locationName": "audioSilenceSettings",
- "documentation": "MediaLive will perform a failover if the specified audio selector is silent for the specified period."
+ "Body": {
+ "shape": "InputDeviceThumbnail",
+ "locationName": "body",
+ "documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive."
},
- "InputLossSettings": {
- "shape": "InputLossFailoverSettings",
- "locationName": "inputLossSettings",
- "documentation": "MediaLive will perform a failover if content is not detected in this input for the specified period."
+ "ContentType": {
+ "shape": "ContentType",
+ "location": "header",
+ "locationName": "Content-Type",
+ "documentation": "Specifies the media type of the thumbnail."
},
- "VideoBlackSettings": {
- "shape": "VideoBlackFailoverSettings",
- "locationName": "videoBlackSettings",
- "documentation": "MediaLive will perform a failover if content is considered black for the specified period."
+ "ContentLength": {
+ "shape": "__long",
+ "location": "header",
+ "locationName": "Content-Length",
+ "documentation": "The length of the content."
+ },
+ "ETag": {
+ "shape": "__string",
+ "location": "header",
+ "locationName": "ETag",
+ "documentation": "The unique, cacheable version of this thumbnail."
+ },
+ "LastModified": {
+ "shape": "__timestamp",
+ "location": "header",
+ "locationName": "Last-Modified",
+ "documentation": "The date and time the thumbnail was last updated at the device."
}
},
- "documentation": "Settings for one failover condition."
+ "documentation": "Placeholder documentation for DescribeInputDeviceThumbnailResponse",
+ "payload": "Body"
},
- "FeatureActivations": {
+ "DescribeInputRequest": {
"type": "structure",
"members": {
- "InputPrepareScheduleActions": {
- "shape": "FeatureActivationsInputPrepareScheduleActions",
- "locationName": "inputPrepareScheduleActions",
- "documentation": "Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled.\nIf you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule."
- },
- "OutputStaticImageOverlayScheduleActions": {
- "shape": "FeatureActivationsOutputStaticImageOverlayScheduleActions",
- "locationName": "outputStaticImageOverlayScheduleActions",
- "documentation": "Enables the output static image overlay feature. Enabling this feature allows you to send channel schedule updates\nto display/clear/modify image overlays on an output-by-output bases."
+ "InputId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputId",
+ "documentation": "Unique ID of the input"
}
},
- "documentation": "Feature Activations"
- },
- "FeatureActivationsInputPrepareScheduleActions": {
- "type": "string",
- "documentation": "Feature Activations Input Prepare Schedule Actions",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "FeatureActivationsOutputStaticImageOverlayScheduleActions": {
- "type": "string",
- "documentation": "Feature Activations Output Static Image Overlay Schedule Actions",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "FecOutputIncludeFec": {
- "type": "string",
- "documentation": "Fec Output Include Fec",
- "enum": [
- "COLUMN",
- "COLUMN_AND_ROW"
- ]
+ "required": [
+ "InputId"
+ ],
+ "documentation": "Placeholder documentation for DescribeInputRequest"
},
- "FecOutputSettings": {
+ "DescribeInputResponse": {
"type": "structure",
"members": {
- "ColumnDepth": {
- "shape": "__integerMin4Max20",
- "locationName": "columnDepth",
- "documentation": "Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive."
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The Unique ARN of the input (generated, immutable)."
},
- "IncludeFec": {
- "shape": "FecOutputIncludeFec",
- "locationName": "includeFec",
- "documentation": "Enables column only or column and row based FEC"
+ "AttachedChannels": {
+ "shape": "__listOf__string",
+ "locationName": "attachedChannels",
+ "documentation": "A list of channel IDs that that input is attached to (currently an input can only be attached to one channel)."
},
- "RowLength": {
- "shape": "__integerMin1Max20",
- "locationName": "rowLength",
- "documentation": "Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive."
+ "Destinations": {
+ "shape": "__listOfInputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of the destinations of the input (PUSH-type)."
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The generated ID of the input (unique for user account, immutable)."
+ },
+ "InputClass": {
+ "shape": "InputClass",
+ "locationName": "inputClass",
+ "documentation": "STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.\nSINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input."
+ },
+ "InputDevices": {
+ "shape": "__listOfInputDeviceSettings",
+ "locationName": "inputDevices",
+ "documentation": "Settings for the input devices."
+ },
+ "InputPartnerIds": {
+ "shape": "__listOf__string",
+ "locationName": "inputPartnerIds",
+ "documentation": "A list of IDs for all Inputs which are partners of this one."
+ },
+ "InputSourceType": {
+ "shape": "InputSourceType",
+ "locationName": "inputSourceType",
+ "documentation": "Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes\nduring input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs."
+ },
+ "MediaConnectFlows": {
+ "shape": "__listOfMediaConnectFlow",
+ "locationName": "mediaConnectFlows",
+ "documentation": "A list of MediaConnect Flows for this input."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The user-assigned name (This is a mutable value)."
+ },
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
+ },
+ "SecurityGroups": {
+ "shape": "__listOf__string",
+ "locationName": "securityGroups",
+ "documentation": "A list of IDs for all the Input Security Groups attached to the input."
+ },
+ "Sources": {
+ "shape": "__listOfInputSource",
+ "locationName": "sources",
+ "documentation": "A list of the sources of the input (PULL-type)."
+ },
+ "State": {
+ "shape": "InputState",
+ "locationName": "state"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "Type": {
+ "shape": "InputType",
+ "locationName": "type"
+ },
+ "SrtSettings": {
+ "shape": "SrtSettings",
+ "locationName": "srtSettings",
+ "documentation": "The settings associated with an SRT input."
+ },
+ "InputNetworkLocation": {
+ "shape": "InputNetworkLocation",
+ "locationName": "inputNetworkLocation",
+ "documentation": "The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for\nan input in a customer network."
+ },
+ "MulticastSettings": {
+ "shape": "MulticastSettings",
+ "locationName": "multicastSettings",
+ "documentation": "Multicast Input settings."
}
},
- "documentation": "Fec Output Settings"
- },
- "FixedAfd": {
- "type": "string",
- "documentation": "Fixed Afd",
- "enum": [
- "AFD_0000",
- "AFD_0010",
- "AFD_0011",
- "AFD_0100",
- "AFD_1000",
- "AFD_1001",
- "AFD_1010",
- "AFD_1011",
- "AFD_1101",
- "AFD_1110",
- "AFD_1111"
- ]
+ "documentation": "Placeholder documentation for DescribeInputResponse"
},
- "FixedModeScheduleActionStartSettings": {
+ "DescribeInputSecurityGroupRequest": {
"type": "structure",
"members": {
- "Time": {
+ "InputSecurityGroupId": {
"shape": "__string",
- "locationName": "time",
- "documentation": "Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants \"T\" for time and \"Z\" for \"UTC format\"."
+ "location": "uri",
+ "locationName": "inputSecurityGroupId",
+ "documentation": "The id of the Input Security Group to describe"
}
},
- "documentation": "Start time for the action.",
"required": [
- "Time"
- ]
+ "InputSecurityGroupId"
+ ],
+ "documentation": "Placeholder documentation for DescribeInputSecurityGroupRequest"
},
- "Fmp4HlsSettings": {
+ "DescribeInputSecurityGroupResponse": {
"type": "structure",
"members": {
- "AudioRenditionSets": {
+ "Arn": {
"shape": "__string",
- "locationName": "audioRenditionSets",
- "documentation": "List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','."
+ "locationName": "arn",
+ "documentation": "Unique ARN of Input Security Group"
},
- "NielsenId3Behavior": {
- "shape": "Fmp4NielsenId3Behavior",
- "locationName": "nielsenId3Behavior",
- "documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output."
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The Id of the Input Security Group"
},
- "TimedMetadataBehavior": {
- "shape": "Fmp4TimedMetadataBehavior",
- "locationName": "timedMetadataBehavior",
- "documentation": "When set to passthrough, timed metadata is passed through from input to output."
- }
+ "Inputs": {
+ "shape": "__listOf__string",
+ "locationName": "inputs",
+ "documentation": "The list of inputs currently using this Input Security Group."
+ },
+ "State": {
+ "shape": "InputSecurityGroupState",
+ "locationName": "state",
+ "documentation": "The current state of the Input Security Group."
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "WhitelistRules": {
+ "shape": "__listOfInputWhitelistRule",
+ "locationName": "whitelistRules",
+ "documentation": "Whitelist rules and their sync status"
+ }
},
- "documentation": "Fmp4 Hls Settings"
- },
- "Fmp4NielsenId3Behavior": {
- "type": "string",
- "documentation": "Fmp4 Nielsen Id3 Behavior",
- "enum": [
- "NO_PASSTHROUGH",
- "PASSTHROUGH"
- ]
- },
- "Fmp4TimedMetadataBehavior": {
- "type": "string",
- "documentation": "Fmp4 Timed Metadata Behavior",
- "enum": [
- "NO_PASSTHROUGH",
- "PASSTHROUGH"
- ]
+ "documentation": "Placeholder documentation for DescribeInputSecurityGroupResponse"
},
- "FollowModeScheduleActionStartSettings": {
+ "DescribeMultiplexProgramRequest": {
"type": "structure",
"members": {
- "FollowPoint": {
- "shape": "FollowPoint",
- "locationName": "followPoint",
- "documentation": "Identifies whether this action starts relative to the start or relative to the end of the reference action."
+ "MultiplexId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "multiplexId",
+ "documentation": "The ID of the multiplex that the program belongs to."
},
- "ReferenceActionName": {
+ "ProgramName": {
"shape": "__string",
- "locationName": "referenceActionName",
- "documentation": "The action name of another action that this one refers to."
+ "location": "uri",
+ "locationName": "programName",
+ "documentation": "The name of the program."
}
},
- "documentation": "Settings to specify if an action follows another.",
"required": [
- "ReferenceActionName",
- "FollowPoint"
- ]
- },
- "FollowPoint": {
- "type": "string",
- "documentation": "Follow reference point.",
- "enum": [
- "END",
- "START"
- ]
+ "MultiplexId",
+ "ProgramName"
+ ],
+ "documentation": "Placeholder documentation for DescribeMultiplexProgramRequest"
},
- "ForbiddenException": {
+ "DescribeMultiplexProgramResponse": {
"type": "structure",
"members": {
- "Message": {
+ "ChannelId": {
"shape": "__string",
- "locationName": "message"
- }
- },
- "exception": true,
- "error": {
- "httpStatusCode": 403
- },
- "documentation": "Placeholder documentation for ForbiddenException"
- },
- "FrameCaptureCdnSettings": {
- "type": "structure",
- "members": {
- "FrameCaptureS3Settings": {
- "shape": "FrameCaptureS3Settings",
- "locationName": "frameCaptureS3Settings"
+ "locationName": "channelId",
+ "documentation": "The MediaLive channel associated with the program."
+ },
+ "MultiplexProgramSettings": {
+ "shape": "MultiplexProgramSettings",
+ "locationName": "multiplexProgramSettings",
+ "documentation": "The settings for this multiplex program."
+ },
+ "PacketIdentifiersMap": {
+ "shape": "MultiplexProgramPacketIdentifiersMap",
+ "locationName": "packetIdentifiersMap",
+ "documentation": "The packet identifier map for this multiplex program."
+ },
+ "PipelineDetails": {
+ "shape": "__listOfMultiplexProgramPipelineDetail",
+ "locationName": "pipelineDetails",
+ "documentation": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time."
+ },
+ "ProgramName": {
+ "shape": "__string",
+ "locationName": "programName",
+ "documentation": "The name of the multiplex program."
}
},
- "documentation": "Frame Capture Cdn Settings"
+ "documentation": "Placeholder documentation for DescribeMultiplexProgramResponse"
},
- "FrameCaptureGroupSettings": {
+ "DescribeMultiplexRequest": {
"type": "structure",
"members": {
- "Destination": {
- "shape": "OutputLocationRef",
- "locationName": "destination",
- "documentation": "The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, \"curling-\") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curling-low.00001.jpg"
- },
- "FrameCaptureCdnSettings": {
- "shape": "FrameCaptureCdnSettings",
- "locationName": "frameCaptureCdnSettings",
- "documentation": "Parameters that control interactions with the CDN."
+ "MultiplexId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "multiplexId",
+ "documentation": "The ID of the multiplex."
}
},
- "documentation": "Frame Capture Group Settings",
"required": [
- "Destination"
- ]
- },
- "FrameCaptureHlsSettings": {
- "type": "structure",
- "members": {
- },
- "documentation": "Frame Capture Hls Settings"
- },
- "FrameCaptureIntervalUnit": {
- "type": "string",
- "documentation": "Frame Capture Interval Unit",
- "enum": [
- "MILLISECONDS",
- "SECONDS"
- ]
+ "MultiplexId"
+ ],
+ "documentation": "Placeholder documentation for DescribeMultiplexRequest"
},
- "FrameCaptureOutputSettings": {
+ "DescribeMultiplexResponse": {
"type": "structure",
"members": {
- "NameModifier": {
+ "Arn": {
"shape": "__string",
- "locationName": "nameModifier",
- "documentation": "Required if the output group contains more than one output. This modifier forms part of the output file name."
+ "locationName": "arn",
+ "documentation": "The unique arn of the multiplex."
+ },
+ "AvailabilityZones": {
+ "shape": "__listOf__string",
+ "locationName": "availabilityZones",
+ "documentation": "A list of availability zones for the multiplex."
+ },
+ "Destinations": {
+ "shape": "__listOfMultiplexOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of the multiplex output destinations."
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique id of the multiplex."
+ },
+ "MultiplexSettings": {
+ "shape": "MultiplexSettings",
+ "locationName": "multiplexSettings",
+ "documentation": "Configuration for a multiplex event."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the multiplex."
+ },
+ "PipelinesRunningCount": {
+ "shape": "__integer",
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
+ },
+ "ProgramCount": {
+ "shape": "__integer",
+ "locationName": "programCount",
+ "documentation": "The number of programs in the multiplex."
+ },
+ "State": {
+ "shape": "MultiplexState",
+ "locationName": "state",
+ "documentation": "The current state of the multiplex."
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
}
},
- "documentation": "Frame Capture Output Settings"
- },
- "FrameCaptureS3LogUploads": {
- "type": "string",
- "documentation": "Frame Capture S3 Log Uploads",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
+ "documentation": "Placeholder documentation for DescribeMultiplexResponse"
},
- "FrameCaptureS3Settings": {
+ "DescribeOfferingRequest": {
"type": "structure",
"members": {
- "CannedAcl": {
- "shape": "S3CannedAcl",
- "locationName": "cannedAcl",
- "documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none."
+ "OfferingId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "offeringId",
+ "documentation": "Unique offering ID, e.g. '87654321'"
}
},
- "documentation": "Frame Capture S3 Settings"
+ "required": [
+ "OfferingId"
+ ],
+ "documentation": "Placeholder documentation for DescribeOfferingRequest"
},
- "FrameCaptureSettings": {
+ "DescribeOfferingResponse": {
"type": "structure",
"members": {
- "CaptureInterval": {
- "shape": "__integerMin1Max3600000",
- "locationName": "captureInterval",
- "documentation": "The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits."
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'"
},
- "CaptureIntervalUnits": {
- "shape": "FrameCaptureIntervalUnit",
- "locationName": "captureIntervalUnits",
- "documentation": "Unit for the frame capture interval."
+ "CurrencyCode": {
+ "shape": "__string",
+ "locationName": "currencyCode",
+ "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
},
- "TimecodeBurninSettings": {
- "shape": "TimecodeBurninSettings",
- "locationName": "timecodeBurninSettings",
- "documentation": "Timecode burn-in settings"
- }
- },
- "documentation": "Frame Capture Settings"
- },
- "GatewayTimeoutException": {
+ "Duration": {
+ "shape": "__integer",
+ "locationName": "duration",
+ "documentation": "Lease duration, e.g. '12'"
+ },
+ "DurationUnits": {
+ "shape": "OfferingDurationUnits",
+ "locationName": "durationUnits",
+ "documentation": "Units for duration, e.g. 'MONTHS'"
+ },
+ "FixedPrice": {
+ "shape": "__double",
+ "locationName": "fixedPrice",
+ "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
+ },
+ "OfferingDescription": {
+ "shape": "__string",
+ "locationName": "offeringDescription",
+ "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
+ },
+ "OfferingId": {
+ "shape": "__string",
+ "locationName": "offeringId",
+ "documentation": "Unique offering ID, e.g. '87654321'"
+ },
+ "OfferingType": {
+ "shape": "OfferingType",
+ "locationName": "offeringType",
+ "documentation": "Offering type, e.g. 'NO_UPFRONT'"
+ },
+ "Region": {
+ "shape": "__string",
+ "locationName": "region",
+ "documentation": "AWS region, e.g. 'us-west-2'"
+ },
+ "ResourceSpecification": {
+ "shape": "ReservationResourceSpecification",
+ "locationName": "resourceSpecification",
+ "documentation": "Resource configuration details"
+ },
+ "UsagePrice": {
+ "shape": "__double",
+ "locationName": "usagePrice",
+ "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
+ }
+ },
+ "documentation": "Placeholder documentation for DescribeOfferingResponse"
+ },
+ "DescribeReservationRequest": {
"type": "structure",
"members": {
- "Message": {
+ "ReservationId": {
"shape": "__string",
- "locationName": "message"
+ "location": "uri",
+ "locationName": "reservationId",
+ "documentation": "Unique reservation ID, e.g. '1234567'"
}
},
- "exception": true,
- "error": {
- "httpStatusCode": 504
- },
- "documentation": "Placeholder documentation for GatewayTimeoutException"
+ "required": [
+ "ReservationId"
+ ],
+ "documentation": "Placeholder documentation for DescribeReservationRequest"
},
- "GlobalConfiguration": {
+ "DescribeReservationResponse": {
"type": "structure",
"members": {
- "InitialAudioGain": {
- "shape": "__integerMinNegative60Max60",
- "locationName": "initialAudioGain",
- "documentation": "Value to set the initial audio gain for the Live Event."
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'"
},
- "InputEndAction": {
- "shape": "GlobalConfigurationInputEndAction",
- "locationName": "inputEndAction",
- "documentation": "Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When \"none\" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the \"Input Loss Behavior\" configuration until the next input switch occurs (which is controlled through the Channel Schedule API)."
+ "Count": {
+ "shape": "__integer",
+ "locationName": "count",
+ "documentation": "Number of reserved resources"
},
- "InputLossBehavior": {
- "shape": "InputLossBehavior",
- "locationName": "inputLossBehavior",
- "documentation": "Settings for system actions when input is lost."
+ "CurrencyCode": {
+ "shape": "__string",
+ "locationName": "currencyCode",
+ "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
},
- "OutputLockingMode": {
- "shape": "GlobalConfigurationOutputLockingMode",
- "locationName": "outputLockingMode",
- "documentation": "Indicates how MediaLive pipelines are synchronized.\n\nPIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other.\nEPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch."
+ "Duration": {
+ "shape": "__integer",
+ "locationName": "duration",
+ "documentation": "Lease duration, e.g. '12'"
},
- "OutputTimingSource": {
- "shape": "GlobalConfigurationOutputTimingSource",
- "locationName": "outputTimingSource",
- "documentation": "Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream."
+ "DurationUnits": {
+ "shape": "OfferingDurationUnits",
+ "locationName": "durationUnits",
+ "documentation": "Units for duration, e.g. 'MONTHS'"
},
- "SupportLowFramerateInputs": {
- "shape": "GlobalConfigurationLowFramerateInputs",
- "locationName": "supportLowFramerateInputs",
- "documentation": "Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second."
+ "End": {
+ "shape": "__string",
+ "locationName": "end",
+ "documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'"
},
- "OutputLockingSettings": {
- "shape": "OutputLockingSettings",
- "locationName": "outputLockingSettings",
- "documentation": "Advanced output locking settings"
+ "FixedPrice": {
+ "shape": "__double",
+ "locationName": "fixedPrice",
+ "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "User specified reservation name"
+ },
+ "OfferingDescription": {
+ "shape": "__string",
+ "locationName": "offeringDescription",
+ "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
+ },
+ "OfferingId": {
+ "shape": "__string",
+ "locationName": "offeringId",
+ "documentation": "Unique offering ID, e.g. '87654321'"
+ },
+ "OfferingType": {
+ "shape": "OfferingType",
+ "locationName": "offeringType",
+ "documentation": "Offering type, e.g. 'NO_UPFRONT'"
+ },
+ "Region": {
+ "shape": "__string",
+ "locationName": "region",
+ "documentation": "AWS region, e.g. 'us-west-2'"
+ },
+ "RenewalSettings": {
+ "shape": "RenewalSettings",
+ "locationName": "renewalSettings",
+ "documentation": "Renewal settings for the reservation"
+ },
+ "ReservationId": {
+ "shape": "__string",
+ "locationName": "reservationId",
+ "documentation": "Unique reservation ID, e.g. '1234567'"
+ },
+ "ResourceSpecification": {
+ "shape": "ReservationResourceSpecification",
+ "locationName": "resourceSpecification",
+ "documentation": "Resource configuration details"
+ },
+ "Start": {
+ "shape": "__string",
+ "locationName": "start",
+ "documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'"
+ },
+ "State": {
+ "shape": "ReservationState",
+ "locationName": "state",
+ "documentation": "Current state of reservation, e.g. 'ACTIVE'"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs"
+ },
+ "UsagePrice": {
+ "shape": "__double",
+ "locationName": "usagePrice",
+ "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
}
},
- "documentation": "Global Configuration"
- },
- "GlobalConfigurationInputEndAction": {
- "type": "string",
- "documentation": "Global Configuration Input End Action",
- "enum": [
- "NONE",
- "SWITCH_AND_LOOP_INPUTS"
- ]
- },
- "GlobalConfigurationLowFramerateInputs": {
- "type": "string",
- "documentation": "Global Configuration Low Framerate Inputs",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "GlobalConfigurationOutputLockingMode": {
- "type": "string",
- "documentation": "Global Configuration Output Locking Mode",
- "enum": [
- "EPOCH_LOCKING",
- "PIPELINE_LOCKING"
- ]
- },
- "GlobalConfigurationOutputTimingSource": {
- "type": "string",
- "documentation": "Global Configuration Output Timing Source",
- "enum": [
- "INPUT_CLOCK",
- "SYSTEM_CLOCK"
- ]
- },
- "H264AdaptiveQuantization": {
- "type": "string",
- "documentation": "H264 Adaptive Quantization",
- "enum": [
- "AUTO",
- "HIGH",
- "HIGHER",
- "LOW",
- "MAX",
- "MEDIUM",
- "OFF"
- ]
- },
- "H264ColorMetadata": {
- "type": "string",
- "documentation": "H264 Color Metadata",
- "enum": [
- "IGNORE",
- "INSERT"
- ]
+ "documentation": "Placeholder documentation for DescribeReservationResponse"
},
- "H264ColorSpaceSettings": {
+ "DescribeScheduleRequest": {
"type": "structure",
"members": {
- "ColorSpacePassthroughSettings": {
- "shape": "ColorSpacePassthroughSettings",
- "locationName": "colorSpacePassthroughSettings"
+ "ChannelId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelId",
+ "documentation": "Id of the channel whose schedule is being updated."
},
- "Rec601Settings": {
- "shape": "Rec601Settings",
- "locationName": "rec601Settings"
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
},
- "Rec709Settings": {
- "shape": "Rec709Settings",
- "locationName": "rec709Settings"
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
}
},
- "documentation": "H264 Color Space Settings"
+ "required": [
+ "ChannelId"
+ ],
+ "documentation": "Placeholder documentation for DescribeScheduleRequest"
},
- "H264EntropyEncoding": {
- "type": "string",
- "documentation": "H264 Entropy Encoding",
- "enum": [
- "CABAC",
- "CAVLC"
- ]
+ "DescribeScheduleResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "The next token; for use in pagination."
+ },
+ "ScheduleActions": {
+ "shape": "__listOfScheduleAction",
+ "locationName": "scheduleActions",
+ "documentation": "The list of actions in the schedule."
+ }
+ },
+ "documentation": "Placeholder documentation for DescribeScheduleResponse"
},
- "H264FilterSettings": {
+ "DescribeThumbnailsRequest": {
"type": "structure",
"members": {
- "TemporalFilterSettings": {
- "shape": "TemporalFilterSettings",
- "locationName": "temporalFilterSettings"
+ "ChannelId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelId",
+ "documentation": "Unique ID of the channel"
+ },
+ "PipelineId": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "pipelineId",
+ "documentation": "Pipeline ID (\"0\" or \"1\")"
+ },
+ "ThumbnailType": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "thumbnailType",
+ "documentation": "thumbnail type"
}
},
- "documentation": "H264 Filter Settings"
+ "required": [
+ "ThumbnailType",
+ "PipelineId",
+ "ChannelId"
+ ],
+ "documentation": "Placeholder documentation for DescribeThumbnailsRequest"
},
- "H264FlickerAq": {
- "type": "string",
- "documentation": "H264 Flicker Aq",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
+ "DescribeThumbnailsResponse": {
+ "type": "structure",
+ "members": {
+ "ThumbnailDetails": {
+ "shape": "__listOfThumbnailDetail",
+ "locationName": "thumbnailDetails"
+ }
+ },
+ "documentation": "Placeholder documentation for DescribeThumbnailsResponse"
},
- "H264ForceFieldPictures": {
+ "DescribeThumbnailsResultModel": {
+ "type": "structure",
+ "members": {
+ "ThumbnailDetails": {
+ "shape": "__listOfThumbnailDetail",
+ "locationName": "thumbnailDetails"
+ }
+ },
+ "documentation": "Thumbnail details for all the pipelines of a running channel."
+ },
+ "DeviceSettingsSyncState": {
"type": "string",
- "documentation": "H264 Force Field Pictures",
+ "documentation": "The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.",
"enum": [
- "DISABLED",
- "ENABLED"
+ "SYNCED",
+ "SYNCING"
]
},
- "H264FramerateControl": {
+ "DeviceUpdateStatus": {
"type": "string",
- "documentation": "H264 Framerate Control",
+ "documentation": "The status of software on the input device.",
"enum": [
- "INITIALIZE_FROM_SOURCE",
- "SPECIFIED"
+ "UP_TO_DATE",
+ "NOT_UP_TO_DATE",
+ "UPDATING"
]
},
- "H264GopBReference": {
+ "DolbyEProgramSelection": {
"type": "string",
- "documentation": "H264 Gop BReference",
+ "documentation": "Dolby EProgram Selection",
"enum": [
- "DISABLED",
- "ENABLED"
+ "ALL_CHANNELS",
+ "PROGRAM_1",
+ "PROGRAM_2",
+ "PROGRAM_3",
+ "PROGRAM_4",
+ "PROGRAM_5",
+ "PROGRAM_6",
+ "PROGRAM_7",
+ "PROGRAM_8"
]
},
- "H264GopSizeUnits": {
- "type": "string",
- "documentation": "H264 Gop Size Units",
- "enum": [
- "FRAMES",
- "SECONDS"
+ "DolbyVision81Settings": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Dolby Vision81 Settings"
+ },
+ "DvbNitSettings": {
+ "type": "structure",
+ "members": {
+ "NetworkId": {
+ "shape": "__integerMin0Max65536",
+ "locationName": "networkId",
+ "documentation": "The numeric value placed in the Network Information Table (NIT)."
+ },
+ "NetworkName": {
+ "shape": "__stringMin1Max256",
+ "locationName": "networkName",
+ "documentation": "The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters."
+ },
+ "RepInterval": {
+ "shape": "__integerMin25Max10000",
+ "locationName": "repInterval",
+ "documentation": "The number of milliseconds between instances of this table in the output transport stream."
+ }
+ },
+ "documentation": "DVB Network Information Table (NIT)",
+ "required": [
+ "NetworkName",
+ "NetworkId"
]
},
- "H264Level": {
+ "DvbSdtOutputSdt": {
"type": "string",
- "documentation": "H264 Level",
+ "documentation": "Dvb Sdt Output Sdt",
"enum": [
- "H264_LEVEL_1",
- "H264_LEVEL_1_1",
- "H264_LEVEL_1_2",
- "H264_LEVEL_1_3",
- "H264_LEVEL_2",
- "H264_LEVEL_2_1",
- "H264_LEVEL_2_2",
- "H264_LEVEL_3",
- "H264_LEVEL_3_1",
- "H264_LEVEL_3_2",
- "H264_LEVEL_4",
- "H264_LEVEL_4_1",
- "H264_LEVEL_4_2",
- "H264_LEVEL_5",
- "H264_LEVEL_5_1",
- "H264_LEVEL_5_2",
- "H264_LEVEL_AUTO"
+ "SDT_FOLLOW",
+ "SDT_FOLLOW_IF_PRESENT",
+ "SDT_MANUAL",
+ "SDT_NONE"
]
},
- "H264LookAheadRateControl": {
+ "DvbSdtSettings": {
+ "type": "structure",
+ "members": {
+ "OutputSdt": {
+ "shape": "DvbSdtOutputSdt",
+ "locationName": "outputSdt",
+ "documentation": "Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information."
+ },
+ "RepInterval": {
+ "shape": "__integerMin25Max2000",
+ "locationName": "repInterval",
+ "documentation": "The number of milliseconds between instances of this table in the output transport stream."
+ },
+ "ServiceName": {
+ "shape": "__stringMin1Max256",
+ "locationName": "serviceName",
+ "documentation": "The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters."
+ },
+ "ServiceProviderName": {
+ "shape": "__stringMin1Max256",
+ "locationName": "serviceProviderName",
+ "documentation": "The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters."
+ }
+ },
+ "documentation": "DVB Service Description Table (SDT)"
+ },
+ "DvbSubDestinationAlignment": {
"type": "string",
- "documentation": "H264 Look Ahead Rate Control",
+ "documentation": "Dvb Sub Destination Alignment",
"enum": [
- "HIGH",
- "LOW",
- "MEDIUM"
+ "CENTERED",
+ "LEFT",
+ "SMART"
]
},
- "H264ParControl": {
+ "DvbSubDestinationBackgroundColor": {
"type": "string",
- "documentation": "H264 Par Control",
+ "documentation": "Dvb Sub Destination Background Color",
"enum": [
- "INITIALIZE_FROM_SOURCE",
- "SPECIFIED"
+ "BLACK",
+ "NONE",
+ "WHITE"
]
},
- "H264Profile": {
+ "DvbSubDestinationFontColor": {
"type": "string",
- "documentation": "H264 Profile",
+ "documentation": "Dvb Sub Destination Font Color",
"enum": [
- "BASELINE",
- "HIGH",
- "HIGH_10BIT",
- "HIGH_422",
- "HIGH_422_10BIT",
- "MAIN"
+ "BLACK",
+ "BLUE",
+ "GREEN",
+ "RED",
+ "WHITE",
+ "YELLOW"
]
},
- "H264QualityLevel": {
+ "DvbSubDestinationOutlineColor": {
"type": "string",
- "documentation": "H264 Quality Level",
+ "documentation": "Dvb Sub Destination Outline Color",
"enum": [
- "ENHANCED_QUALITY",
- "STANDARD_QUALITY"
+ "BLACK",
+ "BLUE",
+ "GREEN",
+ "RED",
+ "WHITE",
+ "YELLOW"
]
},
- "H264RateControlMode": {
- "type": "string",
- "documentation": "H264 Rate Control Mode",
+ "DvbSubDestinationSettings": {
+ "type": "structure",
+ "members": {
+ "Alignment": {
+ "shape": "DvbSubDestinationAlignment",
+ "locationName": "alignment",
+ "documentation": "If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting \"smart\" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ },
+ "BackgroundColor": {
+ "shape": "DvbSubDestinationBackgroundColor",
+ "locationName": "backgroundColor",
+ "documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match."
+ },
+ "BackgroundOpacity": {
+ "shape": "__integerMin0Max255",
+ "locationName": "backgroundOpacity",
+ "documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
+ },
+ "Font": {
+ "shape": "InputLocation",
+ "locationName": "font",
+ "documentation": "External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match."
+ },
+ "FontColor": {
+ "shape": "DvbSubDestinationFontColor",
+ "locationName": "fontColor",
+ "documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ },
+ "FontOpacity": {
+ "shape": "__integerMin0Max255",
+ "locationName": "fontOpacity",
+ "documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match."
+ },
+ "FontResolution": {
+ "shape": "__integerMin96Max600",
+ "locationName": "fontResolution",
+ "documentation": "Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match."
+ },
+ "FontSize": {
+ "shape": "__string",
+ "locationName": "fontSize",
+ "documentation": "When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match."
+ },
+ "OutlineColor": {
+ "shape": "DvbSubDestinationOutlineColor",
+ "locationName": "outlineColor",
+ "documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ },
+ "OutlineSize": {
+ "shape": "__integerMin0Max10",
+ "locationName": "outlineSize",
+ "documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ },
+ "ShadowColor": {
+ "shape": "DvbSubDestinationShadowColor",
+ "locationName": "shadowColor",
+ "documentation": "Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match."
+ },
+ "ShadowOpacity": {
+ "shape": "__integerMin0Max255",
+ "locationName": "shadowOpacity",
+ "documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
+ },
+ "ShadowXOffset": {
+ "shape": "__integer",
+ "locationName": "shadowXOffset",
+ "documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match."
+ },
+ "ShadowYOffset": {
+ "shape": "__integer",
+ "locationName": "shadowYOffset",
+ "documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match."
+ },
+ "TeletextGridControl": {
+ "shape": "DvbSubDestinationTeletextGridControl",
+ "locationName": "teletextGridControl",
+ "documentation": "Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs."
+ },
+ "XPosition": {
+ "shape": "__integerMin0",
+ "locationName": "xPosition",
+ "documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ },
+ "YPosition": {
+ "shape": "__integerMin0",
+ "locationName": "yPosition",
+ "documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
+ }
+ },
+ "documentation": "Dvb Sub Destination Settings"
+ },
+ "DvbSubDestinationShadowColor": {
+ "type": "string",
+ "documentation": "Dvb Sub Destination Shadow Color",
"enum": [
- "CBR",
- "MULTIPLEX",
- "QVBR",
- "VBR"
+ "BLACK",
+ "NONE",
+ "WHITE"
]
},
- "H264ScanType": {
+ "DvbSubDestinationTeletextGridControl": {
"type": "string",
- "documentation": "H264 Scan Type",
+ "documentation": "Dvb Sub Destination Teletext Grid Control",
"enum": [
- "INTERLACED",
- "PROGRESSIVE"
+ "FIXED",
+ "SCALED"
]
},
- "H264SceneChangeDetect": {
+ "DvbSubOcrLanguage": {
"type": "string",
- "documentation": "H264 Scene Change Detect",
+ "documentation": "Dvb Sub Ocr Language",
"enum": [
- "DISABLED",
- "ENABLED"
+ "DEU",
+ "ENG",
+ "FRA",
+ "NLD",
+ "POR",
+ "SPA"
]
},
- "H264Settings": {
+ "DvbSubSourceSettings": {
"type": "structure",
"members": {
- "AdaptiveQuantization": {
- "shape": "H264AdaptiveQuantization",
- "locationName": "adaptiveQuantization",
- "documentation": "Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization."
- },
- "AfdSignaling": {
- "shape": "AfdSignaling",
- "locationName": "afdSignaling",
- "documentation": "Indicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter."
+ "OcrLanguage": {
+ "shape": "DvbSubOcrLanguage",
+ "locationName": "ocrLanguage",
+ "documentation": "If you will configure a WebVTT caption description that references this caption selector, use this field to\nprovide the language to consider when translating the image-based source to text."
},
+ "Pid": {
+ "shape": "__integerMin1",
+ "locationName": "pid",
+ "documentation": "When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors."
+ }
+ },
+ "documentation": "Dvb Sub Source Settings"
+ },
+ "DvbTdtSettings": {
+ "type": "structure",
+ "members": {
+ "RepInterval": {
+ "shape": "__integerMin1000Max30000",
+ "locationName": "repInterval",
+ "documentation": "The number of milliseconds between instances of this table in the output transport stream."
+ }
+ },
+ "documentation": "DVB Time and Date Table (SDT)"
+ },
+ "Eac3AtmosCodingMode": {
+ "type": "string",
+ "documentation": "Eac3 Atmos Coding Mode",
+ "enum": [
+ "CODING_MODE_5_1_4",
+ "CODING_MODE_7_1_4",
+ "CODING_MODE_9_1_6"
+ ]
+ },
+ "Eac3AtmosDrcLine": {
+ "type": "string",
+ "documentation": "Eac3 Atmos Drc Line",
+ "enum": [
+ "FILM_LIGHT",
+ "FILM_STANDARD",
+ "MUSIC_LIGHT",
+ "MUSIC_STANDARD",
+ "NONE",
+ "SPEECH"
+ ]
+ },
+ "Eac3AtmosDrcRf": {
+ "type": "string",
+ "documentation": "Eac3 Atmos Drc Rf",
+ "enum": [
+ "FILM_LIGHT",
+ "FILM_STANDARD",
+ "MUSIC_LIGHT",
+ "MUSIC_STANDARD",
+ "NONE",
+ "SPEECH"
+ ]
+ },
+ "Eac3AtmosSettings": {
+ "type": "structure",
+ "members": {
"Bitrate": {
- "shape": "__integerMin1000",
+ "shape": "__double",
"locationName": "bitrate",
- "documentation": "Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000."
- },
- "BufFillPct": {
- "shape": "__integerMin0Max100",
- "locationName": "bufFillPct",
- "documentation": "Percentage of the buffer that should initially be filled (HRD buffer model)."
- },
- "BufSize": {
- "shape": "__integerMin0",
- "locationName": "bufSize",
- "documentation": "Size of buffer (HRD buffer model) in bits."
- },
- "ColorMetadata": {
- "shape": "H264ColorMetadata",
- "locationName": "colorMetadata",
- "documentation": "Includes colorspace metadata in the output."
- },
- "ColorSpaceSettings": {
- "shape": "H264ColorSpaceSettings",
- "locationName": "colorSpaceSettings",
- "documentation": "Color Space settings"
+ "documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode."
},
- "EntropyEncoding": {
- "shape": "H264EntropyEncoding",
- "locationName": "entropyEncoding",
- "documentation": "Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc."
+ "CodingMode": {
+ "shape": "Eac3AtmosCodingMode",
+ "locationName": "codingMode",
+ "documentation": "Dolby Digital Plus with Dolby Atmos coding mode. Determines number of channels."
},
- "FilterSettings": {
- "shape": "H264FilterSettings",
- "locationName": "filterSettings",
- "documentation": "Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. We\nrecommend that you try both filters and observe the results to decide which one to use.\n\nThe Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptual\nfiltering and motion compensated temporal filtering (MCTF). It operates independently of the compression level.\n\nThe Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the current\ncompression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower."
+ "Dialnorm": {
+ "shape": "__integerMin1Max31",
+ "locationName": "dialnorm",
+ "documentation": "Sets the dialnorm for the output. Default 23."
},
- "FixedAfd": {
- "shape": "FixedAfd",
- "locationName": "fixedAfd",
- "documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'."
+ "DrcLine": {
+ "shape": "Eac3AtmosDrcLine",
+ "locationName": "drcLine",
+ "documentation": "Sets the Dolby dynamic range compression profile."
},
- "FlickerAq": {
- "shape": "H264FlickerAq",
- "locationName": "flickerAq",
- "documentation": "Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ."
+ "DrcRf": {
+ "shape": "Eac3AtmosDrcRf",
+ "locationName": "drcRf",
+ "documentation": "Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels."
},
- "ForceFieldPictures": {
- "shape": "H264ForceFieldPictures",
- "locationName": "forceFieldPictures",
- "documentation": "This setting applies only when scan type is \"interlaced.\" It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.)\nenabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately.\ndisabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content."
+ "HeightTrim": {
+ "shape": "__double",
+ "locationName": "heightTrim",
+ "documentation": "Height dimensional trim. Sets the maximum amount to attenuate the height channels when the downstream player isn??t configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels."
},
- "FramerateControl": {
- "shape": "H264FramerateControl",
- "locationName": "framerateControl",
- "documentation": "This field indicates how the output video frame rate is specified. If \"specified\" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if \"initializeFromSource\" is selected then the output video frame rate will be set equal to the input video frame rate of the first input."
- },
- "FramerateDenominator": {
- "shape": "__integerMin1",
- "locationName": "framerateDenominator",
- "documentation": "Framerate denominator."
- },
- "FramerateNumerator": {
- "shape": "__integerMin1",
- "locationName": "framerateNumerator",
- "documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps."
- },
- "GopBReference": {
- "shape": "H264GopBReference",
- "locationName": "gopBReference",
- "documentation": "Documentation update needed"
- },
- "GopClosedCadence": {
- "shape": "__integerMin0",
- "locationName": "gopClosedCadence",
- "documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting."
- },
- "GopNumBFrames": {
- "shape": "__integerMin0Max7",
- "locationName": "gopNumBFrames",
- "documentation": "Number of B-frames between reference frames."
- },
- "GopSize": {
+ "SurroundTrim": {
"shape": "__double",
- "locationName": "gopSize",
- "documentation": "GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.\nIf gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer."
- },
- "GopSizeUnits": {
- "shape": "H264GopSizeUnits",
- "locationName": "gopSizeUnits",
- "documentation": "Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time."
- },
- "Level": {
- "shape": "H264Level",
- "locationName": "level",
- "documentation": "H.264 Level."
- },
- "LookAheadRateControl": {
- "shape": "H264LookAheadRateControl",
- "locationName": "lookAheadRateControl",
- "documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content."
- },
- "MaxBitrate": {
- "shape": "__integerMin1000",
- "locationName": "maxBitrate",
- "documentation": "For QVBR: See the tooltip for Quality level\n\nFor VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video."
- },
- "MinIInterval": {
- "shape": "__integerMin0Max30",
- "locationName": "minIInterval",
- "documentation": "Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1"
- },
- "NumRefFrames": {
- "shape": "__integerMin1Max6",
- "locationName": "numRefFrames",
- "documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding."
- },
- "ParControl": {
- "shape": "H264ParControl",
- "locationName": "parControl",
- "documentation": "This field indicates how the output pixel aspect ratio is specified. If \"specified\" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if \"initializeFromSource\" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input."
- },
- "ParDenominator": {
- "shape": "__integerMin1",
- "locationName": "parDenominator",
- "documentation": "Pixel Aspect Ratio denominator."
- },
- "ParNumerator": {
- "shape": "__integerMin1",
- "locationName": "parNumerator",
- "documentation": "Pixel Aspect Ratio numerator."
- },
- "Profile": {
- "shape": "H264Profile",
- "locationName": "profile",
- "documentation": "H.264 Profile."
- },
- "QualityLevel": {
- "shape": "H264QualityLevel",
- "locationName": "qualityLevel",
- "documentation": "Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel).\n- ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY.\n- STANDARD_QUALITY: Valid for any Rate control mode."
- },
- "QvbrQualityLevel": {
- "shape": "__integerMin1Max10",
- "locationName": "qvbrQualityLevel",
- "documentation": "Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M\nTo let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called \"Video - rate control mode\" in the MediaLive user guide"
- },
- "RateControlMode": {
- "shape": "H264RateControlMode",
- "locationName": "rateControlMode",
- "documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nVBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR\nif you want to maintain a specific average bitrate over the duration of the channel.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates.\n\nMultiplex: This rate control mode is only supported (and is required) when the video is being\ndelivered to a MediaLive Multiplex in which case the rate control configuration is controlled\nby the properties within the Multiplex Program."
- },
- "ScanType": {
- "shape": "H264ScanType",
- "locationName": "scanType",
- "documentation": "Sets the scan type of the output to progressive or top-field-first interlaced."
- },
- "SceneChangeDetect": {
- "shape": "H264SceneChangeDetect",
- "locationName": "sceneChangeDetect",
- "documentation": "Scene change detection.\n\n- On: inserts I-frames when scene change is detected.\n- Off: does not force an I-frame when scene change is detected."
- },
- "Slices": {
- "shape": "__integerMin1Max32",
- "locationName": "slices",
- "documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution."
- },
- "Softness": {
- "shape": "__integerMin0Max128",
- "locationName": "softness",
- "documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15."
- },
- "SpatialAq": {
- "shape": "H264SpatialAq",
- "locationName": "spatialAq",
- "documentation": "Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ."
- },
- "SubgopLength": {
- "shape": "H264SubGopLength",
- "locationName": "subgopLength",
- "documentation": "If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality."
- },
- "Syntax": {
- "shape": "H264Syntax",
- "locationName": "syntax",
- "documentation": "Produces a bitstream compliant with SMPTE RP-2027."
- },
- "TemporalAq": {
- "shape": "H264TemporalAq",
- "locationName": "temporalAq",
- "documentation": "Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ."
- },
- "TimecodeInsertion": {
- "shape": "H264TimecodeInsertionBehavior",
- "locationName": "timecodeInsertion",
- "documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config"
- },
- "TimecodeBurninSettings": {
- "shape": "TimecodeBurninSettings",
- "locationName": "timecodeBurninSettings",
- "documentation": "Timecode burn-in settings"
- },
- "MinQp": {
- "shape": "__integerMin1Max51",
- "locationName": "minQp",
- "documentation": "Sets the minimum QP. If you aren't familiar with quantization adjustment, leave the field empty. MediaLive will\napply an appropriate value."
+ "locationName": "surroundTrim",
+ "documentation": "Surround dimensional trim. Sets the maximum amount to attenuate the surround channels when the downstream player isn't configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels."
}
},
- "documentation": "H264 Settings"
+ "documentation": "Eac3 Atmos Settings"
},
- "H264SpatialAq": {
+ "Eac3AttenuationControl": {
"type": "string",
- "documentation": "H264 Spatial Aq",
+ "documentation": "Eac3 Attenuation Control",
"enum": [
- "DISABLED",
- "ENABLED"
+ "ATTENUATE_3_DB",
+ "NONE"
]
},
- "H264SubGopLength": {
+ "Eac3BitstreamMode": {
"type": "string",
- "documentation": "H264 Sub Gop Length",
+ "documentation": "Eac3 Bitstream Mode",
"enum": [
- "DYNAMIC",
- "FIXED"
+ "COMMENTARY",
+ "COMPLETE_MAIN",
+ "EMERGENCY",
+ "HEARING_IMPAIRED",
+ "VISUALLY_IMPAIRED"
]
},
- "H264Syntax": {
+ "Eac3CodingMode": {
"type": "string",
- "documentation": "H264 Syntax",
+ "documentation": "Eac3 Coding Mode",
"enum": [
- "DEFAULT",
- "RP2027"
+ "CODING_MODE_1_0",
+ "CODING_MODE_2_0",
+ "CODING_MODE_3_2"
]
},
- "H264TemporalAq": {
+ "Eac3DcFilter": {
"type": "string",
- "documentation": "H264 Temporal Aq",
+ "documentation": "Eac3 Dc Filter",
"enum": [
"DISABLED",
"ENABLED"
]
},
- "H264TimecodeInsertionBehavior": {
+ "Eac3DrcLine": {
"type": "string",
- "documentation": "H264 Timecode Insertion Behavior",
+ "documentation": "Eac3 Drc Line",
+ "enum": [
+ "FILM_LIGHT",
+ "FILM_STANDARD",
+ "MUSIC_LIGHT",
+ "MUSIC_STANDARD",
+ "NONE",
+ "SPEECH"
+ ]
+ },
+ "Eac3DrcRf": {
+ "type": "string",
+ "documentation": "Eac3 Drc Rf",
+ "enum": [
+ "FILM_LIGHT",
+ "FILM_STANDARD",
+ "MUSIC_LIGHT",
+ "MUSIC_STANDARD",
+ "NONE",
+ "SPEECH"
+ ]
+ },
+ "Eac3LfeControl": {
+ "type": "string",
+ "documentation": "Eac3 Lfe Control",
+ "enum": [
+ "LFE",
+ "NO_LFE"
+ ]
+ },
+ "Eac3LfeFilter": {
+ "type": "string",
+ "documentation": "Eac3 Lfe Filter",
"enum": [
"DISABLED",
- "PIC_TIMING_SEI"
+ "ENABLED"
]
},
- "H265AdaptiveQuantization": {
+ "Eac3MetadataControl": {
"type": "string",
- "documentation": "H265 Adaptive Quantization",
+ "documentation": "Eac3 Metadata Control",
"enum": [
- "AUTO",
- "HIGH",
- "HIGHER",
- "LOW",
- "MAX",
- "MEDIUM",
- "OFF"
+ "FOLLOW_INPUT",
+ "USE_CONFIGURED"
]
},
- "H265AlternativeTransferFunction": {
+ "Eac3PassthroughControl": {
"type": "string",
- "documentation": "H265 Alternative Transfer Function",
+ "documentation": "Eac3 Passthrough Control",
"enum": [
- "INSERT",
- "OMIT"
+ "NO_PASSTHROUGH",
+ "WHEN_POSSIBLE"
]
},
- "H265ColorMetadata": {
+ "Eac3PhaseControl": {
"type": "string",
- "documentation": "H265 Color Metadata",
+ "documentation": "Eac3 Phase Control",
"enum": [
- "IGNORE",
- "INSERT"
+ "NO_SHIFT",
+ "SHIFT_90_DEGREES"
]
},
- "H265ColorSpaceSettings": {
+ "Eac3Settings": {
"type": "structure",
"members": {
- "ColorSpacePassthroughSettings": {
- "shape": "ColorSpacePassthroughSettings",
- "locationName": "colorSpacePassthroughSettings"
+ "AttenuationControl": {
+ "shape": "Eac3AttenuationControl",
+ "locationName": "attenuationControl",
+ "documentation": "When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode."
},
- "DolbyVision81Settings": {
- "shape": "DolbyVision81Settings",
- "locationName": "dolbyVision81Settings"
+ "Bitrate": {
+ "shape": "__double",
+ "locationName": "bitrate",
+ "documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode."
},
- "Hdr10Settings": {
- "shape": "Hdr10Settings",
- "locationName": "hdr10Settings"
+ "BitstreamMode": {
+ "shape": "Eac3BitstreamMode",
+ "locationName": "bitstreamMode",
+ "documentation": "Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values."
},
- "Rec601Settings": {
- "shape": "Rec601Settings",
- "locationName": "rec601Settings"
+ "CodingMode": {
+ "shape": "Eac3CodingMode",
+ "locationName": "codingMode",
+ "documentation": "Dolby Digital Plus coding mode. Determines number of channels."
},
- "Rec709Settings": {
- "shape": "Rec709Settings",
- "locationName": "rec709Settings"
- }
- },
- "documentation": "H265 Color Space Settings"
- },
- "H265FilterSettings": {
- "type": "structure",
- "members": {
- "TemporalFilterSettings": {
- "shape": "TemporalFilterSettings",
- "locationName": "temporalFilterSettings"
+ "DcFilter": {
+ "shape": "Eac3DcFilter",
+ "locationName": "dcFilter",
+ "documentation": "When set to enabled, activates a DC highpass filter for all input channels."
+ },
+ "Dialnorm": {
+ "shape": "__integerMin1Max31",
+ "locationName": "dialnorm",
+ "documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through."
+ },
+ "DrcLine": {
+ "shape": "Eac3DrcLine",
+ "locationName": "drcLine",
+ "documentation": "Sets the Dolby dynamic range compression profile."
+ },
+ "DrcRf": {
+ "shape": "Eac3DrcRf",
+ "locationName": "drcRf",
+ "documentation": "Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels."
+ },
+ "LfeControl": {
+ "shape": "Eac3LfeControl",
+ "locationName": "lfeControl",
+ "documentation": "When encoding 3/2 audio, setting to lfe enables the LFE channel"
+ },
+ "LfeFilter": {
+ "shape": "Eac3LfeFilter",
+ "locationName": "lfeFilter",
+ "documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode."
+ },
+ "LoRoCenterMixLevel": {
+ "shape": "__double",
+ "locationName": "loRoCenterMixLevel",
+ "documentation": "Left only/Right only center mix level. Only used for 3/2 coding mode."
+ },
+ "LoRoSurroundMixLevel": {
+ "shape": "__double",
+ "locationName": "loRoSurroundMixLevel",
+ "documentation": "Left only/Right only surround mix level. Only used for 3/2 coding mode."
+ },
+ "LtRtCenterMixLevel": {
+ "shape": "__double",
+ "locationName": "ltRtCenterMixLevel",
+ "documentation": "Left total/Right total center mix level. Only used for 3/2 coding mode."
+ },
+ "LtRtSurroundMixLevel": {
+ "shape": "__double",
+ "locationName": "ltRtSurroundMixLevel",
+ "documentation": "Left total/Right total surround mix level. Only used for 3/2 coding mode."
+ },
+ "MetadataControl": {
+ "shape": "Eac3MetadataControl",
+ "locationName": "metadataControl",
+ "documentation": "When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used."
+ },
+ "PassthroughControl": {
+ "shape": "Eac3PassthroughControl",
+ "locationName": "passthroughControl",
+ "documentation": "When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding."
+ },
+ "PhaseControl": {
+ "shape": "Eac3PhaseControl",
+ "locationName": "phaseControl",
+ "documentation": "When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode."
+ },
+ "StereoDownmix": {
+ "shape": "Eac3StereoDownmix",
+ "locationName": "stereoDownmix",
+ "documentation": "Stereo downmix preference. Only used for 3/2 coding mode."
+ },
+ "SurroundExMode": {
+ "shape": "Eac3SurroundExMode",
+ "locationName": "surroundExMode",
+ "documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels."
+ },
+ "SurroundMode": {
+ "shape": "Eac3SurroundMode",
+ "locationName": "surroundMode",
+ "documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels."
}
},
- "documentation": "H265 Filter Settings"
+ "documentation": "Eac3 Settings"
},
- "H265FlickerAq": {
+ "Eac3StereoDownmix": {
"type": "string",
- "documentation": "H265 Flicker Aq",
+ "documentation": "Eac3 Stereo Downmix",
"enum": [
- "DISABLED",
- "ENABLED"
+ "DPL2",
+ "LO_RO",
+ "LT_RT",
+ "NOT_INDICATED"
]
},
- "H265GopSizeUnits": {
+ "Eac3SurroundExMode": {
"type": "string",
- "documentation": "H265 Gop Size Units",
+ "documentation": "Eac3 Surround Ex Mode",
"enum": [
- "FRAMES",
- "SECONDS"
+ "DISABLED",
+ "ENABLED",
+ "NOT_INDICATED"
]
},
- "H265Level": {
+ "Eac3SurroundMode": {
"type": "string",
- "documentation": "H265 Level",
+ "documentation": "Eac3 Surround Mode",
"enum": [
- "H265_LEVEL_1",
- "H265_LEVEL_2",
- "H265_LEVEL_2_1",
- "H265_LEVEL_3",
- "H265_LEVEL_3_1",
- "H265_LEVEL_4",
- "H265_LEVEL_4_1",
- "H265_LEVEL_5",
- "H265_LEVEL_5_1",
- "H265_LEVEL_5_2",
- "H265_LEVEL_6",
- "H265_LEVEL_6_1",
- "H265_LEVEL_6_2",
- "H265_LEVEL_AUTO"
+ "DISABLED",
+ "ENABLED",
+ "NOT_INDICATED"
]
},
- "H265LookAheadRateControl": {
- "type": "string",
- "documentation": "H265 Look Ahead Rate Control",
- "enum": [
- "HIGH",
- "LOW",
- "MEDIUM"
- ]
+ "EbuTtDDestinationSettings": {
+ "type": "structure",
+ "members": {
+ "CopyrightHolder": {
+ "shape": "__stringMax1000",
+ "locationName": "copyrightHolder",
+ "documentation": "Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata."
+ },
+ "FillLineGap": {
+ "shape": "EbuTtDFillLineGapControl",
+ "locationName": "fillLineGap",
+ "documentation": "Specifies how to handle the gap between the lines (in multi-line captions).\n\n- enabled: Fill with the captions background color (as specified in the input captions).\n- disabled: Leave the gap unfilled."
+ },
+ "FontFamily": {
+ "shape": "__string",
+ "locationName": "fontFamily",
+ "documentation": "Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to \"monospaced\". (If styleControl is set to exclude, the font family is always set to \"monospaced\".)\n\nYou specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size.\n\n- Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font).\n- Leave blank to set the family to “monospace”."
+ },
+ "StyleControl": {
+ "shape": "EbuTtDDestinationStyleControl",
+ "locationName": "styleControl",
+ "documentation": "Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions.\n\n- include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext.\n- exclude: In the font data attached to the EBU-TT captions, set the font family to \"monospaced\". Do not include any other style information."
+ }
+ },
+ "documentation": "Ebu Tt DDestination Settings"
},
- "H265Profile": {
+ "EbuTtDDestinationStyleControl": {
"type": "string",
- "documentation": "H265 Profile",
+ "documentation": "Ebu Tt DDestination Style Control",
"enum": [
- "MAIN",
- "MAIN_10BIT"
+ "EXCLUDE",
+ "INCLUDE"
]
},
- "H265RateControlMode": {
+ "EbuTtDFillLineGapControl": {
"type": "string",
- "documentation": "H265 Rate Control Mode",
+ "documentation": "Ebu Tt DFill Line Gap Control",
"enum": [
- "CBR",
- "MULTIPLEX",
- "QVBR"
+ "DISABLED",
+ "ENABLED"
]
},
- "H265ScanType": {
+ "EmbeddedConvert608To708": {
"type": "string",
- "documentation": "H265 Scan Type",
+ "documentation": "Embedded Convert608 To708",
"enum": [
- "INTERLACED",
- "PROGRESSIVE"
+ "DISABLED",
+ "UPCONVERT"
]
},
- "H265SceneChangeDetect": {
+ "EmbeddedDestinationSettings": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Embedded Destination Settings"
+ },
+ "EmbeddedPlusScte20DestinationSettings": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Embedded Plus Scte20 Destination Settings"
+ },
+ "EmbeddedScte20Detection": {
"type": "string",
- "documentation": "H265 Scene Change Detect",
+ "documentation": "Embedded Scte20 Detection",
"enum": [
- "DISABLED",
- "ENABLED"
+ "AUTO",
+ "OFF"
]
},
- "H265Settings": {
+ "EmbeddedSourceSettings": {
"type": "structure",
"members": {
- "AdaptiveQuantization": {
- "shape": "H265AdaptiveQuantization",
- "locationName": "adaptiveQuantization",
- "documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality."
+ "Convert608To708": {
+ "shape": "EmbeddedConvert608To708",
+ "locationName": "convert608To708",
+ "documentation": "If upconvert, 608 data is both passed through via the \"608 compatibility bytes\" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded."
},
- "AfdSignaling": {
- "shape": "AfdSignaling",
- "locationName": "afdSignaling",
- "documentation": "Indicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter."
- },
- "AlternativeTransferFunction": {
- "shape": "H265AlternativeTransferFunction",
- "locationName": "alternativeTransferFunction",
- "documentation": "Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays."
+ "Scte20Detection": {
+ "shape": "EmbeddedScte20Detection",
+ "locationName": "scte20Detection",
+ "documentation": "Set to \"auto\" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions."
},
- "Bitrate": {
- "shape": "__integerMin100000Max40000000",
- "locationName": "bitrate",
- "documentation": "Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000."
+ "Source608ChannelNumber": {
+ "shape": "__integerMin1Max4",
+ "locationName": "source608ChannelNumber",
+ "documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough."
},
- "BufSize": {
- "shape": "__integerMin100000Max80000000",
- "locationName": "bufSize",
- "documentation": "Size of buffer (HRD buffer model) in bits."
+ "Source608TrackNumber": {
+ "shape": "__integerMin1Max5",
+ "locationName": "source608TrackNumber",
+ "documentation": "This field is unused and deprecated."
+ }
+ },
+ "documentation": "Embedded Source Settings"
+ },
+ "Empty": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Placeholder documentation for Empty"
+ },
+ "EncoderSettings": {
+ "type": "structure",
+ "members": {
+ "AudioDescriptions": {
+ "shape": "__listOfAudioDescription",
+ "locationName": "audioDescriptions"
},
- "ColorMetadata": {
- "shape": "H265ColorMetadata",
- "locationName": "colorMetadata",
- "documentation": "Includes colorspace metadata in the output."
+ "AvailBlanking": {
+ "shape": "AvailBlanking",
+ "locationName": "availBlanking",
+ "documentation": "Settings for ad avail blanking."
},
- "ColorSpaceSettings": {
- "shape": "H265ColorSpaceSettings",
- "locationName": "colorSpaceSettings",
- "documentation": "Color Space settings"
+ "AvailConfiguration": {
+ "shape": "AvailConfiguration",
+ "locationName": "availConfiguration",
+ "documentation": "Event-wide configuration settings for ad avail insertion."
},
- "FilterSettings": {
- "shape": "H265FilterSettings",
- "locationName": "filterSettings",
- "documentation": "Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. We\nrecommend that you try both filters and observe the results to decide which one to use.\n\nThe Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptual\nfiltering and motion compensated temporal filtering (MCTF). It operates independently of the compression level.\n\nThe Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the current\ncompression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower."
+ "BlackoutSlate": {
+ "shape": "BlackoutSlate",
+ "locationName": "blackoutSlate",
+ "documentation": "Settings for blackout slate."
},
- "FixedAfd": {
- "shape": "FixedAfd",
- "locationName": "fixedAfd",
- "documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'."
+ "CaptionDescriptions": {
+ "shape": "__listOfCaptionDescription",
+ "locationName": "captionDescriptions",
+ "documentation": "Settings for caption decriptions"
},
- "FlickerAq": {
- "shape": "H265FlickerAq",
- "locationName": "flickerAq",
- "documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames."
+ "FeatureActivations": {
+ "shape": "FeatureActivations",
+ "locationName": "featureActivations",
+ "documentation": "Feature Activations"
},
- "FramerateDenominator": {
- "shape": "__integerMin1Max3003",
- "locationName": "framerateDenominator",
- "documentation": "Framerate denominator."
+ "GlobalConfiguration": {
+ "shape": "GlobalConfiguration",
+ "locationName": "globalConfiguration",
+ "documentation": "Configuration settings that apply to the event as a whole."
},
- "FramerateNumerator": {
- "shape": "__integerMin1",
- "locationName": "framerateNumerator",
- "documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps."
+ "MotionGraphicsConfiguration": {
+ "shape": "MotionGraphicsConfiguration",
+ "locationName": "motionGraphicsConfiguration",
+ "documentation": "Settings for motion graphics."
},
- "GopClosedCadence": {
- "shape": "__integerMin0",
- "locationName": "gopClosedCadence",
- "documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting."
+ "NielsenConfiguration": {
+ "shape": "NielsenConfiguration",
+ "locationName": "nielsenConfiguration",
+ "documentation": "Nielsen configuration settings."
},
- "GopSize": {
- "shape": "__double",
- "locationName": "gopSize",
- "documentation": "GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.\nIf gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer."
+ "OutputGroups": {
+ "shape": "__listOfOutputGroup",
+ "locationName": "outputGroups"
},
- "GopSizeUnits": {
- "shape": "H265GopSizeUnits",
- "locationName": "gopSizeUnits",
- "documentation": "Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time."
+ "TimecodeConfig": {
+ "shape": "TimecodeConfig",
+ "locationName": "timecodeConfig",
+ "documentation": "Contains settings used to acquire and adjust timecode information from inputs."
},
- "Level": {
- "shape": "H265Level",
- "locationName": "level",
- "documentation": "H.265 Level."
+ "VideoDescriptions": {
+ "shape": "__listOfVideoDescription",
+ "locationName": "videoDescriptions"
},
- "LookAheadRateControl": {
- "shape": "H265LookAheadRateControl",
- "locationName": "lookAheadRateControl",
- "documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content."
+ "ThumbnailConfiguration": {
+ "shape": "ThumbnailConfiguration",
+ "locationName": "thumbnailConfiguration",
+ "documentation": "Thumbnail configuration settings."
},
- "MaxBitrate": {
- "shape": "__integerMin100000Max40000000",
- "locationName": "maxBitrate",
- "documentation": "For QVBR: See the tooltip for Quality level"
+ "ColorCorrectionSettings": {
+ "shape": "ColorCorrectionSettings",
+ "locationName": "colorCorrectionSettings",
+ "documentation": "Color Correction Settings"
+ }
+ },
+ "documentation": "Encoder Settings",
+ "required": [
+ "VideoDescriptions",
+ "AudioDescriptions",
+ "OutputGroups",
+ "TimecodeConfig"
+ ]
+ },
+ "EpochLockingSettings": {
+ "type": "structure",
+ "members": {
+ "CustomEpoch": {
+ "shape": "__string",
+ "locationName": "customEpoch",
+ "documentation": "Optional. Enter a value here to use a custom epoch, instead of the standard epoch (which started at 1970-01-01T00:00:00 UTC). Specify the start time of the custom epoch, in YYYY-MM-DDTHH:MM:SS in UTC. The time must be 2000-01-01T00:00:00 or later. Always set the MM:SS portion to 00:00."
},
- "MinIInterval": {
- "shape": "__integerMin0Max30",
- "locationName": "minIInterval",
- "documentation": "Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1"
+ "JamSyncTime": {
+ "shape": "__string",
+ "locationName": "jamSyncTime",
+ "documentation": "Optional. Enter a time for the jam sync. The default is midnight UTC. When epoch locking is enabled, MediaLive performs a daily jam sync on every output encode to ensure timecodes don’t diverge from the wall clock. The jam sync applies only to encodes with frame rate of 29.97 or 59.94 FPS. To override, enter a time in HH:MM:SS in UTC. Always set the MM:SS portion to 00:00."
+ }
+ },
+ "documentation": "Epoch Locking Settings"
+ },
+ "Esam": {
+ "type": "structure",
+ "members": {
+ "AcquisitionPointId": {
+ "shape": "__stringMax256",
+ "locationName": "acquisitionPointId",
+ "documentation": "Sent as acquisitionPointIdentity to identify the MediaLive channel to the POIS."
},
- "ParDenominator": {
- "shape": "__integerMin1",
- "locationName": "parDenominator",
- "documentation": "Pixel Aspect Ratio denominator."
+ "AdAvailOffset": {
+ "shape": "__integerMinNegative1000Max1000",
+ "locationName": "adAvailOffset",
+ "documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages."
},
- "ParNumerator": {
- "shape": "__integerMin1",
- "locationName": "parNumerator",
- "documentation": "Pixel Aspect Ratio numerator."
+ "PasswordParam": {
+ "shape": "__string",
+ "locationName": "passwordParam",
+ "documentation": "Documentation update needed"
},
- "Profile": {
- "shape": "H265Profile",
- "locationName": "profile",
- "documentation": "H.265 Profile."
+ "PoisEndpoint": {
+ "shape": "__stringMax2048",
+ "locationName": "poisEndpoint",
+ "documentation": "The URL of the signal conditioner endpoint on the Placement Opportunity Information System (POIS). MediaLive sends SignalProcessingEvents here when SCTE-35 messages are read."
},
- "QvbrQualityLevel": {
- "shape": "__integerMin1Max10",
- "locationName": "qvbrQualityLevel",
- "documentation": "Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M"
+ "Username": {
+ "shape": "__string",
+ "locationName": "username",
+ "documentation": "Documentation update needed"
},
- "RateControlMode": {
- "shape": "H265RateControlMode",
- "locationName": "rateControlMode",
- "documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates.\n\nMultiplex: This rate control mode is only supported (and is required) when the video is being\ndelivered to a MediaLive Multiplex in which case the rate control configuration is controlled\nby the properties within the Multiplex Program."
+ "ZoneIdentity": {
+ "shape": "__stringMax256",
+ "locationName": "zoneIdentity",
+ "documentation": "Optional data sent as zoneIdentity to identify the MediaLive channel to the POIS."
+ }
+ },
+ "documentation": "Esam",
+ "required": [
+ "AcquisitionPointId",
+ "PoisEndpoint"
+ ]
+ },
+ "FailoverCondition": {
+ "type": "structure",
+ "members": {
+ "FailoverConditionSettings": {
+ "shape": "FailoverConditionSettings",
+ "locationName": "failoverConditionSettings",
+ "documentation": "Failover condition type-specific settings."
+ }
+ },
+ "documentation": "Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings."
+ },
+ "FailoverConditionSettings": {
+ "type": "structure",
+ "members": {
+ "AudioSilenceSettings": {
+ "shape": "AudioSilenceFailoverSettings",
+ "locationName": "audioSilenceSettings",
+ "documentation": "MediaLive will perform a failover if the specified audio selector is silent for the specified period."
},
- "ScanType": {
- "shape": "H265ScanType",
- "locationName": "scanType",
- "documentation": "Sets the scan type of the output to progressive or top-field-first interlaced."
+ "InputLossSettings": {
+ "shape": "InputLossFailoverSettings",
+ "locationName": "inputLossSettings",
+ "documentation": "MediaLive will perform a failover if content is not detected in this input for the specified period."
},
- "SceneChangeDetect": {
- "shape": "H265SceneChangeDetect",
- "locationName": "sceneChangeDetect",
- "documentation": "Scene change detection."
- },
- "Slices": {
- "shape": "__integerMin1Max16",
- "locationName": "slices",
- "documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution."
- },
- "Tier": {
- "shape": "H265Tier",
- "locationName": "tier",
- "documentation": "H.265 Tier."
- },
- "TimecodeInsertion": {
- "shape": "H265TimecodeInsertionBehavior",
- "locationName": "timecodeInsertion",
- "documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config"
- },
- "TimecodeBurninSettings": {
- "shape": "TimecodeBurninSettings",
- "locationName": "timecodeBurninSettings",
- "documentation": "Timecode burn-in settings"
- },
- "MvOverPictureBoundaries": {
- "shape": "H265MvOverPictureBoundaries",
- "locationName": "mvOverPictureBoundaries",
- "documentation": "If you are setting up the picture as a tile, you must set this to \"disabled\". In all other configurations, you typically enter \"enabled\"."
- },
- "MvTemporalPredictor": {
- "shape": "H265MvTemporalPredictor",
- "locationName": "mvTemporalPredictor",
- "documentation": "If you are setting up the picture as a tile, you must set this to \"disabled\". In other configurations, you typically enter \"enabled\"."
- },
- "TileHeight": {
- "shape": "__integerMin64Max2160",
- "locationName": "tileHeight",
- "documentation": "Set this field to set up the picture as a tile. You must also set tileWidth.\nThe tile height must result in 22 or fewer rows in the frame. The tile width\nmust result in 20 or fewer columns in the frame. And finally, the product of the\ncolumn count and row count must be 64 of less.\nIf the tile width and height are specified, MediaLive will override the video\ncodec slices field with a value that MediaLive calculates"
- },
- "TilePadding": {
- "shape": "H265TilePadding",
- "locationName": "tilePadding",
- "documentation": "Set to \"padded\" to force MediaLive to add padding to the frame, to obtain a frame that is a whole multiple of the tile size.\nIf you are setting up the picture as a tile, you must enter \"padded\".\nIn all other configurations, you typically enter \"none\"."
- },
- "TileWidth": {
- "shape": "__integerMin256Max3840",
- "locationName": "tileWidth",
- "documentation": "Set this field to set up the picture as a tile. See tileHeight for more information."
- },
- "TreeblockSize": {
- "shape": "H265TreeblockSize",
- "locationName": "treeblockSize",
- "documentation": "Select the tree block size used for encoding. If you enter \"auto\", the encoder will pick the best size. If you are setting up the picture as a tile, you must set this to 32x32. In all other configurations, you typically enter \"auto\"."
+ "VideoBlackSettings": {
+ "shape": "VideoBlackFailoverSettings",
+ "locationName": "videoBlackSettings",
+ "documentation": "MediaLive will perform a failover if content is considered black for the specified period."
+ }
+ },
+ "documentation": "Settings for one failover condition."
+ },
+ "FeatureActivations": {
+ "type": "structure",
+ "members": {
+ "InputPrepareScheduleActions": {
+ "shape": "FeatureActivationsInputPrepareScheduleActions",
+ "locationName": "inputPrepareScheduleActions",
+ "documentation": "Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled.\nIf you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule."
},
- "MinQp": {
- "shape": "__integerMin1Max51",
- "locationName": "minQp",
- "documentation": "Sets the minimum QP. If you aren't familiar with quantization adjustment, leave the field empty. MediaLive will\napply an appropriate value."
+ "OutputStaticImageOverlayScheduleActions": {
+ "shape": "FeatureActivationsOutputStaticImageOverlayScheduleActions",
+ "locationName": "outputStaticImageOverlayScheduleActions",
+ "documentation": "Enables the output static image overlay feature. Enabling this feature allows you to send channel schedule updates\nto display/clear/modify image overlays on an output-by-output bases."
}
},
- "documentation": "H265 Settings",
- "required": [
- "FramerateNumerator",
- "FramerateDenominator"
- ]
+ "documentation": "Feature Activations"
},
- "H265Tier": {
+ "FeatureActivationsInputPrepareScheduleActions": {
"type": "string",
- "documentation": "H265 Tier",
+ "documentation": "Feature Activations Input Prepare Schedule Actions",
"enum": [
- "HIGH",
- "MAIN"
+ "DISABLED",
+ "ENABLED"
]
},
- "H265TimecodeInsertionBehavior": {
+ "FeatureActivationsOutputStaticImageOverlayScheduleActions": {
"type": "string",
- "documentation": "H265 Timecode Insertion Behavior",
+ "documentation": "Feature Activations Output Static Image Overlay Schedule Actions",
"enum": [
"DISABLED",
- "PIC_TIMING_SEI"
+ "ENABLED"
]
},
- "Hdr10Settings": {
+ "FecOutputIncludeFec": {
+ "type": "string",
+ "documentation": "Fec Output Include Fec",
+ "enum": [
+ "COLUMN",
+ "COLUMN_AND_ROW"
+ ]
+ },
+ "FecOutputSettings": {
"type": "structure",
"members": {
- "MaxCll": {
- "shape": "__integerMin0Max32768",
- "locationName": "maxCll",
- "documentation": "Maximum Content Light Level\nAn integer metadata value defining the maximum light level, in nits,\nof any single pixel within an encoded HDR video stream or file."
+ "ColumnDepth": {
+ "shape": "__integerMin4Max20",
+ "locationName": "columnDepth",
+ "documentation": "Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive."
},
- "MaxFall": {
- "shape": "__integerMin0Max32768",
- "locationName": "maxFall",
- "documentation": "Maximum Frame Average Light Level\nAn integer metadata value defining the maximum average light level, in nits,\nfor any single frame within an encoded HDR video stream or file."
+ "IncludeFec": {
+ "shape": "FecOutputIncludeFec",
+ "locationName": "includeFec",
+ "documentation": "Enables column only or column and row based FEC"
+ },
+ "RowLength": {
+ "shape": "__integerMin1Max20",
+ "locationName": "rowLength",
+ "documentation": "Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive."
}
},
- "documentation": "Hdr10 Settings"
- },
- "HlsAdMarkers": {
- "type": "string",
- "documentation": "Hls Ad Markers",
- "enum": [
- "ADOBE",
- "ELEMENTAL",
- "ELEMENTAL_SCTE35"
- ]
+ "documentation": "Fec Output Settings"
},
- "HlsAkamaiHttpTransferMode": {
+ "FixedAfd": {
"type": "string",
- "documentation": "Hls Akamai Http Transfer Mode",
+ "documentation": "Fixed Afd",
"enum": [
- "CHUNKED",
- "NON_CHUNKED"
+ "AFD_0000",
+ "AFD_0010",
+ "AFD_0011",
+ "AFD_0100",
+ "AFD_1000",
+ "AFD_1001",
+ "AFD_1010",
+ "AFD_1011",
+ "AFD_1101",
+ "AFD_1110",
+ "AFD_1111"
]
},
- "HlsAkamaiSettings": {
+ "FixedModeScheduleActionStartSettings": {
"type": "structure",
"members": {
- "ConnectionRetryInterval": {
- "shape": "__integerMin0",
- "locationName": "connectionRetryInterval",
- "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost."
- },
- "FilecacheDuration": {
- "shape": "__integerMin0Max600",
- "locationName": "filecacheDuration",
- "documentation": "Size in seconds of file cache for streaming outputs."
- },
- "HttpTransferMode": {
- "shape": "HlsAkamaiHttpTransferMode",
- "locationName": "httpTransferMode",
- "documentation": "Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature."
- },
- "NumRetries": {
- "shape": "__integerMin0",
- "locationName": "numRetries",
- "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with \"s3\" or \"mediastore\". For other URIs, the value is always 3."
- },
- "RestartDelay": {
- "shape": "__integerMin0Max15",
- "locationName": "restartDelay",
- "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart."
- },
- "Salt": {
- "shape": "__string",
- "locationName": "salt",
- "documentation": "Salt for authenticated Akamai."
- },
- "Token": {
+ "Time": {
"shape": "__string",
- "locationName": "token",
- "documentation": "Token parameter for authenticated akamai. If not specified, _gda_ is used."
+ "locationName": "time",
+ "documentation": "Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants \"T\" for time and \"Z\" for \"UTC format\"."
}
},
- "documentation": "Hls Akamai Settings"
+ "documentation": "Start time for the action.",
+ "required": [
+ "Time"
+ ]
},
- "HlsBasicPutSettings": {
+ "Fmp4HlsSettings": {
"type": "structure",
"members": {
- "ConnectionRetryInterval": {
- "shape": "__integerMin0",
- "locationName": "connectionRetryInterval",
- "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost."
- },
- "FilecacheDuration": {
- "shape": "__integerMin0Max600",
- "locationName": "filecacheDuration",
- "documentation": "Size in seconds of file cache for streaming outputs."
+ "AudioRenditionSets": {
+ "shape": "__string",
+ "locationName": "audioRenditionSets",
+ "documentation": "List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','."
},
- "NumRetries": {
- "shape": "__integerMin0",
- "locationName": "numRetries",
- "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with \"s3\" or \"mediastore\". For other URIs, the value is always 3."
+ "NielsenId3Behavior": {
+ "shape": "Fmp4NielsenId3Behavior",
+ "locationName": "nielsenId3Behavior",
+ "documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output."
},
- "RestartDelay": {
- "shape": "__integerMin0Max15",
- "locationName": "restartDelay",
- "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart."
+ "TimedMetadataBehavior": {
+ "shape": "Fmp4TimedMetadataBehavior",
+ "locationName": "timedMetadataBehavior",
+ "documentation": "When set to passthrough, timed metadata is passed through from input to output."
}
},
- "documentation": "Hls Basic Put Settings"
+ "documentation": "Fmp4 Hls Settings"
},
- "HlsCaptionLanguageSetting": {
+ "Fmp4NielsenId3Behavior": {
"type": "string",
- "documentation": "Hls Caption Language Setting",
+ "documentation": "Fmp4 Nielsen Id3 Behavior",
"enum": [
- "INSERT",
- "NONE",
- "OMIT"
+ "NO_PASSTHROUGH",
+ "PASSTHROUGH"
]
},
- "HlsCdnSettings": {
+ "Fmp4TimedMetadataBehavior": {
+ "type": "string",
+ "documentation": "Fmp4 Timed Metadata Behavior",
+ "enum": [
+ "NO_PASSTHROUGH",
+ "PASSTHROUGH"
+ ]
+ },
+ "FollowModeScheduleActionStartSettings": {
"type": "structure",
"members": {
- "HlsAkamaiSettings": {
- "shape": "HlsAkamaiSettings",
- "locationName": "hlsAkamaiSettings"
+ "FollowPoint": {
+ "shape": "FollowPoint",
+ "locationName": "followPoint",
+ "documentation": "Identifies whether this action starts relative to the start or relative to the end of the reference action."
},
- "HlsBasicPutSettings": {
- "shape": "HlsBasicPutSettings",
- "locationName": "hlsBasicPutSettings"
+ "ReferenceActionName": {
+ "shape": "__string",
+ "locationName": "referenceActionName",
+ "documentation": "The action name of another action that this one refers to."
+ }
+ },
+ "documentation": "Settings to specify if an action follows another.",
+ "required": [
+ "ReferenceActionName",
+ "FollowPoint"
+ ]
+ },
+ "FollowPoint": {
+ "type": "string",
+ "documentation": "Follow reference point.",
+ "enum": [
+ "END",
+ "START"
+ ]
+ },
+ "ForbiddenException": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ },
+ "exception": true,
+ "error": {
+ "httpStatusCode": 403
+ },
+ "documentation": "Placeholder documentation for ForbiddenException"
+ },
+ "FrameCaptureCdnSettings": {
+ "type": "structure",
+ "members": {
+ "FrameCaptureS3Settings": {
+ "shape": "FrameCaptureS3Settings",
+ "locationName": "frameCaptureS3Settings"
+ }
+ },
+ "documentation": "Frame Capture Cdn Settings"
+ },
+ "FrameCaptureGroupSettings": {
+ "type": "structure",
+ "members": {
+ "Destination": {
+ "shape": "OutputLocationRef",
+ "locationName": "destination",
+ "documentation": "The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, \"curling-\") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curling-low.00001.jpg"
},
- "HlsMediaStoreSettings": {
- "shape": "HlsMediaStoreSettings",
- "locationName": "hlsMediaStoreSettings"
+ "FrameCaptureCdnSettings": {
+ "shape": "FrameCaptureCdnSettings",
+ "locationName": "frameCaptureCdnSettings",
+ "documentation": "Parameters that control interactions with the CDN."
+ }
+ },
+ "documentation": "Frame Capture Group Settings",
+ "required": [
+ "Destination"
+ ]
+ },
+ "FrameCaptureHlsSettings": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Frame Capture Hls Settings"
+ },
+ "FrameCaptureIntervalUnit": {
+ "type": "string",
+ "documentation": "Frame Capture Interval Unit",
+ "enum": [
+ "MILLISECONDS",
+ "SECONDS"
+ ]
+ },
+ "FrameCaptureOutputSettings": {
+ "type": "structure",
+ "members": {
+ "NameModifier": {
+ "shape": "__string",
+ "locationName": "nameModifier",
+ "documentation": "Required if the output group contains more than one output. This modifier forms part of the output file name."
+ }
+ },
+ "documentation": "Frame Capture Output Settings"
+ },
+ "FrameCaptureS3LogUploads": {
+ "type": "string",
+ "documentation": "Frame Capture S3 Log Uploads",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
+ },
+ "FrameCaptureS3Settings": {
+ "type": "structure",
+ "members": {
+ "CannedAcl": {
+ "shape": "S3CannedAcl",
+ "locationName": "cannedAcl",
+ "documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none."
+ }
+ },
+ "documentation": "Frame Capture S3 Settings"
+ },
+ "FrameCaptureSettings": {
+ "type": "structure",
+ "members": {
+ "CaptureInterval": {
+ "shape": "__integerMin1Max3600000",
+ "locationName": "captureInterval",
+ "documentation": "The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits."
},
- "HlsS3Settings": {
- "shape": "HlsS3Settings",
- "locationName": "hlsS3Settings"
+ "CaptureIntervalUnits": {
+ "shape": "FrameCaptureIntervalUnit",
+ "locationName": "captureIntervalUnits",
+ "documentation": "Unit for the frame capture interval."
},
- "HlsWebdavSettings": {
- "shape": "HlsWebdavSettings",
- "locationName": "hlsWebdavSettings"
+ "TimecodeBurninSettings": {
+ "shape": "TimecodeBurninSettings",
+ "locationName": "timecodeBurninSettings",
+ "documentation": "Timecode burn-in settings"
}
},
- "documentation": "Hls Cdn Settings"
+ "documentation": "Frame Capture Settings"
},
- "HlsClientCache": {
+ "GatewayTimeoutException": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ },
+ "exception": true,
+ "error": {
+ "httpStatusCode": 504
+ },
+ "documentation": "Placeholder documentation for GatewayTimeoutException"
+ },
+ "GlobalConfiguration": {
+ "type": "structure",
+ "members": {
+ "InitialAudioGain": {
+ "shape": "__integerMinNegative60Max60",
+ "locationName": "initialAudioGain",
+ "documentation": "Value to set the initial audio gain for the Live Event."
+ },
+ "InputEndAction": {
+ "shape": "GlobalConfigurationInputEndAction",
+ "locationName": "inputEndAction",
+ "documentation": "Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When \"none\" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the \"Input Loss Behavior\" configuration until the next input switch occurs (which is controlled through the Channel Schedule API)."
+ },
+ "InputLossBehavior": {
+ "shape": "InputLossBehavior",
+ "locationName": "inputLossBehavior",
+ "documentation": "Settings for system actions when input is lost."
+ },
+ "OutputLockingMode": {
+ "shape": "GlobalConfigurationOutputLockingMode",
+ "locationName": "outputLockingMode",
+ "documentation": "Indicates how MediaLive pipelines are synchronized.\n\nPIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other.\nEPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch."
+ },
+ "OutputTimingSource": {
+ "shape": "GlobalConfigurationOutputTimingSource",
+ "locationName": "outputTimingSource",
+ "documentation": "Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream."
+ },
+ "SupportLowFramerateInputs": {
+ "shape": "GlobalConfigurationLowFramerateInputs",
+ "locationName": "supportLowFramerateInputs",
+ "documentation": "Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second."
+ },
+ "OutputLockingSettings": {
+ "shape": "OutputLockingSettings",
+ "locationName": "outputLockingSettings",
+ "documentation": "Advanced output locking settings"
+ }
+ },
+ "documentation": "Global Configuration"
+ },
+ "GlobalConfigurationInputEndAction": {
"type": "string",
- "documentation": "Hls Client Cache",
+ "documentation": "Global Configuration Input End Action",
+ "enum": [
+ "NONE",
+ "SWITCH_AND_LOOP_INPUTS"
+ ]
+ },
+ "GlobalConfigurationLowFramerateInputs": {
+ "type": "string",
+ "documentation": "Global Configuration Low Framerate Inputs",
"enum": [
"DISABLED",
"ENABLED"
]
},
- "HlsCodecSpecification": {
+ "GlobalConfigurationOutputLockingMode": {
"type": "string",
- "documentation": "Hls Codec Specification",
+ "documentation": "Global Configuration Output Locking Mode",
"enum": [
- "RFC_4281",
- "RFC_6381"
+ "EPOCH_LOCKING",
+ "PIPELINE_LOCKING"
]
},
- "HlsDirectoryStructure": {
+ "GlobalConfigurationOutputTimingSource": {
"type": "string",
- "documentation": "Hls Directory Structure",
+ "documentation": "Global Configuration Output Timing Source",
"enum": [
- "SINGLE_DIRECTORY",
- "SUBDIRECTORY_PER_STREAM"
+ "INPUT_CLOCK",
+ "SYSTEM_CLOCK"
]
},
- "HlsDiscontinuityTags": {
+ "H264AdaptiveQuantization": {
"type": "string",
- "documentation": "Hls Discontinuity Tags",
+ "documentation": "H264 Adaptive Quantization",
"enum": [
- "INSERT",
- "NEVER_INSERT"
+ "AUTO",
+ "HIGH",
+ "HIGHER",
+ "LOW",
+ "MAX",
+ "MEDIUM",
+ "OFF"
]
},
- "HlsEncryptionType": {
+ "H264ColorMetadata": {
"type": "string",
- "documentation": "Hls Encryption Type",
+ "documentation": "H264 Color Metadata",
"enum": [
- "AES128",
- "SAMPLE_AES"
+ "IGNORE",
+ "INSERT"
]
},
- "HlsGroupSettings": {
+ "H264ColorSpaceSettings": {
"type": "structure",
"members": {
- "AdMarkers": {
- "shape": "__listOfHlsAdMarkers",
- "locationName": "adMarkers",
- "documentation": "Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs."
+ "ColorSpacePassthroughSettings": {
+ "shape": "ColorSpacePassthroughSettings",
+ "locationName": "colorSpacePassthroughSettings"
},
- "BaseUrlContent": {
- "shape": "__string",
- "locationName": "baseUrlContent",
- "documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file."
+ "Rec601Settings": {
+ "shape": "Rec601Settings",
+ "locationName": "rec601Settings"
},
- "BaseUrlContent1": {
- "shape": "__string",
- "locationName": "baseUrlContent1",
- "documentation": "Optional. One value per output group.\n\nThis field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0."
- },
- "BaseUrlManifest": {
- "shape": "__string",
- "locationName": "baseUrlManifest",
- "documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file."
- },
- "BaseUrlManifest1": {
- "shape": "__string",
- "locationName": "baseUrlManifest1",
- "documentation": "Optional. One value per output group.\n\nComplete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0."
- },
- "CaptionLanguageMappings": {
- "shape": "__listOfCaptionLanguageMapping",
- "locationName": "captionLanguageMappings",
- "documentation": "Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to \"insert\"."
- },
- "CaptionLanguageSetting": {
- "shape": "HlsCaptionLanguageSetting",
- "locationName": "captionLanguageSetting",
- "documentation": "Applies only to 608 Embedded output captions.\ninsert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions.\nnone: Include CLOSED-CAPTIONS=NONE line in the manifest.\nomit: Omit any CLOSED-CAPTIONS line from the manifest."
- },
- "ClientCache": {
- "shape": "HlsClientCache",
- "locationName": "clientCache",
- "documentation": "When set to \"disabled\", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay."
- },
- "CodecSpecification": {
- "shape": "HlsCodecSpecification",
- "locationName": "codecSpecification",
- "documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation."
- },
- "ConstantIv": {
- "shape": "__stringMin32Max32",
- "locationName": "constantIv",
- "documentation": "For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to \"explicit\" then this parameter is required and is used as the IV for encryption."
- },
- "Destination": {
- "shape": "OutputLocationRef",
- "locationName": "destination",
- "documentation": "A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled)."
- },
- "DirectoryStructure": {
- "shape": "HlsDirectoryStructure",
- "locationName": "directoryStructure",
- "documentation": "Place segments in subdirectories."
- },
- "DiscontinuityTags": {
- "shape": "HlsDiscontinuityTags",
- "locationName": "discontinuityTags",
- "documentation": "Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.\nTypically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose.\nChoose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags."
- },
- "EncryptionType": {
- "shape": "HlsEncryptionType",
- "locationName": "encryptionType",
- "documentation": "Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired."
- },
- "HlsCdnSettings": {
- "shape": "HlsCdnSettings",
- "locationName": "hlsCdnSettings",
- "documentation": "Parameters that control interactions with the CDN."
- },
- "HlsId3SegmentTagging": {
- "shape": "HlsId3SegmentTaggingState",
- "locationName": "hlsId3SegmentTagging",
- "documentation": "State of HLS ID3 Segment Tagging"
- },
- "IFrameOnlyPlaylists": {
- "shape": "IFrameOnlyPlaylistType",
- "locationName": "iFrameOnlyPlaylists",
- "documentation": "DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).\n\nSTANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888\""
- },
- "IncompleteSegmentBehavior": {
- "shape": "HlsIncompleteSegmentBehavior",
- "locationName": "incompleteSegmentBehavior",
- "documentation": "Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.\nAuto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups.\nSuppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior."
- },
- "IndexNSegments": {
- "shape": "__integerMin3",
- "locationName": "indexNSegments",
- "documentation": "Applies only if Mode field is LIVE.\n\nSpecifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field."
- },
- "InputLossAction": {
- "shape": "InputLossActionForHlsOut",
- "locationName": "inputLossAction",
- "documentation": "Parameter that control output group behavior on input loss."
- },
- "IvInManifest": {
- "shape": "HlsIvInManifest",
- "locationName": "ivInManifest",
- "documentation": "For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to \"include\", IV is listed in the manifest, otherwise the IV is not in the manifest."
- },
- "IvSource": {
- "shape": "HlsIvSource",
- "locationName": "ivSource",
- "documentation": "For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is \"followsSegmentNumber\", it will cause the IV to change every segment (to match the segment number). If this is set to \"explicit\", you must enter a constantIv value."
- },
- "KeepSegments": {
- "shape": "__integerMin1",
- "locationName": "keepSegments",
- "documentation": "Applies only if Mode field is LIVE.\n\nSpecifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1).\n\nIf this \"keep segments\" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player."
- },
- "KeyFormat": {
- "shape": "__string",
- "locationName": "keyFormat",
- "documentation": "The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of \"identity\" is used. A reverse DNS string can also be given."
- },
- "KeyFormatVersions": {
- "shape": "__string",
- "locationName": "keyFormatVersions",
- "documentation": "Either a single positive integer version value or a slash delimited list of version values (1/2/3)."
- },
- "KeyProviderSettings": {
- "shape": "KeyProviderSettings",
- "locationName": "keyProviderSettings",
- "documentation": "The key provider settings."
- },
- "ManifestCompression": {
- "shape": "HlsManifestCompression",
- "locationName": "manifestCompression",
- "documentation": "When set to gzip, compresses HLS playlist."
- },
- "ManifestDurationFormat": {
- "shape": "HlsManifestDurationFormat",
- "locationName": "manifestDurationFormat",
- "documentation": "Indicates whether the output manifest should use floating point or integer values for segment duration."
- },
- "MinSegmentLength": {
- "shape": "__integerMin0",
- "locationName": "minSegmentLength",
- "documentation": "Minimum length of MPEG-2 Transport Stream segments in seconds. When set, minimum segment length is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed."
- },
- "Mode": {
- "shape": "HlsMode",
- "locationName": "mode",
- "documentation": "If \"vod\", all segments are indexed and kept permanently in the destination and manifest. If \"live\", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event.\n\nVOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a \"VOD\" type manifest on completion of the stream."
- },
- "OutputSelection": {
- "shape": "HlsOutputSelection",
- "locationName": "outputSelection",
- "documentation": "MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group.\n\nVARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest.\n\nSEGMENTS_ONLY: Does not generate any manifests for this output group."
- },
- "ProgramDateTime": {
- "shape": "HlsProgramDateTime",
- "locationName": "programDateTime",
- "documentation": "Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock."
- },
- "ProgramDateTimeClock": {
- "shape": "HlsProgramDateTimeClock",
- "locationName": "programDateTimeClock",
- "documentation": "Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include:\n\nINITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment.\n\nSYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock."
- },
- "ProgramDateTimePeriod": {
- "shape": "__integerMin0Max3600",
- "locationName": "programDateTimePeriod",
- "documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds."
- },
- "RedundantManifest": {
- "shape": "HlsRedundantManifest",
- "locationName": "redundantManifest",
- "documentation": "ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines.\n\nDISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only.\n\nFor an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant."
- },
- "SegmentLength": {
- "shape": "__integerMin1",
- "locationName": "segmentLength",
- "documentation": "Length of MPEG-2 Transport Stream segments to create in seconds. Note that segments will end on the next keyframe after this duration, so actual segment length may be longer."
- },
- "SegmentationMode": {
- "shape": "HlsSegmentationMode",
- "locationName": "segmentationMode",
- "documentation": "useInputSegmentation has been deprecated. The configured segment size is always used."
- },
- "SegmentsPerSubdirectory": {
- "shape": "__integerMin1",
- "locationName": "segmentsPerSubdirectory",
- "documentation": "Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect."
- },
- "StreamInfResolution": {
- "shape": "HlsStreamInfResolution",
- "locationName": "streamInfResolution",
- "documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest."
- },
- "TimedMetadataId3Frame": {
- "shape": "HlsTimedMetadataId3Frame",
- "locationName": "timedMetadataId3Frame",
- "documentation": "Indicates ID3 frame that has the timecode."
- },
- "TimedMetadataId3Period": {
- "shape": "__integerMin0",
- "locationName": "timedMetadataId3Period",
- "documentation": "Timed Metadata interval in seconds."
- },
- "TimestampDeltaMilliseconds": {
- "shape": "__integerMin0",
- "locationName": "timestampDeltaMilliseconds",
- "documentation": "Provides an extra millisecond delta offset to fine tune the timestamps."
- },
- "TsFileMode": {
- "shape": "HlsTsFileMode",
- "locationName": "tsFileMode",
- "documentation": "SEGMENTED_FILES: Emit the program as segments - multiple .ts media files.\n\nSINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching."
+ "Rec709Settings": {
+ "shape": "Rec709Settings",
+ "locationName": "rec709Settings"
}
},
- "documentation": "Hls Group Settings",
- "required": [
- "Destination"
- ]
+ "documentation": "H264 Color Space Settings"
},
- "HlsH265PackagingType": {
+ "H264EntropyEncoding": {
"type": "string",
- "documentation": "Hls H265 Packaging Type",
+ "documentation": "H264 Entropy Encoding",
"enum": [
- "HEV1",
- "HVC1"
+ "CABAC",
+ "CAVLC"
]
},
- "HlsId3SegmentTaggingScheduleActionSettings": {
+ "H264FilterSettings": {
"type": "structure",
"members": {
- "Tag": {
- "shape": "__string",
- "locationName": "tag",
- "documentation": "ID3 tag to insert into each segment. Supports special keyword identifiers to substitute in segment-related values.\\nSupported keyword identifiers: https://docs.aws.amazon.com/medialive/latest/ug/variable-data-identifiers.html"
- },
- "Id3": {
- "shape": "__string",
- "locationName": "id3",
- "documentation": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure"
+ "TemporalFilterSettings": {
+ "shape": "TemporalFilterSettings",
+ "locationName": "temporalFilterSettings"
}
},
- "documentation": "Settings for the action to insert a user-defined ID3 tag in each HLS segment"
+ "documentation": "H264 Filter Settings"
},
- "HlsId3SegmentTaggingState": {
+ "H264FlickerAq": {
"type": "string",
- "documentation": "State of HLS ID3 Segment Tagging",
+ "documentation": "H264 Flicker Aq",
"enum": [
"DISABLED",
"ENABLED"
]
},
- "HlsIncompleteSegmentBehavior": {
+ "H264ForceFieldPictures": {
"type": "string",
- "documentation": "Hls Incomplete Segment Behavior",
+ "documentation": "H264 Force Field Pictures",
"enum": [
- "AUTO",
- "SUPPRESS"
+ "DISABLED",
+ "ENABLED"
]
},
- "HlsInputSettings": {
- "type": "structure",
- "members": {
- "Bandwidth": {
- "shape": "__integerMin0",
- "locationName": "bandwidth",
- "documentation": "When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest."
- },
- "BufferSegments": {
- "shape": "__integerMin0",
- "locationName": "bufferSegments",
- "documentation": "When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8."
- },
- "Retries": {
- "shape": "__integerMin0",
- "locationName": "retries",
- "documentation": "The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable."
- },
- "RetryInterval": {
- "shape": "__integerMin0",
- "locationName": "retryInterval",
- "documentation": "The number of seconds between retries when an attempt to read a manifest or segment fails."
- },
- "Scte35Source": {
- "shape": "HlsScte35SourceType",
- "locationName": "scte35Source",
- "documentation": "Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected."
- }
- },
- "documentation": "Hls Input Settings"
- },
- "HlsIvInManifest": {
+ "H264FramerateControl": {
"type": "string",
- "documentation": "Hls Iv In Manifest",
+ "documentation": "H264 Framerate Control",
"enum": [
- "EXCLUDE",
- "INCLUDE"
+ "INITIALIZE_FROM_SOURCE",
+ "SPECIFIED"
]
},
- "HlsIvSource": {
+ "H264GopBReference": {
"type": "string",
- "documentation": "Hls Iv Source",
+ "documentation": "H264 Gop BReference",
"enum": [
- "EXPLICIT",
- "FOLLOWS_SEGMENT_NUMBER"
+ "DISABLED",
+ "ENABLED"
]
},
- "HlsManifestCompression": {
+ "H264GopSizeUnits": {
"type": "string",
- "documentation": "Hls Manifest Compression",
+ "documentation": "H264 Gop Size Units",
"enum": [
- "GZIP",
- "NONE"
+ "FRAMES",
+ "SECONDS"
]
},
- "HlsManifestDurationFormat": {
+ "H264Level": {
"type": "string",
- "documentation": "Hls Manifest Duration Format",
+ "documentation": "H264 Level",
"enum": [
- "FLOATING_POINT",
- "INTEGER"
+ "H264_LEVEL_1",
+ "H264_LEVEL_1_1",
+ "H264_LEVEL_1_2",
+ "H264_LEVEL_1_3",
+ "H264_LEVEL_2",
+ "H264_LEVEL_2_1",
+ "H264_LEVEL_2_2",
+ "H264_LEVEL_3",
+ "H264_LEVEL_3_1",
+ "H264_LEVEL_3_2",
+ "H264_LEVEL_4",
+ "H264_LEVEL_4_1",
+ "H264_LEVEL_4_2",
+ "H264_LEVEL_5",
+ "H264_LEVEL_5_1",
+ "H264_LEVEL_5_2",
+ "H264_LEVEL_AUTO"
]
},
- "HlsMediaStoreSettings": {
- "type": "structure",
- "members": {
- "ConnectionRetryInterval": {
- "shape": "__integerMin0",
- "locationName": "connectionRetryInterval",
- "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost."
- },
- "FilecacheDuration": {
- "shape": "__integerMin0Max600",
- "locationName": "filecacheDuration",
- "documentation": "Size in seconds of file cache for streaming outputs."
- },
- "MediaStoreStorageClass": {
- "shape": "HlsMediaStoreStorageClass",
- "locationName": "mediaStoreStorageClass",
- "documentation": "When set to temporal, output files are stored in non-persistent memory for faster reading and writing."
- },
- "NumRetries": {
- "shape": "__integerMin0",
- "locationName": "numRetries",
- "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with \"s3\" or \"mediastore\". For other URIs, the value is always 3."
- },
- "RestartDelay": {
- "shape": "__integerMin0Max15",
- "locationName": "restartDelay",
- "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart."
- }
- },
- "documentation": "Hls Media Store Settings"
- },
- "HlsMediaStoreStorageClass": {
+ "H264LookAheadRateControl": {
"type": "string",
- "documentation": "Hls Media Store Storage Class",
+ "documentation": "H264 Look Ahead Rate Control",
"enum": [
- "TEMPORAL"
+ "HIGH",
+ "LOW",
+ "MEDIUM"
]
},
- "HlsMode": {
+ "H264ParControl": {
"type": "string",
- "documentation": "Hls Mode",
+ "documentation": "H264 Par Control",
"enum": [
- "LIVE",
- "VOD"
+ "INITIALIZE_FROM_SOURCE",
+ "SPECIFIED"
]
},
- "HlsOutputSelection": {
+ "H264Profile": {
"type": "string",
- "documentation": "Hls Output Selection",
+ "documentation": "H264 Profile",
"enum": [
- "MANIFESTS_AND_SEGMENTS",
- "SEGMENTS_ONLY",
- "VARIANT_MANIFESTS_AND_SEGMENTS"
- ]
- },
- "HlsOutputSettings": {
- "type": "structure",
- "members": {
- "H265PackagingType": {
- "shape": "HlsH265PackagingType",
- "locationName": "h265PackagingType",
- "documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1."
- },
- "HlsSettings": {
- "shape": "HlsSettings",
- "locationName": "hlsSettings",
- "documentation": "Settings regarding the underlying stream. These settings are different for audio-only outputs."
- },
- "NameModifier": {
- "shape": "__stringMin1",
- "locationName": "nameModifier",
- "documentation": "String concatenated to the end of the destination filename. Accepts \\\"Format Identifiers\\\":#formatIdentifierParameters."
- },
- "SegmentModifier": {
- "shape": "__string",
- "locationName": "segmentModifier",
- "documentation": "String concatenated to end of segment filenames."
- }
- },
- "documentation": "Hls Output Settings",
- "required": [
- "HlsSettings"
+ "BASELINE",
+ "HIGH",
+ "HIGH_10BIT",
+ "HIGH_422",
+ "HIGH_422_10BIT",
+ "MAIN"
]
},
- "HlsProgramDateTime": {
+ "H264QualityLevel": {
"type": "string",
- "documentation": "Hls Program Date Time",
+ "documentation": "H264 Quality Level",
"enum": [
- "EXCLUDE",
- "INCLUDE"
+ "ENHANCED_QUALITY",
+ "STANDARD_QUALITY"
]
},
- "HlsProgramDateTimeClock": {
+ "H264RateControlMode": {
"type": "string",
- "documentation": "Hls Program Date Time Clock",
+ "documentation": "H264 Rate Control Mode",
"enum": [
- "INITIALIZE_FROM_OUTPUT_TIMECODE",
- "SYSTEM_CLOCK"
+ "CBR",
+ "MULTIPLEX",
+ "QVBR",
+ "VBR"
]
},
- "HlsRedundantManifest": {
+ "H264ScanType": {
"type": "string",
- "documentation": "Hls Redundant Manifest",
+ "documentation": "H264 Scan Type",
"enum": [
- "DISABLED",
- "ENABLED"
+ "INTERLACED",
+ "PROGRESSIVE"
]
},
- "HlsS3LogUploads": {
+ "H264SceneChangeDetect": {
"type": "string",
- "documentation": "Hls S3 Log Uploads",
+ "documentation": "H264 Scene Change Detect",
"enum": [
"DISABLED",
"ENABLED"
]
},
- "HlsS3Settings": {
- "type": "structure",
- "members": {
- "CannedAcl": {
- "shape": "S3CannedAcl",
- "locationName": "cannedAcl",
- "documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none."
- }
- },
- "documentation": "Hls S3 Settings"
- },
- "HlsScte35SourceType": {
- "type": "string",
- "documentation": "Hls Scte35 Source Type",
- "enum": [
- "MANIFEST",
- "SEGMENTS"
- ]
- },
- "HlsSegmentationMode": {
- "type": "string",
- "documentation": "Hls Segmentation Mode",
- "enum": [
- "USE_INPUT_SEGMENTATION",
- "USE_SEGMENT_DURATION"
- ]
- },
- "HlsSettings": {
+ "H264Settings": {
"type": "structure",
"members": {
- "AudioOnlyHlsSettings": {
- "shape": "AudioOnlyHlsSettings",
- "locationName": "audioOnlyHlsSettings"
+ "AdaptiveQuantization": {
+ "shape": "H264AdaptiveQuantization",
+ "locationName": "adaptiveQuantization",
+ "documentation": "Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization."
},
- "Fmp4HlsSettings": {
- "shape": "Fmp4HlsSettings",
- "locationName": "fmp4HlsSettings"
+ "AfdSignaling": {
+ "shape": "AfdSignaling",
+ "locationName": "afdSignaling",
+ "documentation": "Indicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter."
},
- "FrameCaptureHlsSettings": {
- "shape": "FrameCaptureHlsSettings",
- "locationName": "frameCaptureHlsSettings"
+ "Bitrate": {
+ "shape": "__integerMin1000",
+ "locationName": "bitrate",
+ "documentation": "Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000."
},
- "StandardHlsSettings": {
- "shape": "StandardHlsSettings",
- "locationName": "standardHlsSettings"
- }
- },
- "documentation": "Hls Settings"
- },
- "HlsStreamInfResolution": {
- "type": "string",
- "documentation": "Hls Stream Inf Resolution",
- "enum": [
- "EXCLUDE",
- "INCLUDE"
- ]
- },
- "HlsTimedMetadataId3Frame": {
- "type": "string",
- "documentation": "Hls Timed Metadata Id3 Frame",
- "enum": [
- "NONE",
- "PRIV",
- "TDRL"
- ]
- },
- "HlsTimedMetadataScheduleActionSettings": {
- "type": "structure",
- "members": {
- "Id3": {
- "shape": "__string",
- "locationName": "id3",
- "documentation": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure"
- }
- },
- "documentation": "Settings for the action to emit HLS metadata",
- "required": [
- "Id3"
- ]
- },
- "HlsTsFileMode": {
- "type": "string",
- "documentation": "Hls Ts File Mode",
- "enum": [
- "SEGMENTED_FILES",
- "SINGLE_FILE"
- ]
- },
- "HlsWebdavHttpTransferMode": {
- "type": "string",
- "documentation": "Hls Webdav Http Transfer Mode",
- "enum": [
- "CHUNKED",
- "NON_CHUNKED"
- ]
- },
- "HlsWebdavSettings": {
- "type": "structure",
- "members": {
- "ConnectionRetryInterval": {
- "shape": "__integerMin0",
- "locationName": "connectionRetryInterval",
- "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost."
- },
- "FilecacheDuration": {
- "shape": "__integerMin0Max600",
- "locationName": "filecacheDuration",
- "documentation": "Size in seconds of file cache for streaming outputs."
- },
- "HttpTransferMode": {
- "shape": "HlsWebdavHttpTransferMode",
- "locationName": "httpTransferMode",
- "documentation": "Specify whether or not to use chunked transfer encoding to WebDAV."
+ "BufFillPct": {
+ "shape": "__integerMin0Max100",
+ "locationName": "bufFillPct",
+ "documentation": "Percentage of the buffer that should initially be filled (HRD buffer model)."
},
- "NumRetries": {
+ "BufSize": {
"shape": "__integerMin0",
- "locationName": "numRetries",
- "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with \"s3\" or \"mediastore\". For other URIs, the value is always 3."
+ "locationName": "bufSize",
+ "documentation": "Size of buffer (HRD buffer model) in bits."
},
- "RestartDelay": {
- "shape": "__integerMin0Max15",
- "locationName": "restartDelay",
- "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart."
- }
- },
- "documentation": "Hls Webdav Settings"
- },
- "HtmlMotionGraphicsSettings": {
- "type": "structure",
- "members": {
- },
- "documentation": "Html Motion Graphics Settings"
- },
- "IFrameOnlyPlaylistType": {
- "type": "string",
- "documentation": "When set to \"standard\", an I-Frame only playlist will be written out for each video output in the output group. This I-Frame only playlist will contain byte range offsets pointing to the I-frame(s) in each segment.",
- "enum": [
- "DISABLED",
- "STANDARD"
- ]
- },
- "ImmediateModeScheduleActionStartSettings": {
- "type": "structure",
- "members": {
- },
- "documentation": "Settings to configure an action so that it occurs as soon as possible."
- },
- "IncludeFillerNalUnits": {
- "type": "string",
- "documentation": "Include Filler Nal Units",
- "enum": [
- "AUTO",
- "DROP",
- "INCLUDE"
- ]
- },
- "Input": {
- "type": "structure",
- "members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The Unique ARN of the input (generated, immutable)."
+ "ColorMetadata": {
+ "shape": "H264ColorMetadata",
+ "locationName": "colorMetadata",
+ "documentation": "Includes colorspace metadata in the output."
},
- "AttachedChannels": {
- "shape": "__listOf__string",
- "locationName": "attachedChannels",
- "documentation": "A list of channel IDs that that input is attached to (currently an input can only be attached to one channel)."
+ "ColorSpaceSettings": {
+ "shape": "H264ColorSpaceSettings",
+ "locationName": "colorSpaceSettings",
+ "documentation": "Color Space settings"
},
- "Destinations": {
- "shape": "__listOfInputDestination",
- "locationName": "destinations",
- "documentation": "A list of the destinations of the input (PUSH-type)."
+ "EntropyEncoding": {
+ "shape": "H264EntropyEncoding",
+ "locationName": "entropyEncoding",
+ "documentation": "Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc."
},
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The generated ID of the input (unique for user account, immutable)."
+ "FilterSettings": {
+ "shape": "H264FilterSettings",
+ "locationName": "filterSettings",
+ "documentation": "Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. We\nrecommend that you try both filters and observe the results to decide which one to use.\n\nThe Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptual\nfiltering and motion compensated temporal filtering (MCTF). It operates independently of the compression level.\n\nThe Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the current\ncompression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower."
},
- "InputClass": {
- "shape": "InputClass",
- "locationName": "inputClass",
- "documentation": "STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.\nSINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input."
+ "FixedAfd": {
+ "shape": "FixedAfd",
+ "locationName": "fixedAfd",
+ "documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'."
},
- "InputDevices": {
- "shape": "__listOfInputDeviceSettings",
- "locationName": "inputDevices",
- "documentation": "Settings for the input devices."
+ "FlickerAq": {
+ "shape": "H264FlickerAq",
+ "locationName": "flickerAq",
+ "documentation": "Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ."
},
- "InputPartnerIds": {
- "shape": "__listOf__string",
- "locationName": "inputPartnerIds",
- "documentation": "A list of IDs for all Inputs which are partners of this one."
+ "ForceFieldPictures": {
+ "shape": "H264ForceFieldPictures",
+ "locationName": "forceFieldPictures",
+ "documentation": "This setting applies only when scan type is \"interlaced.\" It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.)\nenabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately.\ndisabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content."
},
- "InputSourceType": {
- "shape": "InputSourceType",
- "locationName": "inputSourceType",
- "documentation": "Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes\nduring input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs."
+ "FramerateControl": {
+ "shape": "H264FramerateControl",
+ "locationName": "framerateControl",
+ "documentation": "This field indicates how the output video frame rate is specified. If \"specified\" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if \"initializeFromSource\" is selected then the output video frame rate will be set equal to the input video frame rate of the first input."
},
- "MediaConnectFlows": {
- "shape": "__listOfMediaConnectFlow",
- "locationName": "mediaConnectFlows",
- "documentation": "A list of MediaConnect Flows for this input."
+ "FramerateDenominator": {
+ "shape": "__integerMin1",
+ "locationName": "framerateDenominator",
+ "documentation": "Framerate denominator."
},
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "The user-assigned name (This is a mutable value)."
+ "FramerateNumerator": {
+ "shape": "__integerMin1",
+ "locationName": "framerateNumerator",
+ "documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps."
},
- "RoleArn": {
- "shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
+ "GopBReference": {
+ "shape": "H264GopBReference",
+ "locationName": "gopBReference",
+ "documentation": "Documentation update needed"
},
- "SecurityGroups": {
- "shape": "__listOf__string",
- "locationName": "securityGroups",
- "documentation": "A list of IDs for all the Input Security Groups attached to the input."
+ "GopClosedCadence": {
+ "shape": "__integerMin0",
+ "locationName": "gopClosedCadence",
+ "documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting."
},
- "Sources": {
- "shape": "__listOfInputSource",
- "locationName": "sources",
- "documentation": "A list of the sources of the input (PULL-type)."
+ "GopNumBFrames": {
+ "shape": "__integerMin0Max7",
+ "locationName": "gopNumBFrames",
+ "documentation": "Number of B-frames between reference frames."
},
- "State": {
- "shape": "InputState",
- "locationName": "state"
+ "GopSize": {
+ "shape": "__double",
+ "locationName": "gopSize",
+ "documentation": "GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.\nIf gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer."
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "GopSizeUnits": {
+ "shape": "H264GopSizeUnits",
+ "locationName": "gopSizeUnits",
+ "documentation": "Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time."
},
- "Type": {
- "shape": "InputType",
- "locationName": "type"
+ "Level": {
+ "shape": "H264Level",
+ "locationName": "level",
+ "documentation": "H.264 Level."
},
- "SrtSettings": {
- "shape": "SrtSettings",
- "locationName": "srtSettings",
- "documentation": "The settings associated with an SRT input."
- }
- },
- "documentation": "Placeholder documentation for Input"
- },
- "InputAttachment": {
- "type": "structure",
- "members": {
- "AutomaticInputFailoverSettings": {
- "shape": "AutomaticInputFailoverSettings",
- "locationName": "automaticInputFailoverSettings",
- "documentation": "User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input."
+ "LookAheadRateControl": {
+ "shape": "H264LookAheadRateControl",
+ "locationName": "lookAheadRateControl",
+ "documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content."
},
- "InputAttachmentName": {
- "shape": "__string",
- "locationName": "inputAttachmentName",
- "documentation": "User-specified name for the attachment. This is required if the user wants to use this input in an input switch action."
+ "MaxBitrate": {
+ "shape": "__integerMin1000",
+ "locationName": "maxBitrate",
+ "documentation": "For QVBR: See the tooltip for Quality level\n\nFor VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video."
},
- "InputId": {
- "shape": "__string",
- "locationName": "inputId",
- "documentation": "The ID of the input"
+ "MinIInterval": {
+ "shape": "__integerMin0Max30",
+ "locationName": "minIInterval",
+ "documentation": "Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1"
},
- "InputSettings": {
- "shape": "InputSettings",
- "locationName": "inputSettings",
- "documentation": "Settings of an input (caption selector, etc.)"
- }
- },
- "documentation": "Placeholder documentation for InputAttachment"
- },
- "InputChannelLevel": {
- "type": "structure",
- "members": {
- "Gain": {
- "shape": "__integerMinNegative60Max6",
- "locationName": "gain",
- "documentation": "Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB."
+ "NumRefFrames": {
+ "shape": "__integerMin1Max6",
+ "locationName": "numRefFrames",
+ "documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding."
},
- "InputChannel": {
- "shape": "__integerMin0Max15",
- "locationName": "inputChannel",
- "documentation": "The index of the input channel used as a source."
+ "ParControl": {
+ "shape": "H264ParControl",
+ "locationName": "parControl",
+ "documentation": "This field indicates how the output pixel aspect ratio is specified. If \"specified\" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if \"initializeFromSource\" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input."
+ },
+ "ParDenominator": {
+ "shape": "__integerMin1",
+ "locationName": "parDenominator",
+ "documentation": "Pixel Aspect Ratio denominator."
+ },
+ "ParNumerator": {
+ "shape": "__integerMin1",
+ "locationName": "parNumerator",
+ "documentation": "Pixel Aspect Ratio numerator."
+ },
+ "Profile": {
+ "shape": "H264Profile",
+ "locationName": "profile",
+ "documentation": "H.264 Profile."
+ },
+ "QualityLevel": {
+ "shape": "H264QualityLevel",
+ "locationName": "qualityLevel",
+ "documentation": "Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel).\n- ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY.\n- STANDARD_QUALITY: Valid for any Rate control mode."
+ },
+ "QvbrQualityLevel": {
+ "shape": "__integerMin1Max10",
+ "locationName": "qvbrQualityLevel",
+ "documentation": "Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M\nTo let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called \"Video - rate control mode\" in the MediaLive user guide"
+ },
+ "RateControlMode": {
+ "shape": "H264RateControlMode",
+ "locationName": "rateControlMode",
+ "documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nVBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR\nif you want to maintain a specific average bitrate over the duration of the channel.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates.\n\nMultiplex: This rate control mode is only supported (and is required) when the video is being\ndelivered to a MediaLive Multiplex in which case the rate control configuration is controlled\nby the properties within the Multiplex Program."
+ },
+ "ScanType": {
+ "shape": "H264ScanType",
+ "locationName": "scanType",
+ "documentation": "Sets the scan type of the output to progressive or top-field-first interlaced."
+ },
+ "SceneChangeDetect": {
+ "shape": "H264SceneChangeDetect",
+ "locationName": "sceneChangeDetect",
+ "documentation": "Scene change detection.\n\n- On: inserts I-frames when scene change is detected.\n- Off: does not force an I-frame when scene change is detected."
+ },
+ "Slices": {
+ "shape": "__integerMin1Max32",
+ "locationName": "slices",
+ "documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution."
+ },
+ "Softness": {
+ "shape": "__integerMin0Max128",
+ "locationName": "softness",
+ "documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15."
+ },
+ "SpatialAq": {
+ "shape": "H264SpatialAq",
+ "locationName": "spatialAq",
+ "documentation": "Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ."
+ },
+ "SubgopLength": {
+ "shape": "H264SubGopLength",
+ "locationName": "subgopLength",
+ "documentation": "If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality."
+ },
+ "Syntax": {
+ "shape": "H264Syntax",
+ "locationName": "syntax",
+ "documentation": "Produces a bitstream compliant with SMPTE RP-2027."
+ },
+ "TemporalAq": {
+ "shape": "H264TemporalAq",
+ "locationName": "temporalAq",
+ "documentation": "Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ."
+ },
+ "TimecodeInsertion": {
+ "shape": "H264TimecodeInsertionBehavior",
+ "locationName": "timecodeInsertion",
+ "documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config"
+ },
+ "TimecodeBurninSettings": {
+ "shape": "TimecodeBurninSettings",
+ "locationName": "timecodeBurninSettings",
+ "documentation": "Timecode burn-in settings"
+ },
+ "MinQp": {
+ "shape": "__integerMin1Max51",
+ "locationName": "minQp",
+ "documentation": "Sets the minimum QP. If you aren't familiar with quantization adjustment, leave the field empty. MediaLive will\napply an appropriate value."
}
},
- "documentation": "Input Channel Level",
- "required": [
- "InputChannel",
- "Gain"
- ]
+ "documentation": "H264 Settings"
},
- "InputClass": {
+ "H264SpatialAq": {
"type": "string",
- "documentation": "A standard input has two sources and a single pipeline input only has one.",
+ "documentation": "H264 Spatial Aq",
"enum": [
- "STANDARD",
- "SINGLE_PIPELINE"
+ "DISABLED",
+ "ENABLED"
]
},
- "InputClippingSettings": {
- "type": "structure",
- "members": {
- "InputTimecodeSource": {
- "shape": "InputTimecodeSource",
- "locationName": "inputTimecodeSource",
- "documentation": "The source of the timecodes in the source being clipped."
- },
- "StartTimecode": {
- "shape": "StartTimecode",
- "locationName": "startTimecode",
- "documentation": "Settings to identify the start of the clip."
- },
- "StopTimecode": {
- "shape": "StopTimecode",
- "locationName": "stopTimecode",
- "documentation": "Settings to identify the end of the clip."
- }
- },
- "documentation": "Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.",
- "required": [
- "InputTimecodeSource"
+ "H264SubGopLength": {
+ "type": "string",
+ "documentation": "H264 Sub Gop Length",
+ "enum": [
+ "DYNAMIC",
+ "FIXED"
]
},
- "InputCodec": {
+ "H264Syntax": {
"type": "string",
- "documentation": "codec in increasing order of complexity",
+ "documentation": "H264 Syntax",
"enum": [
- "MPEG2",
- "AVC",
- "HEVC"
+ "DEFAULT",
+ "RP2027"
]
},
- "InputDeblockFilter": {
+ "H264TemporalAq": {
"type": "string",
- "documentation": "Input Deblock Filter",
+ "documentation": "H264 Temporal Aq",
"enum": [
"DISABLED",
"ENABLED"
]
},
- "InputDenoiseFilter": {
+ "H264TimecodeInsertionBehavior": {
"type": "string",
- "documentation": "Input Denoise Filter",
+ "documentation": "H264 Timecode Insertion Behavior",
"enum": [
"DISABLED",
- "ENABLED"
+ "PIC_TIMING_SEI"
]
},
- "InputDestination": {
+ "H265AdaptiveQuantization": {
+ "type": "string",
+ "documentation": "H265 Adaptive Quantization",
+ "enum": [
+ "AUTO",
+ "HIGH",
+ "HIGHER",
+ "LOW",
+ "MAX",
+ "MEDIUM",
+ "OFF"
+ ]
+ },
+ "H265AlternativeTransferFunction": {
+ "type": "string",
+ "documentation": "H265 Alternative Transfer Function",
+ "enum": [
+ "INSERT",
+ "OMIT"
+ ]
+ },
+ "H265ColorMetadata": {
+ "type": "string",
+ "documentation": "H265 Color Metadata",
+ "enum": [
+ "IGNORE",
+ "INSERT"
+ ]
+ },
+ "H265ColorSpaceSettings": {
"type": "structure",
"members": {
- "Ip": {
- "shape": "__string",
- "locationName": "ip",
- "documentation": "The system-generated static IP address of endpoint.\nIt remains fixed for the lifetime of the input."
+ "ColorSpacePassthroughSettings": {
+ "shape": "ColorSpacePassthroughSettings",
+ "locationName": "colorSpacePassthroughSettings"
},
- "Port": {
- "shape": "__string",
- "locationName": "port",
- "documentation": "The port number for the input."
+ "DolbyVision81Settings": {
+ "shape": "DolbyVision81Settings",
+ "locationName": "dolbyVision81Settings"
},
- "Url": {
- "shape": "__string",
- "locationName": "url",
- "documentation": "This represents the endpoint that the customer stream will be\npushed to."
+ "Hdr10Settings": {
+ "shape": "Hdr10Settings",
+ "locationName": "hdr10Settings"
},
- "Vpc": {
- "shape": "InputDestinationVpc",
- "locationName": "vpc"
+ "Rec601Settings": {
+ "shape": "Rec601Settings",
+ "locationName": "rec601Settings"
+ },
+ "Rec709Settings": {
+ "shape": "Rec709Settings",
+ "locationName": "rec709Settings"
}
},
- "documentation": "The settings for a PUSH type input."
+ "documentation": "H265 Color Space Settings"
},
- "InputDestinationRequest": {
+ "H265FilterSettings": {
"type": "structure",
"members": {
- "StreamName": {
- "shape": "__string",
- "locationName": "streamName",
- "documentation": "A unique name for the location the RTMP stream is being pushed\nto."
+ "TemporalFilterSettings": {
+ "shape": "TemporalFilterSettings",
+ "locationName": "temporalFilterSettings"
}
},
- "documentation": "Endpoint settings for a PUSH type input."
+ "documentation": "H265 Filter Settings"
},
- "InputDestinationVpc": {
- "type": "structure",
- "members": {
- "AvailabilityZone": {
- "shape": "__string",
- "locationName": "availabilityZone",
- "documentation": "The availability zone of the Input destination."
- },
- "NetworkInterfaceId": {
- "shape": "__string",
- "locationName": "networkInterfaceId",
- "documentation": "The network interface ID of the Input destination in the VPC."
- }
- },
- "documentation": "The properties for a VPC type input destination."
+ "H265FlickerAq": {
+ "type": "string",
+ "documentation": "H265 Flicker Aq",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
},
- "InputDevice": {
- "type": "structure",
- "members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique ARN of the input device."
- },
- "ConnectionState": {
- "shape": "InputDeviceConnectionState",
- "locationName": "connectionState",
- "documentation": "The state of the connection between the input device and AWS."
- },
- "DeviceSettingsSyncState": {
- "shape": "DeviceSettingsSyncState",
- "locationName": "deviceSettingsSyncState",
- "documentation": "The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration."
- },
- "DeviceUpdateStatus": {
- "shape": "DeviceUpdateStatus",
- "locationName": "deviceUpdateStatus",
- "documentation": "The status of software on the input device."
- },
- "HdDeviceSettings": {
- "shape": "InputDeviceHdSettings",
- "locationName": "hdDeviceSettings",
- "documentation": "Settings that describe an input device that is type HD."
- },
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique ID of the input device."
- },
- "MacAddress": {
- "shape": "__string",
- "locationName": "macAddress",
- "documentation": "The network MAC address of the input device."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "A name that you specify for the input device."
- },
- "NetworkSettings": {
- "shape": "InputDeviceNetworkSettings",
- "locationName": "networkSettings",
- "documentation": "The network settings for the input device."
- },
- "SerialNumber": {
- "shape": "__string",
- "locationName": "serialNumber",
- "documentation": "The unique serial number of the input device."
- },
- "Type": {
- "shape": "InputDeviceType",
- "locationName": "type",
- "documentation": "The type of the input device."
- },
- "UhdDeviceSettings": {
- "shape": "InputDeviceUhdSettings",
- "locationName": "uhdDeviceSettings",
- "documentation": "Settings that describe an input device that is type UHD."
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
- },
- "AvailabilityZone": {
- "shape": "__string",
- "locationName": "availabilityZone",
- "documentation": "The Availability Zone associated with this input device."
- },
- "MedialiveInputArns": {
- "shape": "__listOf__string",
- "locationName": "medialiveInputArns",
- "documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT."
- },
- "OutputType": {
- "shape": "InputDeviceOutputType",
- "locationName": "outputType",
- "documentation": "The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input."
- }
- },
- "documentation": "An input device."
+ "H265GopSizeUnits": {
+ "type": "string",
+ "documentation": "H265 Gop Size Units",
+ "enum": [
+ "FRAMES",
+ "SECONDS"
+ ]
},
- "InputDeviceActiveInput": {
+ "H265Level": {
"type": "string",
- "documentation": "The source at the input device that is currently active.",
+ "documentation": "H265 Level",
"enum": [
- "HDMI",
- "SDI"
+ "H265_LEVEL_1",
+ "H265_LEVEL_2",
+ "H265_LEVEL_2_1",
+ "H265_LEVEL_3",
+ "H265_LEVEL_3_1",
+ "H265_LEVEL_4",
+ "H265_LEVEL_4_1",
+ "H265_LEVEL_5",
+ "H265_LEVEL_5_1",
+ "H265_LEVEL_5_2",
+ "H265_LEVEL_6",
+ "H265_LEVEL_6_1",
+ "H265_LEVEL_6_2",
+ "H265_LEVEL_AUTO"
]
},
- "InputDeviceCodec": {
+ "H265LookAheadRateControl": {
"type": "string",
- "documentation": "The codec to use on the video that the device produces.",
+ "documentation": "H265 Look Ahead Rate Control",
"enum": [
- "HEVC",
- "AVC"
+ "HIGH",
+ "LOW",
+ "MEDIUM"
]
},
- "InputDeviceConfigurableSettings": {
- "type": "structure",
- "members": {
- "ConfiguredInput": {
- "shape": "InputDeviceConfiguredInput",
- "locationName": "configuredInput",
- "documentation": "The input source that you want to use. If the device has a source connected to only one of its input ports, or if you don't care which source the device sends, specify Auto. If the device has sources connected to both its input ports, and you want to use a specific source, specify the source."
- },
- "MaxBitrate": {
- "shape": "__integer",
- "locationName": "maxBitrate",
- "documentation": "The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video."
- },
- "LatencyMs": {
- "shape": "__integer",
- "locationName": "latencyMs",
- "documentation": "The Link device's buffer size (latency) in milliseconds (ms)."
- },
- "Codec": {
- "shape": "InputDeviceCodec",
- "locationName": "codec",
- "documentation": "Choose the codec for the video that the device produces. Only UHD devices can specify this parameter."
- },
- "MediaconnectSettings": {
- "shape": "InputDeviceMediaConnectConfigurableSettings",
- "locationName": "mediaconnectSettings",
- "documentation": "To attach this device to a MediaConnect flow, specify these parameters. To detach an existing flow, enter {} for the value of mediaconnectSettings. Only UHD devices can specify this parameter."
- },
- "AudioChannelPairs": {
- "shape": "__listOfInputDeviceConfigurableAudioChannelPairConfig",
- "locationName": "audioChannelPairs",
- "documentation": "An array of eight audio configurations, one for each audio pair in the source. Set up each audio configuration either to exclude the pair, or to format it and include it in the output from the device. This parameter applies only to UHD devices, and only when the device is configured as the source for a MediaConnect flow. For an HD device, you configure the audio by setting up audio selectors in the channel configuration."
- }
- },
- "documentation": "Configurable settings for the input device."
+ "H265Profile": {
+ "type": "string",
+ "documentation": "H265 Profile",
+ "enum": [
+ "MAIN",
+ "MAIN_10BIT"
+ ]
},
- "InputDeviceConfigurationValidationError": {
- "type": "structure",
- "members": {
- "Message": {
- "shape": "__string",
- "locationName": "message",
- "documentation": "The error message."
- },
- "ValidationErrors": {
- "shape": "__listOfValidationError",
- "locationName": "validationErrors",
- "documentation": "A collection of validation error responses."
- }
- },
- "documentation": "Placeholder documentation for InputDeviceConfigurationValidationError"
+ "H265RateControlMode": {
+ "type": "string",
+ "documentation": "H265 Rate Control Mode",
+ "enum": [
+ "CBR",
+ "MULTIPLEX",
+ "QVBR"
+ ]
},
- "InputDeviceConfiguredInput": {
+ "H265ScanType": {
"type": "string",
- "documentation": "The source to activate (use) from the input device.",
+ "documentation": "H265 Scan Type",
"enum": [
- "AUTO",
- "HDMI",
- "SDI"
+ "INTERLACED",
+ "PROGRESSIVE"
]
},
- "InputDeviceConnectionState": {
+ "H265SceneChangeDetect": {
"type": "string",
- "documentation": "The state of the connection between the input device and AWS.",
+ "documentation": "H265 Scene Change Detect",
"enum": [
- "DISCONNECTED",
- "CONNECTED"
+ "DISABLED",
+ "ENABLED"
]
},
- "InputDeviceHdSettings": {
+ "H265Settings": {
"type": "structure",
"members": {
- "ActiveInput": {
- "shape": "InputDeviceActiveInput",
- "locationName": "activeInput",
- "documentation": "If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI)."
- },
- "ConfiguredInput": {
- "shape": "InputDeviceConfiguredInput",
- "locationName": "configuredInput",
- "documentation": "The source at the input device that is currently active. You can specify this source."
+ "AdaptiveQuantization": {
+ "shape": "H265AdaptiveQuantization",
+ "locationName": "adaptiveQuantization",
+ "documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality."
},
- "DeviceState": {
- "shape": "InputDeviceState",
- "locationName": "deviceState",
- "documentation": "The state of the input device."
+ "AfdSignaling": {
+ "shape": "AfdSignaling",
+ "locationName": "afdSignaling",
+ "documentation": "Indicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter."
},
- "Framerate": {
- "shape": "__double",
- "locationName": "framerate",
- "documentation": "The frame rate of the video source."
+ "AlternativeTransferFunction": {
+ "shape": "H265AlternativeTransferFunction",
+ "locationName": "alternativeTransferFunction",
+ "documentation": "Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays."
},
- "Height": {
- "shape": "__integer",
- "locationName": "height",
- "documentation": "The height of the video source, in pixels."
+ "Bitrate": {
+ "shape": "__integerMin100000Max40000000",
+ "locationName": "bitrate",
+ "documentation": "Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000."
+ },
+ "BufSize": {
+ "shape": "__integerMin100000Max80000000",
+ "locationName": "bufSize",
+ "documentation": "Size of buffer (HRD buffer model) in bits."
+ },
+ "ColorMetadata": {
+ "shape": "H265ColorMetadata",
+ "locationName": "colorMetadata",
+ "documentation": "Includes colorspace metadata in the output."
+ },
+ "ColorSpaceSettings": {
+ "shape": "H265ColorSpaceSettings",
+ "locationName": "colorSpaceSettings",
+ "documentation": "Color Space settings"
+ },
+ "FilterSettings": {
+ "shape": "H265FilterSettings",
+ "locationName": "filterSettings",
+ "documentation": "Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. We\nrecommend that you try both filters and observe the results to decide which one to use.\n\nThe Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptual\nfiltering and motion compensated temporal filtering (MCTF). It operates independently of the compression level.\n\nThe Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the current\ncompression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower."
+ },
+ "FixedAfd": {
+ "shape": "FixedAfd",
+ "locationName": "fixedAfd",
+ "documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'."
+ },
+ "FlickerAq": {
+ "shape": "H265FlickerAq",
+ "locationName": "flickerAq",
+ "documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames."
+ },
+ "FramerateDenominator": {
+ "shape": "__integerMin1Max3003",
+ "locationName": "framerateDenominator",
+ "documentation": "Framerate denominator."
+ },
+ "FramerateNumerator": {
+ "shape": "__integerMin1",
+ "locationName": "framerateNumerator",
+ "documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps."
+ },
+ "GopClosedCadence": {
+ "shape": "__integerMin0",
+ "locationName": "gopClosedCadence",
+ "documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting."
+ },
+ "GopSize": {
+ "shape": "__double",
+ "locationName": "gopSize",
+ "documentation": "GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.\nIf gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer."
+ },
+ "GopSizeUnits": {
+ "shape": "H265GopSizeUnits",
+ "locationName": "gopSizeUnits",
+ "documentation": "Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time."
+ },
+ "Level": {
+ "shape": "H265Level",
+ "locationName": "level",
+ "documentation": "H.265 Level."
+ },
+ "LookAheadRateControl": {
+ "shape": "H265LookAheadRateControl",
+ "locationName": "lookAheadRateControl",
+ "documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content."
},
"MaxBitrate": {
- "shape": "__integer",
+ "shape": "__integerMin100000Max40000000",
"locationName": "maxBitrate",
- "documentation": "The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum."
+ "documentation": "For QVBR: See the tooltip for Quality level"
+ },
+ "MinIInterval": {
+ "shape": "__integerMin0Max30",
+ "locationName": "minIInterval",
+ "documentation": "Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1"
+ },
+ "ParDenominator": {
+ "shape": "__integerMin1",
+ "locationName": "parDenominator",
+ "documentation": "Pixel Aspect Ratio denominator."
+ },
+ "ParNumerator": {
+ "shape": "__integerMin1",
+ "locationName": "parNumerator",
+ "documentation": "Pixel Aspect Ratio numerator."
+ },
+ "Profile": {
+ "shape": "H265Profile",
+ "locationName": "profile",
+ "documentation": "H.265 Profile."
+ },
+ "QvbrQualityLevel": {
+ "shape": "__integerMin1Max10",
+ "locationName": "qvbrQualityLevel",
+ "documentation": "Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M"
+ },
+ "RateControlMode": {
+ "shape": "H265RateControlMode",
+ "locationName": "rateControlMode",
+ "documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates.\n\nMultiplex: This rate control mode is only supported (and is required) when the video is being\ndelivered to a MediaLive Multiplex in which case the rate control configuration is controlled\nby the properties within the Multiplex Program."
},
"ScanType": {
- "shape": "InputDeviceScanType",
+ "shape": "H265ScanType",
"locationName": "scanType",
- "documentation": "The scan type of the video source."
+ "documentation": "Sets the scan type of the output to progressive or top-field-first interlaced."
},
- "Width": {
- "shape": "__integer",
- "locationName": "width",
- "documentation": "The width of the video source, in pixels."
+ "SceneChangeDetect": {
+ "shape": "H265SceneChangeDetect",
+ "locationName": "sceneChangeDetect",
+ "documentation": "Scene change detection."
},
- "LatencyMs": {
- "shape": "__integer",
- "locationName": "latencyMs",
- "documentation": "The Link device's buffer size (latency) in milliseconds (ms). You can specify this value."
+ "Slices": {
+ "shape": "__integerMin1Max16",
+ "locationName": "slices",
+ "documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution."
+ },
+ "Tier": {
+ "shape": "H265Tier",
+ "locationName": "tier",
+ "documentation": "H.265 Tier."
+ },
+ "TimecodeInsertion": {
+ "shape": "H265TimecodeInsertionBehavior",
+ "locationName": "timecodeInsertion",
+ "documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config"
+ },
+ "TimecodeBurninSettings": {
+ "shape": "TimecodeBurninSettings",
+ "locationName": "timecodeBurninSettings",
+ "documentation": "Timecode burn-in settings"
+ },
+ "MvOverPictureBoundaries": {
+ "shape": "H265MvOverPictureBoundaries",
+ "locationName": "mvOverPictureBoundaries",
+ "documentation": "If you are setting up the picture as a tile, you must set this to \"disabled\". In all other configurations, you typically enter \"enabled\"."
+ },
+ "MvTemporalPredictor": {
+ "shape": "H265MvTemporalPredictor",
+ "locationName": "mvTemporalPredictor",
+ "documentation": "If you are setting up the picture as a tile, you must set this to \"disabled\". In other configurations, you typically enter \"enabled\"."
+ },
+ "TileHeight": {
+ "shape": "__integerMin64Max2160",
+ "locationName": "tileHeight",
+ "documentation": "Set this field to set up the picture as a tile. You must also set tileWidth.\nThe tile height must result in 22 or fewer rows in the frame. The tile width\nmust result in 20 or fewer columns in the frame. And finally, the product of the\ncolumn count and row count must be 64 of less.\nIf the tile width and height are specified, MediaLive will override the video\ncodec slices field with a value that MediaLive calculates"
+ },
+ "TilePadding": {
+ "shape": "H265TilePadding",
+ "locationName": "tilePadding",
+ "documentation": "Set to \"padded\" to force MediaLive to add padding to the frame, to obtain a frame that is a whole multiple of the tile size.\nIf you are setting up the picture as a tile, you must enter \"padded\".\nIn all other configurations, you typically enter \"none\"."
+ },
+ "TileWidth": {
+ "shape": "__integerMin256Max3840",
+ "locationName": "tileWidth",
+ "documentation": "Set this field to set up the picture as a tile. See tileHeight for more information."
+ },
+ "TreeblockSize": {
+ "shape": "H265TreeblockSize",
+ "locationName": "treeblockSize",
+ "documentation": "Select the tree block size used for encoding. If you enter \"auto\", the encoder will pick the best size. If you are setting up the picture as a tile, you must set this to 32x32. In all other configurations, you typically enter \"auto\"."
+ },
+ "MinQp": {
+ "shape": "__integerMin1Max51",
+ "locationName": "minQp",
+ "documentation": "Sets the minimum QP. If you aren't familiar with quantization adjustment, leave the field empty. MediaLive will\napply an appropriate value."
}
},
- "documentation": "Settings that describe the active source from the input device, and the video characteristics of that source."
+ "documentation": "H265 Settings",
+ "required": [
+ "FramerateNumerator",
+ "FramerateDenominator"
+ ]
},
- "InputDeviceIpScheme": {
+ "H265Tier": {
"type": "string",
- "documentation": "Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address.",
+ "documentation": "H265 Tier",
"enum": [
- "STATIC",
- "DHCP"
+ "HIGH",
+ "MAIN"
]
},
- "InputDeviceMediaConnectConfigurableSettings": {
+ "H265TimecodeInsertionBehavior": {
+ "type": "string",
+ "documentation": "H265 Timecode Insertion Behavior",
+ "enum": [
+ "DISABLED",
+ "PIC_TIMING_SEI"
+ ]
+ },
+ "Hdr10Settings": {
"type": "structure",
"members": {
- "FlowArn": {
- "shape": "__string",
- "locationName": "flowArn",
- "documentation": "The ARN of the MediaConnect flow to attach this device to."
- },
- "RoleArn": {
- "shape": "__string",
- "locationName": "roleArn",
- "documentation": "The ARN for the role that MediaLive assumes to access the attached flow and secret. For more information about how to create this role, see the MediaLive user guide."
- },
- "SecretArn": {
- "shape": "__string",
- "locationName": "secretArn",
- "documentation": "The ARN for the secret that holds the encryption key to encrypt the content output by the device."
+ "MaxCll": {
+ "shape": "__integerMin0Max32768",
+ "locationName": "maxCll",
+ "documentation": "Maximum Content Light Level\nAn integer metadata value defining the maximum light level, in nits,\nof any single pixel within an encoded HDR video stream or file."
},
- "SourceName": {
- "shape": "__string",
- "locationName": "sourceName",
- "documentation": "The name of the MediaConnect Flow source to stream to."
+ "MaxFall": {
+ "shape": "__integerMin0Max32768",
+ "locationName": "maxFall",
+ "documentation": "Maximum Frame Average Light Level\nAn integer metadata value defining the maximum average light level, in nits,\nfor any single frame within an encoded HDR video stream or file."
}
},
- "documentation": "Parameters required to attach a MediaConnect flow to the device."
+ "documentation": "Hdr10 Settings"
},
- "InputDeviceMediaConnectSettings": {
+ "HlsAdMarkers": {
+ "type": "string",
+ "documentation": "Hls Ad Markers",
+ "enum": [
+ "ADOBE",
+ "ELEMENTAL",
+ "ELEMENTAL_SCTE35"
+ ]
+ },
+ "HlsAkamaiHttpTransferMode": {
+ "type": "string",
+ "documentation": "Hls Akamai Http Transfer Mode",
+ "enum": [
+ "CHUNKED",
+ "NON_CHUNKED"
+ ]
+ },
+ "HlsAkamaiSettings": {
"type": "structure",
"members": {
- "FlowArn": {
- "shape": "__string",
- "locationName": "flowArn",
- "documentation": "The ARN of the MediaConnect flow."
+ "ConnectionRetryInterval": {
+ "shape": "__integerMin0",
+ "locationName": "connectionRetryInterval",
+ "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost."
},
- "RoleArn": {
- "shape": "__string",
- "locationName": "roleArn",
- "documentation": "The ARN for the role that MediaLive assumes to access the attached flow and secret."
+ "FilecacheDuration": {
+ "shape": "__integerMin0Max600",
+ "locationName": "filecacheDuration",
+ "documentation": "Size in seconds of file cache for streaming outputs."
},
- "SecretArn": {
+ "HttpTransferMode": {
+ "shape": "HlsAkamaiHttpTransferMode",
+ "locationName": "httpTransferMode",
+ "documentation": "Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature."
+ },
+ "NumRetries": {
+ "shape": "__integerMin0",
+ "locationName": "numRetries",
+ "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with \"s3\" or \"mediastore\". For other URIs, the value is always 3."
+ },
+ "RestartDelay": {
+ "shape": "__integerMin0Max15",
+ "locationName": "restartDelay",
+ "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart."
+ },
+ "Salt": {
"shape": "__string",
- "locationName": "secretArn",
- "documentation": "The ARN of the secret used to encrypt the stream."
+ "locationName": "salt",
+ "documentation": "Salt for authenticated Akamai."
},
- "SourceName": {
+ "Token": {
"shape": "__string",
- "locationName": "sourceName",
- "documentation": "The name of the MediaConnect flow source."
+ "locationName": "token",
+ "documentation": "Token parameter for authenticated akamai. If not specified, _gda_ is used."
}
},
- "documentation": "Information about the MediaConnect flow attached to the device."
+ "documentation": "Hls Akamai Settings"
},
- "InputDeviceNetworkSettings": {
+ "HlsBasicPutSettings": {
"type": "structure",
"members": {
- "DnsAddresses": {
- "shape": "__listOf__string",
- "locationName": "dnsAddresses",
- "documentation": "The DNS addresses of the input device."
- },
- "Gateway": {
- "shape": "__string",
- "locationName": "gateway",
- "documentation": "The network gateway IP address."
+ "ConnectionRetryInterval": {
+ "shape": "__integerMin0",
+ "locationName": "connectionRetryInterval",
+ "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost."
},
- "IpAddress": {
- "shape": "__string",
- "locationName": "ipAddress",
- "documentation": "The IP address of the input device."
+ "FilecacheDuration": {
+ "shape": "__integerMin0Max600",
+ "locationName": "filecacheDuration",
+ "documentation": "Size in seconds of file cache for streaming outputs."
},
- "IpScheme": {
- "shape": "InputDeviceIpScheme",
- "locationName": "ipScheme",
- "documentation": "Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address."
+ "NumRetries": {
+ "shape": "__integerMin0",
+ "locationName": "numRetries",
+ "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with \"s3\" or \"mediastore\". For other URIs, the value is always 3."
},
- "SubnetMask": {
- "shape": "__string",
- "locationName": "subnetMask",
- "documentation": "The subnet mask of the input device."
+ "RestartDelay": {
+ "shape": "__integerMin0Max15",
+ "locationName": "restartDelay",
+ "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart."
}
},
- "documentation": "The network settings for the input device."
+ "documentation": "Hls Basic Put Settings"
},
- "InputDeviceOutputType": {
+ "HlsCaptionLanguageSetting": {
"type": "string",
- "documentation": "The output attachment type of the input device.",
+ "documentation": "Hls Caption Language Setting",
"enum": [
+ "INSERT",
"NONE",
- "MEDIALIVE_INPUT",
- "MEDIACONNECT_FLOW"
+ "OMIT"
]
},
- "InputDeviceRequest": {
+ "HlsCdnSettings": {
"type": "structure",
"members": {
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique ID for the device."
+ "HlsAkamaiSettings": {
+ "shape": "HlsAkamaiSettings",
+ "locationName": "hlsAkamaiSettings"
+ },
+ "HlsBasicPutSettings": {
+ "shape": "HlsBasicPutSettings",
+ "locationName": "hlsBasicPutSettings"
+ },
+ "HlsMediaStoreSettings": {
+ "shape": "HlsMediaStoreSettings",
+ "locationName": "hlsMediaStoreSettings"
+ },
+ "HlsS3Settings": {
+ "shape": "HlsS3Settings",
+ "locationName": "hlsS3Settings"
+ },
+ "HlsWebdavSettings": {
+ "shape": "HlsWebdavSettings",
+ "locationName": "hlsWebdavSettings"
}
},
- "documentation": "Settings for an input device."
+ "documentation": "Hls Cdn Settings"
},
- "InputDeviceScanType": {
+ "HlsClientCache": {
"type": "string",
- "documentation": "The scan type of the video source.",
+ "documentation": "Hls Client Cache",
"enum": [
- "INTERLACED",
- "PROGRESSIVE"
+ "DISABLED",
+ "ENABLED"
]
},
- "InputDeviceSettings": {
- "type": "structure",
- "members": {
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique ID for the device."
- }
- },
- "documentation": "Settings for an input device."
+ "HlsCodecSpecification": {
+ "type": "string",
+ "documentation": "Hls Codec Specification",
+ "enum": [
+ "RFC_4281",
+ "RFC_6381"
+ ]
},
- "InputDeviceState": {
+ "HlsDirectoryStructure": {
"type": "string",
- "documentation": "The state of the input device.",
+ "documentation": "Hls Directory Structure",
"enum": [
- "IDLE",
- "STREAMING"
+ "SINGLE_DIRECTORY",
+ "SUBDIRECTORY_PER_STREAM"
]
},
- "InputDeviceSummary": {
+ "HlsDiscontinuityTags": {
+ "type": "string",
+ "documentation": "Hls Discontinuity Tags",
+ "enum": [
+ "INSERT",
+ "NEVER_INSERT"
+ ]
+ },
+ "HlsEncryptionType": {
+ "type": "string",
+ "documentation": "Hls Encryption Type",
+ "enum": [
+ "AES128",
+ "SAMPLE_AES"
+ ]
+ },
+ "HlsGroupSettings": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique ARN of the input device."
- },
- "ConnectionState": {
- "shape": "InputDeviceConnectionState",
- "locationName": "connectionState",
- "documentation": "The state of the connection between the input device and AWS."
- },
- "DeviceSettingsSyncState": {
- "shape": "DeviceSettingsSyncState",
- "locationName": "deviceSettingsSyncState",
- "documentation": "The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration."
- },
- "DeviceUpdateStatus": {
- "shape": "DeviceUpdateStatus",
- "locationName": "deviceUpdateStatus",
- "documentation": "The status of software on the input device."
- },
- "HdDeviceSettings": {
- "shape": "InputDeviceHdSettings",
- "locationName": "hdDeviceSettings",
- "documentation": "Settings that describe an input device that is type HD."
+ "AdMarkers": {
+ "shape": "__listOfHlsAdMarkers",
+ "locationName": "adMarkers",
+ "documentation": "Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs."
},
- "Id": {
+ "BaseUrlContent": {
"shape": "__string",
- "locationName": "id",
- "documentation": "The unique ID of the input device."
+ "locationName": "baseUrlContent",
+ "documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file."
},
- "MacAddress": {
+ "BaseUrlContent1": {
"shape": "__string",
- "locationName": "macAddress",
- "documentation": "The network MAC address of the input device."
+ "locationName": "baseUrlContent1",
+ "documentation": "Optional. One value per output group.\n\nThis field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0."
},
- "Name": {
+ "BaseUrlManifest": {
"shape": "__string",
- "locationName": "name",
- "documentation": "A name that you specify for the input device."
- },
- "NetworkSettings": {
- "shape": "InputDeviceNetworkSettings",
- "locationName": "networkSettings",
- "documentation": "Network settings for the input device."
+ "locationName": "baseUrlManifest",
+ "documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file."
},
- "SerialNumber": {
+ "BaseUrlManifest1": {
"shape": "__string",
- "locationName": "serialNumber",
- "documentation": "The unique serial number of the input device."
- },
- "Type": {
- "shape": "InputDeviceType",
- "locationName": "type",
- "documentation": "The type of the input device."
+ "locationName": "baseUrlManifest1",
+ "documentation": "Optional. One value per output group.\n\nComplete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0."
},
- "UhdDeviceSettings": {
- "shape": "InputDeviceUhdSettings",
- "locationName": "uhdDeviceSettings",
- "documentation": "Settings that describe an input device that is type UHD."
+ "CaptionLanguageMappings": {
+ "shape": "__listOfCaptionLanguageMapping",
+ "locationName": "captionLanguageMappings",
+ "documentation": "Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to \"insert\"."
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "CaptionLanguageSetting": {
+ "shape": "HlsCaptionLanguageSetting",
+ "locationName": "captionLanguageSetting",
+ "documentation": "Applies only to 608 Embedded output captions.\ninsert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions.\nnone: Include CLOSED-CAPTIONS=NONE line in the manifest.\nomit: Omit any CLOSED-CAPTIONS line from the manifest."
},
- "AvailabilityZone": {
- "shape": "__string",
- "locationName": "availabilityZone",
- "documentation": "The Availability Zone associated with this input device."
+ "ClientCache": {
+ "shape": "HlsClientCache",
+ "locationName": "clientCache",
+ "documentation": "When set to \"disabled\", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay."
},
- "MedialiveInputArns": {
- "shape": "__listOf__string",
- "locationName": "medialiveInputArns",
- "documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT."
+ "CodecSpecification": {
+ "shape": "HlsCodecSpecification",
+ "locationName": "codecSpecification",
+ "documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation."
},
- "OutputType": {
- "shape": "InputDeviceOutputType",
- "locationName": "outputType",
- "documentation": "The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input."
- }
- },
- "documentation": "Details of the input device."
- },
- "InputDeviceTransferType": {
- "type": "string",
- "documentation": "The type of device transfer. INCOMING for an input device that is being transferred to you, OUTGOING for an input device that you are transferring to another AWS account.",
- "enum": [
- "OUTGOING",
- "INCOMING"
- ]
- },
- "InputDeviceType": {
- "type": "string",
- "documentation": "The type of the input device. For an AWS Elemental Link device that outputs resolutions up to 1080, choose \"HD\".",
- "enum": [
- "HD",
- "UHD"
- ]
- },
- "InputDeviceUhdSettings": {
- "type": "structure",
- "members": {
- "ActiveInput": {
- "shape": "InputDeviceActiveInput",
- "locationName": "activeInput",
- "documentation": "If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI)."
+ "ConstantIv": {
+ "shape": "__stringMin32Max32",
+ "locationName": "constantIv",
+ "documentation": "For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to \"explicit\" then this parameter is required and is used as the IV for encryption."
},
- "ConfiguredInput": {
- "shape": "InputDeviceConfiguredInput",
- "locationName": "configuredInput",
- "documentation": "The source at the input device that is currently active. You can specify this source."
+ "Destination": {
+ "shape": "OutputLocationRef",
+ "locationName": "destination",
+ "documentation": "A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled)."
},
- "DeviceState": {
- "shape": "InputDeviceState",
- "locationName": "deviceState",
- "documentation": "The state of the input device."
+ "DirectoryStructure": {
+ "shape": "HlsDirectoryStructure",
+ "locationName": "directoryStructure",
+ "documentation": "Place segments in subdirectories."
},
- "Framerate": {
- "shape": "__double",
- "locationName": "framerate",
- "documentation": "The frame rate of the video source."
+ "DiscontinuityTags": {
+ "shape": "HlsDiscontinuityTags",
+ "locationName": "discontinuityTags",
+ "documentation": "Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.\nTypically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose.\nChoose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags."
},
- "Height": {
- "shape": "__integer",
- "locationName": "height",
- "documentation": "The height of the video source, in pixels."
+ "EncryptionType": {
+ "shape": "HlsEncryptionType",
+ "locationName": "encryptionType",
+ "documentation": "Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired."
},
- "MaxBitrate": {
- "shape": "__integer",
- "locationName": "maxBitrate",
- "documentation": "The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum."
+ "HlsCdnSettings": {
+ "shape": "HlsCdnSettings",
+ "locationName": "hlsCdnSettings",
+ "documentation": "Parameters that control interactions with the CDN."
},
- "ScanType": {
- "shape": "InputDeviceScanType",
- "locationName": "scanType",
- "documentation": "The scan type of the video source."
+ "HlsId3SegmentTagging": {
+ "shape": "HlsId3SegmentTaggingState",
+ "locationName": "hlsId3SegmentTagging",
+ "documentation": "State of HLS ID3 Segment Tagging"
},
- "Width": {
- "shape": "__integer",
- "locationName": "width",
- "documentation": "The width of the video source, in pixels."
+ "IFrameOnlyPlaylists": {
+ "shape": "IFrameOnlyPlaylistType",
+ "locationName": "iFrameOnlyPlaylists",
+ "documentation": "DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).\n\nSTANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888\""
},
- "LatencyMs": {
- "shape": "__integer",
- "locationName": "latencyMs",
- "documentation": "The Link device's buffer size (latency) in milliseconds (ms). You can specify this value."
+ "IncompleteSegmentBehavior": {
+ "shape": "HlsIncompleteSegmentBehavior",
+ "locationName": "incompleteSegmentBehavior",
+ "documentation": "Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.\nAuto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups.\nSuppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior."
},
- "Codec": {
- "shape": "InputDeviceCodec",
- "locationName": "codec",
- "documentation": "The codec for the video that the device produces."
+ "IndexNSegments": {
+ "shape": "__integerMin3",
+ "locationName": "indexNSegments",
+ "documentation": "Applies only if Mode field is LIVE.\n\nSpecifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field."
},
- "MediaconnectSettings": {
- "shape": "InputDeviceMediaConnectSettings",
- "locationName": "mediaconnectSettings",
- "documentation": "Information about the MediaConnect flow attached to the device. Returned only if the outputType is MEDIACONNECT_FLOW."
+ "InputLossAction": {
+ "shape": "InputLossActionForHlsOut",
+ "locationName": "inputLossAction",
+ "documentation": "Parameter that control output group behavior on input loss."
},
- "AudioChannelPairs": {
- "shape": "__listOfInputDeviceUhdAudioChannelPairConfig",
- "locationName": "audioChannelPairs",
- "documentation": "An array of eight audio configurations, one for each audio pair in the source. Each audio configuration specifies either to exclude the pair, or to format it and include it in the output from the UHD device. Applies only when the device is configured as the source for a MediaConnect flow."
+ "IvInManifest": {
+ "shape": "HlsIvInManifest",
+ "locationName": "ivInManifest",
+ "documentation": "For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to \"include\", IV is listed in the manifest, otherwise the IV is not in the manifest."
+ },
+ "IvSource": {
+ "shape": "HlsIvSource",
+ "locationName": "ivSource",
+ "documentation": "For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is \"followsSegmentNumber\", it will cause the IV to change every segment (to match the segment number). If this is set to \"explicit\", you must enter a constantIv value."
+ },
+ "KeepSegments": {
+ "shape": "__integerMin1",
+ "locationName": "keepSegments",
+ "documentation": "Applies only if Mode field is LIVE.\n\nSpecifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1).\n\nIf this \"keep segments\" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player."
+ },
+ "KeyFormat": {
+ "shape": "__string",
+ "locationName": "keyFormat",
+ "documentation": "The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of \"identity\" is used. A reverse DNS string can also be given."
+ },
+ "KeyFormatVersions": {
+ "shape": "__string",
+ "locationName": "keyFormatVersions",
+ "documentation": "Either a single positive integer version value or a slash delimited list of version values (1/2/3)."
+ },
+ "KeyProviderSettings": {
+ "shape": "KeyProviderSettings",
+ "locationName": "keyProviderSettings",
+ "documentation": "The key provider settings."
+ },
+ "ManifestCompression": {
+ "shape": "HlsManifestCompression",
+ "locationName": "manifestCompression",
+ "documentation": "When set to gzip, compresses HLS playlist."
+ },
+ "ManifestDurationFormat": {
+ "shape": "HlsManifestDurationFormat",
+ "locationName": "manifestDurationFormat",
+ "documentation": "Indicates whether the output manifest should use floating point or integer values for segment duration."
+ },
+ "MinSegmentLength": {
+ "shape": "__integerMin0",
+ "locationName": "minSegmentLength",
+ "documentation": "Minimum length of MPEG-2 Transport Stream segments in seconds. When set, minimum segment length is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed."
+ },
+ "Mode": {
+ "shape": "HlsMode",
+ "locationName": "mode",
+ "documentation": "If \"vod\", all segments are indexed and kept permanently in the destination and manifest. If \"live\", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event.\n\nVOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a \"VOD\" type manifest on completion of the stream."
+ },
+ "OutputSelection": {
+ "shape": "HlsOutputSelection",
+ "locationName": "outputSelection",
+ "documentation": "MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group.\n\nVARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest.\n\nSEGMENTS_ONLY: Does not generate any manifests for this output group."
+ },
+ "ProgramDateTime": {
+ "shape": "HlsProgramDateTime",
+ "locationName": "programDateTime",
+ "documentation": "Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock."
+ },
+ "ProgramDateTimeClock": {
+ "shape": "HlsProgramDateTimeClock",
+ "locationName": "programDateTimeClock",
+ "documentation": "Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include:\n\nINITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment.\n\nSYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock."
+ },
+ "ProgramDateTimePeriod": {
+ "shape": "__integerMin0Max3600",
+ "locationName": "programDateTimePeriod",
+ "documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds."
+ },
+ "RedundantManifest": {
+ "shape": "HlsRedundantManifest",
+ "locationName": "redundantManifest",
+ "documentation": "ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines.\n\nDISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only.\n\nFor an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant."
+ },
+ "SegmentLength": {
+ "shape": "__integerMin1",
+ "locationName": "segmentLength",
+ "documentation": "Length of MPEG-2 Transport Stream segments to create in seconds. Note that segments will end on the next keyframe after this duration, so actual segment length may be longer."
+ },
+ "SegmentationMode": {
+ "shape": "HlsSegmentationMode",
+ "locationName": "segmentationMode",
+ "documentation": "useInputSegmentation has been deprecated. The configured segment size is always used."
+ },
+ "SegmentsPerSubdirectory": {
+ "shape": "__integerMin1",
+ "locationName": "segmentsPerSubdirectory",
+ "documentation": "Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect."
+ },
+ "StreamInfResolution": {
+ "shape": "HlsStreamInfResolution",
+ "locationName": "streamInfResolution",
+ "documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest."
+ },
+ "TimedMetadataId3Frame": {
+ "shape": "HlsTimedMetadataId3Frame",
+ "locationName": "timedMetadataId3Frame",
+ "documentation": "Indicates ID3 frame that has the timecode."
+ },
+ "TimedMetadataId3Period": {
+ "shape": "__integerMin0",
+ "locationName": "timedMetadataId3Period",
+ "documentation": "Timed Metadata interval in seconds."
+ },
+ "TimestampDeltaMilliseconds": {
+ "shape": "__integerMin0",
+ "locationName": "timestampDeltaMilliseconds",
+ "documentation": "Provides an extra millisecond delta offset to fine tune the timestamps."
+ },
+ "TsFileMode": {
+ "shape": "HlsTsFileMode",
+ "locationName": "tsFileMode",
+ "documentation": "SEGMENTED_FILES: Emit the program as segments - multiple .ts media files.\n\nSINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching."
}
},
- "documentation": "Settings that describe the active source from the input device, and the video characteristics of that source."
+ "documentation": "Hls Group Settings",
+ "required": [
+ "Destination"
+ ]
},
- "InputFilter": {
+ "HlsH265PackagingType": {
"type": "string",
- "documentation": "Input Filter",
+ "documentation": "Hls H265 Packaging Type",
"enum": [
- "AUTO",
- "DISABLED",
- "FORCED"
+ "HEV1",
+ "HVC1"
]
},
- "InputLocation": {
+ "HlsId3SegmentTaggingScheduleActionSettings": {
"type": "structure",
"members": {
- "PasswordParam": {
+ "Tag": {
"shape": "__string",
- "locationName": "passwordParam",
- "documentation": "key used to extract the password from EC2 Parameter store"
+ "locationName": "tag",
+ "documentation": "ID3 tag to insert into each segment. Supports special keyword identifiers to substitute in segment-related values.\\nSupported keyword identifiers: https://docs.aws.amazon.com/medialive/latest/ug/variable-data-identifiers.html"
},
- "Uri": {
- "shape": "__stringMax2048",
- "locationName": "uri",
- "documentation": "Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: \"rtmp://fmsserver/live\"."
- },
- "Username": {
+ "Id3": {
"shape": "__string",
- "locationName": "username",
- "documentation": "Documentation update needed"
+ "locationName": "id3",
+ "documentation": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure"
}
},
- "documentation": "Input Location",
- "required": [
- "Uri"
+ "documentation": "Settings for the action to insert a user-defined ID3 tag in each HLS segment"
+ },
+ "HlsId3SegmentTaggingState": {
+ "type": "string",
+ "documentation": "State of HLS ID3 Segment Tagging",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
]
},
- "InputLossActionForHlsOut": {
+ "HlsIncompleteSegmentBehavior": {
"type": "string",
- "documentation": "Input Loss Action For Hls Out",
+ "documentation": "Hls Incomplete Segment Behavior",
"enum": [
- "EMIT_OUTPUT",
- "PAUSE_OUTPUT"
+ "AUTO",
+ "SUPPRESS"
]
},
- "InputLossActionForMsSmoothOut": {
+ "HlsInputSettings": {
+ "type": "structure",
+ "members": {
+ "Bandwidth": {
+ "shape": "__integerMin0",
+ "locationName": "bandwidth",
+ "documentation": "When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest."
+ },
+ "BufferSegments": {
+ "shape": "__integerMin0",
+ "locationName": "bufferSegments",
+ "documentation": "When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8."
+ },
+ "Retries": {
+ "shape": "__integerMin0",
+ "locationName": "retries",
+ "documentation": "The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable."
+ },
+ "RetryInterval": {
+ "shape": "__integerMin0",
+ "locationName": "retryInterval",
+ "documentation": "The number of seconds between retries when an attempt to read a manifest or segment fails."
+ },
+ "Scte35Source": {
+ "shape": "HlsScte35SourceType",
+ "locationName": "scte35Source",
+ "documentation": "Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected."
+ }
+ },
+ "documentation": "Hls Input Settings"
+ },
+ "HlsIvInManifest": {
"type": "string",
- "documentation": "Input Loss Action For Ms Smooth Out",
+ "documentation": "Hls Iv In Manifest",
"enum": [
- "EMIT_OUTPUT",
- "PAUSE_OUTPUT"
+ "EXCLUDE",
+ "INCLUDE"
]
},
- "InputLossActionForRtmpOut": {
+ "HlsIvSource": {
"type": "string",
- "documentation": "Input Loss Action For Rtmp Out",
+ "documentation": "Hls Iv Source",
"enum": [
- "EMIT_OUTPUT",
- "PAUSE_OUTPUT"
+ "EXPLICIT",
+ "FOLLOWS_SEGMENT_NUMBER"
]
},
- "InputLossActionForUdpOut": {
+ "HlsManifestCompression": {
"type": "string",
- "documentation": "Input Loss Action For Udp Out",
+ "documentation": "Hls Manifest Compression",
"enum": [
- "DROP_PROGRAM",
- "DROP_TS",
- "EMIT_PROGRAM"
+ "GZIP",
+ "NONE"
]
},
- "InputLossBehavior": {
+ "HlsManifestDurationFormat": {
+ "type": "string",
+ "documentation": "Hls Manifest Duration Format",
+ "enum": [
+ "FLOATING_POINT",
+ "INTEGER"
+ ]
+ },
+ "HlsMediaStoreSettings": {
"type": "structure",
"members": {
- "BlackFrameMsec": {
- "shape": "__integerMin0Max1000000",
- "locationName": "blackFrameMsec",
- "documentation": "Documentation update needed"
+ "ConnectionRetryInterval": {
+ "shape": "__integerMin0",
+ "locationName": "connectionRetryInterval",
+ "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost."
},
- "InputLossImageColor": {
- "shape": "__stringMin6Max6",
- "locationName": "inputLossImageColor",
- "documentation": "When input loss image type is \"color\" this field specifies the color to use. Value: 6 hex characters representing the values of RGB."
+ "FilecacheDuration": {
+ "shape": "__integerMin0Max600",
+ "locationName": "filecacheDuration",
+ "documentation": "Size in seconds of file cache for streaming outputs."
},
- "InputLossImageSlate": {
- "shape": "InputLocation",
- "locationName": "inputLossImageSlate",
- "documentation": "When input loss image type is \"slate\" these fields specify the parameters for accessing the slate."
+ "MediaStoreStorageClass": {
+ "shape": "HlsMediaStoreStorageClass",
+ "locationName": "mediaStoreStorageClass",
+ "documentation": "When set to temporal, output files are stored in non-persistent memory for faster reading and writing."
},
- "InputLossImageType": {
- "shape": "InputLossImageType",
- "locationName": "inputLossImageType",
- "documentation": "Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec."
+ "NumRetries": {
+ "shape": "__integerMin0",
+ "locationName": "numRetries",
+ "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with \"s3\" or \"mediastore\". For other URIs, the value is always 3."
},
- "RepeatFrameMsec": {
- "shape": "__integerMin0Max1000000",
- "locationName": "repeatFrameMsec",
- "documentation": "Documentation update needed"
+ "RestartDelay": {
+ "shape": "__integerMin0Max15",
+ "locationName": "restartDelay",
+ "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart."
}
},
- "documentation": "Input Loss Behavior"
+ "documentation": "Hls Media Store Settings"
},
- "InputLossFailoverSettings": {
+ "HlsMediaStoreStorageClass": {
+ "type": "string",
+ "documentation": "Hls Media Store Storage Class",
+ "enum": [
+ "TEMPORAL"
+ ]
+ },
+ "HlsMode": {
+ "type": "string",
+ "documentation": "Hls Mode",
+ "enum": [
+ "LIVE",
+ "VOD"
+ ]
+ },
+ "HlsOutputSelection": {
+ "type": "string",
+ "documentation": "Hls Output Selection",
+ "enum": [
+ "MANIFESTS_AND_SEGMENTS",
+ "SEGMENTS_ONLY",
+ "VARIANT_MANIFESTS_AND_SEGMENTS"
+ ]
+ },
+ "HlsOutputSettings": {
"type": "structure",
"members": {
- "InputLossThresholdMsec": {
- "shape": "__integerMin100",
- "locationName": "inputLossThresholdMsec",
- "documentation": "The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur."
+ "H265PackagingType": {
+ "shape": "HlsH265PackagingType",
+ "locationName": "h265PackagingType",
+ "documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1."
+ },
+ "HlsSettings": {
+ "shape": "HlsSettings",
+ "locationName": "hlsSettings",
+ "documentation": "Settings regarding the underlying stream. These settings are different for audio-only outputs."
+ },
+ "NameModifier": {
+ "shape": "__stringMin1",
+ "locationName": "nameModifier",
+ "documentation": "String concatenated to the end of the destination filename. Accepts \\\"Format Identifiers\\\":#formatIdentifierParameters."
+ },
+ "SegmentModifier": {
+ "shape": "__string",
+ "locationName": "segmentModifier",
+ "documentation": "String concatenated to end of segment filenames."
}
},
- "documentation": "MediaLive will perform a failover if content is not detected in this input for the specified period."
+ "documentation": "Hls Output Settings",
+ "required": [
+ "HlsSettings"
+ ]
},
- "InputLossImageType": {
+ "HlsProgramDateTime": {
"type": "string",
- "documentation": "Input Loss Image Type",
+ "documentation": "Hls Program Date Time",
"enum": [
- "COLOR",
- "SLATE"
+ "EXCLUDE",
+ "INCLUDE"
]
},
- "InputMaximumBitrate": {
+ "HlsProgramDateTimeClock": {
"type": "string",
- "documentation": "Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.",
+ "documentation": "Hls Program Date Time Clock",
"enum": [
- "MAX_10_MBPS",
- "MAX_20_MBPS",
- "MAX_50_MBPS"
+ "INITIALIZE_FROM_OUTPUT_TIMECODE",
+ "SYSTEM_CLOCK"
]
},
- "InputPreference": {
+ "HlsRedundantManifest": {
"type": "string",
- "documentation": "Input preference when deciding which input to make active when a previously failed input has recovered.\nIf \\\"EQUAL_INPUT_PREFERENCE\\\", then the active input will stay active as long as it is healthy.\nIf \\\"PRIMARY_INPUT_PREFERRED\\\", then always switch back to the primary input when it is healthy.",
+ "documentation": "Hls Redundant Manifest",
"enum": [
- "EQUAL_INPUT_PREFERENCE",
- "PRIMARY_INPUT_PREFERRED"
+ "DISABLED",
+ "ENABLED"
]
},
- "InputPrepareScheduleActionSettings": {
+ "HlsS3LogUploads": {
+ "type": "string",
+ "documentation": "Hls S3 Log Uploads",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
+ },
+ "HlsS3Settings": {
"type": "structure",
"members": {
- "InputAttachmentNameReference": {
- "shape": "__string",
- "locationName": "inputAttachmentNameReference",
- "documentation": "The name of the input attachment that should be prepared by this action. If no name is provided, the action will stop the most recent prepare (if any) when activated."
- },
- "InputClippingSettings": {
- "shape": "InputClippingSettings",
- "locationName": "inputClippingSettings",
- "documentation": "Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file."
- },
- "UrlPath": {
- "shape": "__listOf__string",
- "locationName": "urlPath",
- "documentation": "The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source."
+ "CannedAcl": {
+ "shape": "S3CannedAcl",
+ "locationName": "cannedAcl",
+ "documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none."
}
},
- "documentation": "Action to prepare an input for a future immediate input switch."
+ "documentation": "Hls S3 Settings"
},
- "InputResolution": {
+ "HlsScte35SourceType": {
"type": "string",
- "documentation": "Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines",
+ "documentation": "Hls Scte35 Source Type",
"enum": [
- "SD",
- "HD",
- "UHD"
+ "MANIFEST",
+ "SEGMENTS"
]
},
- "InputSecurityGroup": {
+ "HlsSegmentationMode": {
+ "type": "string",
+ "documentation": "Hls Segmentation Mode",
+ "enum": [
+ "USE_INPUT_SEGMENTATION",
+ "USE_SEGMENT_DURATION"
+ ]
+ },
+ "HlsSettings": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "Unique ARN of Input Security Group"
- },
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The Id of the Input Security Group"
- },
- "Inputs": {
- "shape": "__listOf__string",
- "locationName": "inputs",
- "documentation": "The list of inputs currently using this Input Security Group."
+ "AudioOnlyHlsSettings": {
+ "shape": "AudioOnlyHlsSettings",
+ "locationName": "audioOnlyHlsSettings"
},
- "State": {
- "shape": "InputSecurityGroupState",
- "locationName": "state",
- "documentation": "The current state of the Input Security Group."
+ "Fmp4HlsSettings": {
+ "shape": "Fmp4HlsSettings",
+ "locationName": "fmp4HlsSettings"
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "FrameCaptureHlsSettings": {
+ "shape": "FrameCaptureHlsSettings",
+ "locationName": "frameCaptureHlsSettings"
},
- "WhitelistRules": {
- "shape": "__listOfInputWhitelistRule",
- "locationName": "whitelistRules",
- "documentation": "Whitelist rules and their sync status"
+ "StandardHlsSettings": {
+ "shape": "StandardHlsSettings",
+ "locationName": "standardHlsSettings"
}
},
- "documentation": "An Input Security Group"
+ "documentation": "Hls Settings"
},
- "InputSecurityGroupState": {
+ "HlsStreamInfResolution": {
"type": "string",
+ "documentation": "Hls Stream Inf Resolution",
"enum": [
- "IDLE",
- "IN_USE",
- "UPDATING",
- "DELETED"
- ],
- "documentation": "Placeholder documentation for InputSecurityGroupState"
+ "EXCLUDE",
+ "INCLUDE"
+ ]
},
- "InputSecurityGroupWhitelistRequest": {
+ "HlsTimedMetadataId3Frame": {
+ "type": "string",
+ "documentation": "Hls Timed Metadata Id3 Frame",
+ "enum": [
+ "NONE",
+ "PRIV",
+ "TDRL"
+ ]
+ },
+ "HlsTimedMetadataScheduleActionSettings": {
"type": "structure",
"members": {
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
- },
- "WhitelistRules": {
- "shape": "__listOfInputWhitelistRuleCidr",
- "locationName": "whitelistRules",
- "documentation": "List of IPv4 CIDR addresses to whitelist"
+ "Id3": {
+ "shape": "__string",
+ "locationName": "id3",
+ "documentation": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure"
}
},
- "documentation": "Request of IPv4 CIDR addresses to whitelist in a security group."
+ "documentation": "Settings for the action to emit HLS metadata",
+ "required": [
+ "Id3"
+ ]
},
- "InputSettings": {
+ "HlsTsFileMode": {
+ "type": "string",
+ "documentation": "Hls Ts File Mode",
+ "enum": [
+ "SEGMENTED_FILES",
+ "SINGLE_FILE"
+ ]
+ },
+ "HlsWebdavHttpTransferMode": {
+ "type": "string",
+ "documentation": "Hls Webdav Http Transfer Mode",
+ "enum": [
+ "CHUNKED",
+ "NON_CHUNKED"
+ ]
+ },
+ "HlsWebdavSettings": {
"type": "structure",
"members": {
- "AudioSelectors": {
- "shape": "__listOfAudioSelector",
- "locationName": "audioSelectors",
- "documentation": "Used to select the audio stream to decode for inputs that have multiple available."
- },
- "CaptionSelectors": {
- "shape": "__listOfCaptionSelector",
- "locationName": "captionSelectors",
- "documentation": "Used to select the caption input to use for inputs that have multiple available."
- },
- "DeblockFilter": {
- "shape": "InputDeblockFilter",
- "locationName": "deblockFilter",
- "documentation": "Enable or disable the deblock filter when filtering."
- },
- "DenoiseFilter": {
- "shape": "InputDenoiseFilter",
- "locationName": "denoiseFilter",
- "documentation": "Enable or disable the denoise filter when filtering."
- },
- "FilterStrength": {
- "shape": "__integerMin1Max5",
- "locationName": "filterStrength",
- "documentation": "Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest)."
- },
- "InputFilter": {
- "shape": "InputFilter",
- "locationName": "inputFilter",
- "documentation": "Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default.\n1) auto - filtering will be applied depending on input type/quality\n2) disabled - no filtering will be applied to the input\n3) forced - filtering will be applied regardless of input type"
- },
- "NetworkInputSettings": {
- "shape": "NetworkInputSettings",
- "locationName": "networkInputSettings",
- "documentation": "Input settings."
+ "ConnectionRetryInterval": {
+ "shape": "__integerMin0",
+ "locationName": "connectionRetryInterval",
+ "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost."
},
- "Scte35Pid": {
- "shape": "__integerMin32Max8191",
- "locationName": "scte35Pid",
- "documentation": "PID from which to read SCTE-35 messages. If left undefined, EML will select the first SCTE-35 PID found in the input."
+ "FilecacheDuration": {
+ "shape": "__integerMin0Max600",
+ "locationName": "filecacheDuration",
+ "documentation": "Size in seconds of file cache for streaming outputs."
},
- "Smpte2038DataPreference": {
- "shape": "Smpte2038DataPreference",
- "locationName": "smpte2038DataPreference",
- "documentation": "Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages.\n- PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any).\n- IGNORE: Never extract any ancillary data from SMPTE-2038."
+ "HttpTransferMode": {
+ "shape": "HlsWebdavHttpTransferMode",
+ "locationName": "httpTransferMode",
+ "documentation": "Specify whether or not to use chunked transfer encoding to WebDAV."
},
- "SourceEndBehavior": {
- "shape": "InputSourceEndBehavior",
- "locationName": "sourceEndBehavior",
- "documentation": "Loop input if it is a file. This allows a file input to be streamed indefinitely."
+ "NumRetries": {
+ "shape": "__integerMin0",
+ "locationName": "numRetries",
+ "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with \"s3\" or \"mediastore\". For other URIs, the value is always 3."
},
- "VideoSelector": {
- "shape": "VideoSelector",
- "locationName": "videoSelector",
- "documentation": "Informs which video elementary stream to decode for input types that have multiple available."
+ "RestartDelay": {
+ "shape": "__integerMin0Max15",
+ "locationName": "restartDelay",
+ "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart."
}
},
- "documentation": "Live Event input parameters. There can be multiple inputs in a single Live Event."
+ "documentation": "Hls Webdav Settings"
},
- "InputSource": {
+ "HtmlMotionGraphicsSettings": {
"type": "structure",
"members": {
- "PasswordParam": {
- "shape": "__string",
- "locationName": "passwordParam",
- "documentation": "The key used to extract the password from EC2 Parameter store."
- },
- "Url": {
- "shape": "__string",
- "locationName": "url",
- "documentation": "This represents the customer's source URL where stream is\npulled from."
- },
- "Username": {
- "shape": "__string",
- "locationName": "username",
- "documentation": "The username for the input source."
- }
},
- "documentation": "The settings for a PULL type input."
+ "documentation": "Html Motion Graphics Settings"
},
- "InputSourceEndBehavior": {
+ "IFrameOnlyPlaylistType": {
"type": "string",
- "documentation": "Input Source End Behavior",
+ "documentation": "When set to \"standard\", an I-Frame only playlist will be written out for each video output in the output group. This I-Frame only playlist will contain byte range offsets pointing to the I-frame(s) in each segment.",
"enum": [
- "CONTINUE",
- "LOOP"
+ "DISABLED",
+ "STANDARD"
]
},
- "InputSourceRequest": {
+ "ImmediateModeScheduleActionStartSettings": {
"type": "structure",
"members": {
- "PasswordParam": {
- "shape": "__string",
- "locationName": "passwordParam",
- "documentation": "The key used to extract the password from EC2 Parameter store."
- },
- "Url": {
- "shape": "__string",
- "locationName": "url",
- "documentation": "This represents the customer's source URL where stream is\npulled from."
- },
- "Username": {
- "shape": "__string",
- "locationName": "username",
- "documentation": "The username for the input source."
- }
},
- "documentation": "Settings for for a PULL type input."
+ "documentation": "Settings to configure an action so that it occurs as soon as possible."
},
- "InputSourceType": {
+ "IncludeFillerNalUnits": {
"type": "string",
- "documentation": "There are two types of input sources, static and dynamic. If an input source is dynamic you can\nchange the source url of the input dynamically using an input switch action. Currently, two input types\nsupport a dynamic url at this time, MP4_FILE and TS_FILE. By default all input sources are static.",
+ "documentation": "Include Filler Nal Units",
"enum": [
- "STATIC",
- "DYNAMIC"
+ "AUTO",
+ "DROP",
+ "INCLUDE"
]
},
- "InputSpecification": {
+ "Input": {
"type": "structure",
"members": {
- "Codec": {
- "shape": "InputCodec",
- "locationName": "codec",
- "documentation": "Input codec"
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The Unique ARN of the input (generated, immutable)."
},
- "MaximumBitrate": {
- "shape": "InputMaximumBitrate",
- "locationName": "maximumBitrate",
- "documentation": "Maximum input bitrate, categorized coarsely"
+ "AttachedChannels": {
+ "shape": "__listOf__string",
+ "locationName": "attachedChannels",
+ "documentation": "A list of channel IDs that that input is attached to (currently an input can only be attached to one channel)."
},
- "Resolution": {
- "shape": "InputResolution",
- "locationName": "resolution",
- "documentation": "Input resolution, categorized coarsely"
+ "Destinations": {
+ "shape": "__listOfInputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of the destinations of the input (PUSH-type)."
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The generated ID of the input (unique for user account, immutable)."
+ },
+ "InputClass": {
+ "shape": "InputClass",
+ "locationName": "inputClass",
+ "documentation": "STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.\nSINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input."
+ },
+ "InputDevices": {
+ "shape": "__listOfInputDeviceSettings",
+ "locationName": "inputDevices",
+ "documentation": "Settings for the input devices."
+ },
+ "InputPartnerIds": {
+ "shape": "__listOf__string",
+ "locationName": "inputPartnerIds",
+ "documentation": "A list of IDs for all Inputs which are partners of this one."
+ },
+ "InputSourceType": {
+ "shape": "InputSourceType",
+ "locationName": "inputSourceType",
+ "documentation": "Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes\nduring input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs."
+ },
+ "MediaConnectFlows": {
+ "shape": "__listOfMediaConnectFlow",
+ "locationName": "mediaConnectFlows",
+ "documentation": "A list of MediaConnect Flows for this input."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The user-assigned name (This is a mutable value)."
+ },
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
+ },
+ "SecurityGroups": {
+ "shape": "__listOf__string",
+ "locationName": "securityGroups",
+ "documentation": "A list of IDs for all the Input Security Groups attached to the input."
+ },
+ "Sources": {
+ "shape": "__listOfInputSource",
+ "locationName": "sources",
+ "documentation": "A list of the sources of the input (PULL-type)."
+ },
+ "State": {
+ "shape": "InputState",
+ "locationName": "state"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "Type": {
+ "shape": "InputType",
+ "locationName": "type"
+ },
+ "SrtSettings": {
+ "shape": "SrtSettings",
+ "locationName": "srtSettings",
+ "documentation": "The settings associated with an SRT input."
+ },
+ "InputNetworkLocation": {
+ "shape": "InputNetworkLocation",
+ "locationName": "inputNetworkLocation",
+ "documentation": "The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for\nan input in a customer network."
+ },
+ "MulticastSettings": {
+ "shape": "MulticastSettings",
+ "locationName": "multicastSettings",
+ "documentation": "Multicast Input settings."
}
},
- "documentation": "Placeholder documentation for InputSpecification"
- },
- "InputState": {
- "type": "string",
- "enum": [
- "CREATING",
- "DETACHED",
- "ATTACHED",
- "DELETING",
- "DELETED"
- ],
- "documentation": "Placeholder documentation for InputState"
+ "documentation": "Placeholder documentation for Input"
},
- "InputSwitchScheduleActionSettings": {
+ "InputAttachment": {
"type": "structure",
"members": {
- "InputAttachmentNameReference": {
+ "AutomaticInputFailoverSettings": {
+ "shape": "AutomaticInputFailoverSettings",
+ "locationName": "automaticInputFailoverSettings",
+ "documentation": "User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input."
+ },
+ "InputAttachmentName": {
"shape": "__string",
- "locationName": "inputAttachmentNameReference",
- "documentation": "The name of the input attachment (not the name of the input!) to switch to. The name is specified in the channel configuration."
+ "locationName": "inputAttachmentName",
+ "documentation": "User-specified name for the attachment. This is required if the user wants to use this input in an input switch action."
},
- "InputClippingSettings": {
- "shape": "InputClippingSettings",
- "locationName": "inputClippingSettings",
- "documentation": "Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file."
+ "InputId": {
+ "shape": "__string",
+ "locationName": "inputId",
+ "documentation": "The ID of the input"
},
- "UrlPath": {
+ "InputSettings": {
+ "shape": "InputSettings",
+ "locationName": "inputSettings",
+ "documentation": "Settings of an input (caption selector, etc.)"
+ },
+ "LogicalInterfaceNames": {
"shape": "__listOf__string",
- "locationName": "urlPath",
- "documentation": "The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source."
+ "locationName": "logicalInterfaceNames",
+ "documentation": "Optional assignment of an input to a logical interface on the Node. Only applies to on premises channels."
}
},
- "documentation": "Settings for the \"switch input\" action: to switch from ingesting one input to ingesting another input.",
- "required": [
- "InputAttachmentNameReference"
- ]
+ "documentation": "Placeholder documentation for InputAttachment"
},
- "InputTimecodeSource": {
- "type": "string",
- "documentation": "Documentation update needed",
- "enum": [
- "ZEROBASED",
- "EMBEDDED"
+ "InputChannelLevel": {
+ "type": "structure",
+ "members": {
+ "Gain": {
+ "shape": "__integerMinNegative60Max6",
+ "locationName": "gain",
+ "documentation": "Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB."
+ },
+ "InputChannel": {
+ "shape": "__integerMin0Max15",
+ "locationName": "inputChannel",
+ "documentation": "The index of the input channel used as a source."
+ }
+ },
+ "documentation": "Input Channel Level",
+ "required": [
+ "InputChannel",
+ "Gain"
]
},
- "InputType": {
+ "InputClass": {
"type": "string",
- "documentation": "The different types of inputs that AWS Elemental MediaLive supports.",
+ "documentation": "A standard input has two sources and a single pipeline input only has one.",
"enum": [
- "UDP_PUSH",
- "RTP_PUSH",
- "RTMP_PUSH",
- "RTMP_PULL",
- "URL_PULL",
- "MP4_FILE",
- "MEDIACONNECT",
- "INPUT_DEVICE",
- "AWS_CDI",
- "TS_FILE",
- "SRT_CALLER"
+ "STANDARD",
+ "SINGLE_PIPELINE"
]
},
- "InputVpcRequest": {
+ "InputClippingSettings": {
"type": "structure",
"members": {
- "SecurityGroupIds": {
- "shape": "__listOf__string",
- "locationName": "securityGroupIds",
- "documentation": "A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces.\nRequires subnetIds. If none are specified then the VPC default security group will be used."
+ "InputTimecodeSource": {
+ "shape": "InputTimecodeSource",
+ "locationName": "inputTimecodeSource",
+ "documentation": "The source of the timecodes in the source being clipped."
},
- "SubnetIds": {
- "shape": "__listOf__string",
- "locationName": "subnetIds",
- "documentation": "A list of 2 VPC subnet IDs from the same VPC.\nSubnet IDs must be mapped to two unique availability zones (AZ)."
+ "StartTimecode": {
+ "shape": "StartTimecode",
+ "locationName": "startTimecode",
+ "documentation": "Settings to identify the start of the clip."
+ },
+ "StopTimecode": {
+ "shape": "StopTimecode",
+ "locationName": "stopTimecode",
+ "documentation": "Settings to identify the end of the clip."
}
},
- "documentation": "Settings for a private VPC Input.\nWhen this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses.\nThis property requires setting the roleArn property on Input creation.\nNot compatible with the inputSecurityGroups property.",
+ "documentation": "Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.",
"required": [
- "SubnetIds"
+ "InputTimecodeSource"
]
},
- "InputWhitelistRule": {
+ "InputCodec": {
+ "type": "string",
+ "documentation": "codec in increasing order of complexity",
+ "enum": [
+ "MPEG2",
+ "AVC",
+ "HEVC"
+ ]
+ },
+ "InputDeblockFilter": {
+ "type": "string",
+ "documentation": "Input Deblock Filter",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
+ },
+ "InputDenoiseFilter": {
+ "type": "string",
+ "documentation": "Input Denoise Filter",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
+ },
+ "InputDestination": {
"type": "structure",
"members": {
- "Cidr": {
+ "Ip": {
"shape": "__string",
- "locationName": "cidr",
- "documentation": "The IPv4 CIDR that's whitelisted."
+ "locationName": "ip",
+ "documentation": "The system-generated static IP address of endpoint.\nIt remains fixed for the lifetime of the input."
+ },
+ "Port": {
+ "shape": "__string",
+ "locationName": "port",
+ "documentation": "The port number for the input."
+ },
+ "Url": {
+ "shape": "__string",
+ "locationName": "url",
+ "documentation": "This represents the endpoint that the customer stream will be\npushed to."
+ },
+ "Vpc": {
+ "shape": "InputDestinationVpc",
+ "locationName": "vpc"
+ },
+ "Network": {
+ "shape": "__string",
+ "locationName": "network",
+ "documentation": "The ID of the attached network."
+ },
+ "NetworkRoutes": {
+ "shape": "__listOfInputDestinationRoute",
+ "locationName": "networkRoutes",
+ "documentation": "If the push input has an input location of ON-PREM it's a requirement to specify what the route of the input\nis going to be on the customer local network."
}
},
- "documentation": "Whitelist rule"
+ "documentation": "The settings for a PUSH type input."
},
- "InputWhitelistRuleCidr": {
+ "InputDestinationRequest": {
"type": "structure",
"members": {
- "Cidr": {
+ "StreamName": {
"shape": "__string",
- "locationName": "cidr",
- "documentation": "The IPv4 CIDR to whitelist."
+ "locationName": "streamName",
+ "documentation": "A unique name for the location the RTMP stream is being pushed\nto."
+ },
+ "Network": {
+ "shape": "__string",
+ "locationName": "network",
+ "documentation": "If the push input has an input location of ON-PREM, ID the ID of the attached network."
+ },
+ "NetworkRoutes": {
+ "shape": "__listOfInputRequestDestinationRoute",
+ "locationName": "networkRoutes",
+ "documentation": "If the push input has an input location of ON-PREM it's a requirement to specify what the route of the input\nis going to be on the customer local network."
+ },
+ "StaticIpAddress": {
+ "shape": "__string",
+ "locationName": "staticIpAddress",
+ "documentation": "If the push input has an input location of ON-PREM it's optional to specify what the ip address\nof the input is going to be on the customer local network."
}
},
- "documentation": "An IPv4 CIDR to whitelist."
+ "documentation": "Endpoint settings for a PUSH type input."
},
- "InternalServerErrorException": {
+ "InputDestinationVpc": {
"type": "structure",
"members": {
- "Message": {
+ "AvailabilityZone": {
"shape": "__string",
- "locationName": "message"
- }
- },
- "exception": true,
- "error": {
- "httpStatusCode": 500
- },
- "documentation": "Placeholder documentation for InternalServerErrorException"
- },
- "InternalServiceError": {
- "type": "structure",
- "members": {
- "Message": {
+ "locationName": "availabilityZone",
+ "documentation": "The availability zone of the Input destination."
+ },
+ "NetworkInterfaceId": {
"shape": "__string",
- "locationName": "message"
+ "locationName": "networkInterfaceId",
+ "documentation": "The network interface ID of the Input destination in the VPC."
}
},
- "documentation": "Placeholder documentation for InternalServiceError"
+ "documentation": "The properties for a VPC type input destination."
},
- "InvalidRequest": {
+ "InputDevice": {
"type": "structure",
"members": {
- "Message": {
+ "Arn": {
"shape": "__string",
- "locationName": "message"
- }
- },
- "documentation": "Placeholder documentation for InvalidRequest"
- },
- "KeyProviderSettings": {
- "type": "structure",
- "members": {
- "StaticKeySettings": {
- "shape": "StaticKeySettings",
- "locationName": "staticKeySettings"
+ "locationName": "arn",
+ "documentation": "The unique ARN of the input device."
+ },
+ "ConnectionState": {
+ "shape": "InputDeviceConnectionState",
+ "locationName": "connectionState",
+ "documentation": "The state of the connection between the input device and AWS."
+ },
+ "DeviceSettingsSyncState": {
+ "shape": "DeviceSettingsSyncState",
+ "locationName": "deviceSettingsSyncState",
+ "documentation": "The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration."
+ },
+ "DeviceUpdateStatus": {
+ "shape": "DeviceUpdateStatus",
+ "locationName": "deviceUpdateStatus",
+ "documentation": "The status of software on the input device."
+ },
+ "HdDeviceSettings": {
+ "shape": "InputDeviceHdSettings",
+ "locationName": "hdDeviceSettings",
+ "documentation": "Settings that describe an input device that is type HD."
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique ID of the input device."
+ },
+ "MacAddress": {
+ "shape": "__string",
+ "locationName": "macAddress",
+ "documentation": "The network MAC address of the input device."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "A name that you specify for the input device."
+ },
+ "NetworkSettings": {
+ "shape": "InputDeviceNetworkSettings",
+ "locationName": "networkSettings",
+ "documentation": "The network settings for the input device."
+ },
+ "SerialNumber": {
+ "shape": "__string",
+ "locationName": "serialNumber",
+ "documentation": "The unique serial number of the input device."
+ },
+ "Type": {
+ "shape": "InputDeviceType",
+ "locationName": "type",
+ "documentation": "The type of the input device."
+ },
+ "UhdDeviceSettings": {
+ "shape": "InputDeviceUhdSettings",
+ "locationName": "uhdDeviceSettings",
+ "documentation": "Settings that describe an input device that is type UHD."
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "AvailabilityZone": {
+ "shape": "__string",
+ "locationName": "availabilityZone",
+ "documentation": "The Availability Zone associated with this input device."
+ },
+ "MedialiveInputArns": {
+ "shape": "__listOf__string",
+ "locationName": "medialiveInputArns",
+ "documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT."
+ },
+ "OutputType": {
+ "shape": "InputDeviceOutputType",
+ "locationName": "outputType",
+ "documentation": "The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input."
}
},
- "documentation": "Key Provider Settings"
+ "documentation": "An input device."
},
- "LastFrameClippingBehavior": {
+ "InputDeviceActiveInput": {
"type": "string",
- "documentation": "If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode.",
+ "documentation": "The source at the input device that is currently active.",
"enum": [
- "EXCLUDE_LAST_FRAME",
- "INCLUDE_LAST_FRAME"
+ "HDMI",
+ "SDI"
]
},
- "LimitExceeded": {
- "type": "structure",
- "members": {
- "Message": {
- "shape": "__string",
- "locationName": "message"
- }
- },
- "documentation": "Placeholder documentation for LimitExceeded"
+ "InputDeviceCodec": {
+ "type": "string",
+ "documentation": "The codec to use on the video that the device produces.",
+ "enum": [
+ "HEVC",
+ "AVC"
+ ]
},
- "ListChannelsRequest": {
+ "InputDeviceConfigurableSettings": {
"type": "structure",
"members": {
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
+ "ConfiguredInput": {
+ "shape": "InputDeviceConfiguredInput",
+ "locationName": "configuredInput",
+ "documentation": "The input source that you want to use. If the device has a source connected to only one of its input ports, or if you don't care which source the device sends, specify Auto. If the device has sources connected to both its input ports, and you want to use a specific source, specify the source."
},
- "NextToken": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "nextToken"
- }
- },
- "documentation": "Placeholder documentation for ListChannelsRequest"
- },
- "ListChannelsResponse": {
- "type": "structure",
- "members": {
- "Channels": {
- "shape": "__listOfChannelSummary",
- "locationName": "channels"
+ "MaxBitrate": {
+ "shape": "__integer",
+ "locationName": "maxBitrate",
+ "documentation": "The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video."
},
- "NextToken": {
- "shape": "__string",
- "locationName": "nextToken"
- }
- },
- "documentation": "Placeholder documentation for ListChannelsResponse"
- },
- "ListChannelsResultModel": {
- "type": "structure",
- "members": {
- "Channels": {
- "shape": "__listOfChannelSummary",
- "locationName": "channels"
+ "LatencyMs": {
+ "shape": "__integer",
+ "locationName": "latencyMs",
+ "documentation": "The Link device's buffer size (latency) in milliseconds (ms)."
},
- "NextToken": {
- "shape": "__string",
- "locationName": "nextToken"
+ "Codec": {
+ "shape": "InputDeviceCodec",
+ "locationName": "codec",
+ "documentation": "Choose the codec for the video that the device produces. Only UHD devices can specify this parameter."
+ },
+ "MediaconnectSettings": {
+ "shape": "InputDeviceMediaConnectConfigurableSettings",
+ "locationName": "mediaconnectSettings",
+ "documentation": "To attach this device to a MediaConnect flow, specify these parameters. To detach an existing flow, enter {} for the value of mediaconnectSettings. Only UHD devices can specify this parameter."
+ },
+ "AudioChannelPairs": {
+ "shape": "__listOfInputDeviceConfigurableAudioChannelPairConfig",
+ "locationName": "audioChannelPairs",
+ "documentation": "An array of eight audio configurations, one for each audio pair in the source. Set up each audio configuration either to exclude the pair, or to format it and include it in the output from the device. This parameter applies only to UHD devices, and only when the device is configured as the source for a MediaConnect flow. For an HD device, you configure the audio by setting up audio selectors in the channel configuration."
}
},
- "documentation": "Placeholder documentation for ListChannelsResultModel"
+ "documentation": "Configurable settings for the input device."
},
- "ListInputDeviceTransfersRequest": {
+ "InputDeviceConfigurationValidationError": {
"type": "structure",
"members": {
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
- },
- "NextToken": {
+ "Message": {
"shape": "__string",
- "location": "querystring",
- "locationName": "nextToken"
+ "locationName": "message",
+ "documentation": "The error message."
},
- "TransferType": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "transferType"
+ "ValidationErrors": {
+ "shape": "__listOfValidationError",
+ "locationName": "validationErrors",
+ "documentation": "A collection of validation error responses."
}
},
- "required": [
- "TransferType"
- ],
- "documentation": "Placeholder documentation for ListInputDeviceTransfersRequest"
+ "documentation": "Placeholder documentation for InputDeviceConfigurationValidationError"
},
- "ListInputDeviceTransfersResponse": {
+ "InputDeviceConfiguredInput": {
+ "type": "string",
+ "documentation": "The source to activate (use) from the input device.",
+ "enum": [
+ "AUTO",
+ "HDMI",
+ "SDI"
+ ]
+ },
+ "InputDeviceConnectionState": {
+ "type": "string",
+ "documentation": "The state of the connection between the input device and AWS.",
+ "enum": [
+ "DISCONNECTED",
+ "CONNECTED"
+ ]
+ },
+ "InputDeviceHdSettings": {
"type": "structure",
"members": {
- "InputDeviceTransfers": {
- "shape": "__listOfTransferringInputDeviceSummary",
- "locationName": "inputDeviceTransfers",
- "documentation": "The list of devices that you are transferring or are being transferred to you."
+ "ActiveInput": {
+ "shape": "InputDeviceActiveInput",
+ "locationName": "activeInput",
+ "documentation": "If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI)."
},
- "NextToken": {
- "shape": "__string",
- "locationName": "nextToken",
- "documentation": "A token to get additional list results."
+ "ConfiguredInput": {
+ "shape": "InputDeviceConfiguredInput",
+ "locationName": "configuredInput",
+ "documentation": "The source at the input device that is currently active. You can specify this source."
+ },
+ "DeviceState": {
+ "shape": "InputDeviceState",
+ "locationName": "deviceState",
+ "documentation": "The state of the input device."
+ },
+ "Framerate": {
+ "shape": "__double",
+ "locationName": "framerate",
+ "documentation": "The frame rate of the video source."
+ },
+ "Height": {
+ "shape": "__integer",
+ "locationName": "height",
+ "documentation": "The height of the video source, in pixels."
+ },
+ "MaxBitrate": {
+ "shape": "__integer",
+ "locationName": "maxBitrate",
+ "documentation": "The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum."
+ },
+ "ScanType": {
+ "shape": "InputDeviceScanType",
+ "locationName": "scanType",
+ "documentation": "The scan type of the video source."
+ },
+ "Width": {
+ "shape": "__integer",
+ "locationName": "width",
+ "documentation": "The width of the video source, in pixels."
+ },
+ "LatencyMs": {
+ "shape": "__integer",
+ "locationName": "latencyMs",
+ "documentation": "The Link device's buffer size (latency) in milliseconds (ms). You can specify this value."
}
},
- "documentation": "Placeholder documentation for ListInputDeviceTransfersResponse"
+ "documentation": "Settings that describe the active source from the input device, and the video characteristics of that source."
},
- "ListInputDeviceTransfersResultModel": {
+ "InputDeviceIpScheme": {
+ "type": "string",
+ "documentation": "Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address.",
+ "enum": [
+ "STATIC",
+ "DHCP"
+ ]
+ },
+ "InputDeviceMediaConnectConfigurableSettings": {
"type": "structure",
"members": {
- "InputDeviceTransfers": {
- "shape": "__listOfTransferringInputDeviceSummary",
- "locationName": "inputDeviceTransfers",
- "documentation": "The list of devices that you are transferring or are being transferred to you."
+ "FlowArn": {
+ "shape": "__string",
+ "locationName": "flowArn",
+ "documentation": "The ARN of the MediaConnect flow to attach this device to."
},
- "NextToken": {
+ "RoleArn": {
"shape": "__string",
- "locationName": "nextToken",
- "documentation": "A token to get additional list results."
- }
- },
- "documentation": "The list of input devices in the transferred state. The recipient hasn't yet accepted or rejected the transfer."
- },
- "ListInputDevicesRequest": {
- "type": "structure",
- "members": {
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
+ "locationName": "roleArn",
+ "documentation": "The ARN for the role that MediaLive assumes to access the attached flow and secret. For more information about how to create this role, see the MediaLive user guide."
},
- "NextToken": {
+ "SecretArn": {
"shape": "__string",
- "location": "querystring",
- "locationName": "nextToken"
- }
- },
- "documentation": "Placeholder documentation for ListInputDevicesRequest"
- },
- "ListInputDevicesResponse": {
- "type": "structure",
- "members": {
- "InputDevices": {
- "shape": "__listOfInputDeviceSummary",
- "locationName": "inputDevices",
- "documentation": "The list of input devices."
+ "locationName": "secretArn",
+ "documentation": "The ARN for the secret that holds the encryption key to encrypt the content output by the device."
},
- "NextToken": {
+ "SourceName": {
"shape": "__string",
- "locationName": "nextToken",
- "documentation": "A token to get additional list results."
+ "locationName": "sourceName",
+ "documentation": "The name of the MediaConnect Flow source to stream to."
}
},
- "documentation": "Placeholder documentation for ListInputDevicesResponse"
+ "documentation": "Parameters required to attach a MediaConnect flow to the device."
},
- "ListInputDevicesResultModel": {
+ "InputDeviceMediaConnectSettings": {
"type": "structure",
"members": {
- "InputDevices": {
- "shape": "__listOfInputDeviceSummary",
- "locationName": "inputDevices",
- "documentation": "The list of input devices."
+ "FlowArn": {
+ "shape": "__string",
+ "locationName": "flowArn",
+ "documentation": "The ARN of the MediaConnect flow."
},
- "NextToken": {
+ "RoleArn": {
"shape": "__string",
- "locationName": "nextToken",
- "documentation": "A token to get additional list results."
- }
- },
- "documentation": "The list of input devices owned by the AWS account."
- },
- "ListInputSecurityGroupsRequest": {
- "type": "structure",
- "members": {
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
+ "locationName": "roleArn",
+ "documentation": "The ARN for the role that MediaLive assumes to access the attached flow and secret."
},
- "NextToken": {
+ "SecretArn": {
"shape": "__string",
- "location": "querystring",
- "locationName": "nextToken"
- }
- },
- "documentation": "Placeholder documentation for ListInputSecurityGroupsRequest"
- },
- "ListInputSecurityGroupsResponse": {
- "type": "structure",
- "members": {
- "InputSecurityGroups": {
- "shape": "__listOfInputSecurityGroup",
- "locationName": "inputSecurityGroups",
- "documentation": "List of input security groups"
+ "locationName": "secretArn",
+ "documentation": "The ARN of the secret used to encrypt the stream."
},
- "NextToken": {
+ "SourceName": {
"shape": "__string",
- "locationName": "nextToken"
+ "locationName": "sourceName",
+ "documentation": "The name of the MediaConnect flow source."
}
},
- "documentation": "Placeholder documentation for ListInputSecurityGroupsResponse"
+ "documentation": "Information about the MediaConnect flow attached to the device."
},
- "ListInputSecurityGroupsResultModel": {
+ "InputDeviceNetworkSettings": {
"type": "structure",
"members": {
- "InputSecurityGroups": {
- "shape": "__listOfInputSecurityGroup",
- "locationName": "inputSecurityGroups",
- "documentation": "List of input security groups"
+ "DnsAddresses": {
+ "shape": "__listOf__string",
+ "locationName": "dnsAddresses",
+ "documentation": "The DNS addresses of the input device."
},
- "NextToken": {
+ "Gateway": {
"shape": "__string",
- "locationName": "nextToken"
+ "locationName": "gateway",
+ "documentation": "The network gateway IP address."
+ },
+ "IpAddress": {
+ "shape": "__string",
+ "locationName": "ipAddress",
+ "documentation": "The IP address of the input device."
+ },
+ "IpScheme": {
+ "shape": "InputDeviceIpScheme",
+ "locationName": "ipScheme",
+ "documentation": "Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address."
+ },
+ "SubnetMask": {
+ "shape": "__string",
+ "locationName": "subnetMask",
+ "documentation": "The subnet mask of the input device."
}
},
- "documentation": "Result of input security group list request"
+ "documentation": "The network settings for the input device."
},
- "ListInputsRequest": {
+ "InputDeviceOutputType": {
+ "type": "string",
+ "documentation": "The output attachment type of the input device.",
+ "enum": [
+ "NONE",
+ "MEDIALIVE_INPUT",
+ "MEDIACONNECT_FLOW"
+ ]
+ },
+ "InputDeviceRequest": {
"type": "structure",
"members": {
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
- },
- "NextToken": {
+ "Id": {
"shape": "__string",
- "location": "querystring",
- "locationName": "nextToken"
+ "locationName": "id",
+ "documentation": "The unique ID for the device."
}
},
- "documentation": "Placeholder documentation for ListInputsRequest"
+ "documentation": "Settings for an input device."
},
- "ListInputsResponse": {
+ "InputDeviceScanType": {
+ "type": "string",
+ "documentation": "The scan type of the video source.",
+ "enum": [
+ "INTERLACED",
+ "PROGRESSIVE"
+ ]
+ },
+ "InputDeviceSettings": {
"type": "structure",
"members": {
- "Inputs": {
- "shape": "__listOfInput",
- "locationName": "inputs"
- },
- "NextToken": {
+ "Id": {
"shape": "__string",
- "locationName": "nextToken"
+ "locationName": "id",
+ "documentation": "The unique ID for the device."
}
},
- "documentation": "Placeholder documentation for ListInputsResponse"
+ "documentation": "Settings for an input device."
},
- "ListInputsResultModel": {
+ "InputDeviceState": {
+ "type": "string",
+ "documentation": "The state of the input device.",
+ "enum": [
+ "IDLE",
+ "STREAMING"
+ ]
+ },
+ "InputDeviceSummary": {
"type": "structure",
"members": {
- "Inputs": {
- "shape": "__listOfInput",
- "locationName": "inputs"
- },
- "NextToken": {
+ "Arn": {
"shape": "__string",
- "locationName": "nextToken"
- }
- },
- "documentation": "Placeholder documentation for ListInputsResultModel"
- },
- "ListMultiplexProgramsRequest": {
- "type": "structure",
- "members": {
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults",
- "documentation": "The maximum number of items to return."
- },
- "MultiplexId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "multiplexId",
- "documentation": "The ID of the multiplex that the programs belong to."
- },
- "NextToken": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "nextToken",
- "documentation": "The token to retrieve the next page of results."
- }
- },
- "required": [
- "MultiplexId"
- ],
- "documentation": "Placeholder documentation for ListMultiplexProgramsRequest"
- },
- "ListMultiplexProgramsResponse": {
- "type": "structure",
- "members": {
- "MultiplexPrograms": {
- "shape": "__listOfMultiplexProgramSummary",
- "locationName": "multiplexPrograms",
- "documentation": "List of multiplex programs."
- },
- "NextToken": {
- "shape": "__string",
- "locationName": "nextToken",
- "documentation": "Token for the next ListMultiplexProgram request."
- }
- },
- "documentation": "Placeholder documentation for ListMultiplexProgramsResponse"
- },
- "ListMultiplexProgramsResultModel": {
- "type": "structure",
- "members": {
- "MultiplexPrograms": {
- "shape": "__listOfMultiplexProgramSummary",
- "locationName": "multiplexPrograms",
- "documentation": "List of multiplex programs."
+ "locationName": "arn",
+ "documentation": "The unique ARN of the input device."
},
- "NextToken": {
- "shape": "__string",
- "locationName": "nextToken",
- "documentation": "Token for the next ListMultiplexProgram request."
- }
- },
- "documentation": "Placeholder documentation for ListMultiplexProgramsResultModel"
- },
- "ListMultiplexesRequest": {
- "type": "structure",
- "members": {
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults",
- "documentation": "The maximum number of items to return."
+ "ConnectionState": {
+ "shape": "InputDeviceConnectionState",
+ "locationName": "connectionState",
+ "documentation": "The state of the connection between the input device and AWS."
},
- "NextToken": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "nextToken",
- "documentation": "The token to retrieve the next page of results."
- }
- },
- "documentation": "Placeholder documentation for ListMultiplexesRequest"
- },
- "ListMultiplexesResponse": {
- "type": "structure",
- "members": {
- "Multiplexes": {
- "shape": "__listOfMultiplexSummary",
- "locationName": "multiplexes",
- "documentation": "List of multiplexes."
+ "DeviceSettingsSyncState": {
+ "shape": "DeviceSettingsSyncState",
+ "locationName": "deviceSettingsSyncState",
+ "documentation": "The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration."
},
- "NextToken": {
- "shape": "__string",
- "locationName": "nextToken",
- "documentation": "Token for the next ListMultiplexes request."
- }
- },
- "documentation": "Placeholder documentation for ListMultiplexesResponse"
- },
- "ListMultiplexesResultModel": {
- "type": "structure",
- "members": {
- "Multiplexes": {
- "shape": "__listOfMultiplexSummary",
- "locationName": "multiplexes",
- "documentation": "List of multiplexes."
+ "DeviceUpdateStatus": {
+ "shape": "DeviceUpdateStatus",
+ "locationName": "deviceUpdateStatus",
+ "documentation": "The status of software on the input device."
},
- "NextToken": {
- "shape": "__string",
- "locationName": "nextToken",
- "documentation": "Token for the next ListMultiplexes request."
- }
- },
- "documentation": "Placeholder documentation for ListMultiplexesResultModel"
- },
- "ListOfferingsRequest": {
- "type": "structure",
- "members": {
- "ChannelClass": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "channelClass",
- "documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'"
+ "HdDeviceSettings": {
+ "shape": "InputDeviceHdSettings",
+ "locationName": "hdDeviceSettings",
+ "documentation": "Settings that describe an input device that is type HD."
},
- "ChannelConfiguration": {
+ "Id": {
"shape": "__string",
- "location": "querystring",
- "locationName": "channelConfiguration",
- "documentation": "Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)"
+ "locationName": "id",
+ "documentation": "The unique ID of the input device."
},
- "Codec": {
+ "MacAddress": {
"shape": "__string",
- "location": "querystring",
- "locationName": "codec",
- "documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'"
+ "locationName": "macAddress",
+ "documentation": "The network MAC address of the input device."
},
- "Duration": {
+ "Name": {
"shape": "__string",
- "location": "querystring",
- "locationName": "duration",
- "documentation": "Filter by offering duration, e.g. '12'"
+ "locationName": "name",
+ "documentation": "A name that you specify for the input device."
},
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
+ "NetworkSettings": {
+ "shape": "InputDeviceNetworkSettings",
+ "locationName": "networkSettings",
+ "documentation": "Network settings for the input device."
},
- "MaximumBitrate": {
+ "SerialNumber": {
"shape": "__string",
- "location": "querystring",
- "locationName": "maximumBitrate",
- "documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'"
+ "locationName": "serialNumber",
+ "documentation": "The unique serial number of the input device."
},
- "MaximumFramerate": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "maximumFramerate",
- "documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'"
+ "Type": {
+ "shape": "InputDeviceType",
+ "locationName": "type",
+ "documentation": "The type of the input device."
},
- "NextToken": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "nextToken"
+ "UhdDeviceSettings": {
+ "shape": "InputDeviceUhdSettings",
+ "locationName": "uhdDeviceSettings",
+ "documentation": "Settings that describe an input device that is type UHD."
},
- "Resolution": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "resolution",
- "documentation": "Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'"
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
},
- "ResourceType": {
+ "AvailabilityZone": {
"shape": "__string",
- "location": "querystring",
- "locationName": "resourceType",
- "documentation": "Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'"
+ "locationName": "availabilityZone",
+ "documentation": "The Availability Zone associated with this input device."
},
- "SpecialFeature": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "specialFeature",
- "documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'"
+ "MedialiveInputArns": {
+ "shape": "__listOf__string",
+ "locationName": "medialiveInputArns",
+ "documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT."
},
- "VideoQuality": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "videoQuality",
- "documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'"
+ "OutputType": {
+ "shape": "InputDeviceOutputType",
+ "locationName": "outputType",
+ "documentation": "The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input."
}
},
- "documentation": "Placeholder documentation for ListOfferingsRequest"
+ "documentation": "Details of the input device."
},
- "ListOfferingsResponse": {
- "type": "structure",
- "members": {
- "NextToken": {
- "shape": "__string",
- "locationName": "nextToken",
- "documentation": "Token to retrieve the next page of results"
- },
- "Offerings": {
- "shape": "__listOfOffering",
- "locationName": "offerings",
- "documentation": "List of offerings"
- }
- },
- "documentation": "Placeholder documentation for ListOfferingsResponse"
+ "InputDeviceTransferType": {
+ "type": "string",
+ "documentation": "The type of device transfer. INCOMING for an input device that is being transferred to you, OUTGOING for an input device that you are transferring to another AWS account.",
+ "enum": [
+ "OUTGOING",
+ "INCOMING"
+ ]
},
- "ListOfferingsResultModel": {
+ "InputDeviceType": {
+ "type": "string",
+ "documentation": "The type of the input device. For an AWS Elemental Link device that outputs resolutions up to 1080, choose \"HD\".",
+ "enum": [
+ "HD",
+ "UHD"
+ ]
+ },
+ "InputDeviceUhdSettings": {
"type": "structure",
"members": {
- "NextToken": {
- "shape": "__string",
- "locationName": "nextToken",
- "documentation": "Token to retrieve the next page of results"
+ "ActiveInput": {
+ "shape": "InputDeviceActiveInput",
+ "locationName": "activeInput",
+ "documentation": "If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI)."
},
- "Offerings": {
- "shape": "__listOfOffering",
- "locationName": "offerings",
- "documentation": "List of offerings"
- }
- },
- "documentation": "ListOfferings response"
- },
- "ListReservationsRequest": {
- "type": "structure",
- "members": {
- "ChannelClass": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "channelClass",
- "documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'"
+ "ConfiguredInput": {
+ "shape": "InputDeviceConfiguredInput",
+ "locationName": "configuredInput",
+ "documentation": "The source at the input device that is currently active. You can specify this source."
},
- "Codec": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "codec",
- "documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'"
+ "DeviceState": {
+ "shape": "InputDeviceState",
+ "locationName": "deviceState",
+ "documentation": "The state of the input device."
},
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
+ "Framerate": {
+ "shape": "__double",
+ "locationName": "framerate",
+ "documentation": "The frame rate of the video source."
},
- "MaximumBitrate": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "maximumBitrate",
- "documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'"
+ "Height": {
+ "shape": "__integer",
+ "locationName": "height",
+ "documentation": "The height of the video source, in pixels."
},
- "MaximumFramerate": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "maximumFramerate",
- "documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'"
+ "MaxBitrate": {
+ "shape": "__integer",
+ "locationName": "maxBitrate",
+ "documentation": "The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum."
},
- "NextToken": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "nextToken"
+ "ScanType": {
+ "shape": "InputDeviceScanType",
+ "locationName": "scanType",
+ "documentation": "The scan type of the video source."
},
- "Resolution": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "resolution",
- "documentation": "Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'"
+ "Width": {
+ "shape": "__integer",
+ "locationName": "width",
+ "documentation": "The width of the video source, in pixels."
},
- "ResourceType": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "resourceType",
- "documentation": "Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'"
+ "LatencyMs": {
+ "shape": "__integer",
+ "locationName": "latencyMs",
+ "documentation": "The Link device's buffer size (latency) in milliseconds (ms). You can specify this value."
},
- "SpecialFeature": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "specialFeature",
- "documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'"
+ "Codec": {
+ "shape": "InputDeviceCodec",
+ "locationName": "codec",
+ "documentation": "The codec for the video that the device produces."
},
- "VideoQuality": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "videoQuality",
- "documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'"
- }
- },
- "documentation": "Placeholder documentation for ListReservationsRequest"
- },
- "ListReservationsResponse": {
- "type": "structure",
- "members": {
- "NextToken": {
- "shape": "__string",
- "locationName": "nextToken",
- "documentation": "Token to retrieve the next page of results"
+ "MediaconnectSettings": {
+ "shape": "InputDeviceMediaConnectSettings",
+ "locationName": "mediaconnectSettings",
+ "documentation": "Information about the MediaConnect flow attached to the device. Returned only if the outputType is MEDIACONNECT_FLOW."
},
- "Reservations": {
- "shape": "__listOfReservation",
- "locationName": "reservations",
- "documentation": "List of reservations"
+ "AudioChannelPairs": {
+ "shape": "__listOfInputDeviceUhdAudioChannelPairConfig",
+ "locationName": "audioChannelPairs",
+ "documentation": "An array of eight audio configurations, one for each audio pair in the source. Each audio configuration specifies either to exclude the pair, or to format it and include it in the output from the UHD device. Applies only when the device is configured as the source for a MediaConnect flow."
}
},
- "documentation": "Placeholder documentation for ListReservationsResponse"
+ "documentation": "Settings that describe the active source from the input device, and the video characteristics of that source."
},
- "ListReservationsResultModel": {
+ "InputFilter": {
+ "type": "string",
+ "documentation": "Input Filter",
+ "enum": [
+ "AUTO",
+ "DISABLED",
+ "FORCED"
+ ]
+ },
+ "InputLocation": {
"type": "structure",
"members": {
- "NextToken": {
+ "PasswordParam": {
"shape": "__string",
- "locationName": "nextToken",
- "documentation": "Token to retrieve the next page of results"
+ "locationName": "passwordParam",
+ "documentation": "key used to extract the password from EC2 Parameter store"
},
- "Reservations": {
- "shape": "__listOfReservation",
- "locationName": "reservations",
- "documentation": "List of reservations"
- }
- },
- "documentation": "ListReservations response"
- },
- "ListTagsForResourceRequest": {
- "type": "structure",
- "members": {
- "ResourceArn": {
+ "Uri": {
+ "shape": "__stringMax2048",
+ "locationName": "uri",
+ "documentation": "Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: \"rtmp://fmsserver/live\"."
+ },
+ "Username": {
"shape": "__string",
- "location": "uri",
- "locationName": "resource-arn"
+ "locationName": "username",
+ "documentation": "Documentation update needed"
}
},
+ "documentation": "Input Location",
"required": [
- "ResourceArn"
- ],
- "documentation": "Placeholder documentation for ListTagsForResourceRequest"
- },
- "ListTagsForResourceResponse": {
- "type": "structure",
- "members": {
- "Tags": {
- "shape": "Tags",
- "locationName": "tags"
- }
- },
- "documentation": "Placeholder documentation for ListTagsForResourceResponse"
- },
- "LogLevel": {
- "type": "string",
- "documentation": "The log level the user wants for their channel.",
- "enum": [
- "ERROR",
- "WARNING",
- "INFO",
- "DEBUG",
- "DISABLED"
- ]
- },
- "M2tsAbsentInputAudioBehavior": {
- "type": "string",
- "documentation": "M2ts Absent Input Audio Behavior",
- "enum": [
- "DROP",
- "ENCODE_SILENCE"
- ]
- },
- "M2tsArib": {
- "type": "string",
- "documentation": "M2ts Arib",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "M2tsAribCaptionsPidControl": {
- "type": "string",
- "documentation": "M2ts Arib Captions Pid Control",
- "enum": [
- "AUTO",
- "USE_CONFIGURED"
- ]
- },
- "M2tsAudioBufferModel": {
- "type": "string",
- "documentation": "M2ts Audio Buffer Model",
- "enum": [
- "ATSC",
- "DVB"
+ "Uri"
]
},
- "M2tsAudioInterval": {
+ "InputLossActionForHlsOut": {
"type": "string",
- "documentation": "M2ts Audio Interval",
+ "documentation": "Input Loss Action For Hls Out",
"enum": [
- "VIDEO_AND_FIXED_INTERVALS",
- "VIDEO_INTERVAL"
+ "EMIT_OUTPUT",
+ "PAUSE_OUTPUT"
]
},
- "M2tsAudioStreamType": {
+ "InputLossActionForMsSmoothOut": {
"type": "string",
- "documentation": "M2ts Audio Stream Type",
+ "documentation": "Input Loss Action For Ms Smooth Out",
"enum": [
- "ATSC",
- "DVB"
+ "EMIT_OUTPUT",
+ "PAUSE_OUTPUT"
]
},
- "M2tsBufferModel": {
+ "InputLossActionForRtmpOut": {
"type": "string",
- "documentation": "M2ts Buffer Model",
+ "documentation": "Input Loss Action For Rtmp Out",
"enum": [
- "MULTIPLEX",
- "NONE"
+ "EMIT_OUTPUT",
+ "PAUSE_OUTPUT"
]
},
- "M2tsCcDescriptor": {
+ "InputLossActionForUdpOut": {
"type": "string",
- "documentation": "M2ts Cc Descriptor",
+ "documentation": "Input Loss Action For Udp Out",
"enum": [
- "DISABLED",
- "ENABLED"
+ "DROP_PROGRAM",
+ "DROP_TS",
+ "EMIT_PROGRAM"
]
},
- "M2tsEbifControl": {
- "type": "string",
- "documentation": "M2ts Ebif Control",
- "enum": [
- "NONE",
- "PASSTHROUGH"
- ]
- },
- "M2tsEbpPlacement": {
- "type": "string",
- "documentation": "M2ts Ebp Placement",
- "enum": [
- "VIDEO_AND_AUDIO_PIDS",
- "VIDEO_PID"
- ]
+ "InputLossBehavior": {
+ "type": "structure",
+ "members": {
+ "BlackFrameMsec": {
+ "shape": "__integerMin0Max1000000",
+ "locationName": "blackFrameMsec",
+ "documentation": "Documentation update needed"
+ },
+ "InputLossImageColor": {
+ "shape": "__stringMin6Max6",
+ "locationName": "inputLossImageColor",
+ "documentation": "When input loss image type is \"color\" this field specifies the color to use. Value: 6 hex characters representing the values of RGB."
+ },
+ "InputLossImageSlate": {
+ "shape": "InputLocation",
+ "locationName": "inputLossImageSlate",
+ "documentation": "When input loss image type is \"slate\" these fields specify the parameters for accessing the slate."
+ },
+ "InputLossImageType": {
+ "shape": "InputLossImageType",
+ "locationName": "inputLossImageType",
+ "documentation": "Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec."
+ },
+ "RepeatFrameMsec": {
+ "shape": "__integerMin0Max1000000",
+ "locationName": "repeatFrameMsec",
+ "documentation": "Documentation update needed"
+ }
+ },
+ "documentation": "Input Loss Behavior"
},
- "M2tsEsRateInPes": {
- "type": "string",
- "documentation": "M2ts Es Rate In Pes",
- "enum": [
- "EXCLUDE",
- "INCLUDE"
- ]
+ "InputLossFailoverSettings": {
+ "type": "structure",
+ "members": {
+ "InputLossThresholdMsec": {
+ "shape": "__integerMin100",
+ "locationName": "inputLossThresholdMsec",
+ "documentation": "The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur."
+ }
+ },
+ "documentation": "MediaLive will perform a failover if content is not detected in this input for the specified period."
},
- "M2tsKlv": {
+ "InputLossImageType": {
"type": "string",
- "documentation": "M2ts Klv",
+ "documentation": "Input Loss Image Type",
"enum": [
- "NONE",
- "PASSTHROUGH"
+ "COLOR",
+ "SLATE"
]
},
- "M2tsNielsenId3Behavior": {
+ "InputMaximumBitrate": {
"type": "string",
- "documentation": "M2ts Nielsen Id3 Behavior",
+ "documentation": "Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.",
"enum": [
- "NO_PASSTHROUGH",
- "PASSTHROUGH"
+ "MAX_10_MBPS",
+ "MAX_20_MBPS",
+ "MAX_50_MBPS"
]
},
- "M2tsPcrControl": {
+ "InputPreference": {
"type": "string",
- "documentation": "M2ts Pcr Control",
+ "documentation": "Input preference when deciding which input to make active when a previously failed input has recovered.\nIf \\\"EQUAL_INPUT_PREFERENCE\\\", then the active input will stay active as long as it is healthy.\nIf \\\"PRIMARY_INPUT_PREFERRED\\\", then always switch back to the primary input when it is healthy.",
"enum": [
- "CONFIGURED_PCR_PERIOD",
- "PCR_EVERY_PES_PACKET"
+ "EQUAL_INPUT_PREFERENCE",
+ "PRIMARY_INPUT_PREFERRED"
]
},
- "M2tsRateMode": {
- "type": "string",
- "documentation": "M2ts Rate Mode",
- "enum": [
- "CBR",
- "VBR"
- ]
+ "InputPrepareScheduleActionSettings": {
+ "type": "structure",
+ "members": {
+ "InputAttachmentNameReference": {
+ "shape": "__string",
+ "locationName": "inputAttachmentNameReference",
+ "documentation": "The name of the input attachment that should be prepared by this action. If no name is provided, the action will stop the most recent prepare (if any) when activated."
+ },
+ "InputClippingSettings": {
+ "shape": "InputClippingSettings",
+ "locationName": "inputClippingSettings",
+ "documentation": "Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file."
+ },
+ "UrlPath": {
+ "shape": "__listOf__string",
+ "locationName": "urlPath",
+ "documentation": "The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source."
+ }
+ },
+ "documentation": "Action to prepare an input for a future immediate input switch."
},
- "M2tsScte35Control": {
+ "InputResolution": {
"type": "string",
- "documentation": "M2ts Scte35 Control",
+ "documentation": "Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines",
"enum": [
- "NONE",
- "PASSTHROUGH"
+ "SD",
+ "HD",
+ "UHD"
]
},
- "M2tsSegmentationMarkers": {
- "type": "string",
- "documentation": "M2ts Segmentation Markers",
- "enum": [
- "EBP",
- "EBP_LEGACY",
- "NONE",
- "PSI_SEGSTART",
- "RAI_ADAPT",
- "RAI_SEGSTART"
- ]
+ "InputSecurityGroup": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "Unique ARN of Input Security Group"
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The Id of the Input Security Group"
+ },
+ "Inputs": {
+ "shape": "__listOf__string",
+ "locationName": "inputs",
+ "documentation": "The list of inputs currently using this Input Security Group."
+ },
+ "State": {
+ "shape": "InputSecurityGroupState",
+ "locationName": "state",
+ "documentation": "The current state of the Input Security Group."
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "WhitelistRules": {
+ "shape": "__listOfInputWhitelistRule",
+ "locationName": "whitelistRules",
+ "documentation": "Whitelist rules and their sync status"
+ }
+ },
+ "documentation": "An Input Security Group"
},
- "M2tsSegmentationStyle": {
+ "InputSecurityGroupState": {
"type": "string",
- "documentation": "M2ts Segmentation Style",
"enum": [
- "MAINTAIN_CADENCE",
- "RESET_CADENCE"
- ]
+ "IDLE",
+ "IN_USE",
+ "UPDATING",
+ "DELETED"
+ ],
+ "documentation": "Placeholder documentation for InputSecurityGroupState"
},
- "M2tsSettings": {
+ "InputSecurityGroupWhitelistRequest": {
"type": "structure",
"members": {
- "AbsentInputAudioBehavior": {
- "shape": "M2tsAbsentInputAudioBehavior",
- "locationName": "absentInputAudioBehavior",
- "documentation": "When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream."
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
},
- "Arib": {
- "shape": "M2tsArib",
- "locationName": "arib",
- "documentation": "When set to enabled, uses ARIB-compliant field muxing and removes video descriptor."
+ "WhitelistRules": {
+ "shape": "__listOfInputWhitelistRuleCidr",
+ "locationName": "whitelistRules",
+ "documentation": "List of IPv4 CIDR addresses to whitelist"
+ }
+ },
+ "documentation": "Request of IPv4 CIDR addresses to whitelist in a security group."
+ },
+ "InputSettings": {
+ "type": "structure",
+ "members": {
+ "AudioSelectors": {
+ "shape": "__listOfAudioSelector",
+ "locationName": "audioSelectors",
+ "documentation": "Used to select the audio stream to decode for inputs that have multiple available."
},
- "AribCaptionsPid": {
- "shape": "__string",
- "locationName": "aribCaptionsPid",
- "documentation": "Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
+ "CaptionSelectors": {
+ "shape": "__listOfCaptionSelector",
+ "locationName": "captionSelectors",
+ "documentation": "Used to select the caption input to use for inputs that have multiple available."
},
- "AribCaptionsPidControl": {
- "shape": "M2tsAribCaptionsPidControl",
- "locationName": "aribCaptionsPidControl",
- "documentation": "If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number."
+ "DeblockFilter": {
+ "shape": "InputDeblockFilter",
+ "locationName": "deblockFilter",
+ "documentation": "Enable or disable the deblock filter when filtering."
},
- "AudioBufferModel": {
- "shape": "M2tsAudioBufferModel",
- "locationName": "audioBufferModel",
- "documentation": "When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used."
+ "DenoiseFilter": {
+ "shape": "InputDenoiseFilter",
+ "locationName": "denoiseFilter",
+ "documentation": "Enable or disable the denoise filter when filtering."
},
- "AudioFramesPerPes": {
- "shape": "__integerMin0",
- "locationName": "audioFramesPerPes",
- "documentation": "The number of audio frames to insert for each PES packet."
+ "FilterStrength": {
+ "shape": "__integerMin1Max5",
+ "locationName": "filterStrength",
+ "documentation": "Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest)."
},
- "AudioPids": {
- "shape": "__string",
- "locationName": "audioPids",
- "documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)."
+ "InputFilter": {
+ "shape": "InputFilter",
+ "locationName": "inputFilter",
+ "documentation": "Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default.\n1) auto - filtering will be applied depending on input type/quality\n2) disabled - no filtering will be applied to the input\n3) forced - filtering will be applied regardless of input type"
},
- "AudioStreamType": {
- "shape": "M2tsAudioStreamType",
- "locationName": "audioStreamType",
- "documentation": "When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06."
+ "NetworkInputSettings": {
+ "shape": "NetworkInputSettings",
+ "locationName": "networkInputSettings",
+ "documentation": "Input settings."
},
- "Bitrate": {
- "shape": "__integerMin0",
- "locationName": "bitrate",
- "documentation": "The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate."
- },
- "BufferModel": {
- "shape": "M2tsBufferModel",
- "locationName": "bufferModel",
- "documentation": "Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices."
- },
- "CcDescriptor": {
- "shape": "M2tsCcDescriptor",
- "locationName": "ccDescriptor",
- "documentation": "When set to enabled, generates captionServiceDescriptor in PMT."
- },
- "DvbNitSettings": {
- "shape": "DvbNitSettings",
- "locationName": "dvbNitSettings",
- "documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval."
- },
- "DvbSdtSettings": {
- "shape": "DvbSdtSettings",
- "locationName": "dvbSdtSettings",
- "documentation": "Inserts DVB Service Description Table (SDT) at the specified table repetition interval."
- },
- "DvbSubPids": {
- "shape": "__string",
- "locationName": "dvbSubPids",
- "documentation": "Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "DvbTdtSettings": {
- "shape": "DvbTdtSettings",
- "locationName": "dvbTdtSettings",
- "documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval."
- },
- "DvbTeletextPid": {
- "shape": "__string",
- "locationName": "dvbTeletextPid",
- "documentation": "Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "Ebif": {
- "shape": "M2tsEbifControl",
- "locationName": "ebif",
- "documentation": "If set to passthrough, passes any EBIF data from the input source to this output."
- },
- "EbpAudioInterval": {
- "shape": "M2tsAudioInterval",
- "locationName": "ebpAudioInterval",
- "documentation": "When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval."
- },
- "EbpLookaheadMs": {
- "shape": "__integerMin0Max10000",
- "locationName": "ebpLookaheadMs",
- "documentation": "When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate."
- },
- "EbpPlacement": {
- "shape": "M2tsEbpPlacement",
- "locationName": "ebpPlacement",
- "documentation": "Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID."
- },
- "EcmPid": {
- "shape": "__string",
- "locationName": "ecmPid",
- "documentation": "This field is unused and deprecated."
- },
- "EsRateInPes": {
- "shape": "M2tsEsRateInPes",
- "locationName": "esRateInPes",
- "documentation": "Include or exclude the ES Rate field in the PES header."
- },
- "EtvPlatformPid": {
- "shape": "__string",
- "locationName": "etvPlatformPid",
- "documentation": "Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "EtvSignalPid": {
- "shape": "__string",
- "locationName": "etvSignalPid",
- "documentation": "Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "FragmentTime": {
- "shape": "__doubleMin0",
- "locationName": "fragmentTime",
- "documentation": "The length in seconds of each fragment. Only used with EBP markers."
- },
- "Klv": {
- "shape": "M2tsKlv",
- "locationName": "klv",
- "documentation": "If set to passthrough, passes any KLV data from the input source to this output."
- },
- "KlvDataPids": {
- "shape": "__string",
- "locationName": "klvDataPids",
- "documentation": "Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "NielsenId3Behavior": {
- "shape": "M2tsNielsenId3Behavior",
- "locationName": "nielsenId3Behavior",
- "documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output."
- },
- "NullPacketBitrate": {
- "shape": "__doubleMin0",
- "locationName": "nullPacketBitrate",
- "documentation": "Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets."
- },
- "PatInterval": {
- "shape": "__integerMin0Max1000",
- "locationName": "patInterval",
- "documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000."
+ "Scte35Pid": {
+ "shape": "__integerMin32Max8191",
+ "locationName": "scte35Pid",
+ "documentation": "PID from which to read SCTE-35 messages. If left undefined, EML will select the first SCTE-35 PID found in the input."
},
- "PcrControl": {
- "shape": "M2tsPcrControl",
- "locationName": "pcrControl",
- "documentation": "When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream."
+ "Smpte2038DataPreference": {
+ "shape": "Smpte2038DataPreference",
+ "locationName": "smpte2038DataPreference",
+ "documentation": "Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages.\n- PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any).\n- IGNORE: Never extract any ancillary data from SMPTE-2038."
},
- "PcrPeriod": {
- "shape": "__integerMin0Max500",
- "locationName": "pcrPeriod",
- "documentation": "Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream."
+ "SourceEndBehavior": {
+ "shape": "InputSourceEndBehavior",
+ "locationName": "sourceEndBehavior",
+ "documentation": "Loop input if it is a file. This allows a file input to be streamed indefinitely."
},
- "PcrPid": {
+ "VideoSelector": {
+ "shape": "VideoSelector",
+ "locationName": "videoSelector",
+ "documentation": "Informs which video elementary stream to decode for input types that have multiple available."
+ }
+ },
+ "documentation": "Live Event input parameters. There can be multiple inputs in a single Live Event."
+ },
+ "InputSource": {
+ "type": "structure",
+ "members": {
+ "PasswordParam": {
"shape": "__string",
- "locationName": "pcrPid",
- "documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "PmtInterval": {
- "shape": "__integerMin0Max1000",
- "locationName": "pmtInterval",
- "documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000."
+ "locationName": "passwordParam",
+ "documentation": "The key used to extract the password from EC2 Parameter store."
},
- "PmtPid": {
+ "Url": {
"shape": "__string",
- "locationName": "pmtPid",
- "documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "ProgramNum": {
- "shape": "__integerMin0Max65535",
- "locationName": "programNum",
- "documentation": "The value of the program number field in the Program Map Table."
- },
- "RateMode": {
- "shape": "M2tsRateMode",
- "locationName": "rateMode",
- "documentation": "When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set."
+ "locationName": "url",
+ "documentation": "This represents the customer's source URL where stream is\npulled from."
},
- "Scte27Pids": {
+ "Username": {
"shape": "__string",
- "locationName": "scte27Pids",
- "documentation": "Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "Scte35Control": {
- "shape": "M2tsScte35Control",
- "locationName": "scte35Control",
- "documentation": "Optionally pass SCTE-35 signals from the input source to this output."
- },
- "Scte35Pid": {
+ "locationName": "username",
+ "documentation": "The username for the input source."
+ }
+ },
+ "documentation": "The settings for a PULL type input."
+ },
+ "InputSourceEndBehavior": {
+ "type": "string",
+ "documentation": "Input Source End Behavior",
+ "enum": [
+ "CONTINUE",
+ "LOOP"
+ ]
+ },
+ "InputSourceRequest": {
+ "type": "structure",
+ "members": {
+ "PasswordParam": {
"shape": "__string",
- "locationName": "scte35Pid",
- "documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "SegmentationMarkers": {
- "shape": "M2tsSegmentationMarkers",
- "locationName": "segmentationMarkers",
- "documentation": "Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format."
- },
- "SegmentationStyle": {
- "shape": "M2tsSegmentationStyle",
- "locationName": "segmentationStyle",
- "documentation": "The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted.\n\nWhen a segmentation style of \"resetCadence\" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds.\n\nWhen a segmentation style of \"maintainCadence\" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule."
- },
- "SegmentationTime": {
- "shape": "__doubleMin1",
- "locationName": "segmentationTime",
- "documentation": "The length in seconds of each segment. Required unless markers is set to _none_."
- },
- "TimedMetadataBehavior": {
- "shape": "M2tsTimedMetadataBehavior",
- "locationName": "timedMetadataBehavior",
- "documentation": "When set to passthrough, timed metadata will be passed through from input to output."
+ "locationName": "passwordParam",
+ "documentation": "The key used to extract the password from EC2 Parameter store."
},
- "TimedMetadataPid": {
+ "Url": {
"shape": "__string",
- "locationName": "timedMetadataPid",
- "documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "TransportStreamId": {
- "shape": "__integerMin0Max65535",
- "locationName": "transportStreamId",
- "documentation": "The value of the transport stream ID field in the Program Map Table."
+ "locationName": "url",
+ "documentation": "This represents the customer's source URL where stream is\npulled from."
},
- "VideoPid": {
+ "Username": {
"shape": "__string",
- "locationName": "videoPid",
- "documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "Scte35PrerollPullupMilliseconds": {
- "shape": "__doubleMin0Max5000",
- "locationName": "scte35PrerollPullupMilliseconds",
- "documentation": "Defines the amount SCTE-35 preroll will be increased (in milliseconds) on the output. Preroll is the amount of time between the presence of a SCTE-35 indication in a transport stream and the PTS of the video frame it references. Zero means don't add pullup (it doesn't mean set the preroll to zero). Negative pullup is not supported, which means that you can't make the preroll shorter. Be aware that latency in the output will increase by the pullup amount."
+ "locationName": "username",
+ "documentation": "The username for the input source."
}
},
- "documentation": "M2ts Settings"
+ "documentation": "Settings for for a PULL type input."
},
- "M2tsTimedMetadataBehavior": {
+ "InputSourceType": {
"type": "string",
- "documentation": "M2ts Timed Metadata Behavior",
+ "documentation": "There are two types of input sources, static and dynamic. If an input source is dynamic you can\nchange the source url of the input dynamically using an input switch action. Currently, two input types\nsupport a dynamic url at this time, MP4_FILE and TS_FILE. By default all input sources are static.",
"enum": [
- "NO_PASSTHROUGH",
- "PASSTHROUGH"
+ "STATIC",
+ "DYNAMIC"
]
},
- "M3u8KlvBehavior": {
- "type": "string",
- "documentation": "M3u8 Klv Behavior",
- "enum": [
- "NO_PASSTHROUGH",
- "PASSTHROUGH"
- ]
+ "InputSpecification": {
+ "type": "structure",
+ "members": {
+ "Codec": {
+ "shape": "InputCodec",
+ "locationName": "codec",
+ "documentation": "Input codec"
+ },
+ "MaximumBitrate": {
+ "shape": "InputMaximumBitrate",
+ "locationName": "maximumBitrate",
+ "documentation": "Maximum input bitrate, categorized coarsely"
+ },
+ "Resolution": {
+ "shape": "InputResolution",
+ "locationName": "resolution",
+ "documentation": "Input resolution, categorized coarsely"
+ }
+ },
+ "documentation": "Placeholder documentation for InputSpecification"
},
- "M3u8NielsenId3Behavior": {
+ "InputState": {
"type": "string",
- "documentation": "M3u8 Nielsen Id3 Behavior",
"enum": [
- "NO_PASSTHROUGH",
- "PASSTHROUGH"
+ "CREATING",
+ "DETACHED",
+ "ATTACHED",
+ "DELETING",
+ "DELETED"
+ ],
+ "documentation": "Placeholder documentation for InputState"
+ },
+ "InputSwitchScheduleActionSettings": {
+ "type": "structure",
+ "members": {
+ "InputAttachmentNameReference": {
+ "shape": "__string",
+ "locationName": "inputAttachmentNameReference",
+ "documentation": "The name of the input attachment (not the name of the input!) to switch to. The name is specified in the channel configuration."
+ },
+ "InputClippingSettings": {
+ "shape": "InputClippingSettings",
+ "locationName": "inputClippingSettings",
+ "documentation": "Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file."
+ },
+ "UrlPath": {
+ "shape": "__listOf__string",
+ "locationName": "urlPath",
+ "documentation": "The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source."
+ }
+ },
+ "documentation": "Settings for the \"switch input\" action: to switch from ingesting one input to ingesting another input.",
+ "required": [
+ "InputAttachmentNameReference"
]
},
- "M3u8PcrControl": {
+ "InputTimecodeSource": {
"type": "string",
- "documentation": "M3u8 Pcr Control",
+ "documentation": "Documentation update needed",
"enum": [
- "CONFIGURED_PCR_PERIOD",
- "PCR_EVERY_PES_PACKET"
+ "ZEROBASED",
+ "EMBEDDED"
]
},
- "M3u8Scte35Behavior": {
+ "InputType": {
"type": "string",
- "documentation": "M3u8 Scte35 Behavior",
+ "documentation": "The different types of inputs that AWS Elemental MediaLive supports.",
"enum": [
- "NO_PASSTHROUGH",
- "PASSTHROUGH"
+ "UDP_PUSH",
+ "RTP_PUSH",
+ "RTMP_PUSH",
+ "RTMP_PULL",
+ "URL_PULL",
+ "MP4_FILE",
+ "MEDIACONNECT",
+ "INPUT_DEVICE",
+ "AWS_CDI",
+ "TS_FILE",
+ "SRT_CALLER",
+ "MULTICAST"
]
},
- "M3u8Settings": {
+ "InputVpcRequest": {
"type": "structure",
"members": {
- "AudioFramesPerPes": {
- "shape": "__integerMin0",
- "locationName": "audioFramesPerPes",
- "documentation": "The number of audio frames to insert for each PES packet."
- },
- "AudioPids": {
- "shape": "__string",
- "locationName": "audioPids",
- "documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values."
- },
- "EcmPid": {
- "shape": "__string",
- "locationName": "ecmPid",
- "documentation": "This parameter is unused and deprecated."
- },
- "NielsenId3Behavior": {
- "shape": "M3u8NielsenId3Behavior",
- "locationName": "nielsenId3Behavior",
- "documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output."
- },
- "PatInterval": {
- "shape": "__integerMin0Max1000",
- "locationName": "patInterval",
- "documentation": "The number of milliseconds between instances of this table in the output transport stream. A value of \\\"0\\\" writes out the PMT once per segment file."
- },
- "PcrControl": {
- "shape": "M3u8PcrControl",
- "locationName": "pcrControl",
- "documentation": "When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream."
- },
- "PcrPeriod": {
- "shape": "__integerMin0Max500",
- "locationName": "pcrPeriod",
- "documentation": "Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream."
- },
- "PcrPid": {
- "shape": "__string",
- "locationName": "pcrPid",
- "documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value."
- },
- "PmtInterval": {
- "shape": "__integerMin0Max1000",
- "locationName": "pmtInterval",
- "documentation": "The number of milliseconds between instances of this table in the output transport stream. A value of \\\"0\\\" writes out the PMT once per segment file."
- },
- "PmtPid": {
- "shape": "__string",
- "locationName": "pmtPid",
- "documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value."
- },
- "ProgramNum": {
- "shape": "__integerMin0Max65535",
- "locationName": "programNum",
- "documentation": "The value of the program number field in the Program Map Table."
- },
- "Scte35Behavior": {
- "shape": "M3u8Scte35Behavior",
- "locationName": "scte35Behavior",
- "documentation": "If set to passthrough, passes any SCTE-35 signals from the input source to this output."
- },
- "Scte35Pid": {
- "shape": "__string",
- "locationName": "scte35Pid",
- "documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value."
- },
- "TimedMetadataBehavior": {
- "shape": "M3u8TimedMetadataBehavior",
- "locationName": "timedMetadataBehavior",
- "documentation": "When set to passthrough, timed metadata is passed through from input to output."
- },
- "TimedMetadataPid": {
- "shape": "__string",
- "locationName": "timedMetadataPid",
- "documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
- },
- "TransportStreamId": {
- "shape": "__integerMin0Max65535",
- "locationName": "transportStreamId",
- "documentation": "The value of the transport stream ID field in the Program Map Table."
- },
- "VideoPid": {
- "shape": "__string",
- "locationName": "videoPid",
- "documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value."
- },
- "KlvBehavior": {
- "shape": "M3u8KlvBehavior",
- "locationName": "klvBehavior",
- "documentation": "If set to passthrough, passes any KLV data from the input source to this output."
+ "SecurityGroupIds": {
+ "shape": "__listOf__string",
+ "locationName": "securityGroupIds",
+ "documentation": "A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces.\nRequires subnetIds. If none are specified then the VPC default security group will be used."
},
- "KlvDataPids": {
- "shape": "__string",
- "locationName": "klvDataPids",
- "documentation": "Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)."
+ "SubnetIds": {
+ "shape": "__listOf__string",
+ "locationName": "subnetIds",
+ "documentation": "A list of 2 VPC subnet IDs from the same VPC.\nSubnet IDs must be mapped to two unique availability zones (AZ)."
}
},
- "documentation": "Settings information for the .m3u8 container"
- },
- "M3u8TimedMetadataBehavior": {
- "type": "string",
- "documentation": "M3u8 Timed Metadata Behavior",
- "enum": [
- "NO_PASSTHROUGH",
- "PASSTHROUGH"
+ "documentation": "Settings for a private VPC Input.\nWhen this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses.\nThis property requires setting the roleArn property on Input creation.\nNot compatible with the inputSecurityGroups property.",
+ "required": [
+ "SubnetIds"
]
},
- "MaintenanceCreateSettings": {
+ "InputWhitelistRule": {
"type": "structure",
"members": {
- "MaintenanceDay": {
- "shape": "MaintenanceDay",
- "locationName": "maintenanceDay",
- "documentation": "Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows."
- },
- "MaintenanceStartTime": {
- "shape": "__stringPattern010920300",
- "locationName": "maintenanceStartTime",
- "documentation": "Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows."
+ "Cidr": {
+ "shape": "__string",
+ "locationName": "cidr",
+ "documentation": "The IPv4 CIDR that's whitelisted."
}
},
- "documentation": "Placeholder documentation for MaintenanceCreateSettings"
- },
- "MaintenanceDay": {
- "type": "string",
- "documentation": "The currently selected maintenance day.",
- "enum": [
- "MONDAY",
- "TUESDAY",
- "WEDNESDAY",
- "THURSDAY",
- "FRIDAY",
- "SATURDAY",
- "SUNDAY"
- ]
+ "documentation": "Whitelist rule"
},
- "MaintenanceStatus": {
+ "InputWhitelistRuleCidr": {
"type": "structure",
"members": {
- "MaintenanceDay": {
- "shape": "MaintenanceDay",
- "locationName": "maintenanceDay",
- "documentation": "The currently selected maintenance day."
- },
- "MaintenanceDeadline": {
- "shape": "__string",
- "locationName": "maintenanceDeadline",
- "documentation": "Maintenance is required by the displayed date and time. Date and time is in ISO."
- },
- "MaintenanceScheduledDate": {
- "shape": "__string",
- "locationName": "maintenanceScheduledDate",
- "documentation": "The currently scheduled maintenance date and time. Date and time is in ISO."
- },
- "MaintenanceStartTime": {
+ "Cidr": {
"shape": "__string",
- "locationName": "maintenanceStartTime",
- "documentation": "The currently selected maintenance start time. Time is in UTC."
+ "locationName": "cidr",
+ "documentation": "The IPv4 CIDR to whitelist."
}
},
- "documentation": "Placeholder documentation for MaintenanceStatus"
+ "documentation": "An IPv4 CIDR to whitelist."
},
- "MaintenanceUpdateSettings": {
+ "InternalServerErrorException": {
"type": "structure",
"members": {
- "MaintenanceDay": {
- "shape": "MaintenanceDay",
- "locationName": "maintenanceDay",
- "documentation": "Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows."
- },
- "MaintenanceScheduledDate": {
+ "Message": {
"shape": "__string",
- "locationName": "maintenanceScheduledDate",
- "documentation": "Choose a specific date for maintenance to occur. The chosen date is used for the next maintenance window only."
- },
- "MaintenanceStartTime": {
- "shape": "__stringPattern010920300",
- "locationName": "maintenanceStartTime",
- "documentation": "Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows."
+ "locationName": "message"
}
},
- "documentation": "Placeholder documentation for MaintenanceUpdateSettings"
- },
- "MaxResults": {
- "type": "integer",
- "min": 1,
- "max": 1000,
- "documentation": "Placeholder documentation for MaxResults"
+ "exception": true,
+ "error": {
+ "httpStatusCode": 500
+ },
+ "documentation": "Placeholder documentation for InternalServerErrorException"
},
- "MediaConnectFlow": {
+ "InternalServiceError": {
"type": "structure",
"members": {
- "FlowArn": {
+ "Message": {
"shape": "__string",
- "locationName": "flowArn",
- "documentation": "The unique ARN of the MediaConnect Flow being used as a source."
+ "locationName": "message"
}
},
- "documentation": "The settings for a MediaConnect Flow."
+ "documentation": "Placeholder documentation for InternalServiceError"
},
- "MediaConnectFlowRequest": {
+ "InvalidRequest": {
"type": "structure",
"members": {
- "FlowArn": {
+ "Message": {
"shape": "__string",
- "locationName": "flowArn",
- "documentation": "The ARN of the MediaConnect Flow that you want to use as a source."
+ "locationName": "message"
}
},
- "documentation": "The settings for a MediaConnect Flow."
+ "documentation": "Placeholder documentation for InvalidRequest"
},
- "MediaPackageGroupSettings": {
+ "KeyProviderSettings": {
"type": "structure",
"members": {
- "Destination": {
- "shape": "OutputLocationRef",
- "locationName": "destination",
- "documentation": "MediaPackage channel destination."
+ "StaticKeySettings": {
+ "shape": "StaticKeySettings",
+ "locationName": "staticKeySettings"
}
},
- "documentation": "Media Package Group Settings",
- "required": [
- "Destination"
+ "documentation": "Key Provider Settings"
+ },
+ "LastFrameClippingBehavior": {
+ "type": "string",
+ "documentation": "If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode.",
+ "enum": [
+ "EXCLUDE_LAST_FRAME",
+ "INCLUDE_LAST_FRAME"
]
},
- "MediaPackageOutputDestinationSettings": {
+ "LimitExceeded": {
"type": "structure",
"members": {
- "ChannelId": {
- "shape": "__stringMin1",
- "locationName": "channelId",
- "documentation": "ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region."
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
}
},
- "documentation": "MediaPackage Output Destination Settings"
+ "documentation": "Placeholder documentation for LimitExceeded"
},
- "MediaPackageOutputSettings": {
+ "ListChannelsRequest": {
"type": "structure",
"members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ }
},
- "documentation": "Media Package Output Settings"
+ "documentation": "Placeholder documentation for ListChannelsRequest"
},
- "MotionGraphicsActivateScheduleActionSettings": {
+ "ListChannelsResponse": {
"type": "structure",
"members": {
- "Duration": {
- "shape": "__longMin0Max86400000",
- "locationName": "duration",
- "documentation": "Duration (in milliseconds) that motion graphics should render on to the video stream. Leaving out this property or setting to 0 will result in rendering continuing until a deactivate action is processed."
- },
- "PasswordParam": {
- "shape": "__string",
- "locationName": "passwordParam",
- "documentation": "Key used to extract the password from EC2 Parameter store"
+ "Channels": {
+ "shape": "__listOfChannelSummary",
+ "locationName": "channels"
},
- "Url": {
+ "NextToken": {
"shape": "__string",
- "locationName": "url",
- "documentation": "URI of the HTML5 content to be rendered into the live stream."
+ "locationName": "nextToken"
+ }
+ },
+ "documentation": "Placeholder documentation for ListChannelsResponse"
+ },
+ "ListChannelsResultModel": {
+ "type": "structure",
+ "members": {
+ "Channels": {
+ "shape": "__listOfChannelSummary",
+ "locationName": "channels"
},
- "Username": {
+ "NextToken": {
"shape": "__string",
- "locationName": "username",
- "documentation": "Documentation update needed"
+ "locationName": "nextToken"
}
},
- "documentation": "Settings to specify the rendering of motion graphics into the video stream."
+ "documentation": "Placeholder documentation for ListChannelsResultModel"
},
- "MotionGraphicsConfiguration": {
+ "ListInputDeviceTransfersRequest": {
"type": "structure",
"members": {
- "MotionGraphicsInsertion": {
- "shape": "MotionGraphicsInsertion",
- "locationName": "motionGraphicsInsertion"
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
},
- "MotionGraphicsSettings": {
- "shape": "MotionGraphicsSettings",
- "locationName": "motionGraphicsSettings",
- "documentation": "Motion Graphics Settings"
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ },
+ "TransferType": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "transferType"
}
},
- "documentation": "Motion Graphics Configuration",
"required": [
- "MotionGraphicsSettings"
- ]
+ "TransferType"
+ ],
+ "documentation": "Placeholder documentation for ListInputDeviceTransfersRequest"
},
- "MotionGraphicsDeactivateScheduleActionSettings": {
+ "ListInputDeviceTransfersResponse": {
"type": "structure",
"members": {
+ "InputDeviceTransfers": {
+ "shape": "__listOfTransferringInputDeviceSummary",
+ "locationName": "inputDeviceTransfers",
+ "documentation": "The list of devices that you are transferring or are being transferred to you."
+ },
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "A token to get additional list results."
+ }
},
- "documentation": "Settings to specify the ending of rendering motion graphics into the video stream."
- },
- "MotionGraphicsInsertion": {
- "type": "string",
- "documentation": "Motion Graphics Insertion",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
+ "documentation": "Placeholder documentation for ListInputDeviceTransfersResponse"
},
- "MotionGraphicsSettings": {
+ "ListInputDeviceTransfersResultModel": {
"type": "structure",
"members": {
- "HtmlMotionGraphicsSettings": {
- "shape": "HtmlMotionGraphicsSettings",
- "locationName": "htmlMotionGraphicsSettings"
+ "InputDeviceTransfers": {
+ "shape": "__listOfTransferringInputDeviceSummary",
+ "locationName": "inputDeviceTransfers",
+ "documentation": "The list of devices that you are transferring or are being transferred to you."
+ },
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "A token to get additional list results."
}
},
- "documentation": "Motion Graphics Settings"
+ "documentation": "The list of input devices in the transferred state. The recipient hasn't yet accepted or rejected the transfer."
},
- "Mp2CodingMode": {
- "type": "string",
- "documentation": "Mp2 Coding Mode",
- "enum": [
- "CODING_MODE_1_0",
- "CODING_MODE_2_0"
- ]
+ "ListInputDevicesRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ }
+ },
+ "documentation": "Placeholder documentation for ListInputDevicesRequest"
},
- "Mp2Settings": {
+ "ListInputDevicesResponse": {
"type": "structure",
"members": {
- "Bitrate": {
- "shape": "__double",
- "locationName": "bitrate",
- "documentation": "Average bitrate in bits/second."
+ "InputDevices": {
+ "shape": "__listOfInputDeviceSummary",
+ "locationName": "inputDevices",
+ "documentation": "The list of input devices."
},
- "CodingMode": {
- "shape": "Mp2CodingMode",
- "locationName": "codingMode",
- "documentation": "The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo)."
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "A token to get additional list results."
+ }
+ },
+ "documentation": "Placeholder documentation for ListInputDevicesResponse"
+ },
+ "ListInputDevicesResultModel": {
+ "type": "structure",
+ "members": {
+ "InputDevices": {
+ "shape": "__listOfInputDeviceSummary",
+ "locationName": "inputDevices",
+ "documentation": "The list of input devices."
},
- "SampleRate": {
- "shape": "__double",
- "locationName": "sampleRate",
- "documentation": "Sample rate in Hz."
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "A token to get additional list results."
}
},
- "documentation": "Mp2 Settings"
+ "documentation": "The list of input devices owned by the AWS account."
},
- "Mpeg2AdaptiveQuantization": {
- "type": "string",
- "documentation": "Mpeg2 Adaptive Quantization",
- "enum": [
- "AUTO",
- "HIGH",
- "LOW",
- "MEDIUM",
- "OFF"
- ]
- },
- "Mpeg2ColorMetadata": {
- "type": "string",
- "documentation": "Mpeg2 Color Metadata",
- "enum": [
- "IGNORE",
- "INSERT"
- ]
- },
- "Mpeg2ColorSpace": {
- "type": "string",
- "documentation": "Mpeg2 Color Space",
- "enum": [
- "AUTO",
- "PASSTHROUGH"
- ]
- },
- "Mpeg2DisplayRatio": {
- "type": "string",
- "documentation": "Mpeg2 Display Ratio",
- "enum": [
- "DISPLAYRATIO16X9",
- "DISPLAYRATIO4X3"
- ]
- },
- "Mpeg2FilterSettings": {
+ "ListInputSecurityGroupsRequest": {
"type": "structure",
"members": {
- "TemporalFilterSettings": {
- "shape": "TemporalFilterSettings",
- "locationName": "temporalFilterSettings"
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
}
},
- "documentation": "Mpeg2 Filter Settings"
- },
- "Mpeg2GopSizeUnits": {
- "type": "string",
- "documentation": "Mpeg2 Gop Size Units",
- "enum": [
- "FRAMES",
- "SECONDS"
- ]
- },
- "Mpeg2ScanType": {
- "type": "string",
- "documentation": "Mpeg2 Scan Type",
- "enum": [
- "INTERLACED",
- "PROGRESSIVE"
- ]
+ "documentation": "Placeholder documentation for ListInputSecurityGroupsRequest"
},
- "Mpeg2Settings": {
+ "ListInputSecurityGroupsResponse": {
"type": "structure",
"members": {
- "AdaptiveQuantization": {
- "shape": "Mpeg2AdaptiveQuantization",
- "locationName": "adaptiveQuantization",
- "documentation": "Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality."
- },
- "AfdSignaling": {
- "shape": "AfdSignaling",
- "locationName": "afdSignaling",
- "documentation": "Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO.\nAUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid).\nFIXED: MediaLive will use the value you specify in fixedAFD."
- },
- "ColorMetadata": {
- "shape": "Mpeg2ColorMetadata",
- "locationName": "colorMetadata",
- "documentation": "Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata."
- },
- "ColorSpace": {
- "shape": "Mpeg2ColorSpace",
- "locationName": "colorSpace",
- "documentation": "Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \\\"MediaLive Features - Video - color space\\\" in the MediaLive User Guide.\nPASSTHROUGH: Keep the color space of the input content - do not convert it.\nAUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709."
- },
- "DisplayAspectRatio": {
- "shape": "Mpeg2DisplayRatio",
- "locationName": "displayAspectRatio",
- "documentation": "Sets the pixel aspect ratio for the encode."
- },
- "FilterSettings": {
- "shape": "Mpeg2FilterSettings",
- "locationName": "filterSettings",
- "documentation": "Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied.\nTEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean.\nWhen the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise.\nWhen the content is reasonably clean, the filter tends to decrease the bitrate."
- },
- "FixedAfd": {
- "shape": "FixedAfd",
- "locationName": "fixedAfd",
- "documentation": "Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode."
- },
- "FramerateDenominator": {
- "shape": "__integerMin1",
- "locationName": "framerateDenominator",
- "documentation": "description\": \"The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS."
- },
- "FramerateNumerator": {
- "shape": "__integerMin1",
- "locationName": "framerateNumerator",
- "documentation": "The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS."
- },
- "GopClosedCadence": {
- "shape": "__integerMin0",
- "locationName": "gopClosedCadence",
- "documentation": "MPEG2: default is open GOP."
+ "InputSecurityGroups": {
+ "shape": "__listOfInputSecurityGroup",
+ "locationName": "inputSecurityGroups",
+ "documentation": "List of input security groups"
},
- "GopNumBFrames": {
- "shape": "__integerMin0Max7",
- "locationName": "gopNumBFrames",
- "documentation": "Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default."
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ }
+ },
+ "documentation": "Placeholder documentation for ListInputSecurityGroupsResponse"
+ },
+ "ListInputSecurityGroupsResultModel": {
+ "type": "structure",
+ "members": {
+ "InputSecurityGroups": {
+ "shape": "__listOfInputSecurityGroup",
+ "locationName": "inputSecurityGroups",
+ "documentation": "List of input security groups"
},
- "GopSize": {
- "shape": "__double",
- "locationName": "gopSize",
- "documentation": "Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default.\nIf gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer."
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ }
+ },
+ "documentation": "Result of input security group list request"
+ },
+ "ListInputsRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
},
- "GopSizeUnits": {
- "shape": "Mpeg2GopSizeUnits",
- "locationName": "gopSizeUnits",
- "documentation": "Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count."
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ }
+ },
+ "documentation": "Placeholder documentation for ListInputsRequest"
+ },
+ "ListInputsResponse": {
+ "type": "structure",
+ "members": {
+ "Inputs": {
+ "shape": "__listOfInput",
+ "locationName": "inputs"
},
- "ScanType": {
- "shape": "Mpeg2ScanType",
- "locationName": "scanType",
- "documentation": "Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first)."
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ }
+ },
+ "documentation": "Placeholder documentation for ListInputsResponse"
+ },
+ "ListInputsResultModel": {
+ "type": "structure",
+ "members": {
+ "Inputs": {
+ "shape": "__listOfInput",
+ "locationName": "inputs"
},
- "SubgopLength": {
- "shape": "Mpeg2SubGopLength",
- "locationName": "subgopLength",
- "documentation": "Relates to the GOP structure. If you do not know what GOP is, use the default.\nFIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames.\nDYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality."
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ }
+ },
+ "documentation": "Placeholder documentation for ListInputsResultModel"
+ },
+ "ListMultiplexProgramsRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults",
+ "documentation": "The maximum number of items to return."
},
- "TimecodeInsertion": {
- "shape": "Mpeg2TimecodeInsertionBehavior",
- "locationName": "timecodeInsertion",
- "documentation": "Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \\\"MediaLive Features - Timecode configuration\\\" in the MediaLive User Guide.\nDISABLED: do not include timecodes.\nGOP_TIMECODE: Include timecode metadata in the GOP header."
+ "MultiplexId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "multiplexId",
+ "documentation": "The ID of the multiplex that the programs belong to."
},
- "TimecodeBurninSettings": {
- "shape": "TimecodeBurninSettings",
- "locationName": "timecodeBurninSettings",
- "documentation": "Timecode burn-in settings"
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "The token to retrieve the next page of results."
}
},
- "documentation": "Mpeg2 Settings",
"required": [
- "FramerateNumerator",
- "FramerateDenominator"
- ]
- },
- "Mpeg2SubGopLength": {
- "type": "string",
- "documentation": "Mpeg2 Sub Gop Length",
- "enum": [
- "DYNAMIC",
- "FIXED"
- ]
- },
- "Mpeg2TimecodeInsertionBehavior": {
- "type": "string",
- "documentation": "Mpeg2 Timecode Insertion Behavior",
- "enum": [
- "DISABLED",
- "GOP_TIMECODE"
- ]
+ "MultiplexId"
+ ],
+ "documentation": "Placeholder documentation for ListMultiplexProgramsRequest"
},
- "MsSmoothGroupSettings": {
+ "ListMultiplexProgramsResponse": {
"type": "structure",
"members": {
- "AcquisitionPointId": {
- "shape": "__string",
- "locationName": "acquisitionPointId",
- "documentation": "The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE."
+ "MultiplexPrograms": {
+ "shape": "__listOfMultiplexProgramSummary",
+ "locationName": "multiplexPrograms",
+ "documentation": "List of multiplex programs."
},
- "AudioOnlyTimecodeControl": {
- "shape": "SmoothGroupAudioOnlyTimecodeControl",
- "locationName": "audioOnlyTimecodeControl",
- "documentation": "If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream."
- },
- "CertificateMode": {
- "shape": "SmoothGroupCertificateMode",
- "locationName": "certificateMode",
- "documentation": "If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail."
- },
- "ConnectionRetryInterval": {
- "shape": "__integerMin0",
- "locationName": "connectionRetryInterval",
- "documentation": "Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established."
- },
- "Destination": {
- "shape": "OutputLocationRef",
- "locationName": "destination",
- "documentation": "Smooth Streaming publish point on an IIS server. Elemental Live acts as a \"Push\" encoder to IIS."
- },
- "EventId": {
- "shape": "__string",
- "locationName": "eventId",
- "documentation": "MS Smooth event ID to be sent to the IIS server.\n\nShould only be specified if eventIdMode is set to useConfigured."
- },
- "EventIdMode": {
- "shape": "SmoothGroupEventIdMode",
- "locationName": "eventIdMode",
- "documentation": "Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run.\n\nOptions:\n- \"useConfigured\" - use the value provided in eventId\n- \"useTimestamp\" - generate and send an event ID based on the current timestamp\n- \"noEventId\" - do not send an event ID to the IIS server."
- },
- "EventStopBehavior": {
- "shape": "SmoothGroupEventStopBehavior",
- "locationName": "eventStopBehavior",
- "documentation": "When set to sendEos, send EOS signal to IIS server when stopping the event"
- },
- "FilecacheDuration": {
- "shape": "__integerMin0",
- "locationName": "filecacheDuration",
- "documentation": "Size in seconds of file cache for streaming outputs."
- },
- "FragmentLength": {
- "shape": "__integerMin1",
- "locationName": "fragmentLength",
- "documentation": "Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate."
- },
- "InputLossAction": {
- "shape": "InputLossActionForMsSmoothOut",
- "locationName": "inputLossAction",
- "documentation": "Parameter that control output group behavior on input loss."
- },
- "NumRetries": {
- "shape": "__integerMin0",
- "locationName": "numRetries",
- "documentation": "Number of retry attempts."
- },
- "RestartDelay": {
- "shape": "__integerMin0",
- "locationName": "restartDelay",
- "documentation": "Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration."
- },
- "SegmentationMode": {
- "shape": "SmoothGroupSegmentationMode",
- "locationName": "segmentationMode",
- "documentation": "useInputSegmentation has been deprecated. The configured segment size is always used."
- },
- "SendDelayMs": {
- "shape": "__integerMin0Max10000",
- "locationName": "sendDelayMs",
- "documentation": "Number of milliseconds to delay the output from the second pipeline."
- },
- "SparseTrackType": {
- "shape": "SmoothGroupSparseTrackType",
- "locationName": "sparseTrackType",
- "documentation": "Identifies the type of data to place in the sparse track:\n- SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment.\n- SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment.\n- NONE: Don't generate a sparse track for any outputs in this output group."
- },
- "StreamManifestBehavior": {
- "shape": "SmoothGroupStreamManifestBehavior",
- "locationName": "streamManifestBehavior",
- "documentation": "When set to send, send stream manifest so publishing point doesn't start until all streams start."
- },
- "TimestampOffset": {
+ "NextToken": {
"shape": "__string",
- "locationName": "timestampOffset",
- "documentation": "Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset."
- },
- "TimestampOffsetMode": {
- "shape": "SmoothGroupTimestampOffsetMode",
- "locationName": "timestampOffsetMode",
- "documentation": "Type of timestamp date offset to use.\n- useEventStartDate: Use the date the event was started as the offset\n- useConfiguredOffset: Use an explicitly configured date as the offset"
+ "locationName": "nextToken",
+ "documentation": "Token for the next ListMultiplexProgram request."
}
},
- "documentation": "Ms Smooth Group Settings",
- "required": [
- "Destination"
- ]
- },
- "MsSmoothH265PackagingType": {
- "type": "string",
- "documentation": "Ms Smooth H265 Packaging Type",
- "enum": [
- "HEV1",
- "HVC1"
- ]
+ "documentation": "Placeholder documentation for ListMultiplexProgramsResponse"
},
- "MsSmoothOutputSettings": {
+ "ListMultiplexProgramsResultModel": {
"type": "structure",
"members": {
- "H265PackagingType": {
- "shape": "MsSmoothH265PackagingType",
- "locationName": "h265PackagingType",
- "documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1."
+ "MultiplexPrograms": {
+ "shape": "__listOfMultiplexProgramSummary",
+ "locationName": "multiplexPrograms",
+ "documentation": "List of multiplex programs."
},
- "NameModifier": {
+ "NextToken": {
"shape": "__string",
- "locationName": "nameModifier",
- "documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type."
+ "locationName": "nextToken",
+ "documentation": "Token for the next ListMultiplexProgram request."
}
},
- "documentation": "Ms Smooth Output Settings"
+ "documentation": "Placeholder documentation for ListMultiplexProgramsResultModel"
},
- "Multiplex": {
+ "ListMultiplexesRequest": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique arn of the multiplex."
- },
- "AvailabilityZones": {
- "shape": "__listOf__string",
- "locationName": "availabilityZones",
- "documentation": "A list of availability zones for the multiplex."
- },
- "Destinations": {
- "shape": "__listOfMultiplexOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of the multiplex output destinations."
- },
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique id of the multiplex."
- },
- "MultiplexSettings": {
- "shape": "MultiplexSettings",
- "locationName": "multiplexSettings",
- "documentation": "Configuration for a multiplex event."
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults",
+ "documentation": "The maximum number of items to return."
},
- "Name": {
+ "NextToken": {
"shape": "__string",
- "locationName": "name",
- "documentation": "The name of the multiplex."
- },
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
- },
- "ProgramCount": {
- "shape": "__integer",
- "locationName": "programCount",
- "documentation": "The number of programs in the multiplex."
- },
- "State": {
- "shape": "MultiplexState",
- "locationName": "state",
- "documentation": "The current state of the multiplex."
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "The token to retrieve the next page of results."
}
},
- "documentation": "The multiplex object."
+ "documentation": "Placeholder documentation for ListMultiplexesRequest"
},
- "MultiplexConfigurationValidationError": {
+ "ListMultiplexesResponse": {
"type": "structure",
"members": {
- "Message": {
- "shape": "__string",
- "locationName": "message",
- "documentation": "The error message."
+ "Multiplexes": {
+ "shape": "__listOfMultiplexSummary",
+ "locationName": "multiplexes",
+ "documentation": "List of multiplexes."
},
- "ValidationErrors": {
- "shape": "__listOfValidationError",
- "locationName": "validationErrors",
- "documentation": "A collection of validation error responses."
- }
- },
- "documentation": "Placeholder documentation for MultiplexConfigurationValidationError"
- },
- "MultiplexGroupSettings": {
- "type": "structure",
- "members": {
- },
- "documentation": "Multiplex Group Settings"
- },
- "MultiplexMediaConnectOutputDestinationSettings": {
- "type": "structure",
- "members": {
- "EntitlementArn": {
- "shape": "__stringMin1",
- "locationName": "entitlementArn",
- "documentation": "The MediaConnect entitlement ARN available as a Flow source."
- }
- },
- "documentation": "Multiplex MediaConnect output destination settings."
- },
- "MultiplexOutputDestination": {
- "type": "structure",
- "members": {
- "MediaConnectSettings": {
- "shape": "MultiplexMediaConnectOutputDestinationSettings",
- "locationName": "mediaConnectSettings",
- "documentation": "Multiplex MediaConnect output destination settings."
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token for the next ListMultiplexes request."
}
},
- "documentation": "Multiplex output destination settings"
+ "documentation": "Placeholder documentation for ListMultiplexesResponse"
},
- "MultiplexOutputSettings": {
+ "ListMultiplexesResultModel": {
"type": "structure",
"members": {
- "Destination": {
- "shape": "OutputLocationRef",
- "locationName": "destination",
- "documentation": "Destination is a Multiplex."
+ "Multiplexes": {
+ "shape": "__listOfMultiplexSummary",
+ "locationName": "multiplexes",
+ "documentation": "List of multiplexes."
+ },
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token for the next ListMultiplexes request."
}
},
- "documentation": "Multiplex Output Settings",
- "required": [
- "Destination"
- ]
+ "documentation": "Placeholder documentation for ListMultiplexesResultModel"
},
- "MultiplexProgram": {
+ "ListOfferingsRequest": {
"type": "structure",
"members": {
- "ChannelId": {
+ "ChannelClass": {
"shape": "__string",
- "locationName": "channelId",
- "documentation": "The MediaLive channel associated with the program."
+ "location": "querystring",
+ "locationName": "channelClass",
+ "documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'"
},
- "MultiplexProgramSettings": {
- "shape": "MultiplexProgramSettings",
- "locationName": "multiplexProgramSettings",
- "documentation": "The settings for this multiplex program."
+ "ChannelConfiguration": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "channelConfiguration",
+ "documentation": "Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)"
},
- "PacketIdentifiersMap": {
- "shape": "MultiplexProgramPacketIdentifiersMap",
- "locationName": "packetIdentifiersMap",
- "documentation": "The packet identifier map for this multiplex program."
+ "Codec": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "codec",
+ "documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', 'LINK', or 'AV1'"
},
- "PipelineDetails": {
- "shape": "__listOfMultiplexProgramPipelineDetail",
- "locationName": "pipelineDetails",
- "documentation": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time."
+ "Duration": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "duration",
+ "documentation": "Filter by offering duration, e.g. '12'"
},
- "ProgramName": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "MaximumBitrate": {
"shape": "__string",
- "locationName": "programName",
- "documentation": "The name of the multiplex program."
+ "location": "querystring",
+ "locationName": "maximumBitrate",
+ "documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'"
+ },
+ "MaximumFramerate": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "maximumFramerate",
+ "documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ },
+ "Resolution": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "resolution",
+ "documentation": "Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'"
+ },
+ "ResourceType": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "resourceType",
+ "documentation": "Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'"
+ },
+ "SpecialFeature": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "specialFeature",
+ "documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'"
+ },
+ "VideoQuality": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "videoQuality",
+ "documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'"
}
},
- "documentation": "The multiplex program object."
+ "documentation": "Placeholder documentation for ListOfferingsRequest"
},
- "MultiplexProgramChannelDestinationSettings": {
+ "ListOfferingsResponse": {
"type": "structure",
"members": {
- "MultiplexId": {
- "shape": "__stringMin1",
- "locationName": "multiplexId",
- "documentation": "The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances.\nThe Multiplex must be in the same region as the Channel."
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token to retrieve the next page of results"
},
- "ProgramName": {
- "shape": "__stringMin1",
- "locationName": "programName",
- "documentation": "The program name of the Multiplex program that the encoder is providing output to."
+ "Offerings": {
+ "shape": "__listOfOffering",
+ "locationName": "offerings",
+ "documentation": "List of offerings"
}
},
- "documentation": "Multiplex Program Input Destination Settings for outputting a Channel to a Multiplex"
+ "documentation": "Placeholder documentation for ListOfferingsResponse"
},
- "MultiplexProgramPacketIdentifiersMap": {
+ "ListOfferingsResultModel": {
"type": "structure",
"members": {
- "AudioPids": {
- "shape": "__listOf__integer",
- "locationName": "audioPids"
- },
- "DvbSubPids": {
- "shape": "__listOf__integer",
- "locationName": "dvbSubPids"
- },
- "DvbTeletextPid": {
- "shape": "__integer",
- "locationName": "dvbTeletextPid"
- },
- "EtvPlatformPid": {
- "shape": "__integer",
- "locationName": "etvPlatformPid"
- },
- "EtvSignalPid": {
- "shape": "__integer",
- "locationName": "etvSignalPid"
- },
- "KlvDataPids": {
- "shape": "__listOf__integer",
- "locationName": "klvDataPids"
- },
- "PcrPid": {
- "shape": "__integer",
- "locationName": "pcrPid"
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token to retrieve the next page of results"
},
- "PmtPid": {
- "shape": "__integer",
- "locationName": "pmtPid"
+ "Offerings": {
+ "shape": "__listOfOffering",
+ "locationName": "offerings",
+ "documentation": "List of offerings"
+ }
+ },
+ "documentation": "ListOfferings response"
+ },
+ "ListReservationsRequest": {
+ "type": "structure",
+ "members": {
+ "ChannelClass": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "channelClass",
+ "documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'"
},
- "PrivateMetadataPid": {
- "shape": "__integer",
- "locationName": "privateMetadataPid"
+ "Codec": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "codec",
+ "documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', 'LINK', or 'AV1'"
},
- "Scte27Pids": {
- "shape": "__listOf__integer",
- "locationName": "scte27Pids"
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
},
- "Scte35Pid": {
- "shape": "__integer",
- "locationName": "scte35Pid"
+ "MaximumBitrate": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "maximumBitrate",
+ "documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'"
},
- "TimedMetadataPid": {
- "shape": "__integer",
- "locationName": "timedMetadataPid"
+ "MaximumFramerate": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "maximumFramerate",
+ "documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'"
},
- "VideoPid": {
- "shape": "__integer",
- "locationName": "videoPid"
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
},
- "AribCaptionsPid": {
- "shape": "__integer",
- "locationName": "aribCaptionsPid"
+ "Resolution": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "resolution",
+ "documentation": "Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'"
},
- "DvbTeletextPids": {
- "shape": "__listOf__integer",
- "locationName": "dvbTeletextPids"
+ "ResourceType": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "resourceType",
+ "documentation": "Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'"
},
- "EcmPid": {
- "shape": "__integer",
- "locationName": "ecmPid"
+ "SpecialFeature": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "specialFeature",
+ "documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'"
},
- "Smpte2038Pid": {
- "shape": "__integer",
- "locationName": "smpte2038Pid"
+ "VideoQuality": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "videoQuality",
+ "documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'"
}
},
- "documentation": "Packet identifiers map for a given Multiplex program."
+ "documentation": "Placeholder documentation for ListReservationsRequest"
},
- "MultiplexProgramPipelineDetail": {
+ "ListReservationsResponse": {
"type": "structure",
"members": {
- "ActiveChannelPipeline": {
+ "NextToken": {
"shape": "__string",
- "locationName": "activeChannelPipeline",
- "documentation": "Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex."
+ "locationName": "nextToken",
+ "documentation": "Token to retrieve the next page of results"
},
- "PipelineId": {
- "shape": "__string",
- "locationName": "pipelineId",
- "documentation": "Identifies a specific pipeline in the multiplex."
+ "Reservations": {
+ "shape": "__listOfReservation",
+ "locationName": "reservations",
+ "documentation": "List of reservations"
}
},
- "documentation": "The current source for one of the pipelines in the multiplex."
+ "documentation": "Placeholder documentation for ListReservationsResponse"
},
- "MultiplexProgramServiceDescriptor": {
+ "ListReservationsResultModel": {
"type": "structure",
"members": {
- "ProviderName": {
- "shape": "__stringMax256",
- "locationName": "providerName",
- "documentation": "Name of the provider."
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token to retrieve the next page of results"
},
- "ServiceName": {
- "shape": "__stringMax256",
- "locationName": "serviceName",
- "documentation": "Name of the service."
- }
- },
- "documentation": "Transport stream service descriptor configuration for the Multiplex program.",
- "required": [
- "ProviderName",
- "ServiceName"
- ]
- },
- "MultiplexProgramSettings": {
- "type": "structure",
- "members": {
- "PreferredChannelPipeline": {
- "shape": "PreferredChannelPipeline",
- "locationName": "preferredChannelPipeline",
- "documentation": "Indicates which pipeline is preferred by the multiplex for program ingest."
- },
- "ProgramNumber": {
- "shape": "__integerMin0Max65535",
- "locationName": "programNumber",
- "documentation": "Unique program number."
- },
- "ServiceDescriptor": {
- "shape": "MultiplexProgramServiceDescriptor",
- "locationName": "serviceDescriptor",
- "documentation": "Transport stream service descriptor configuration for the Multiplex program."
- },
- "VideoSettings": {
- "shape": "MultiplexVideoSettings",
- "locationName": "videoSettings",
- "documentation": "Program video settings configuration."
+ "Reservations": {
+ "shape": "__listOfReservation",
+ "locationName": "reservations",
+ "documentation": "List of reservations"
}
},
- "documentation": "Multiplex Program settings configuration.",
- "required": [
- "ProgramNumber"
- ]
+ "documentation": "ListReservations response"
},
- "MultiplexProgramSummary": {
+ "ListTagsForResourceRequest": {
"type": "structure",
"members": {
- "ChannelId": {
- "shape": "__string",
- "locationName": "channelId",
- "documentation": "The MediaLive Channel associated with the program."
- },
- "ProgramName": {
+ "ResourceArn": {
"shape": "__string",
- "locationName": "programName",
- "documentation": "The name of the multiplex program."
- }
- },
- "documentation": "Placeholder documentation for MultiplexProgramSummary"
- },
- "MultiplexSettings": {
- "type": "structure",
- "members": {
- "MaximumVideoBufferDelayMilliseconds": {
- "shape": "__integerMin800Max3000",
- "locationName": "maximumVideoBufferDelayMilliseconds",
- "documentation": "Maximum video buffer delay in milliseconds."
- },
- "TransportStreamBitrate": {
- "shape": "__integerMin1000000Max100000000",
- "locationName": "transportStreamBitrate",
- "documentation": "Transport stream bit rate."
- },
- "TransportStreamId": {
- "shape": "__integerMin0Max65535",
- "locationName": "transportStreamId",
- "documentation": "Transport stream ID."
- },
- "TransportStreamReservedBitrate": {
- "shape": "__integerMin0Max100000000",
- "locationName": "transportStreamReservedBitrate",
- "documentation": "Transport stream reserved bit rate."
+ "location": "uri",
+ "locationName": "resource-arn"
}
},
- "documentation": "Contains configuration for a Multiplex event",
"required": [
- "TransportStreamBitrate",
- "TransportStreamId"
- ]
+ "ResourceArn"
+ ],
+ "documentation": "Placeholder documentation for ListTagsForResourceRequest"
},
- "MultiplexSettingsSummary": {
+ "ListTagsForResourceResponse": {
"type": "structure",
"members": {
- "TransportStreamBitrate": {
- "shape": "__integerMin1000000Max100000000",
- "locationName": "transportStreamBitrate",
- "documentation": "Transport stream bit rate."
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
}
},
- "documentation": "Contains summary configuration for a Multiplex event."
+ "documentation": "Placeholder documentation for ListTagsForResourceResponse"
},
- "MultiplexState": {
+ "LogLevel": {
"type": "string",
- "documentation": "The current state of the multiplex.",
+ "documentation": "The log level the user wants for their channel.",
"enum": [
- "CREATING",
- "CREATE_FAILED",
- "IDLE",
- "STARTING",
- "RUNNING",
- "RECOVERING",
- "STOPPING",
- "DELETING",
- "DELETED"
+ "ERROR",
+ "WARNING",
+ "INFO",
+ "DEBUG",
+ "DISABLED"
]
},
- "MultiplexStatmuxVideoSettings": {
- "type": "structure",
- "members": {
- "MaximumBitrate": {
- "shape": "__integerMin100000Max100000000",
- "locationName": "maximumBitrate",
- "documentation": "Maximum statmux bitrate."
- },
- "MinimumBitrate": {
- "shape": "__integerMin100000Max100000000",
- "locationName": "minimumBitrate",
- "documentation": "Minimum statmux bitrate."
- },
- "Priority": {
- "shape": "__integerMinNegative5Max5",
- "locationName": "priority",
- "documentation": "The purpose of the priority is to use a combination of the\\nmultiplex rate control algorithm and the QVBR capability of the\\nencoder to prioritize the video quality of some channels in a\\nmultiplex over others. Channels that have a higher priority will\\nget higher video quality at the expense of the video quality of\\nother channels in the multiplex with lower priority."
- }
- },
- "documentation": "Statmux rate control settings"
+ "M2tsAbsentInputAudioBehavior": {
+ "type": "string",
+ "documentation": "M2ts Absent Input Audio Behavior",
+ "enum": [
+ "DROP",
+ "ENCODE_SILENCE"
+ ]
},
- "MultiplexSummary": {
- "type": "structure",
- "members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique arn of the multiplex."
- },
- "AvailabilityZones": {
- "shape": "__listOf__string",
- "locationName": "availabilityZones",
- "documentation": "A list of availability zones for the multiplex."
- },
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique id of the multiplex."
- },
- "MultiplexSettings": {
- "shape": "MultiplexSettingsSummary",
- "locationName": "multiplexSettings",
- "documentation": "Configuration for a multiplex event."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "The name of the multiplex."
- },
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
- },
- "ProgramCount": {
- "shape": "__integer",
- "locationName": "programCount",
- "documentation": "The number of programs in the multiplex."
- },
- "State": {
- "shape": "MultiplexState",
- "locationName": "state",
- "documentation": "The current state of the multiplex."
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
- }
- },
- "documentation": "Placeholder documentation for MultiplexSummary"
+ "M2tsArib": {
+ "type": "string",
+ "documentation": "M2ts Arib",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
},
- "MultiplexVideoSettings": {
- "type": "structure",
- "members": {
- "ConstantBitrate": {
- "shape": "__integerMin100000Max100000000",
- "locationName": "constantBitrate",
- "documentation": "The constant bitrate configuration for the video encode.\nWhen this field is defined, StatmuxSettings must be undefined."
- },
- "StatmuxSettings": {
- "shape": "MultiplexStatmuxVideoSettings",
- "locationName": "statmuxSettings",
- "documentation": "Statmux rate control settings.\nWhen this field is defined, ConstantBitrate must be undefined."
- }
- },
- "documentation": "The video configuration for each program in a multiplex."
+ "M2tsAribCaptionsPidControl": {
+ "type": "string",
+ "documentation": "M2ts Arib Captions Pid Control",
+ "enum": [
+ "AUTO",
+ "USE_CONFIGURED"
+ ]
},
- "NetworkInputServerValidation": {
+ "M2tsAudioBufferModel": {
"type": "string",
- "documentation": "Network Input Server Validation",
+ "documentation": "M2ts Audio Buffer Model",
"enum": [
- "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME",
- "CHECK_CRYPTOGRAPHY_ONLY"
+ "ATSC",
+ "DVB"
]
},
- "NetworkInputSettings": {
- "type": "structure",
- "members": {
- "HlsInputSettings": {
- "shape": "HlsInputSettings",
- "locationName": "hlsInputSettings",
- "documentation": "Specifies HLS input settings when the uri is for a HLS manifest."
- },
- "ServerValidation": {
- "shape": "NetworkInputServerValidation",
- "locationName": "serverValidation",
- "documentation": "Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https."
- }
- },
- "documentation": "Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection."
+ "M2tsAudioInterval": {
+ "type": "string",
+ "documentation": "M2ts Audio Interval",
+ "enum": [
+ "VIDEO_AND_FIXED_INTERVALS",
+ "VIDEO_INTERVAL"
+ ]
},
- "NielsenCBET": {
- "type": "structure",
- "members": {
- "CbetCheckDigitString": {
- "shape": "__stringMin2Max2",
- "locationName": "cbetCheckDigitString",
- "documentation": "Enter the CBET check digits to use in the watermark."
- },
- "CbetStepaside": {
- "shape": "NielsenWatermarksCbetStepaside",
- "locationName": "cbetStepaside",
- "documentation": "Determines the method of CBET insertion mode when prior encoding is detected on the same layer."
- },
- "Csid": {
- "shape": "__stringMin1Max7",
- "locationName": "csid",
- "documentation": "Enter the CBET Source ID (CSID) to use in the watermark"
- }
- },
- "documentation": "Nielsen CBET",
- "required": [
- "CbetCheckDigitString",
- "CbetStepaside",
- "Csid"
+ "M2tsAudioStreamType": {
+ "type": "string",
+ "documentation": "M2ts Audio Stream Type",
+ "enum": [
+ "ATSC",
+ "DVB"
]
},
- "NielsenConfiguration": {
- "type": "structure",
- "members": {
- "DistributorId": {
- "shape": "__string",
- "locationName": "distributorId",
- "documentation": "Enter the Distributor ID assigned to your organization by Nielsen."
- },
- "NielsenPcmToId3Tagging": {
- "shape": "NielsenPcmToId3TaggingState",
- "locationName": "nielsenPcmToId3Tagging",
- "documentation": "Enables Nielsen PCM to ID3 tagging"
- }
- },
- "documentation": "Nielsen Configuration"
- },
- "NielsenNaesIiNw": {
- "type": "structure",
- "members": {
- "CheckDigitString": {
- "shape": "__stringMin2Max2",
- "locationName": "checkDigitString",
- "documentation": "Enter the check digit string for the watermark"
- },
- "Sid": {
- "shape": "__doubleMin1Max65535",
- "locationName": "sid",
- "documentation": "Enter the Nielsen Source ID (SID) to include in the watermark"
- },
- "Timezone": {
- "shape": "NielsenWatermarkTimezones",
- "locationName": "timezone",
- "documentation": "Choose the timezone for the time stamps in the watermark. If not provided,\nthe timestamps will be in Coordinated Universal Time (UTC)"
- }
- },
- "documentation": "Nielsen Naes Ii Nw",
- "required": [
- "CheckDigitString",
- "Sid"
+ "M2tsBufferModel": {
+ "type": "string",
+ "documentation": "M2ts Buffer Model",
+ "enum": [
+ "MULTIPLEX",
+ "NONE"
]
},
- "NielsenPcmToId3TaggingState": {
+ "M2tsCcDescriptor": {
"type": "string",
- "documentation": "State of Nielsen PCM to ID3 tagging",
+ "documentation": "M2ts Cc Descriptor",
"enum": [
"DISABLED",
"ENABLED"
]
},
- "NielsenWatermarkTimezones": {
+ "M2tsEbifControl": {
"type": "string",
- "documentation": "Nielsen Watermark Timezones",
+ "documentation": "M2ts Ebif Control",
"enum": [
- "AMERICA_PUERTO_RICO",
- "US_ALASKA",
- "US_ARIZONA",
- "US_CENTRAL",
- "US_EASTERN",
- "US_HAWAII",
- "US_MOUNTAIN",
- "US_PACIFIC",
- "US_SAMOA",
- "UTC"
+ "NONE",
+ "PASSTHROUGH"
]
},
- "NielsenWatermarksCbetStepaside": {
+ "M2tsEbpPlacement": {
"type": "string",
- "documentation": "Nielsen Watermarks Cbet Stepaside",
+ "documentation": "M2ts Ebp Placement",
"enum": [
- "DISABLED",
- "ENABLED"
+ "VIDEO_AND_AUDIO_PIDS",
+ "VIDEO_PID"
]
},
- "NielsenWatermarksDistributionTypes": {
+ "M2tsEsRateInPes": {
"type": "string",
- "documentation": "Nielsen Watermarks Distribution Types",
+ "documentation": "M2ts Es Rate In Pes",
"enum": [
- "FINAL_DISTRIBUTOR",
- "PROGRAM_CONTENT"
+ "EXCLUDE",
+ "INCLUDE"
]
},
- "NielsenWatermarksSettings": {
- "type": "structure",
- "members": {
- "NielsenCbetSettings": {
- "shape": "NielsenCBET",
- "locationName": "nielsenCbetSettings",
- "documentation": "Complete these fields only if you want to insert watermarks of type Nielsen CBET"
- },
- "NielsenDistributionType": {
- "shape": "NielsenWatermarksDistributionTypes",
- "locationName": "nielsenDistributionType",
- "documentation": "Choose the distribution types that you want to assign to the watermarks:\n- PROGRAM_CONTENT\n- FINAL_DISTRIBUTOR"
- },
- "NielsenNaesIiNwSettings": {
- "shape": "NielsenNaesIiNw",
- "locationName": "nielsenNaesIiNwSettings",
- "documentation": "Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW)."
- }
- },
- "documentation": "Nielsen Watermarks Settings"
+ "M2tsKlv": {
+ "type": "string",
+ "documentation": "M2ts Klv",
+ "enum": [
+ "NONE",
+ "PASSTHROUGH"
+ ]
},
- "NotFoundException": {
- "type": "structure",
- "members": {
- "Message": {
- "shape": "__string",
- "locationName": "message"
- }
- },
- "exception": true,
- "error": {
- "httpStatusCode": 404
- },
- "documentation": "Placeholder documentation for NotFoundException"
+ "M2tsNielsenId3Behavior": {
+ "type": "string",
+ "documentation": "M2ts Nielsen Id3 Behavior",
+ "enum": [
+ "NO_PASSTHROUGH",
+ "PASSTHROUGH"
+ ]
},
- "Offering": {
- "type": "structure",
- "members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'"
- },
- "CurrencyCode": {
- "shape": "__string",
- "locationName": "currencyCode",
- "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
- },
- "Duration": {
- "shape": "__integer",
- "locationName": "duration",
- "documentation": "Lease duration, e.g. '12'"
- },
- "DurationUnits": {
- "shape": "OfferingDurationUnits",
- "locationName": "durationUnits",
- "documentation": "Units for duration, e.g. 'MONTHS'"
- },
- "FixedPrice": {
- "shape": "__double",
- "locationName": "fixedPrice",
- "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
- },
- "OfferingDescription": {
- "shape": "__string",
- "locationName": "offeringDescription",
- "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
- },
- "OfferingId": {
- "shape": "__string",
- "locationName": "offeringId",
- "documentation": "Unique offering ID, e.g. '87654321'"
- },
- "OfferingType": {
- "shape": "OfferingType",
- "locationName": "offeringType",
- "documentation": "Offering type, e.g. 'NO_UPFRONT'"
- },
- "Region": {
- "shape": "__string",
- "locationName": "region",
- "documentation": "AWS region, e.g. 'us-west-2'"
- },
- "ResourceSpecification": {
- "shape": "ReservationResourceSpecification",
- "locationName": "resourceSpecification",
- "documentation": "Resource configuration details"
- },
- "UsagePrice": {
- "shape": "__double",
- "locationName": "usagePrice",
- "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
- }
- },
- "documentation": "Reserved resources available for purchase"
+ "M2tsPcrControl": {
+ "type": "string",
+ "documentation": "M2ts Pcr Control",
+ "enum": [
+ "CONFIGURED_PCR_PERIOD",
+ "PCR_EVERY_PES_PACKET"
+ ]
},
- "OfferingDurationUnits": {
+ "M2tsRateMode": {
"type": "string",
- "documentation": "Units for duration, e.g. 'MONTHS'",
+ "documentation": "M2ts Rate Mode",
"enum": [
- "MONTHS"
+ "CBR",
+ "VBR"
]
},
- "OfferingType": {
+ "M2tsScte35Control": {
"type": "string",
- "documentation": "Offering type, e.g. 'NO_UPFRONT'",
+ "documentation": "M2ts Scte35 Control",
"enum": [
- "NO_UPFRONT"
+ "NONE",
+ "PASSTHROUGH"
]
},
- "Output": {
+ "M2tsSegmentationMarkers": {
+ "type": "string",
+ "documentation": "M2ts Segmentation Markers",
+ "enum": [
+ "EBP",
+ "EBP_LEGACY",
+ "NONE",
+ "PSI_SEGSTART",
+ "RAI_ADAPT",
+ "RAI_SEGSTART"
+ ]
+ },
+ "M2tsSegmentationStyle": {
+ "type": "string",
+ "documentation": "M2ts Segmentation Style",
+ "enum": [
+ "MAINTAIN_CADENCE",
+ "RESET_CADENCE"
+ ]
+ },
+ "M2tsSettings": {
"type": "structure",
"members": {
- "AudioDescriptionNames": {
- "shape": "__listOf__string",
- "locationName": "audioDescriptionNames",
- "documentation": "The names of the AudioDescriptions used as audio sources for this output."
- },
- "CaptionDescriptionNames": {
- "shape": "__listOf__string",
- "locationName": "captionDescriptionNames",
- "documentation": "The names of the CaptionDescriptions used as caption sources for this output."
- },
- "OutputName": {
- "shape": "__stringMin1Max255",
- "locationName": "outputName",
- "documentation": "The name used to identify an output."
+ "AbsentInputAudioBehavior": {
+ "shape": "M2tsAbsentInputAudioBehavior",
+ "locationName": "absentInputAudioBehavior",
+ "documentation": "When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream."
},
- "OutputSettings": {
- "shape": "OutputSettings",
- "locationName": "outputSettings",
- "documentation": "Output type-specific settings."
+ "Arib": {
+ "shape": "M2tsArib",
+ "locationName": "arib",
+ "documentation": "When set to enabled, uses ARIB-compliant field muxing and removes video descriptor."
},
- "VideoDescriptionName": {
- "shape": "__string",
- "locationName": "videoDescriptionName",
- "documentation": "The name of the VideoDescription used as the source for this output."
- }
- },
- "documentation": "Output settings. There can be multiple outputs within a group.",
- "required": [
- "OutputSettings"
- ]
- },
- "OutputDestination": {
- "type": "structure",
- "members": {
- "Id": {
+ "AribCaptionsPid": {
"shape": "__string",
- "locationName": "id",
- "documentation": "User-specified id. This is used in an output group or an output."
- },
- "MediaPackageSettings": {
- "shape": "__listOfMediaPackageOutputDestinationSettings",
- "locationName": "mediaPackageSettings",
- "documentation": "Destination settings for a MediaPackage output; one destination for both encoders."
- },
- "MultiplexSettings": {
- "shape": "MultiplexProgramChannelDestinationSettings",
- "locationName": "multiplexSettings",
- "documentation": "Destination settings for a Multiplex output; one destination for both encoders."
+ "locationName": "aribCaptionsPid",
+ "documentation": "Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
},
- "Settings": {
- "shape": "__listOfOutputDestinationSettings",
- "locationName": "settings",
- "documentation": "Destination settings for a standard output; one destination for each redundant encoder."
- }
- },
- "documentation": "Placeholder documentation for OutputDestination"
- },
- "OutputDestinationSettings": {
- "type": "structure",
- "members": {
- "PasswordParam": {
- "shape": "__string",
- "locationName": "passwordParam",
- "documentation": "key used to extract the password from EC2 Parameter store"
+ "AribCaptionsPidControl": {
+ "shape": "M2tsAribCaptionsPidControl",
+ "locationName": "aribCaptionsPidControl",
+ "documentation": "If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number."
},
- "StreamName": {
- "shape": "__string",
- "locationName": "streamName",
- "documentation": "Stream name for RTMP destinations (URLs of type rtmp://)"
+ "AudioBufferModel": {
+ "shape": "M2tsAudioBufferModel",
+ "locationName": "audioBufferModel",
+ "documentation": "When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used."
},
- "Url": {
- "shape": "__string",
- "locationName": "url",
- "documentation": "A URL specifying a destination"
+ "AudioFramesPerPes": {
+ "shape": "__integerMin0",
+ "locationName": "audioFramesPerPes",
+ "documentation": "The number of audio frames to insert for each PES packet."
},
- "Username": {
+ "AudioPids": {
"shape": "__string",
- "locationName": "username",
- "documentation": "username for destination"
- }
- },
- "documentation": "Placeholder documentation for OutputDestinationSettings"
- },
- "OutputGroup": {
- "type": "structure",
- "members": {
- "Name": {
- "shape": "__stringMax32",
- "locationName": "name",
- "documentation": "Custom output group name optionally defined by the user."
- },
- "OutputGroupSettings": {
- "shape": "OutputGroupSettings",
- "locationName": "outputGroupSettings",
- "documentation": "Settings associated with the output group."
+ "locationName": "audioPids",
+ "documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)."
},
- "Outputs": {
- "shape": "__listOfOutput",
- "locationName": "outputs"
- }
- },
- "documentation": "Output groups for this Live Event. Output groups contain information about where streams should be distributed.",
- "required": [
- "Outputs",
- "OutputGroupSettings"
- ]
- },
- "OutputGroupSettings": {
- "type": "structure",
- "members": {
- "ArchiveGroupSettings": {
- "shape": "ArchiveGroupSettings",
- "locationName": "archiveGroupSettings"
+ "AudioStreamType": {
+ "shape": "M2tsAudioStreamType",
+ "locationName": "audioStreamType",
+ "documentation": "When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06."
},
- "FrameCaptureGroupSettings": {
- "shape": "FrameCaptureGroupSettings",
- "locationName": "frameCaptureGroupSettings"
+ "Bitrate": {
+ "shape": "__integerMin0",
+ "locationName": "bitrate",
+ "documentation": "The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate."
},
- "HlsGroupSettings": {
- "shape": "HlsGroupSettings",
- "locationName": "hlsGroupSettings"
+ "BufferModel": {
+ "shape": "M2tsBufferModel",
+ "locationName": "bufferModel",
+ "documentation": "Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices."
},
- "MediaPackageGroupSettings": {
- "shape": "MediaPackageGroupSettings",
- "locationName": "mediaPackageGroupSettings"
+ "CcDescriptor": {
+ "shape": "M2tsCcDescriptor",
+ "locationName": "ccDescriptor",
+ "documentation": "When set to enabled, generates captionServiceDescriptor in PMT."
},
- "MsSmoothGroupSettings": {
- "shape": "MsSmoothGroupSettings",
- "locationName": "msSmoothGroupSettings"
+ "DvbNitSettings": {
+ "shape": "DvbNitSettings",
+ "locationName": "dvbNitSettings",
+ "documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval."
},
- "MultiplexGroupSettings": {
- "shape": "MultiplexGroupSettings",
- "locationName": "multiplexGroupSettings"
+ "DvbSdtSettings": {
+ "shape": "DvbSdtSettings",
+ "locationName": "dvbSdtSettings",
+ "documentation": "Inserts DVB Service Description Table (SDT) at the specified table repetition interval."
},
- "RtmpGroupSettings": {
- "shape": "RtmpGroupSettings",
- "locationName": "rtmpGroupSettings"
+ "DvbSubPids": {
+ "shape": "__string",
+ "locationName": "dvbSubPids",
+ "documentation": "Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)."
},
- "UdpGroupSettings": {
- "shape": "UdpGroupSettings",
- "locationName": "udpGroupSettings"
+ "DvbTdtSettings": {
+ "shape": "DvbTdtSettings",
+ "locationName": "dvbTdtSettings",
+ "documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval."
},
- "CmafIngestGroupSettings": {
- "shape": "CmafIngestGroupSettings",
- "locationName": "cmafIngestGroupSettings"
- }
- },
- "documentation": "Output Group Settings"
- },
- "OutputLocationRef": {
- "type": "structure",
- "members": {
- "DestinationRefId": {
+ "DvbTeletextPid": {
"shape": "__string",
- "locationName": "destinationRefId"
- }
- },
- "documentation": "Reference to an OutputDestination ID defined in the channel"
- },
- "OutputLockingSettings": {
- "type": "structure",
- "members": {
- "EpochLockingSettings": {
- "shape": "EpochLockingSettings",
- "locationName": "epochLockingSettings"
+ "locationName": "dvbTeletextPid",
+ "documentation": "Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
},
- "PipelineLockingSettings": {
- "shape": "PipelineLockingSettings",
- "locationName": "pipelineLockingSettings"
- }
- },
- "documentation": "Output Locking Settings"
- },
- "OutputSettings": {
- "type": "structure",
- "members": {
- "ArchiveOutputSettings": {
- "shape": "ArchiveOutputSettings",
- "locationName": "archiveOutputSettings"
+ "Ebif": {
+ "shape": "M2tsEbifControl",
+ "locationName": "ebif",
+ "documentation": "If set to passthrough, passes any EBIF data from the input source to this output."
},
- "FrameCaptureOutputSettings": {
- "shape": "FrameCaptureOutputSettings",
- "locationName": "frameCaptureOutputSettings"
+ "EbpAudioInterval": {
+ "shape": "M2tsAudioInterval",
+ "locationName": "ebpAudioInterval",
+ "documentation": "When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval."
},
- "HlsOutputSettings": {
- "shape": "HlsOutputSettings",
- "locationName": "hlsOutputSettings"
+ "EbpLookaheadMs": {
+ "shape": "__integerMin0Max10000",
+ "locationName": "ebpLookaheadMs",
+ "documentation": "When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate."
},
- "MediaPackageOutputSettings": {
- "shape": "MediaPackageOutputSettings",
- "locationName": "mediaPackageOutputSettings"
+ "EbpPlacement": {
+ "shape": "M2tsEbpPlacement",
+ "locationName": "ebpPlacement",
+ "documentation": "Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID."
},
- "MsSmoothOutputSettings": {
- "shape": "MsSmoothOutputSettings",
- "locationName": "msSmoothOutputSettings"
+ "EcmPid": {
+ "shape": "__string",
+ "locationName": "ecmPid",
+ "documentation": "This field is unused and deprecated."
},
- "MultiplexOutputSettings": {
- "shape": "MultiplexOutputSettings",
- "locationName": "multiplexOutputSettings"
+ "EsRateInPes": {
+ "shape": "M2tsEsRateInPes",
+ "locationName": "esRateInPes",
+ "documentation": "Include or exclude the ES Rate field in the PES header."
},
- "RtmpOutputSettings": {
- "shape": "RtmpOutputSettings",
- "locationName": "rtmpOutputSettings"
+ "EtvPlatformPid": {
+ "shape": "__string",
+ "locationName": "etvPlatformPid",
+ "documentation": "Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
},
- "UdpOutputSettings": {
- "shape": "UdpOutputSettings",
- "locationName": "udpOutputSettings"
+ "EtvSignalPid": {
+ "shape": "__string",
+ "locationName": "etvSignalPid",
+ "documentation": "Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
},
- "CmafIngestOutputSettings": {
- "shape": "CmafIngestOutputSettings",
- "locationName": "cmafIngestOutputSettings"
- }
- },
- "documentation": "Output Settings"
- },
- "PassThroughSettings": {
- "type": "structure",
- "members": {
- },
- "documentation": "Pass Through Settings"
- },
- "PauseStateScheduleActionSettings": {
- "type": "structure",
- "members": {
- "Pipelines": {
- "shape": "__listOfPipelinePauseStateSettings",
- "locationName": "pipelines"
- }
- },
- "documentation": "Settings for the action to set pause state of a channel."
- },
- "PipelineDetail": {
- "type": "structure",
- "members": {
- "ActiveInputAttachmentName": {
+ "FragmentTime": {
+ "shape": "__doubleMin0",
+ "locationName": "fragmentTime",
+ "documentation": "The length in seconds of each fragment. Only used with EBP markers."
+ },
+ "Klv": {
+ "shape": "M2tsKlv",
+ "locationName": "klv",
+ "documentation": "If set to passthrough, passes any KLV data from the input source to this output."
+ },
+ "KlvDataPids": {
"shape": "__string",
- "locationName": "activeInputAttachmentName",
- "documentation": "The name of the active input attachment currently being ingested by this pipeline."
+ "locationName": "klvDataPids",
+ "documentation": "Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)."
},
- "ActiveInputSwitchActionName": {
+ "NielsenId3Behavior": {
+ "shape": "M2tsNielsenId3Behavior",
+ "locationName": "nielsenId3Behavior",
+ "documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output."
+ },
+ "NullPacketBitrate": {
+ "shape": "__doubleMin0",
+ "locationName": "nullPacketBitrate",
+ "documentation": "Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets."
+ },
+ "PatInterval": {
+ "shape": "__integerMin0Max1000",
+ "locationName": "patInterval",
+ "documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000."
+ },
+ "PcrControl": {
+ "shape": "M2tsPcrControl",
+ "locationName": "pcrControl",
+ "documentation": "When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream."
+ },
+ "PcrPeriod": {
+ "shape": "__integerMin0Max500",
+ "locationName": "pcrPeriod",
+ "documentation": "Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream."
+ },
+ "PcrPid": {
"shape": "__string",
- "locationName": "activeInputSwitchActionName",
- "documentation": "The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline."
+ "locationName": "pcrPid",
+ "documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
},
- "ActiveMotionGraphicsActionName": {
+ "PmtInterval": {
+ "shape": "__integerMin0Max1000",
+ "locationName": "pmtInterval",
+ "documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000."
+ },
+ "PmtPid": {
"shape": "__string",
- "locationName": "activeMotionGraphicsActionName",
- "documentation": "The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline."
+ "locationName": "pmtPid",
+ "documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
},
- "ActiveMotionGraphicsUri": {
+ "ProgramNum": {
+ "shape": "__integerMin0Max65535",
+ "locationName": "programNum",
+ "documentation": "The value of the program number field in the Program Map Table."
+ },
+ "RateMode": {
+ "shape": "M2tsRateMode",
+ "locationName": "rateMode",
+ "documentation": "When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set."
+ },
+ "Scte27Pids": {
"shape": "__string",
- "locationName": "activeMotionGraphicsUri",
- "documentation": "The current URI being used for HTML5 motion graphics for this pipeline."
+ "locationName": "scte27Pids",
+ "documentation": "Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)."
},
- "PipelineId": {
+ "Scte35Control": {
+ "shape": "M2tsScte35Control",
+ "locationName": "scte35Control",
+ "documentation": "Optionally pass SCTE-35 signals from the input source to this output."
+ },
+ "Scte35Pid": {
"shape": "__string",
- "locationName": "pipelineId",
- "documentation": "Pipeline ID"
+ "locationName": "scte35Pid",
+ "documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
+ },
+ "SegmentationMarkers": {
+ "shape": "M2tsSegmentationMarkers",
+ "locationName": "segmentationMarkers",
+ "documentation": "Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format."
+ },
+ "SegmentationStyle": {
+ "shape": "M2tsSegmentationStyle",
+ "locationName": "segmentationStyle",
+ "documentation": "The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted.\n\nWhen a segmentation style of \"resetCadence\" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds.\n\nWhen a segmentation style of \"maintainCadence\" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule."
+ },
+ "SegmentationTime": {
+ "shape": "__doubleMin1",
+ "locationName": "segmentationTime",
+ "documentation": "The length in seconds of each segment. Required unless markers is set to _none_."
+ },
+ "TimedMetadataBehavior": {
+ "shape": "M2tsTimedMetadataBehavior",
+ "locationName": "timedMetadataBehavior",
+ "documentation": "When set to passthrough, timed metadata will be passed through from input to output."
+ },
+ "TimedMetadataPid": {
+ "shape": "__string",
+ "locationName": "timedMetadataPid",
+ "documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
+ },
+ "TransportStreamId": {
+ "shape": "__integerMin0Max65535",
+ "locationName": "transportStreamId",
+ "documentation": "The value of the transport stream ID field in the Program Map Table."
+ },
+ "VideoPid": {
+ "shape": "__string",
+ "locationName": "videoPid",
+ "documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
+ },
+ "Scte35PrerollPullupMilliseconds": {
+ "shape": "__doubleMin0Max5000",
+ "locationName": "scte35PrerollPullupMilliseconds",
+ "documentation": "Defines the amount SCTE-35 preroll will be increased (in milliseconds) on the output. Preroll is the amount of time between the presence of a SCTE-35 indication in a transport stream and the PTS of the video frame it references. Zero means don't add pullup (it doesn't mean set the preroll to zero). Negative pullup is not supported, which means that you can't make the preroll shorter. Be aware that latency in the output will increase by the pullup amount."
}
},
- "documentation": "Runtime details of a pipeline when a channel is running."
+ "documentation": "M2ts Settings"
},
- "PipelineId": {
+ "M2tsTimedMetadataBehavior": {
"type": "string",
- "documentation": "Pipeline ID",
+ "documentation": "M2ts Timed Metadata Behavior",
"enum": [
- "PIPELINE_0",
- "PIPELINE_1"
+ "NO_PASSTHROUGH",
+ "PASSTHROUGH"
]
},
- "PipelineLockingSettings": {
- "type": "structure",
- "members": {
- },
- "documentation": "Pipeline Locking Settings"
+ "M3u8KlvBehavior": {
+ "type": "string",
+ "documentation": "M3u8 Klv Behavior",
+ "enum": [
+ "NO_PASSTHROUGH",
+ "PASSTHROUGH"
+ ]
},
- "PipelinePauseStateSettings": {
- "type": "structure",
- "members": {
- "PipelineId": {
- "shape": "PipelineId",
- "locationName": "pipelineId",
- "documentation": "Pipeline ID to pause (\"PIPELINE_0\" or \"PIPELINE_1\")."
- }
- },
- "documentation": "Settings for pausing a pipeline.",
- "required": [
- "PipelineId"
+ "M3u8NielsenId3Behavior": {
+ "type": "string",
+ "documentation": "M3u8 Nielsen Id3 Behavior",
+ "enum": [
+ "NO_PASSTHROUGH",
+ "PASSTHROUGH"
]
},
- "PreferredChannelPipeline": {
+ "M3u8PcrControl": {
"type": "string",
- "documentation": "Indicates which pipeline is preferred by the multiplex for program ingest.\nIf set to \\\"PIPELINE_0\\\" or \\\"PIPELINE_1\\\" and an unhealthy ingest causes the multiplex to switch to the non-preferred pipeline,\nit will switch back once that ingest is healthy again. If set to \\\"CURRENTLY_ACTIVE\\\",\nit will not switch back to the other pipeline based on it recovering to a healthy state,\nit will only switch if the active pipeline becomes unhealthy.",
+ "documentation": "M3u8 Pcr Control",
"enum": [
- "CURRENTLY_ACTIVE",
- "PIPELINE_0",
- "PIPELINE_1"
+ "CONFIGURED_PCR_PERIOD",
+ "PCR_EVERY_PES_PACKET"
]
},
- "PurchaseOffering": {
+ "M3u8Scte35Behavior": {
+ "type": "string",
+ "documentation": "M3u8 Scte35 Behavior",
+ "enum": [
+ "NO_PASSTHROUGH",
+ "PASSTHROUGH"
+ ]
+ },
+ "M3u8Settings": {
"type": "structure",
"members": {
- "Count": {
- "shape": "__integerMin1",
- "locationName": "count",
- "documentation": "Number of resources"
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name for the new reservation"
- },
- "RenewalSettings": {
- "shape": "RenewalSettings",
- "locationName": "renewalSettings",
- "documentation": "Renewal settings for the reservation"
+ "AudioFramesPerPes": {
+ "shape": "__integerMin0",
+ "locationName": "audioFramesPerPes",
+ "documentation": "The number of audio frames to insert for each PES packet."
},
- "RequestId": {
+ "AudioPids": {
"shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.",
- "idempotencyToken": true
+ "locationName": "audioPids",
+ "documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values."
},
- "Start": {
+ "EcmPid": {
"shape": "__string",
- "locationName": "start",
- "documentation": "Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now."
+ "locationName": "ecmPid",
+ "documentation": "This parameter is unused and deprecated."
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs"
- }
- },
- "documentation": "PurchaseOffering request",
- "required": [
- "Count"
- ]
- },
- "PurchaseOfferingRequest": {
- "type": "structure",
- "members": {
- "Count": {
- "shape": "__integerMin1",
- "locationName": "count",
- "documentation": "Number of resources"
+ "NielsenId3Behavior": {
+ "shape": "M3u8NielsenId3Behavior",
+ "locationName": "nielsenId3Behavior",
+ "documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output."
},
- "Name": {
+ "PatInterval": {
+ "shape": "__integerMin0Max1000",
+ "locationName": "patInterval",
+ "documentation": "The number of milliseconds between instances of this table in the output transport stream. A value of \\\"0\\\" writes out the PMT once per segment file."
+ },
+ "PcrControl": {
+ "shape": "M3u8PcrControl",
+ "locationName": "pcrControl",
+ "documentation": "When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream."
+ },
+ "PcrPeriod": {
+ "shape": "__integerMin0Max500",
+ "locationName": "pcrPeriod",
+ "documentation": "Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream."
+ },
+ "PcrPid": {
"shape": "__string",
- "locationName": "name",
- "documentation": "Name for the new reservation"
+ "locationName": "pcrPid",
+ "documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value."
},
- "OfferingId": {
+ "PmtInterval": {
+ "shape": "__integerMin0Max1000",
+ "locationName": "pmtInterval",
+ "documentation": "The number of milliseconds between instances of this table in the output transport stream. A value of \\\"0\\\" writes out the PMT once per segment file."
+ },
+ "PmtPid": {
"shape": "__string",
- "location": "uri",
- "locationName": "offeringId",
- "documentation": "Offering to purchase, e.g. '87654321'"
+ "locationName": "pmtPid",
+ "documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value."
},
- "RenewalSettings": {
- "shape": "RenewalSettings",
- "locationName": "renewalSettings",
- "documentation": "Renewal settings for the reservation"
+ "ProgramNum": {
+ "shape": "__integerMin0Max65535",
+ "locationName": "programNum",
+ "documentation": "The value of the program number field in the Program Map Table."
},
- "RequestId": {
+ "Scte35Behavior": {
+ "shape": "M3u8Scte35Behavior",
+ "locationName": "scte35Behavior",
+ "documentation": "If set to passthrough, passes any SCTE-35 signals from the input source to this output."
+ },
+ "Scte35Pid": {
"shape": "__string",
- "locationName": "requestId",
- "documentation": "Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.",
- "idempotencyToken": true
+ "locationName": "scte35Pid",
+ "documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value."
},
- "Start": {
+ "TimedMetadataBehavior": {
+ "shape": "M3u8TimedMetadataBehavior",
+ "locationName": "timedMetadataBehavior",
+ "documentation": "When set to passthrough, timed metadata is passed through from input to output."
+ },
+ "TimedMetadataPid": {
"shape": "__string",
- "locationName": "start",
- "documentation": "Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now."
+ "locationName": "timedMetadataPid",
+ "documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)."
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs"
- }
- },
- "required": [
- "OfferingId",
- "Count"
- ],
- "documentation": "Placeholder documentation for PurchaseOfferingRequest"
- },
- "PurchaseOfferingResponse": {
- "type": "structure",
- "members": {
- "Reservation": {
- "shape": "Reservation",
- "locationName": "reservation"
- }
- },
- "documentation": "Placeholder documentation for PurchaseOfferingResponse"
- },
- "PurchaseOfferingResultModel": {
- "type": "structure",
- "members": {
- "Reservation": {
- "shape": "Reservation",
- "locationName": "reservation"
+ "TransportStreamId": {
+ "shape": "__integerMin0Max65535",
+ "locationName": "transportStreamId",
+ "documentation": "The value of the transport stream ID field in the Program Map Table."
+ },
+ "VideoPid": {
+ "shape": "__string",
+ "locationName": "videoPid",
+ "documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value."
+ },
+ "KlvBehavior": {
+ "shape": "M3u8KlvBehavior",
+ "locationName": "klvBehavior",
+ "documentation": "If set to passthrough, passes any KLV data from the input source to this output."
+ },
+ "KlvDataPids": {
+ "shape": "__string",
+ "locationName": "klvDataPids",
+ "documentation": "Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)."
}
},
- "documentation": "PurchaseOffering response"
+ "documentation": "Settings information for the .m3u8 container"
},
- "RawSettings": {
- "type": "structure",
- "members": {
- },
- "documentation": "Raw Settings"
+ "M3u8TimedMetadataBehavior": {
+ "type": "string",
+ "documentation": "M3u8 Timed Metadata Behavior",
+ "enum": [
+ "NO_PASSTHROUGH",
+ "PASSTHROUGH"
+ ]
},
- "RebootInputDevice": {
+ "MaintenanceCreateSettings": {
"type": "structure",
"members": {
- "Force": {
- "shape": "RebootInputDeviceForce",
- "locationName": "force",
- "documentation": "Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes."
+ "MaintenanceDay": {
+ "shape": "MaintenanceDay",
+ "locationName": "maintenanceDay",
+ "documentation": "Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows."
+ },
+ "MaintenanceStartTime": {
+ "shape": "__stringPattern010920300",
+ "locationName": "maintenanceStartTime",
+ "documentation": "Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows."
}
},
- "documentation": "Placeholder documentation for RebootInputDevice"
+ "documentation": "Placeholder documentation for MaintenanceCreateSettings"
},
- "RebootInputDeviceForce": {
+ "MaintenanceDay": {
"type": "string",
- "documentation": "Whether or not to force reboot the input device.",
+ "documentation": "The currently selected maintenance day.",
"enum": [
- "NO",
- "YES"
+ "MONDAY",
+ "TUESDAY",
+ "WEDNESDAY",
+ "THURSDAY",
+ "FRIDAY",
+ "SATURDAY",
+ "SUNDAY"
]
},
- "RebootInputDeviceRequest": {
+ "MaintenanceStatus": {
"type": "structure",
"members": {
- "Force": {
- "shape": "RebootInputDeviceForce",
- "locationName": "force",
- "documentation": "Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes."
+ "MaintenanceDay": {
+ "shape": "MaintenanceDay",
+ "locationName": "maintenanceDay",
+ "documentation": "The currently selected maintenance day."
},
- "InputDeviceId": {
+ "MaintenanceDeadline": {
"shape": "__string",
- "location": "uri",
- "locationName": "inputDeviceId",
- "documentation": "The unique ID of the input device to reboot. For example, hd-123456789abcdef."
+ "locationName": "maintenanceDeadline",
+ "documentation": "Maintenance is required by the displayed date and time. Date and time is in ISO."
+ },
+ "MaintenanceScheduledDate": {
+ "shape": "__string",
+ "locationName": "maintenanceScheduledDate",
+ "documentation": "The currently scheduled maintenance date and time. Date and time is in ISO."
+ },
+ "MaintenanceStartTime": {
+ "shape": "__string",
+ "locationName": "maintenanceStartTime",
+ "documentation": "The currently selected maintenance start time. Time is in UTC."
}
},
- "documentation": "A request to reboot an AWS Elemental device.",
- "required": [
- "InputDeviceId"
- ]
+ "documentation": "Placeholder documentation for MaintenanceStatus"
},
- "RebootInputDeviceResponse": {
+ "MaintenanceUpdateSettings": {
"type": "structure",
"members": {
+ "MaintenanceDay": {
+ "shape": "MaintenanceDay",
+ "locationName": "maintenanceDay",
+ "documentation": "Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows."
+ },
+ "MaintenanceScheduledDate": {
+ "shape": "__string",
+ "locationName": "maintenanceScheduledDate",
+ "documentation": "Choose a specific date for maintenance to occur. The chosen date is used for the next maintenance window only."
+ },
+ "MaintenanceStartTime": {
+ "shape": "__stringPattern010920300",
+ "locationName": "maintenanceStartTime",
+ "documentation": "Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows."
+ }
},
- "documentation": "Placeholder documentation for RebootInputDeviceResponse"
+ "documentation": "Placeholder documentation for MaintenanceUpdateSettings"
},
- "Rec601Settings": {
- "type": "structure",
- "members": {
- },
- "documentation": "Rec601 Settings"
+ "MaxResults": {
+ "type": "integer",
+ "min": 1,
+ "max": 1000,
+ "documentation": "Placeholder documentation for MaxResults"
},
- "Rec709Settings": {
+ "MediaConnectFlow": {
"type": "structure",
"members": {
+ "FlowArn": {
+ "shape": "__string",
+ "locationName": "flowArn",
+ "documentation": "The unique ARN of the MediaConnect Flow being used as a source."
+ }
},
- "documentation": "Rec709 Settings"
+ "documentation": "The settings for a MediaConnect Flow."
},
- "RejectInputDeviceTransferRequest": {
+ "MediaConnectFlowRequest": {
"type": "structure",
"members": {
- "InputDeviceId": {
+ "FlowArn": {
"shape": "__string",
- "location": "uri",
- "locationName": "inputDeviceId",
- "documentation": "The unique ID of the input device to reject. For example, hd-123456789abcdef."
+ "locationName": "flowArn",
+ "documentation": "The ARN of the MediaConnect Flow that you want to use as a source."
}
},
- "required": [
- "InputDeviceId"
- ],
- "documentation": "Placeholder documentation for RejectInputDeviceTransferRequest"
+ "documentation": "The settings for a MediaConnect Flow."
},
- "RejectInputDeviceTransferResponse": {
+ "MediaPackageGroupSettings": {
"type": "structure",
"members": {
+ "Destination": {
+ "shape": "OutputLocationRef",
+ "locationName": "destination",
+ "documentation": "MediaPackage channel destination."
+ }
},
- "documentation": "Placeholder documentation for RejectInputDeviceTransferResponse"
+ "documentation": "Media Package Group Settings",
+ "required": [
+ "Destination"
+ ]
},
- "RemixSettings": {
+ "MediaPackageOutputDestinationSettings": {
"type": "structure",
"members": {
- "ChannelMappings": {
- "shape": "__listOfAudioChannelMapping",
- "locationName": "channelMappings",
- "documentation": "Mapping of input channels to output channels, with appropriate gain adjustments."
- },
- "ChannelsIn": {
- "shape": "__integerMin1Max16",
- "locationName": "channelsIn",
- "documentation": "Number of input channels to be used."
- },
- "ChannelsOut": {
- "shape": "__integerMin1Max8",
- "locationName": "channelsOut",
- "documentation": "Number of output channels to be produced.\nValid values: 1, 2, 4, 6, 8"
+ "ChannelId": {
+ "shape": "__stringMin1",
+ "locationName": "channelId",
+ "documentation": "ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region."
}
},
- "documentation": "Remix Settings",
- "required": [
- "ChannelMappings"
- ]
+ "documentation": "MediaPackage Output Destination Settings"
},
- "RenewalSettings": {
+ "MediaPackageOutputSettings": {
"type": "structure",
"members": {
- "AutomaticRenewal": {
- "shape": "ReservationAutomaticRenewal",
- "locationName": "automaticRenewal",
- "documentation": "Automatic renewal status for the reservation"
- },
- "RenewalCount": {
- "shape": "__integerMin1",
- "locationName": "renewalCount",
- "documentation": "Count for the reservation renewal"
- }
},
- "documentation": "The Renewal settings for Reservations"
+ "documentation": "Media Package Output Settings"
},
- "Reservation": {
+ "MotionGraphicsActivateScheduleActionSettings": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'"
- },
- "Count": {
- "shape": "__integer",
- "locationName": "count",
- "documentation": "Number of reserved resources"
- },
- "CurrencyCode": {
- "shape": "__string",
- "locationName": "currencyCode",
- "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
- },
"Duration": {
- "shape": "__integer",
+ "shape": "__longMin0Max86400000",
"locationName": "duration",
- "documentation": "Lease duration, e.g. '12'"
- },
- "DurationUnits": {
- "shape": "OfferingDurationUnits",
- "locationName": "durationUnits",
- "documentation": "Units for duration, e.g. 'MONTHS'"
- },
- "End": {
- "shape": "__string",
- "locationName": "end",
- "documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'"
- },
- "FixedPrice": {
- "shape": "__double",
- "locationName": "fixedPrice",
- "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "User specified reservation name"
- },
- "OfferingDescription": {
- "shape": "__string",
- "locationName": "offeringDescription",
- "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
- },
- "OfferingId": {
- "shape": "__string",
- "locationName": "offeringId",
- "documentation": "Unique offering ID, e.g. '87654321'"
- },
- "OfferingType": {
- "shape": "OfferingType",
- "locationName": "offeringType",
- "documentation": "Offering type, e.g. 'NO_UPFRONT'"
+ "documentation": "Duration (in milliseconds) that motion graphics should render on to the video stream. Leaving out this property or setting to 0 will result in rendering continuing until a deactivate action is processed."
},
- "Region": {
+ "PasswordParam": {
"shape": "__string",
- "locationName": "region",
- "documentation": "AWS region, e.g. 'us-west-2'"
- },
- "RenewalSettings": {
- "shape": "RenewalSettings",
- "locationName": "renewalSettings",
- "documentation": "Renewal settings for the reservation"
+ "locationName": "passwordParam",
+ "documentation": "Key used to extract the password from EC2 Parameter store"
},
- "ReservationId": {
+ "Url": {
"shape": "__string",
- "locationName": "reservationId",
- "documentation": "Unique reservation ID, e.g. '1234567'"
- },
- "ResourceSpecification": {
- "shape": "ReservationResourceSpecification",
- "locationName": "resourceSpecification",
- "documentation": "Resource configuration details"
+ "locationName": "url",
+ "documentation": "URI of the HTML5 content to be rendered into the live stream."
},
- "Start": {
+ "Username": {
"shape": "__string",
- "locationName": "start",
- "documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'"
- },
- "State": {
- "shape": "ReservationState",
- "locationName": "state",
- "documentation": "Current state of reservation, e.g. 'ACTIVE'"
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs"
+ "locationName": "username",
+ "documentation": "Documentation update needed"
+ }
+ },
+ "documentation": "Settings to specify the rendering of motion graphics into the video stream."
+ },
+ "MotionGraphicsConfiguration": {
+ "type": "structure",
+ "members": {
+ "MotionGraphicsInsertion": {
+ "shape": "MotionGraphicsInsertion",
+ "locationName": "motionGraphicsInsertion"
},
- "UsagePrice": {
- "shape": "__double",
- "locationName": "usagePrice",
- "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
+ "MotionGraphicsSettings": {
+ "shape": "MotionGraphicsSettings",
+ "locationName": "motionGraphicsSettings",
+ "documentation": "Motion Graphics Settings"
}
},
- "documentation": "Reserved resources available to use"
+ "documentation": "Motion Graphics Configuration",
+ "required": [
+ "MotionGraphicsSettings"
+ ]
},
- "ReservationAutomaticRenewal": {
+ "MotionGraphicsDeactivateScheduleActionSettings": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Settings to specify the ending of rendering motion graphics into the video stream."
+ },
+ "MotionGraphicsInsertion": {
"type": "string",
- "documentation": "Automatic Renewal Status for Reservation",
+ "documentation": "Motion Graphics Insertion",
"enum": [
"DISABLED",
- "ENABLED",
- "UNAVAILABLE"
+ "ENABLED"
]
},
- "ReservationCodec": {
+ "MotionGraphicsSettings": {
+ "type": "structure",
+ "members": {
+ "HtmlMotionGraphicsSettings": {
+ "shape": "HtmlMotionGraphicsSettings",
+ "locationName": "htmlMotionGraphicsSettings"
+ }
+ },
+ "documentation": "Motion Graphics Settings"
+ },
+ "Mp2CodingMode": {
"type": "string",
- "documentation": "Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO'",
+ "documentation": "Mp2 Coding Mode",
"enum": [
- "MPEG2",
- "AVC",
- "HEVC",
- "AUDIO",
- "LINK"
+ "CODING_MODE_1_0",
+ "CODING_MODE_2_0"
]
},
- "ReservationMaximumBitrate": {
+ "Mp2Settings": {
+ "type": "structure",
+ "members": {
+ "Bitrate": {
+ "shape": "__double",
+ "locationName": "bitrate",
+ "documentation": "Average bitrate in bits/second."
+ },
+ "CodingMode": {
+ "shape": "Mp2CodingMode",
+ "locationName": "codingMode",
+ "documentation": "The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo)."
+ },
+ "SampleRate": {
+ "shape": "__double",
+ "locationName": "sampleRate",
+ "documentation": "Sample rate in Hz."
+ }
+ },
+ "documentation": "Mp2 Settings"
+ },
+ "Mpeg2AdaptiveQuantization": {
"type": "string",
- "documentation": "Maximum bitrate in megabits per second",
+ "documentation": "Mpeg2 Adaptive Quantization",
"enum": [
- "MAX_10_MBPS",
- "MAX_20_MBPS",
- "MAX_50_MBPS"
+ "AUTO",
+ "HIGH",
+ "LOW",
+ "MEDIUM",
+ "OFF"
]
},
- "ReservationMaximumFramerate": {
+ "Mpeg2ColorMetadata": {
"type": "string",
- "documentation": "Maximum framerate in frames per second (Outputs only)",
+ "documentation": "Mpeg2 Color Metadata",
"enum": [
- "MAX_30_FPS",
- "MAX_60_FPS"
+ "IGNORE",
+ "INSERT"
]
},
- "ReservationResolution": {
+ "Mpeg2ColorSpace": {
"type": "string",
- "documentation": "Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, FHD is 1080 lines, UHD is greater than 1080 lines",
+ "documentation": "Mpeg2 Color Space",
"enum": [
- "SD",
- "HD",
- "FHD",
- "UHD"
+ "AUTO",
+ "PASSTHROUGH"
]
},
- "ReservationResourceSpecification": {
- "type": "structure",
- "members": {
- "ChannelClass": {
- "shape": "ChannelClass",
- "locationName": "channelClass",
- "documentation": "Channel class, e.g. 'STANDARD'"
- },
- "Codec": {
- "shape": "ReservationCodec",
- "locationName": "codec",
- "documentation": "Codec, e.g. 'AVC'"
- },
- "MaximumBitrate": {
- "shape": "ReservationMaximumBitrate",
- "locationName": "maximumBitrate",
- "documentation": "Maximum bitrate, e.g. 'MAX_20_MBPS'"
- },
- "MaximumFramerate": {
- "shape": "ReservationMaximumFramerate",
- "locationName": "maximumFramerate",
- "documentation": "Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)"
- },
- "Resolution": {
- "shape": "ReservationResolution",
- "locationName": "resolution",
- "documentation": "Resolution, e.g. 'HD'"
- },
- "ResourceType": {
- "shape": "ReservationResourceType",
- "locationName": "resourceType",
- "documentation": "Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'"
- },
- "SpecialFeature": {
- "shape": "ReservationSpecialFeature",
- "locationName": "specialFeature",
- "documentation": "Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)"
- },
- "VideoQuality": {
- "shape": "ReservationVideoQuality",
- "locationName": "videoQuality",
- "documentation": "Video quality, e.g. 'STANDARD' (Outputs only)"
- }
- },
- "documentation": "Resource configuration (codec, resolution, bitrate, ...)"
- },
- "ReservationResourceType": {
- "type": "string",
- "documentation": "Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'",
- "enum": [
- "INPUT",
- "OUTPUT",
- "MULTIPLEX",
- "CHANNEL"
- ]
- },
- "ReservationSpecialFeature": {
- "type": "string",
- "documentation": "Special features, 'ADVANCED_AUDIO' 'AUDIO_NORMALIZATION' 'MGHD' or 'MGUHD'",
- "enum": [
- "ADVANCED_AUDIO",
- "AUDIO_NORMALIZATION",
- "MGHD",
- "MGUHD"
- ]
- },
- "ReservationState": {
- "type": "string",
- "documentation": "Current reservation state",
- "enum": [
- "ACTIVE",
- "EXPIRED",
- "CANCELED",
- "DELETED"
- ]
- },
- "ReservationVideoQuality": {
+ "Mpeg2DisplayRatio": {
"type": "string",
- "documentation": "Video quality, e.g. 'STANDARD' (Outputs only)",
+ "documentation": "Mpeg2 Display Ratio",
"enum": [
- "STANDARD",
- "ENHANCED",
- "PREMIUM"
+ "DISPLAYRATIO16X9",
+ "DISPLAYRATIO4X3"
]
},
- "ResourceConflict": {
- "type": "structure",
- "members": {
- "Message": {
- "shape": "__string",
- "locationName": "message"
- }
- },
- "documentation": "Placeholder documentation for ResourceConflict"
- },
- "ResourceNotFound": {
+ "Mpeg2FilterSettings": {
"type": "structure",
"members": {
- "Message": {
- "shape": "__string",
- "locationName": "message"
+ "TemporalFilterSettings": {
+ "shape": "TemporalFilterSettings",
+ "locationName": "temporalFilterSettings"
}
},
- "documentation": "Placeholder documentation for ResourceNotFound"
- },
- "RtmpAdMarkers": {
- "type": "string",
- "documentation": "Rtmp Ad Markers",
- "enum": [
- "ON_CUE_POINT_SCTE35"
- ]
+ "documentation": "Mpeg2 Filter Settings"
},
- "RtmpCacheFullBehavior": {
+ "Mpeg2GopSizeUnits": {
"type": "string",
- "documentation": "Rtmp Cache Full Behavior",
+ "documentation": "Mpeg2 Gop Size Units",
"enum": [
- "DISCONNECT_IMMEDIATELY",
- "WAIT_FOR_SERVER"
+ "FRAMES",
+ "SECONDS"
]
},
- "RtmpCaptionData": {
+ "Mpeg2ScanType": {
"type": "string",
- "documentation": "Rtmp Caption Data",
+ "documentation": "Mpeg2 Scan Type",
"enum": [
- "ALL",
- "FIELD1_608",
- "FIELD1_AND_FIELD2_608"
+ "INTERLACED",
+ "PROGRESSIVE"
]
},
- "RtmpCaptionInfoDestinationSettings": {
- "type": "structure",
- "members": {
- },
- "documentation": "Rtmp Caption Info Destination Settings"
- },
- "RtmpGroupSettings": {
+ "Mpeg2Settings": {
"type": "structure",
"members": {
- "AdMarkers": {
- "shape": "__listOfRtmpAdMarkers",
- "locationName": "adMarkers",
- "documentation": "Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream."
+ "AdaptiveQuantization": {
+ "shape": "Mpeg2AdaptiveQuantization",
+ "locationName": "adaptiveQuantization",
+ "documentation": "Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality."
},
- "AuthenticationScheme": {
- "shape": "AuthenticationScheme",
- "locationName": "authenticationScheme",
- "documentation": "Authentication scheme to use when connecting with CDN"
+ "AfdSignaling": {
+ "shape": "AfdSignaling",
+ "locationName": "afdSignaling",
+ "documentation": "Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO.\nAUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid).\nFIXED: MediaLive will use the value you specify in fixedAFD."
},
- "CacheFullBehavior": {
- "shape": "RtmpCacheFullBehavior",
- "locationName": "cacheFullBehavior",
- "documentation": "Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again."
+ "ColorMetadata": {
+ "shape": "Mpeg2ColorMetadata",
+ "locationName": "colorMetadata",
+ "documentation": "Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata."
},
- "CacheLength": {
- "shape": "__integerMin30",
- "locationName": "cacheLength",
- "documentation": "Cache length, in seconds, is used to calculate buffer size."
+ "ColorSpace": {
+ "shape": "Mpeg2ColorSpace",
+ "locationName": "colorSpace",
+ "documentation": "Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \\\"MediaLive Features - Video - color space\\\" in the MediaLive User Guide.\nPASSTHROUGH: Keep the color space of the input content - do not convert it.\nAUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709."
},
- "CaptionData": {
- "shape": "RtmpCaptionData",
- "locationName": "captionData",
- "documentation": "Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed."
+ "DisplayAspectRatio": {
+ "shape": "Mpeg2DisplayRatio",
+ "locationName": "displayAspectRatio",
+ "documentation": "Sets the pixel aspect ratio for the encode."
},
- "InputLossAction": {
- "shape": "InputLossActionForRtmpOut",
- "locationName": "inputLossAction",
- "documentation": "Controls the behavior of this RTMP group if input becomes unavailable.\n\n- emitOutput: Emit a slate until input returns.\n- pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection."
+ "FilterSettings": {
+ "shape": "Mpeg2FilterSettings",
+ "locationName": "filterSettings",
+ "documentation": "Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied.\nTEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean.\nWhen the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise.\nWhen the content is reasonably clean, the filter tends to decrease the bitrate."
},
- "RestartDelay": {
+ "FixedAfd": {
+ "shape": "FixedAfd",
+ "locationName": "fixedAfd",
+ "documentation": "Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode."
+ },
+ "FramerateDenominator": {
+ "shape": "__integerMin1",
+ "locationName": "framerateDenominator",
+ "documentation": "description\": \"The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS."
+ },
+ "FramerateNumerator": {
+ "shape": "__integerMin1",
+ "locationName": "framerateNumerator",
+ "documentation": "The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS."
+ },
+ "GopClosedCadence": {
"shape": "__integerMin0",
- "locationName": "restartDelay",
- "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart."
+ "locationName": "gopClosedCadence",
+ "documentation": "MPEG2: default is open GOP."
},
- "IncludeFillerNalUnits": {
- "shape": "IncludeFillerNalUnits",
- "locationName": "includeFillerNalUnits",
- "documentation": "Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto."
+ "GopNumBFrames": {
+ "shape": "__integerMin0Max7",
+ "locationName": "gopNumBFrames",
+ "documentation": "Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default."
+ },
+ "GopSize": {
+ "shape": "__double",
+ "locationName": "gopSize",
+ "documentation": "Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default.\nIf gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer."
+ },
+ "GopSizeUnits": {
+ "shape": "Mpeg2GopSizeUnits",
+ "locationName": "gopSizeUnits",
+ "documentation": "Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count."
+ },
+ "ScanType": {
+ "shape": "Mpeg2ScanType",
+ "locationName": "scanType",
+ "documentation": "Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first)."
+ },
+ "SubgopLength": {
+ "shape": "Mpeg2SubGopLength",
+ "locationName": "subgopLength",
+ "documentation": "Relates to the GOP structure. If you do not know what GOP is, use the default.\nFIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames.\nDYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality."
+ },
+ "TimecodeInsertion": {
+ "shape": "Mpeg2TimecodeInsertionBehavior",
+ "locationName": "timecodeInsertion",
+ "documentation": "Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \\\"MediaLive Features - Timecode configuration\\\" in the MediaLive User Guide.\nDISABLED: do not include timecodes.\nGOP_TIMECODE: Include timecode metadata in the GOP header."
+ },
+ "TimecodeBurninSettings": {
+ "shape": "TimecodeBurninSettings",
+ "locationName": "timecodeBurninSettings",
+ "documentation": "Timecode burn-in settings"
}
},
- "documentation": "Rtmp Group Settings"
+ "documentation": "Mpeg2 Settings",
+ "required": [
+ "FramerateNumerator",
+ "FramerateDenominator"
+ ]
},
- "RtmpOutputCertificateMode": {
+ "Mpeg2SubGopLength": {
"type": "string",
- "documentation": "Rtmp Output Certificate Mode",
+ "documentation": "Mpeg2 Sub Gop Length",
"enum": [
- "SELF_SIGNED",
- "VERIFY_AUTHENTICITY"
+ "DYNAMIC",
+ "FIXED"
]
},
- "RtmpOutputSettings": {
+ "Mpeg2TimecodeInsertionBehavior": {
+ "type": "string",
+ "documentation": "Mpeg2 Timecode Insertion Behavior",
+ "enum": [
+ "DISABLED",
+ "GOP_TIMECODE"
+ ]
+ },
+ "MsSmoothGroupSettings": {
"type": "structure",
"members": {
+ "AcquisitionPointId": {
+ "shape": "__string",
+ "locationName": "acquisitionPointId",
+ "documentation": "The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE."
+ },
+ "AudioOnlyTimecodeControl": {
+ "shape": "SmoothGroupAudioOnlyTimecodeControl",
+ "locationName": "audioOnlyTimecodeControl",
+ "documentation": "If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream."
+ },
"CertificateMode": {
- "shape": "RtmpOutputCertificateMode",
+ "shape": "SmoothGroupCertificateMode",
"locationName": "certificateMode",
- "documentation": "If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail."
+ "documentation": "If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail."
},
"ConnectionRetryInterval": {
- "shape": "__integerMin1",
+ "shape": "__integerMin0",
"locationName": "connectionRetryInterval",
- "documentation": "Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost."
+ "documentation": "Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established."
},
"Destination": {
"shape": "OutputLocationRef",
"locationName": "destination",
- "documentation": "The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers."
+ "documentation": "Smooth Streaming publish point on an IIS server. Elemental Live acts as a \"Push\" encoder to IIS."
+ },
+ "EventId": {
+ "shape": "__string",
+ "locationName": "eventId",
+ "documentation": "MS Smooth event ID to be sent to the IIS server.\n\nShould only be specified if eventIdMode is set to useConfigured."
+ },
+ "EventIdMode": {
+ "shape": "SmoothGroupEventIdMode",
+ "locationName": "eventIdMode",
+ "documentation": "Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run.\n\nOptions:\n- \"useConfigured\" - use the value provided in eventId\n- \"useTimestamp\" - generate and send an event ID based on the current timestamp\n- \"noEventId\" - do not send an event ID to the IIS server."
+ },
+ "EventStopBehavior": {
+ "shape": "SmoothGroupEventStopBehavior",
+ "locationName": "eventStopBehavior",
+ "documentation": "When set to sendEos, send EOS signal to IIS server when stopping the event"
+ },
+ "FilecacheDuration": {
+ "shape": "__integerMin0",
+ "locationName": "filecacheDuration",
+ "documentation": "Size in seconds of file cache for streaming outputs."
+ },
+ "FragmentLength": {
+ "shape": "__integerMin1",
+ "locationName": "fragmentLength",
+ "documentation": "Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate."
+ },
+ "InputLossAction": {
+ "shape": "InputLossActionForMsSmoothOut",
+ "locationName": "inputLossAction",
+ "documentation": "Parameter that control output group behavior on input loss."
},
"NumRetries": {
"shape": "__integerMin0",
"locationName": "numRetries",
"documentation": "Number of retry attempts."
+ },
+ "RestartDelay": {
+ "shape": "__integerMin0",
+ "locationName": "restartDelay",
+ "documentation": "Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration."
+ },
+ "SegmentationMode": {
+ "shape": "SmoothGroupSegmentationMode",
+ "locationName": "segmentationMode",
+ "documentation": "useInputSegmentation has been deprecated. The configured segment size is always used."
+ },
+ "SendDelayMs": {
+ "shape": "__integerMin0Max10000",
+ "locationName": "sendDelayMs",
+ "documentation": "Number of milliseconds to delay the output from the second pipeline."
+ },
+ "SparseTrackType": {
+ "shape": "SmoothGroupSparseTrackType",
+ "locationName": "sparseTrackType",
+ "documentation": "Identifies the type of data to place in the sparse track:\n- SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment.\n- SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment.\n- NONE: Don't generate a sparse track for any outputs in this output group."
+ },
+ "StreamManifestBehavior": {
+ "shape": "SmoothGroupStreamManifestBehavior",
+ "locationName": "streamManifestBehavior",
+ "documentation": "When set to send, send stream manifest so publishing point doesn't start until all streams start."
+ },
+ "TimestampOffset": {
+ "shape": "__string",
+ "locationName": "timestampOffset",
+ "documentation": "Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset."
+ },
+ "TimestampOffsetMode": {
+ "shape": "SmoothGroupTimestampOffsetMode",
+ "locationName": "timestampOffsetMode",
+ "documentation": "Type of timestamp date offset to use.\n- useEventStartDate: Use the date the event was started as the offset\n- useConfiguredOffset: Use an explicitly configured date as the offset"
}
},
- "documentation": "Rtmp Output Settings",
+ "documentation": "Ms Smooth Group Settings",
"required": [
"Destination"
]
},
- "S3CannedAcl": {
+ "MsSmoothH265PackagingType": {
"type": "string",
- "documentation": "S3 Canned Acl",
+ "documentation": "Ms Smooth H265 Packaging Type",
"enum": [
- "AUTHENTICATED_READ",
- "BUCKET_OWNER_FULL_CONTROL",
- "BUCKET_OWNER_READ",
- "PUBLIC_READ"
+ "HEV1",
+ "HVC1"
]
},
- "ScheduleAction": {
+ "MsSmoothOutputSettings": {
"type": "structure",
"members": {
- "ActionName": {
- "shape": "__string",
- "locationName": "actionName",
- "documentation": "The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused."
- },
- "ScheduleActionSettings": {
- "shape": "ScheduleActionSettings",
- "locationName": "scheduleActionSettings",
- "documentation": "Settings for this schedule action."
+ "H265PackagingType": {
+ "shape": "MsSmoothH265PackagingType",
+ "locationName": "h265PackagingType",
+ "documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1."
},
- "ScheduleActionStartSettings": {
- "shape": "ScheduleActionStartSettings",
- "locationName": "scheduleActionStartSettings",
- "documentation": "The time for the action to start in the channel."
+ "NameModifier": {
+ "shape": "__string",
+ "locationName": "nameModifier",
+ "documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type."
}
},
- "documentation": "Contains information on a single schedule action.",
- "required": [
- "ActionName",
- "ScheduleActionStartSettings",
- "ScheduleActionSettings"
- ]
+ "documentation": "Ms Smooth Output Settings"
},
- "ScheduleActionSettings": {
+ "Multiplex": {
"type": "structure",
"members": {
- "HlsId3SegmentTaggingSettings": {
- "shape": "HlsId3SegmentTaggingScheduleActionSettings",
- "locationName": "hlsId3SegmentTaggingSettings",
- "documentation": "Action to insert HLS ID3 segment tagging"
- },
- "HlsTimedMetadataSettings": {
- "shape": "HlsTimedMetadataScheduleActionSettings",
- "locationName": "hlsTimedMetadataSettings",
- "documentation": "Action to insert HLS metadata"
- },
- "InputPrepareSettings": {
- "shape": "InputPrepareScheduleActionSettings",
- "locationName": "inputPrepareSettings",
- "documentation": "Action to prepare an input for a future immediate input switch"
- },
- "InputSwitchSettings": {
- "shape": "InputSwitchScheduleActionSettings",
- "locationName": "inputSwitchSettings",
- "documentation": "Action to switch the input"
- },
- "MotionGraphicsImageActivateSettings": {
- "shape": "MotionGraphicsActivateScheduleActionSettings",
- "locationName": "motionGraphicsImageActivateSettings",
- "documentation": "Action to activate a motion graphics image overlay"
- },
- "MotionGraphicsImageDeactivateSettings": {
- "shape": "MotionGraphicsDeactivateScheduleActionSettings",
- "locationName": "motionGraphicsImageDeactivateSettings",
- "documentation": "Action to deactivate a motion graphics image overlay"
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The unique arn of the multiplex."
},
- "PauseStateSettings": {
- "shape": "PauseStateScheduleActionSettings",
- "locationName": "pauseStateSettings",
- "documentation": "Action to pause or unpause one or both channel pipelines"
+ "AvailabilityZones": {
+ "shape": "__listOf__string",
+ "locationName": "availabilityZones",
+ "documentation": "A list of availability zones for the multiplex."
},
- "Scte35InputSettings": {
- "shape": "Scte35InputScheduleActionSettings",
- "locationName": "scte35InputSettings",
- "documentation": "Action to specify scte35 input"
+ "Destinations": {
+ "shape": "__listOfMultiplexOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of the multiplex output destinations."
},
- "Scte35ReturnToNetworkSettings": {
- "shape": "Scte35ReturnToNetworkScheduleActionSettings",
- "locationName": "scte35ReturnToNetworkSettings",
- "documentation": "Action to insert SCTE-35 return_to_network message"
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique id of the multiplex."
},
- "Scte35SpliceInsertSettings": {
- "shape": "Scte35SpliceInsertScheduleActionSettings",
- "locationName": "scte35SpliceInsertSettings",
- "documentation": "Action to insert SCTE-35 splice_insert message"
+ "MultiplexSettings": {
+ "shape": "MultiplexSettings",
+ "locationName": "multiplexSettings",
+ "documentation": "Configuration for a multiplex event."
},
- "Scte35TimeSignalSettings": {
- "shape": "Scte35TimeSignalScheduleActionSettings",
- "locationName": "scte35TimeSignalSettings",
- "documentation": "Action to insert SCTE-35 time_signal message"
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the multiplex."
},
- "StaticImageActivateSettings": {
- "shape": "StaticImageActivateScheduleActionSettings",
- "locationName": "staticImageActivateSettings",
- "documentation": "Action to activate a static image overlay"
+ "PipelinesRunningCount": {
+ "shape": "__integer",
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
},
- "StaticImageDeactivateSettings": {
- "shape": "StaticImageDeactivateScheduleActionSettings",
- "locationName": "staticImageDeactivateSettings",
- "documentation": "Action to deactivate a static image overlay"
+ "ProgramCount": {
+ "shape": "__integer",
+ "locationName": "programCount",
+ "documentation": "The number of programs in the multiplex."
},
- "StaticImageOutputActivateSettings": {
- "shape": "StaticImageOutputActivateScheduleActionSettings",
- "locationName": "staticImageOutputActivateSettings",
- "documentation": "Action to activate a static image overlay in one or more specified outputs"
+ "State": {
+ "shape": "MultiplexState",
+ "locationName": "state",
+ "documentation": "The current state of the multiplex."
},
- "StaticImageOutputDeactivateSettings": {
- "shape": "StaticImageOutputDeactivateScheduleActionSettings",
- "locationName": "staticImageOutputDeactivateSettings",
- "documentation": "Action to deactivate a static image overlay in one or more specified outputs"
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
}
},
- "documentation": "Holds the settings for a single schedule action."
+ "documentation": "The multiplex object."
},
- "ScheduleActionStartSettings": {
+ "MultiplexConfigurationValidationError": {
"type": "structure",
"members": {
- "FixedModeScheduleActionStartSettings": {
- "shape": "FixedModeScheduleActionStartSettings",
- "locationName": "fixedModeScheduleActionStartSettings",
- "documentation": "Option for specifying the start time for an action."
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "The error message."
},
- "FollowModeScheduleActionStartSettings": {
- "shape": "FollowModeScheduleActionStartSettings",
- "locationName": "followModeScheduleActionStartSettings",
- "documentation": "Option for specifying an action as relative to another action."
- },
- "ImmediateModeScheduleActionStartSettings": {
- "shape": "ImmediateModeScheduleActionStartSettings",
- "locationName": "immediateModeScheduleActionStartSettings",
- "documentation": "Option for specifying an action that should be applied immediately."
+ "ValidationErrors": {
+ "shape": "__listOfValidationError",
+ "locationName": "validationErrors",
+ "documentation": "A collection of validation error responses."
}
},
- "documentation": "Settings to specify when an action should occur. Only one of the options must be selected."
+ "documentation": "Placeholder documentation for MultiplexConfigurationValidationError"
},
- "ScheduleDeleteResultModel": {
+ "MultiplexGroupSettings": {
"type": "structure",
"members": {
},
- "documentation": "Result of a schedule deletion."
+ "documentation": "Multiplex Group Settings"
},
- "ScheduleDescribeResultModel": {
+ "MultiplexMediaConnectOutputDestinationSettings": {
"type": "structure",
"members": {
- "NextToken": {
- "shape": "__string",
- "locationName": "nextToken",
- "documentation": "The next token; for use in pagination."
- },
- "ScheduleActions": {
- "shape": "__listOfScheduleAction",
- "locationName": "scheduleActions",
- "documentation": "The list of actions in the schedule."
+ "EntitlementArn": {
+ "shape": "__stringMin1",
+ "locationName": "entitlementArn",
+ "documentation": "The MediaConnect entitlement ARN available as a Flow source."
}
},
- "documentation": "Results of a schedule describe.",
- "required": [
- "ScheduleActions"
- ]
- },
- "Scte20Convert608To708": {
- "type": "string",
- "documentation": "Scte20 Convert608 To708",
- "enum": [
- "DISABLED",
- "UPCONVERT"
- ]
+ "documentation": "Multiplex MediaConnect output destination settings."
},
- "Scte20PlusEmbeddedDestinationSettings": {
+ "MultiplexOutputDestination": {
"type": "structure",
"members": {
+ "MediaConnectSettings": {
+ "shape": "MultiplexMediaConnectOutputDestinationSettings",
+ "locationName": "mediaConnectSettings",
+ "documentation": "Multiplex MediaConnect output destination settings."
+ }
},
- "documentation": "Scte20 Plus Embedded Destination Settings"
+ "documentation": "Multiplex output destination settings"
},
- "Scte20SourceSettings": {
+ "MultiplexOutputSettings": {
"type": "structure",
"members": {
- "Convert608To708": {
- "shape": "Scte20Convert608To708",
- "locationName": "convert608To708",
- "documentation": "If upconvert, 608 data is both passed through via the \"608 compatibility bytes\" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded."
- },
- "Source608ChannelNumber": {
- "shape": "__integerMin1Max4",
- "locationName": "source608ChannelNumber",
- "documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough."
+ "Destination": {
+ "shape": "OutputLocationRef",
+ "locationName": "destination",
+ "documentation": "Destination is a Multiplex."
}
},
- "documentation": "Scte20 Source Settings"
+ "documentation": "Multiplex Output Settings",
+ "required": [
+ "Destination"
+ ]
},
- "Scte27DestinationSettings": {
+ "MultiplexProgram": {
"type": "structure",
"members": {
+ "ChannelId": {
+ "shape": "__string",
+ "locationName": "channelId",
+ "documentation": "The MediaLive channel associated with the program."
+ },
+ "MultiplexProgramSettings": {
+ "shape": "MultiplexProgramSettings",
+ "locationName": "multiplexProgramSettings",
+ "documentation": "The settings for this multiplex program."
+ },
+ "PacketIdentifiersMap": {
+ "shape": "MultiplexProgramPacketIdentifiersMap",
+ "locationName": "packetIdentifiersMap",
+ "documentation": "The packet identifier map for this multiplex program."
+ },
+ "PipelineDetails": {
+ "shape": "__listOfMultiplexProgramPipelineDetail",
+ "locationName": "pipelineDetails",
+ "documentation": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time."
+ },
+ "ProgramName": {
+ "shape": "__string",
+ "locationName": "programName",
+ "documentation": "The name of the multiplex program."
+ }
},
- "documentation": "Scte27 Destination Settings"
- },
- "Scte27OcrLanguage": {
- "type": "string",
- "documentation": "Scte27 Ocr Language",
- "enum": [
- "DEU",
- "ENG",
- "FRA",
- "NLD",
- "POR",
- "SPA"
- ]
+ "documentation": "The multiplex program object."
},
- "Scte27SourceSettings": {
+ "MultiplexProgramChannelDestinationSettings": {
"type": "structure",
"members": {
- "OcrLanguage": {
- "shape": "Scte27OcrLanguage",
- "locationName": "ocrLanguage",
- "documentation": "If you will configure a WebVTT caption description that references this caption selector, use this field to\nprovide the language to consider when translating the image-based source to text."
+ "MultiplexId": {
+ "shape": "__stringMin1",
+ "locationName": "multiplexId",
+ "documentation": "The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances.\nThe Multiplex must be in the same region as the Channel."
},
- "Pid": {
- "shape": "__integerMin1",
- "locationName": "pid",
- "documentation": "The pid field is used in conjunction with the caption selector languageCode field as follows:\n - Specify PID and Language: Extracts captions from that PID; the language is \"informational\".\n - Specify PID and omit Language: Extracts the specified PID.\n - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be.\n - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through."
+ "ProgramName": {
+ "shape": "__stringMin1",
+ "locationName": "programName",
+ "documentation": "The program name of the Multiplex program that the encoder is providing output to."
}
},
- "documentation": "Scte27 Source Settings"
- },
- "Scte35AposNoRegionalBlackoutBehavior": {
- "type": "string",
- "documentation": "Scte35 Apos No Regional Blackout Behavior",
- "enum": [
- "FOLLOW",
- "IGNORE"
- ]
- },
- "Scte35AposWebDeliveryAllowedBehavior": {
- "type": "string",
- "documentation": "Scte35 Apos Web Delivery Allowed Behavior",
- "enum": [
- "FOLLOW",
- "IGNORE"
- ]
- },
- "Scte35ArchiveAllowedFlag": {
- "type": "string",
- "documentation": "Corresponds to the archive_allowed parameter. A value of ARCHIVE_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the \"restriction\" flags then you must include all four of them.",
- "enum": [
- "ARCHIVE_NOT_ALLOWED",
- "ARCHIVE_ALLOWED"
- ]
+ "documentation": "Multiplex Program Input Destination Settings for outputting a Channel to a Multiplex"
},
- "Scte35DeliveryRestrictions": {
+ "MultiplexProgramPacketIdentifiersMap": {
"type": "structure",
"members": {
- "ArchiveAllowedFlag": {
- "shape": "Scte35ArchiveAllowedFlag",
- "locationName": "archiveAllowedFlag",
- "documentation": "Corresponds to SCTE-35 archive_allowed_flag."
+ "AudioPids": {
+ "shape": "__listOf__integer",
+ "locationName": "audioPids"
},
- "DeviceRestrictions": {
- "shape": "Scte35DeviceRestrictions",
- "locationName": "deviceRestrictions",
- "documentation": "Corresponds to SCTE-35 device_restrictions parameter."
+ "DvbSubPids": {
+ "shape": "__listOf__integer",
+ "locationName": "dvbSubPids"
},
- "NoRegionalBlackoutFlag": {
- "shape": "Scte35NoRegionalBlackoutFlag",
- "locationName": "noRegionalBlackoutFlag",
- "documentation": "Corresponds to SCTE-35 no_regional_blackout_flag parameter."
+ "DvbTeletextPid": {
+ "shape": "__integer",
+ "locationName": "dvbTeletextPid"
},
- "WebDeliveryAllowedFlag": {
- "shape": "Scte35WebDeliveryAllowedFlag",
- "locationName": "webDeliveryAllowedFlag",
- "documentation": "Corresponds to SCTE-35 web_delivery_allowed_flag parameter."
+ "EtvPlatformPid": {
+ "shape": "__integer",
+ "locationName": "etvPlatformPid"
+ },
+ "EtvSignalPid": {
+ "shape": "__integer",
+ "locationName": "etvSignalPid"
+ },
+ "KlvDataPids": {
+ "shape": "__listOf__integer",
+ "locationName": "klvDataPids"
+ },
+ "PcrPid": {
+ "shape": "__integer",
+ "locationName": "pcrPid"
+ },
+ "PmtPid": {
+ "shape": "__integer",
+ "locationName": "pmtPid"
+ },
+ "PrivateMetadataPid": {
+ "shape": "__integer",
+ "locationName": "privateMetadataPid"
+ },
+ "Scte27Pids": {
+ "shape": "__listOf__integer",
+ "locationName": "scte27Pids"
+ },
+ "Scte35Pid": {
+ "shape": "__integer",
+ "locationName": "scte35Pid"
+ },
+ "TimedMetadataPid": {
+ "shape": "__integer",
+ "locationName": "timedMetadataPid"
+ },
+ "VideoPid": {
+ "shape": "__integer",
+ "locationName": "videoPid"
+ },
+ "AribCaptionsPid": {
+ "shape": "__integer",
+ "locationName": "aribCaptionsPid"
+ },
+ "DvbTeletextPids": {
+ "shape": "__listOf__integer",
+ "locationName": "dvbTeletextPids"
+ },
+ "EcmPid": {
+ "shape": "__integer",
+ "locationName": "ecmPid"
+ },
+ "Smpte2038Pid": {
+ "shape": "__integer",
+ "locationName": "smpte2038Pid"
}
},
- "documentation": "Corresponds to SCTE-35 delivery_not_restricted_flag parameter. To declare delivery restrictions, include this element and its four \"restriction\" flags. To declare that there are no restrictions, omit this element.",
- "required": [
- "DeviceRestrictions",
- "ArchiveAllowedFlag",
- "WebDeliveryAllowedFlag",
- "NoRegionalBlackoutFlag"
- ]
+ "documentation": "Packet identifiers map for a given Multiplex program."
},
- "Scte35Descriptor": {
+ "MultiplexProgramPipelineDetail": {
"type": "structure",
"members": {
- "Scte35DescriptorSettings": {
- "shape": "Scte35DescriptorSettings",
- "locationName": "scte35DescriptorSettings",
- "documentation": "SCTE-35 Descriptor Settings."
+ "ActiveChannelPipeline": {
+ "shape": "__string",
+ "locationName": "activeChannelPipeline",
+ "documentation": "Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex."
+ },
+ "PipelineId": {
+ "shape": "__string",
+ "locationName": "pipelineId",
+ "documentation": "Identifies a specific pipeline in the multiplex."
}
},
- "documentation": "Holds one set of SCTE-35 Descriptor Settings.",
- "required": [
- "Scte35DescriptorSettings"
- ]
+ "documentation": "The current source for one of the pipelines in the multiplex."
},
- "Scte35DescriptorSettings": {
+ "MultiplexProgramServiceDescriptor": {
"type": "structure",
"members": {
- "SegmentationDescriptorScte35DescriptorSettings": {
- "shape": "Scte35SegmentationDescriptor",
- "locationName": "segmentationDescriptorScte35DescriptorSettings",
- "documentation": "SCTE-35 Segmentation Descriptor."
+ "ProviderName": {
+ "shape": "__stringMax256",
+ "locationName": "providerName",
+ "documentation": "Name of the provider."
+ },
+ "ServiceName": {
+ "shape": "__stringMax256",
+ "locationName": "serviceName",
+ "documentation": "Name of the service."
}
},
- "documentation": "SCTE-35 Descriptor settings.",
+ "documentation": "Transport stream service descriptor configuration for the Multiplex program.",
"required": [
- "SegmentationDescriptorScte35DescriptorSettings"
- ]
- },
- "Scte35DeviceRestrictions": {
- "type": "string",
- "documentation": "Corresponds to the device_restrictions parameter in a segmentation_descriptor. If you include one of the \"restriction\" flags then you must include all four of them.",
- "enum": [
- "NONE",
- "RESTRICT_GROUP0",
- "RESTRICT_GROUP1",
- "RESTRICT_GROUP2"
- ]
- },
- "Scte35InputMode": {
- "type": "string",
- "documentation": "Whether the SCTE-35 input should be the active input or a fixed input.",
- "enum": [
- "FIXED",
- "FOLLOW_ACTIVE"
+ "ProviderName",
+ "ServiceName"
]
},
- "Scte35InputScheduleActionSettings": {
+ "MultiplexProgramSettings": {
"type": "structure",
"members": {
- "InputAttachmentNameReference": {
- "shape": "__string",
- "locationName": "inputAttachmentNameReference",
- "documentation": "In fixed mode, enter the name of the input attachment that you want to use as a SCTE-35 input. (Don't enter the ID of the input.)\""
+ "PreferredChannelPipeline": {
+ "shape": "PreferredChannelPipeline",
+ "locationName": "preferredChannelPipeline",
+ "documentation": "Indicates which pipeline is preferred by the multiplex for program ingest."
},
- "Mode": {
- "shape": "Scte35InputMode",
- "locationName": "mode",
- "documentation": "Whether the SCTE-35 input should be the active input or a fixed input."
+ "ProgramNumber": {
+ "shape": "__integerMin0Max65535",
+ "locationName": "programNumber",
+ "documentation": "Unique program number."
+ },
+ "ServiceDescriptor": {
+ "shape": "MultiplexProgramServiceDescriptor",
+ "locationName": "serviceDescriptor",
+ "documentation": "Transport stream service descriptor configuration for the Multiplex program."
+ },
+ "VideoSettings": {
+ "shape": "MultiplexVideoSettings",
+ "locationName": "videoSettings",
+ "documentation": "Program video settings configuration."
}
},
- "documentation": "Scte35Input Schedule Action Settings",
+ "documentation": "Multiplex Program settings configuration.",
"required": [
- "Mode"
- ]
- },
- "Scte35NoRegionalBlackoutFlag": {
- "type": "string",
- "documentation": "Corresponds to the no_regional_blackout_flag parameter. A value of REGIONAL_BLACKOUT corresponds to 0 (false) in the SCTE-35 specification. If you include one of the \"restriction\" flags then you must include all four of them.",
- "enum": [
- "REGIONAL_BLACKOUT",
- "NO_REGIONAL_BLACKOUT"
+ "ProgramNumber"
]
},
- "Scte35ReturnToNetworkScheduleActionSettings": {
+ "MultiplexProgramSummary": {
"type": "structure",
"members": {
- "SpliceEventId": {
- "shape": "__longMin0Max4294967295",
- "locationName": "spliceEventId",
- "documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35."
+ "ChannelId": {
+ "shape": "__string",
+ "locationName": "channelId",
+ "documentation": "The MediaLive Channel associated with the program."
+ },
+ "ProgramName": {
+ "shape": "__string",
+ "locationName": "programName",
+ "documentation": "The name of the multiplex program."
}
},
- "documentation": "Settings for a SCTE-35 return_to_network message.",
- "required": [
- "SpliceEventId"
- ]
- },
- "Scte35SegmentationCancelIndicator": {
- "type": "string",
- "documentation": "Corresponds to SCTE-35 segmentation_event_cancel_indicator. SEGMENTATION_EVENT_NOT_CANCELED corresponds to 0 in the SCTE-35 specification and indicates that this is an insertion request. SEGMENTATION_EVENT_CANCELED corresponds to 1 in the SCTE-35 specification and indicates that this is a cancelation request, in which case complete this field and the existing event ID to cancel.",
- "enum": [
- "SEGMENTATION_EVENT_NOT_CANCELED",
- "SEGMENTATION_EVENT_CANCELED"
- ]
+ "documentation": "Placeholder documentation for MultiplexProgramSummary"
},
- "Scte35SegmentationDescriptor": {
+ "MultiplexSettings": {
"type": "structure",
"members": {
- "DeliveryRestrictions": {
- "shape": "Scte35DeliveryRestrictions",
- "locationName": "deliveryRestrictions",
- "documentation": "Holds the four SCTE-35 delivery restriction parameters."
- },
- "SegmentNum": {
- "shape": "__integerMin0Max255",
- "locationName": "segmentNum",
- "documentation": "Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id."
- },
- "SegmentationCancelIndicator": {
- "shape": "Scte35SegmentationCancelIndicator",
- "locationName": "segmentationCancelIndicator",
- "documentation": "Corresponds to SCTE-35 segmentation_event_cancel_indicator."
- },
- "SegmentationDuration": {
- "shape": "__longMin0Max1099511627775",
- "locationName": "segmentationDuration",
- "documentation": "Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message."
- },
- "SegmentationEventId": {
- "shape": "__longMin0Max4294967295",
- "locationName": "segmentationEventId",
- "documentation": "Corresponds to SCTE-35 segmentation_event_id. "
- },
- "SegmentationTypeId": {
- "shape": "__integerMin0Max255",
- "locationName": "segmentationTypeId",
- "documentation": "Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, \"52\"). In the CLI, API, or an SDK, enter the ID in hex (for example, \"0x34\") or decimal (for example, \"52\")."
- },
- "SegmentationUpid": {
- "shape": "__string",
- "locationName": "segmentationUpid",
- "documentation": "Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII \"ADS Information\" becomes hex \"41445320496e666f726d6174696f6e."
- },
- "SegmentationUpidType": {
- "shape": "__integerMin0Max255",
- "locationName": "segmentationUpidType",
- "documentation": "Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, \"0x0C\" hex from the specification is \"12\" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, \"0x0C\" ) or in decimal (for example, \"12\")."
+ "MaximumVideoBufferDelayMilliseconds": {
+ "shape": "__integerMin800Max3000",
+ "locationName": "maximumVideoBufferDelayMilliseconds",
+ "documentation": "Maximum video buffer delay in milliseconds."
},
- "SegmentsExpected": {
- "shape": "__integerMin0Max255",
- "locationName": "segmentsExpected",
- "documentation": "Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id."
+ "TransportStreamBitrate": {
+ "shape": "__integerMin1000000Max100000000",
+ "locationName": "transportStreamBitrate",
+ "documentation": "Transport stream bit rate."
},
- "SubSegmentNum": {
- "shape": "__integerMin0Max255",
- "locationName": "subSegmentNum",
- "documentation": "Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id."
+ "TransportStreamId": {
+ "shape": "__integerMin0Max65535",
+ "locationName": "transportStreamId",
+ "documentation": "Transport stream ID."
},
- "SubSegmentsExpected": {
- "shape": "__integerMin0Max255",
- "locationName": "subSegmentsExpected",
- "documentation": "Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id."
+ "TransportStreamReservedBitrate": {
+ "shape": "__integerMin0Max100000000",
+ "locationName": "transportStreamReservedBitrate",
+ "documentation": "Transport stream reserved bit rate."
}
},
- "documentation": "Corresponds to SCTE-35 segmentation_descriptor.",
+ "documentation": "Contains configuration for a Multiplex event",
"required": [
- "SegmentationEventId",
- "SegmentationCancelIndicator"
+ "TransportStreamBitrate",
+ "TransportStreamId"
]
},
- "Scte35SpliceInsert": {
+ "MultiplexSettingsSummary": {
"type": "structure",
"members": {
- "AdAvailOffset": {
- "shape": "__integerMinNegative1000Max1000",
- "locationName": "adAvailOffset",
- "documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages."
- },
- "NoRegionalBlackoutFlag": {
- "shape": "Scte35SpliceInsertNoRegionalBlackoutBehavior",
- "locationName": "noRegionalBlackoutFlag",
- "documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates"
- },
- "WebDeliveryAllowedFlag": {
- "shape": "Scte35SpliceInsertWebDeliveryAllowedBehavior",
- "locationName": "webDeliveryAllowedFlag",
- "documentation": "When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates"
+ "TransportStreamBitrate": {
+ "shape": "__integerMin1000000Max100000000",
+ "locationName": "transportStreamBitrate",
+ "documentation": "Transport stream bit rate."
}
},
- "documentation": "Typical configuration that applies breaks on splice inserts in addition to time signal placement opportunities, breaks, and advertisements."
+ "documentation": "Contains summary configuration for a Multiplex event."
},
- "Scte35SpliceInsertNoRegionalBlackoutBehavior": {
+ "MultiplexState": {
"type": "string",
- "documentation": "Scte35 Splice Insert No Regional Blackout Behavior",
+ "documentation": "The current state of the multiplex.",
"enum": [
- "FOLLOW",
- "IGNORE"
+ "CREATING",
+ "CREATE_FAILED",
+ "IDLE",
+ "STARTING",
+ "RUNNING",
+ "RECOVERING",
+ "STOPPING",
+ "DELETING",
+ "DELETED"
]
},
- "Scte35SpliceInsertScheduleActionSettings": {
+ "MultiplexStatmuxVideoSettings": {
"type": "structure",
"members": {
- "Duration": {
- "shape": "__longMin0Max8589934591",
- "locationName": "duration",
- "documentation": "Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time."
+ "MaximumBitrate": {
+ "shape": "__integerMin100000Max100000000",
+ "locationName": "maximumBitrate",
+ "documentation": "Maximum statmux bitrate."
},
- "SpliceEventId": {
- "shape": "__longMin0Max4294967295",
- "locationName": "spliceEventId",
- "documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35."
+ "MinimumBitrate": {
+ "shape": "__integerMin100000Max100000000",
+ "locationName": "minimumBitrate",
+ "documentation": "Minimum statmux bitrate."
+ },
+ "Priority": {
+ "shape": "__integerMinNegative5Max5",
+ "locationName": "priority",
+ "documentation": "The purpose of the priority is to use a combination of the\\nmultiplex rate control algorithm and the QVBR capability of the\\nencoder to prioritize the video quality of some channels in a\\nmultiplex over others. Channels that have a higher priority will\\nget higher video quality at the expense of the video quality of\\nother channels in the multiplex with lower priority."
}
},
- "documentation": "Settings for a SCTE-35 splice_insert message.",
- "required": [
- "SpliceEventId"
- ]
- },
- "Scte35SpliceInsertWebDeliveryAllowedBehavior": {
- "type": "string",
- "documentation": "Scte35 Splice Insert Web Delivery Allowed Behavior",
- "enum": [
- "FOLLOW",
- "IGNORE"
- ]
+ "documentation": "Statmux rate control settings"
},
- "Scte35TimeSignalApos": {
+ "MultiplexSummary": {
"type": "structure",
"members": {
- "AdAvailOffset": {
- "shape": "__integerMinNegative1000Max1000",
- "locationName": "adAvailOffset",
- "documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages."
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The unique arn of the multiplex."
},
- "NoRegionalBlackoutFlag": {
- "shape": "Scte35AposNoRegionalBlackoutBehavior",
- "locationName": "noRegionalBlackoutFlag",
- "documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates"
+ "AvailabilityZones": {
+ "shape": "__listOf__string",
+ "locationName": "availabilityZones",
+ "documentation": "A list of availability zones for the multiplex."
},
- "WebDeliveryAllowedFlag": {
- "shape": "Scte35AposWebDeliveryAllowedBehavior",
- "locationName": "webDeliveryAllowedFlag",
- "documentation": "When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates"
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique id of the multiplex."
+ },
+ "MultiplexSettings": {
+ "shape": "MultiplexSettingsSummary",
+ "locationName": "multiplexSettings",
+ "documentation": "Configuration for a multiplex event."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the multiplex."
+ },
+ "PipelinesRunningCount": {
+ "shape": "__integer",
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
+ },
+ "ProgramCount": {
+ "shape": "__integer",
+ "locationName": "programCount",
+ "documentation": "The number of programs in the multiplex."
+ },
+ "State": {
+ "shape": "MultiplexState",
+ "locationName": "state",
+ "documentation": "The current state of the multiplex."
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
}
},
- "documentation": "Atypical configuration that applies segment breaks only on SCTE-35 time signal placement opportunities and breaks."
+ "documentation": "Placeholder documentation for MultiplexSummary"
},
- "Scte35TimeSignalScheduleActionSettings": {
+ "MultiplexVideoSettings": {
"type": "structure",
"members": {
- "Scte35Descriptors": {
- "shape": "__listOfScte35Descriptor",
- "locationName": "scte35Descriptors",
- "documentation": "The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal."
+ "ConstantBitrate": {
+ "shape": "__integerMin100000Max100000000",
+ "locationName": "constantBitrate",
+ "documentation": "The constant bitrate configuration for the video encode.\nWhen this field is defined, StatmuxSettings must be undefined."
+ },
+ "StatmuxSettings": {
+ "shape": "MultiplexStatmuxVideoSettings",
+ "locationName": "statmuxSettings",
+ "documentation": "Statmux rate control settings.\nWhen this field is defined, ConstantBitrate must be undefined."
}
},
- "documentation": "Settings for a SCTE-35 time_signal.",
- "required": [
- "Scte35Descriptors"
- ]
- },
- "Scte35WebDeliveryAllowedFlag": {
- "type": "string",
- "documentation": "Corresponds to the web_delivery_allowed_flag parameter. A value of WEB_DELIVERY_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the \"restriction\" flags then you must include all four of them.",
- "enum": [
- "WEB_DELIVERY_NOT_ALLOWED",
- "WEB_DELIVERY_ALLOWED"
- ]
+ "documentation": "The video configuration for each program in a multiplex."
},
- "SmoothGroupAudioOnlyTimecodeControl": {
+ "NetworkInputServerValidation": {
"type": "string",
- "documentation": "Smooth Group Audio Only Timecode Control",
+ "documentation": "Network Input Server Validation",
"enum": [
- "PASSTHROUGH",
- "USE_CONFIGURED_CLOCK"
+ "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME",
+ "CHECK_CRYPTOGRAPHY_ONLY"
]
},
- "SmoothGroupCertificateMode": {
- "type": "string",
- "documentation": "Smooth Group Certificate Mode",
- "enum": [
- "SELF_SIGNED",
- "VERIFY_AUTHENTICITY"
- ]
+ "NetworkInputSettings": {
+ "type": "structure",
+ "members": {
+ "HlsInputSettings": {
+ "shape": "HlsInputSettings",
+ "locationName": "hlsInputSettings",
+ "documentation": "Specifies HLS input settings when the uri is for a HLS manifest."
+ },
+ "ServerValidation": {
+ "shape": "NetworkInputServerValidation",
+ "locationName": "serverValidation",
+ "documentation": "Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https."
+ },
+ "MulticastInputSettings": {
+ "shape": "MulticastInputSettings",
+ "locationName": "multicastInputSettings",
+ "documentation": "Specifies multicast input settings when the uri is for a multicast event."
+ }
+ },
+ "documentation": "Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection."
},
- "SmoothGroupEventIdMode": {
- "type": "string",
- "documentation": "Smooth Group Event Id Mode",
- "enum": [
- "NO_EVENT_ID",
- "USE_CONFIGURED",
- "USE_TIMESTAMP"
+ "NielsenCBET": {
+ "type": "structure",
+ "members": {
+ "CbetCheckDigitString": {
+ "shape": "__stringMin2Max2",
+ "locationName": "cbetCheckDigitString",
+ "documentation": "Enter the CBET check digits to use in the watermark."
+ },
+ "CbetStepaside": {
+ "shape": "NielsenWatermarksCbetStepaside",
+ "locationName": "cbetStepaside",
+ "documentation": "Determines the method of CBET insertion mode when prior encoding is detected on the same layer."
+ },
+ "Csid": {
+ "shape": "__stringMin1Max7",
+ "locationName": "csid",
+ "documentation": "Enter the CBET Source ID (CSID) to use in the watermark"
+ }
+ },
+ "documentation": "Nielsen CBET",
+ "required": [
+ "CbetCheckDigitString",
+ "CbetStepaside",
+ "Csid"
]
},
- "SmoothGroupEventStopBehavior": {
- "type": "string",
- "documentation": "Smooth Group Event Stop Behavior",
- "enum": [
- "NONE",
- "SEND_EOS"
- ]
+ "NielsenConfiguration": {
+ "type": "structure",
+ "members": {
+ "DistributorId": {
+ "shape": "__string",
+ "locationName": "distributorId",
+ "documentation": "Enter the Distributor ID assigned to your organization by Nielsen."
+ },
+ "NielsenPcmToId3Tagging": {
+ "shape": "NielsenPcmToId3TaggingState",
+ "locationName": "nielsenPcmToId3Tagging",
+ "documentation": "Enables Nielsen PCM to ID3 tagging"
+ }
+ },
+ "documentation": "Nielsen Configuration"
},
- "SmoothGroupSegmentationMode": {
- "type": "string",
- "documentation": "Smooth Group Segmentation Mode",
- "enum": [
- "USE_INPUT_SEGMENTATION",
- "USE_SEGMENT_DURATION"
+ "NielsenNaesIiNw": {
+ "type": "structure",
+ "members": {
+ "CheckDigitString": {
+ "shape": "__stringMin2Max2",
+ "locationName": "checkDigitString",
+ "documentation": "Enter the check digit string for the watermark"
+ },
+ "Sid": {
+ "shape": "__doubleMin1Max65535",
+ "locationName": "sid",
+ "documentation": "Enter the Nielsen Source ID (SID) to include in the watermark"
+ },
+ "Timezone": {
+ "shape": "NielsenWatermarkTimezones",
+ "locationName": "timezone",
+ "documentation": "Choose the timezone for the time stamps in the watermark. If not provided,\nthe timestamps will be in Coordinated Universal Time (UTC)"
+ }
+ },
+ "documentation": "Nielsen Naes Ii Nw",
+ "required": [
+ "CheckDigitString",
+ "Sid"
]
},
- "SmoothGroupSparseTrackType": {
+ "NielsenPcmToId3TaggingState": {
"type": "string",
- "documentation": "Smooth Group Sparse Track Type",
+ "documentation": "State of Nielsen PCM to ID3 tagging",
"enum": [
- "NONE",
- "SCTE_35",
- "SCTE_35_WITHOUT_SEGMENTATION"
+ "DISABLED",
+ "ENABLED"
]
},
- "SmoothGroupStreamManifestBehavior": {
+ "NielsenWatermarkTimezones": {
"type": "string",
- "documentation": "Smooth Group Stream Manifest Behavior",
+ "documentation": "Nielsen Watermark Timezones",
"enum": [
- "DO_NOT_SEND",
- "SEND"
+ "AMERICA_PUERTO_RICO",
+ "US_ALASKA",
+ "US_ARIZONA",
+ "US_CENTRAL",
+ "US_EASTERN",
+ "US_HAWAII",
+ "US_MOUNTAIN",
+ "US_PACIFIC",
+ "US_SAMOA",
+ "UTC"
]
},
- "SmoothGroupTimestampOffsetMode": {
+ "NielsenWatermarksCbetStepaside": {
"type": "string",
- "documentation": "Smooth Group Timestamp Offset Mode",
+ "documentation": "Nielsen Watermarks Cbet Stepaside",
"enum": [
- "USE_CONFIGURED_OFFSET",
- "USE_EVENT_START_DATE"
+ "DISABLED",
+ "ENABLED"
]
},
- "Smpte2038DataPreference": {
+ "NielsenWatermarksDistributionTypes": {
"type": "string",
- "documentation": "Smpte2038 Data Preference",
+ "documentation": "Nielsen Watermarks Distribution Types",
"enum": [
- "IGNORE",
- "PREFER"
+ "FINAL_DISTRIBUTOR",
+ "PROGRAM_CONTENT"
]
},
- "SmpteTtDestinationSettings": {
+ "NielsenWatermarksSettings": {
"type": "structure",
"members": {
- },
- "documentation": "Smpte Tt Destination Settings"
- },
- "StandardHlsSettings": {
- "type": "structure",
- "members": {
- "AudioRenditionSets": {
- "shape": "__string",
- "locationName": "audioRenditionSets",
- "documentation": "List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','."
+ "NielsenCbetSettings": {
+ "shape": "NielsenCBET",
+ "locationName": "nielsenCbetSettings",
+ "documentation": "Complete these fields only if you want to insert watermarks of type Nielsen CBET"
},
- "M3u8Settings": {
- "shape": "M3u8Settings",
- "locationName": "m3u8Settings"
+ "NielsenDistributionType": {
+ "shape": "NielsenWatermarksDistributionTypes",
+ "locationName": "nielsenDistributionType",
+ "documentation": "Choose the distribution types that you want to assign to the watermarks:\n- PROGRAM_CONTENT\n- FINAL_DISTRIBUTOR"
+ },
+ "NielsenNaesIiNwSettings": {
+ "shape": "NielsenNaesIiNw",
+ "locationName": "nielsenNaesIiNwSettings",
+ "documentation": "Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW)."
}
},
- "documentation": "Standard Hls Settings",
- "required": [
- "M3u8Settings"
- ]
+ "documentation": "Nielsen Watermarks Settings"
},
- "StartChannelRequest": {
+ "NotFoundException": {
"type": "structure",
"members": {
- "ChannelId": {
+ "Message": {
"shape": "__string",
- "location": "uri",
- "locationName": "channelId",
- "documentation": "A request to start a channel"
+ "locationName": "message"
}
},
- "required": [
- "ChannelId"
- ],
- "documentation": "Placeholder documentation for StartChannelRequest"
+ "exception": true,
+ "error": {
+ "httpStatusCode": 404
+ },
+ "documentation": "Placeholder documentation for NotFoundException"
},
- "StartChannelResponse": {
+ "Offering": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
- "documentation": "The unique arn of the channel."
- },
- "CdiInputSpecification": {
- "shape": "CdiInputSpecification",
- "locationName": "cdiInputSpecification",
- "documentation": "Specification of CDI inputs for this channel"
- },
- "ChannelClass": {
- "shape": "ChannelClass",
- "locationName": "channelClass",
- "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
- },
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
- },
- "EgressEndpoints": {
- "shape": "__listOfChannelEgressEndpoint",
- "locationName": "egressEndpoints",
- "documentation": "The endpoints where outgoing connections initiate from"
- },
- "EncoderSettings": {
- "shape": "EncoderSettings",
- "locationName": "encoderSettings"
+ "documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'"
},
- "Id": {
+ "CurrencyCode": {
"shape": "__string",
- "locationName": "id",
- "documentation": "The unique id of the channel."
- },
- "InputAttachments": {
- "shape": "__listOfInputAttachment",
- "locationName": "inputAttachments",
- "documentation": "List of input attachments for channel."
+ "locationName": "currencyCode",
+ "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
},
- "InputSpecification": {
- "shape": "InputSpecification",
- "locationName": "inputSpecification",
- "documentation": "Specification of network and file inputs for this channel"
+ "Duration": {
+ "shape": "__integer",
+ "locationName": "duration",
+ "documentation": "Lease duration, e.g. '12'"
},
- "LogLevel": {
- "shape": "LogLevel",
- "locationName": "logLevel",
- "documentation": "The log level being written to CloudWatch Logs."
+ "DurationUnits": {
+ "shape": "OfferingDurationUnits",
+ "locationName": "durationUnits",
+ "documentation": "Units for duration, e.g. 'MONTHS'"
},
- "Maintenance": {
- "shape": "MaintenanceStatus",
- "locationName": "maintenance",
- "documentation": "Maintenance settings for this channel."
+ "FixedPrice": {
+ "shape": "__double",
+ "locationName": "fixedPrice",
+ "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
},
- "Name": {
+ "OfferingDescription": {
"shape": "__string",
- "locationName": "name",
- "documentation": "The name of the channel. (user-mutable)"
+ "locationName": "offeringDescription",
+ "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
},
- "PipelineDetails": {
- "shape": "__listOfPipelineDetail",
- "locationName": "pipelineDetails",
- "documentation": "Runtime details for the pipelines of a running channel."
+ "OfferingId": {
+ "shape": "__string",
+ "locationName": "offeringId",
+ "documentation": "Unique offering ID, e.g. '87654321'"
},
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
+ "OfferingType": {
+ "shape": "OfferingType",
+ "locationName": "offeringType",
+ "documentation": "Offering type, e.g. 'NO_UPFRONT'"
},
- "RoleArn": {
+ "Region": {
"shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
- },
- "State": {
- "shape": "ChannelState",
- "locationName": "state"
+ "locationName": "region",
+ "documentation": "AWS region, e.g. 'us-west-2'"
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "ResourceSpecification": {
+ "shape": "ReservationResourceSpecification",
+ "locationName": "resourceSpecification",
+ "documentation": "Resource configuration details"
},
- "Vpc": {
- "shape": "VpcOutputSettingsDescription",
- "locationName": "vpc",
- "documentation": "Settings for VPC output"
+ "UsagePrice": {
+ "shape": "__double",
+ "locationName": "usagePrice",
+ "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
}
},
- "documentation": "Placeholder documentation for StartChannelResponse"
+ "documentation": "Reserved resources available for purchase"
},
- "StartInputDeviceMaintenanceWindowRequest": {
- "type": "structure",
- "members": {
- "InputDeviceId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputDeviceId",
- "documentation": "The unique ID of the input device to start a maintenance window for. For example, hd-123456789abcdef."
- }
- },
- "required": [
- "InputDeviceId"
- ],
- "documentation": "Placeholder documentation for StartInputDeviceMaintenanceWindowRequest"
+ "OfferingDurationUnits": {
+ "type": "string",
+ "documentation": "Units for duration, e.g. 'MONTHS'",
+ "enum": [
+ "MONTHS"
+ ]
},
- "StartInputDeviceMaintenanceWindowResponse": {
- "type": "structure",
- "members": {
- },
- "documentation": "Placeholder documentation for StartInputDeviceMaintenanceWindowResponse"
+ "OfferingType": {
+ "type": "string",
+ "documentation": "Offering type, e.g. 'NO_UPFRONT'",
+ "enum": [
+ "NO_UPFRONT"
+ ]
},
- "StartInputDeviceRequest": {
+ "Output": {
"type": "structure",
"members": {
- "InputDeviceId": {
+ "AudioDescriptionNames": {
+ "shape": "__listOf__string",
+ "locationName": "audioDescriptionNames",
+ "documentation": "The names of the AudioDescriptions used as audio sources for this output."
+ },
+ "CaptionDescriptionNames": {
+ "shape": "__listOf__string",
+ "locationName": "captionDescriptionNames",
+ "documentation": "The names of the CaptionDescriptions used as caption sources for this output."
+ },
+ "OutputName": {
+ "shape": "__stringMin1Max255",
+ "locationName": "outputName",
+ "documentation": "The name used to identify an output."
+ },
+ "OutputSettings": {
+ "shape": "OutputSettings",
+ "locationName": "outputSettings",
+ "documentation": "Output type-specific settings."
+ },
+ "VideoDescriptionName": {
"shape": "__string",
- "location": "uri",
- "locationName": "inputDeviceId",
- "documentation": "The unique ID of the input device to start. For example, hd-123456789abcdef."
+ "locationName": "videoDescriptionName",
+ "documentation": "The name of the VideoDescription used as the source for this output."
}
},
+ "documentation": "Output settings. There can be multiple outputs within a group.",
"required": [
- "InputDeviceId"
- ],
- "documentation": "Placeholder documentation for StartInputDeviceRequest"
+ "OutputSettings"
+ ]
},
- "StartInputDeviceResponse": {
+ "OutputDestination": {
"type": "structure",
"members": {
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "User-specified id. This is used in an output group or an output."
+ },
+ "MediaPackageSettings": {
+ "shape": "__listOfMediaPackageOutputDestinationSettings",
+ "locationName": "mediaPackageSettings",
+ "documentation": "Destination settings for a MediaPackage output; one destination for both encoders."
+ },
+ "MultiplexSettings": {
+ "shape": "MultiplexProgramChannelDestinationSettings",
+ "locationName": "multiplexSettings",
+ "documentation": "Destination settings for a Multiplex output; one destination for both encoders."
+ },
+ "Settings": {
+ "shape": "__listOfOutputDestinationSettings",
+ "locationName": "settings",
+ "documentation": "Destination settings for a standard output; one destination for each redundant encoder."
+ },
+ "SrtSettings": {
+ "shape": "__listOfSrtOutputDestinationSettings",
+ "locationName": "srtSettings",
+ "documentation": "SRT settings for an SRT output; one destination for each redundant encoder."
+ }
},
- "documentation": "Placeholder documentation for StartInputDeviceResponse"
+ "documentation": "Placeholder documentation for OutputDestination"
},
- "StartMultiplexRequest": {
+ "OutputDestinationSettings": {
"type": "structure",
"members": {
- "MultiplexId": {
+ "PasswordParam": {
"shape": "__string",
- "location": "uri",
- "locationName": "multiplexId",
- "documentation": "The ID of the multiplex."
+ "locationName": "passwordParam",
+ "documentation": "key used to extract the password from EC2 Parameter store"
+ },
+ "StreamName": {
+ "shape": "__string",
+ "locationName": "streamName",
+ "documentation": "Stream name for RTMP destinations (URLs of type rtmp://)"
+ },
+ "Url": {
+ "shape": "__string",
+ "locationName": "url",
+ "documentation": "A URL specifying a destination"
+ },
+ "Username": {
+ "shape": "__string",
+ "locationName": "username",
+ "documentation": "username for destination"
+ }
+ },
+ "documentation": "Placeholder documentation for OutputDestinationSettings"
+ },
+ "OutputGroup": {
+ "type": "structure",
+ "members": {
+ "Name": {
+ "shape": "__stringMax32",
+ "locationName": "name",
+ "documentation": "Custom output group name optionally defined by the user."
+ },
+ "OutputGroupSettings": {
+ "shape": "OutputGroupSettings",
+ "locationName": "outputGroupSettings",
+ "documentation": "Settings associated with the output group."
+ },
+ "Outputs": {
+ "shape": "__listOfOutput",
+ "locationName": "outputs"
}
},
+ "documentation": "Output groups for this Live Event. Output groups contain information about where streams should be distributed.",
"required": [
- "MultiplexId"
- ],
- "documentation": "Placeholder documentation for StartMultiplexRequest"
+ "Outputs",
+ "OutputGroupSettings"
+ ]
},
- "StartMultiplexResponse": {
+ "OutputGroupSettings": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique arn of the multiplex."
+ "ArchiveGroupSettings": {
+ "shape": "ArchiveGroupSettings",
+ "locationName": "archiveGroupSettings"
},
- "AvailabilityZones": {
- "shape": "__listOf__string",
- "locationName": "availabilityZones",
- "documentation": "A list of availability zones for the multiplex."
+ "FrameCaptureGroupSettings": {
+ "shape": "FrameCaptureGroupSettings",
+ "locationName": "frameCaptureGroupSettings"
},
- "Destinations": {
- "shape": "__listOfMultiplexOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of the multiplex output destinations."
+ "HlsGroupSettings": {
+ "shape": "HlsGroupSettings",
+ "locationName": "hlsGroupSettings"
},
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique id of the multiplex."
+ "MediaPackageGroupSettings": {
+ "shape": "MediaPackageGroupSettings",
+ "locationName": "mediaPackageGroupSettings"
},
- "MultiplexSettings": {
- "shape": "MultiplexSettings",
- "locationName": "multiplexSettings",
- "documentation": "Configuration for a multiplex event."
+ "MsSmoothGroupSettings": {
+ "shape": "MsSmoothGroupSettings",
+ "locationName": "msSmoothGroupSettings"
},
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "The name of the multiplex."
+ "MultiplexGroupSettings": {
+ "shape": "MultiplexGroupSettings",
+ "locationName": "multiplexGroupSettings"
},
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
+ "RtmpGroupSettings": {
+ "shape": "RtmpGroupSettings",
+ "locationName": "rtmpGroupSettings"
},
- "ProgramCount": {
- "shape": "__integer",
- "locationName": "programCount",
- "documentation": "The number of programs in the multiplex."
+ "UdpGroupSettings": {
+ "shape": "UdpGroupSettings",
+ "locationName": "udpGroupSettings"
},
- "State": {
- "shape": "MultiplexState",
- "locationName": "state",
- "documentation": "The current state of the multiplex."
+ "CmafIngestGroupSettings": {
+ "shape": "CmafIngestGroupSettings",
+ "locationName": "cmafIngestGroupSettings"
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "SrtGroupSettings": {
+ "shape": "SrtGroupSettings",
+ "locationName": "srtGroupSettings"
}
},
- "documentation": "Placeholder documentation for StartMultiplexResponse"
+ "documentation": "Output Group Settings"
},
- "StartTimecode": {
+ "OutputLocationRef": {
"type": "structure",
"members": {
- "Timecode": {
+ "DestinationRefId": {
"shape": "__string",
- "locationName": "timecode",
- "documentation": "The timecode for the frame where you want to start the clip. Optional; if not specified, the clip starts at first frame in the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF."
+ "locationName": "destinationRefId"
}
},
- "documentation": "Settings to identify the start of the clip."
+ "documentation": "Reference to an OutputDestination ID defined in the channel"
},
- "StaticImageActivateScheduleActionSettings": {
+ "OutputLockingSettings": {
"type": "structure",
"members": {
- "Duration": {
- "shape": "__integerMin0",
- "locationName": "duration",
- "documentation": "The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated."
+ "EpochLockingSettings": {
+ "shape": "EpochLockingSettings",
+ "locationName": "epochLockingSettings"
},
- "FadeIn": {
- "shape": "__integerMin0",
- "locationName": "fadeIn",
- "documentation": "The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in)."
+ "PipelineLockingSettings": {
+ "shape": "PipelineLockingSettings",
+ "locationName": "pipelineLockingSettings"
+ }
+ },
+ "documentation": "Output Locking Settings"
+ },
+ "OutputSettings": {
+ "type": "structure",
+ "members": {
+ "ArchiveOutputSettings": {
+ "shape": "ArchiveOutputSettings",
+ "locationName": "archiveOutputSettings"
},
- "FadeOut": {
- "shape": "__integerMin0",
- "locationName": "fadeOut",
- "documentation": "Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out)."
+ "FrameCaptureOutputSettings": {
+ "shape": "FrameCaptureOutputSettings",
+ "locationName": "frameCaptureOutputSettings"
},
- "Height": {
- "shape": "__integerMin1",
- "locationName": "height",
- "documentation": "The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay."
+ "HlsOutputSettings": {
+ "shape": "HlsOutputSettings",
+ "locationName": "hlsOutputSettings"
},
- "Image": {
- "shape": "InputLocation",
- "locationName": "image",
- "documentation": "The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video."
+ "MediaPackageOutputSettings": {
+ "shape": "MediaPackageOutputSettings",
+ "locationName": "mediaPackageOutputSettings"
},
- "ImageX": {
- "shape": "__integerMin0",
- "locationName": "imageX",
- "documentation": "Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right."
+ "MsSmoothOutputSettings": {
+ "shape": "MsSmoothOutputSettings",
+ "locationName": "msSmoothOutputSettings"
},
- "ImageY": {
- "shape": "__integerMin0",
- "locationName": "imageY",
- "documentation": "Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom."
+ "MultiplexOutputSettings": {
+ "shape": "MultiplexOutputSettings",
+ "locationName": "multiplexOutputSettings"
},
- "Layer": {
- "shape": "__integerMin0Max7",
- "locationName": "layer",
- "documentation": "The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0."
+ "RtmpOutputSettings": {
+ "shape": "RtmpOutputSettings",
+ "locationName": "rtmpOutputSettings"
},
- "Opacity": {
- "shape": "__integerMin0Max100",
- "locationName": "opacity",
- "documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100."
+ "UdpOutputSettings": {
+ "shape": "UdpOutputSettings",
+ "locationName": "udpOutputSettings"
},
- "Width": {
- "shape": "__integerMin1",
- "locationName": "width",
- "documentation": "The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay."
+ "CmafIngestOutputSettings": {
+ "shape": "CmafIngestOutputSettings",
+ "locationName": "cmafIngestOutputSettings"
+ },
+ "SrtOutputSettings": {
+ "shape": "SrtOutputSettings",
+ "locationName": "srtOutputSettings"
}
},
- "documentation": "Settings for the action to activate a static image.",
- "required": [
- "Image"
- ]
+ "documentation": "Output Settings"
},
- "StaticImageDeactivateScheduleActionSettings": {
+ "PassThroughSettings": {
"type": "structure",
"members": {
- "FadeOut": {
- "shape": "__integerMin0",
- "locationName": "fadeOut",
- "documentation": "The time in milliseconds for the image to fade out. Default is 0 (no fade-out)."
- },
- "Layer": {
- "shape": "__integerMin0Max7",
- "locationName": "layer",
- "documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0."
+ },
+ "documentation": "Pass Through Settings"
+ },
+ "PauseStateScheduleActionSettings": {
+ "type": "structure",
+ "members": {
+ "Pipelines": {
+ "shape": "__listOfPipelinePauseStateSettings",
+ "locationName": "pipelines"
}
},
- "documentation": "Settings for the action to deactivate the image in a specific layer."
+ "documentation": "Settings for the action to set pause state of a channel."
},
- "StaticImageOutputActivateScheduleActionSettings": {
+ "PipelineDetail": {
"type": "structure",
"members": {
- "Duration": {
- "shape": "__integerMin0",
- "locationName": "duration",
- "documentation": "The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated."
+ "ActiveInputAttachmentName": {
+ "shape": "__string",
+ "locationName": "activeInputAttachmentName",
+ "documentation": "The name of the active input attachment currently being ingested by this pipeline."
},
- "FadeIn": {
- "shape": "__integerMin0",
- "locationName": "fadeIn",
- "documentation": "The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in)."
+ "ActiveInputSwitchActionName": {
+ "shape": "__string",
+ "locationName": "activeInputSwitchActionName",
+ "documentation": "The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline."
},
- "FadeOut": {
- "shape": "__integerMin0",
- "locationName": "fadeOut",
- "documentation": "Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out)."
- },
- "Height": {
- "shape": "__integerMin1",
- "locationName": "height",
- "documentation": "The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay."
- },
- "Image": {
- "shape": "InputLocation",
- "locationName": "image",
- "documentation": "The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video."
- },
- "ImageX": {
- "shape": "__integerMin0",
- "locationName": "imageX",
- "documentation": "Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right."
- },
- "ImageY": {
- "shape": "__integerMin0",
- "locationName": "imageY",
- "documentation": "Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom."
- },
- "Layer": {
- "shape": "__integerMin0Max7",
- "locationName": "layer",
- "documentation": "The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0."
- },
- "Opacity": {
- "shape": "__integerMin0Max100",
- "locationName": "opacity",
- "documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100."
+ "ActiveMotionGraphicsActionName": {
+ "shape": "__string",
+ "locationName": "activeMotionGraphicsActionName",
+ "documentation": "The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline."
},
- "OutputNames": {
- "shape": "__listOf__string",
- "locationName": "outputNames",
- "documentation": "The name(s) of the output(s) the activation should apply to."
+ "ActiveMotionGraphicsUri": {
+ "shape": "__string",
+ "locationName": "activeMotionGraphicsUri",
+ "documentation": "The current URI being used for HTML5 motion graphics for this pipeline."
},
- "Width": {
- "shape": "__integerMin1",
- "locationName": "width",
- "documentation": "The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay."
+ "PipelineId": {
+ "shape": "__string",
+ "locationName": "pipelineId",
+ "documentation": "Pipeline ID"
}
},
- "documentation": "Settings for the action to activate a static image.",
- "required": [
- "OutputNames",
- "Image"
+ "documentation": "Runtime details of a pipeline when a channel is running."
+ },
+ "PipelineId": {
+ "type": "string",
+ "documentation": "Pipeline ID",
+ "enum": [
+ "PIPELINE_0",
+ "PIPELINE_1"
]
},
- "StaticImageOutputDeactivateScheduleActionSettings": {
+ "PipelineLockingSettings": {
"type": "structure",
"members": {
- "FadeOut": {
- "shape": "__integerMin0",
- "locationName": "fadeOut",
- "documentation": "The time in milliseconds for the image to fade out. Default is 0 (no fade-out)."
- },
- "Layer": {
- "shape": "__integerMin0Max7",
- "locationName": "layer",
- "documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0."
- },
- "OutputNames": {
- "shape": "__listOf__string",
- "locationName": "outputNames",
- "documentation": "The name(s) of the output(s) the deactivation should apply to."
- }
},
- "documentation": "Settings for the action to deactivate the image in a specific layer.",
- "required": [
- "OutputNames"
- ]
+ "documentation": "Pipeline Locking Settings"
},
- "StaticKeySettings": {
+ "PipelinePauseStateSettings": {
"type": "structure",
"members": {
- "KeyProviderServer": {
- "shape": "InputLocation",
- "locationName": "keyProviderServer",
- "documentation": "The URL of the license server used for protecting content."
- },
- "StaticKeyValue": {
- "shape": "__stringMin32Max32",
- "locationName": "staticKeyValue",
- "documentation": "Static key value as a 32 character hexadecimal string."
+ "PipelineId": {
+ "shape": "PipelineId",
+ "locationName": "pipelineId",
+ "documentation": "Pipeline ID to pause (\"PIPELINE_0\" or \"PIPELINE_1\")."
}
},
- "documentation": "Static Key Settings",
+ "documentation": "Settings for pausing a pipeline.",
"required": [
- "StaticKeyValue"
+ "PipelineId"
]
},
- "StopChannelRequest": {
- "type": "structure",
- "members": {
- "ChannelId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "channelId",
- "documentation": "A request to stop a running channel"
- }
- },
- "required": [
- "ChannelId"
- ],
- "documentation": "Placeholder documentation for StopChannelRequest"
+ "PreferredChannelPipeline": {
+ "type": "string",
+ "documentation": "Indicates which pipeline is preferred by the multiplex for program ingest.\nIf set to \\\"PIPELINE_0\\\" or \\\"PIPELINE_1\\\" and an unhealthy ingest causes the multiplex to switch to the non-preferred pipeline,\nit will switch back once that ingest is healthy again. If set to \\\"CURRENTLY_ACTIVE\\\",\nit will not switch back to the other pipeline based on it recovering to a healthy state,\nit will only switch if the active pipeline becomes unhealthy.",
+ "enum": [
+ "CURRENTLY_ACTIVE",
+ "PIPELINE_0",
+ "PIPELINE_1"
+ ]
},
- "StopChannelResponse": {
+ "PurchaseOffering": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique arn of the channel."
- },
- "CdiInputSpecification": {
- "shape": "CdiInputSpecification",
- "locationName": "cdiInputSpecification",
- "documentation": "Specification of CDI inputs for this channel"
- },
- "ChannelClass": {
- "shape": "ChannelClass",
- "locationName": "channelClass",
- "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
- },
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
- },
- "EgressEndpoints": {
- "shape": "__listOfChannelEgressEndpoint",
- "locationName": "egressEndpoints",
- "documentation": "The endpoints where outgoing connections initiate from"
- },
- "EncoderSettings": {
- "shape": "EncoderSettings",
- "locationName": "encoderSettings"
+ "Count": {
+ "shape": "__integerMin1",
+ "locationName": "count",
+ "documentation": "Number of resources"
},
- "Id": {
+ "Name": {
"shape": "__string",
- "locationName": "id",
- "documentation": "The unique id of the channel."
+ "locationName": "name",
+ "documentation": "Name for the new reservation"
},
- "InputAttachments": {
- "shape": "__listOfInputAttachment",
- "locationName": "inputAttachments",
- "documentation": "List of input attachments for channel."
+ "RenewalSettings": {
+ "shape": "RenewalSettings",
+ "locationName": "renewalSettings",
+ "documentation": "Renewal settings for the reservation"
},
- "InputSpecification": {
- "shape": "InputSpecification",
- "locationName": "inputSpecification",
- "documentation": "Specification of network and file inputs for this channel"
+ "RequestId": {
+ "shape": "__string",
+ "locationName": "requestId",
+ "documentation": "Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.",
+ "idempotencyToken": true
},
- "LogLevel": {
- "shape": "LogLevel",
- "locationName": "logLevel",
- "documentation": "The log level being written to CloudWatch Logs."
+ "Start": {
+ "shape": "__string",
+ "locationName": "start",
+ "documentation": "Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now."
},
- "Maintenance": {
- "shape": "MaintenanceStatus",
- "locationName": "maintenance",
- "documentation": "Maintenance settings for this channel."
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs"
+ }
+ },
+ "documentation": "PurchaseOffering request",
+ "required": [
+ "Count"
+ ]
+ },
+ "PurchaseOfferingRequest": {
+ "type": "structure",
+ "members": {
+ "Count": {
+ "shape": "__integerMin1",
+ "locationName": "count",
+ "documentation": "Number of resources"
},
"Name": {
"shape": "__string",
"locationName": "name",
- "documentation": "The name of the channel. (user-mutable)"
+ "documentation": "Name for the new reservation"
},
- "PipelineDetails": {
- "shape": "__listOfPipelineDetail",
- "locationName": "pipelineDetails",
- "documentation": "Runtime details for the pipelines of a running channel."
+ "OfferingId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "offeringId",
+ "documentation": "Offering to purchase, e.g. '87654321'"
},
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
+ "RenewalSettings": {
+ "shape": "RenewalSettings",
+ "locationName": "renewalSettings",
+ "documentation": "Renewal settings for the reservation"
},
- "RoleArn": {
+ "RequestId": {
"shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
+ "locationName": "requestId",
+ "documentation": "Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.",
+ "idempotencyToken": true
},
- "State": {
- "shape": "ChannelState",
- "locationName": "state"
+ "Start": {
+ "shape": "__string",
+ "locationName": "start",
+ "documentation": "Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now."
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
- "documentation": "A collection of key-value pairs."
- },
- "Vpc": {
- "shape": "VpcOutputSettingsDescription",
- "locationName": "vpc",
- "documentation": "Settings for VPC output"
+ "documentation": "A collection of key-value pairs"
}
},
- "documentation": "Placeholder documentation for StopChannelResponse"
+ "required": [
+ "OfferingId",
+ "Count"
+ ],
+ "documentation": "Placeholder documentation for PurchaseOfferingRequest"
},
- "StopInputDeviceRequest": {
+ "PurchaseOfferingResponse": {
"type": "structure",
"members": {
- "InputDeviceId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputDeviceId",
- "documentation": "The unique ID of the input device to stop. For example, hd-123456789abcdef."
+ "Reservation": {
+ "shape": "Reservation",
+ "locationName": "reservation"
}
},
- "required": [
- "InputDeviceId"
- ],
- "documentation": "Placeholder documentation for StopInputDeviceRequest"
+ "documentation": "Placeholder documentation for PurchaseOfferingResponse"
},
- "StopInputDeviceResponse": {
+ "PurchaseOfferingResultModel": {
"type": "structure",
"members": {
+ "Reservation": {
+ "shape": "Reservation",
+ "locationName": "reservation"
+ }
},
- "documentation": "Placeholder documentation for StopInputDeviceResponse"
+ "documentation": "PurchaseOffering response"
},
- "StopMultiplexRequest": {
+ "RawSettings": {
"type": "structure",
"members": {
- "MultiplexId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "multiplexId",
- "documentation": "The ID of the multiplex."
- }
},
- "required": [
- "MultiplexId"
- ],
- "documentation": "Placeholder documentation for StopMultiplexRequest"
+ "documentation": "Raw Settings"
},
- "StopMultiplexResponse": {
+ "RebootInputDevice": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique arn of the multiplex."
- },
- "AvailabilityZones": {
- "shape": "__listOf__string",
- "locationName": "availabilityZones",
- "documentation": "A list of availability zones for the multiplex."
- },
- "Destinations": {
- "shape": "__listOfMultiplexOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of the multiplex output destinations."
- },
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique id of the multiplex."
- },
- "MultiplexSettings": {
- "shape": "MultiplexSettings",
- "locationName": "multiplexSettings",
- "documentation": "Configuration for a multiplex event."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "The name of the multiplex."
- },
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
- },
- "ProgramCount": {
- "shape": "__integer",
- "locationName": "programCount",
- "documentation": "The number of programs in the multiplex."
- },
- "State": {
- "shape": "MultiplexState",
- "locationName": "state",
- "documentation": "The current state of the multiplex."
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "Force": {
+ "shape": "RebootInputDeviceForce",
+ "locationName": "force",
+ "documentation": "Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes."
}
},
- "documentation": "Placeholder documentation for StopMultiplexResponse"
+ "documentation": "Placeholder documentation for RebootInputDevice"
},
- "StopTimecode": {
+ "RebootInputDeviceForce": {
+ "type": "string",
+ "documentation": "Whether or not to force reboot the input device.",
+ "enum": [
+ "NO",
+ "YES"
+ ]
+ },
+ "RebootInputDeviceRequest": {
"type": "structure",
"members": {
- "LastFrameClippingBehavior": {
- "shape": "LastFrameClippingBehavior",
- "locationName": "lastFrameClippingBehavior",
- "documentation": "If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode."
+ "Force": {
+ "shape": "RebootInputDeviceForce",
+ "locationName": "force",
+ "documentation": "Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes."
},
- "Timecode": {
+ "InputDeviceId": {
"shape": "__string",
- "locationName": "timecode",
- "documentation": "The timecode for the frame where you want to stop the clip. Optional; if not specified, the clip continues to the end of the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF."
+ "location": "uri",
+ "locationName": "inputDeviceId",
+ "documentation": "The unique ID of the input device to reboot. For example, hd-123456789abcdef."
}
},
- "documentation": "Settings to identify the end of the clip."
+ "documentation": "A request to reboot an AWS Elemental device.",
+ "required": [
+ "InputDeviceId"
+ ]
},
- "Tags": {
- "type": "map",
- "key": {
- "shape": "__string"
- },
- "value": {
- "shape": "__string"
+ "RebootInputDeviceResponse": {
+ "type": "structure",
+ "members": {
},
- "documentation": "Placeholder documentation for Tags"
+ "documentation": "Placeholder documentation for RebootInputDeviceResponse"
},
- "TagsModel": {
+ "Rec601Settings": {
"type": "structure",
"members": {
- "Tags": {
- "shape": "Tags",
- "locationName": "tags"
- }
},
- "documentation": "Placeholder documentation for TagsModel"
+ "documentation": "Rec601 Settings"
},
- "TeletextDestinationSettings": {
+ "Rec709Settings": {
"type": "structure",
"members": {
},
- "documentation": "Teletext Destination Settings"
+ "documentation": "Rec709 Settings"
},
- "TeletextSourceSettings": {
+ "RejectInputDeviceTransferRequest": {
"type": "structure",
"members": {
- "OutputRectangle": {
- "shape": "CaptionRectangle",
- "locationName": "outputRectangle",
- "documentation": "Optionally defines a region where TTML style captions will be displayed"
- },
- "PageNumber": {
+ "InputDeviceId": {
"shape": "__string",
- "locationName": "pageNumber",
- "documentation": "Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no \"0x\" prefix."
+ "location": "uri",
+ "locationName": "inputDeviceId",
+ "documentation": "The unique ID of the input device to reject. For example, hd-123456789abcdef."
}
},
- "documentation": "Teletext Source Settings"
- },
- "TemporalFilterPostFilterSharpening": {
- "type": "string",
- "documentation": "Temporal Filter Post Filter Sharpening",
- "enum": [
- "AUTO",
- "DISABLED",
- "ENABLED"
- ]
+ "required": [
+ "InputDeviceId"
+ ],
+ "documentation": "Placeholder documentation for RejectInputDeviceTransferRequest"
},
- "TemporalFilterSettings": {
+ "RejectInputDeviceTransferResponse": {
"type": "structure",
"members": {
- "PostFilterSharpening": {
- "shape": "TemporalFilterPostFilterSharpening",
- "locationName": "postFilterSharpening",
- "documentation": "If you enable this filter, the results are the following:\n- If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source.\n- If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR."
- },
- "Strength": {
- "shape": "TemporalFilterStrength",
- "locationName": "strength",
- "documentation": "Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft."
- }
},
- "documentation": "Temporal Filter Settings"
- },
- "TemporalFilterStrength": {
- "type": "string",
- "documentation": "Temporal Filter Strength",
- "enum": [
- "AUTO",
- "STRENGTH_1",
- "STRENGTH_2",
- "STRENGTH_3",
- "STRENGTH_4",
- "STRENGTH_5",
- "STRENGTH_6",
- "STRENGTH_7",
- "STRENGTH_8",
- "STRENGTH_9",
- "STRENGTH_10",
- "STRENGTH_11",
- "STRENGTH_12",
- "STRENGTH_13",
- "STRENGTH_14",
- "STRENGTH_15",
- "STRENGTH_16"
- ]
+ "documentation": "Placeholder documentation for RejectInputDeviceTransferResponse"
},
- "Thumbnail": {
+ "RemixSettings": {
"type": "structure",
"members": {
- "Body": {
- "shape": "__string",
- "locationName": "body",
- "documentation": "The binary data for the latest thumbnail."
- },
- "ContentType": {
- "shape": "__string",
- "locationName": "contentType",
- "documentation": "The content type for the latest thumbnail."
+ "ChannelMappings": {
+ "shape": "__listOfAudioChannelMapping",
+ "locationName": "channelMappings",
+ "documentation": "Mapping of input channels to output channels, with appropriate gain adjustments."
},
- "ThumbnailType": {
- "shape": "ThumbnailType",
- "locationName": "thumbnailType",
- "documentation": "Thumbnail Type"
+ "ChannelsIn": {
+ "shape": "__integerMin1Max16",
+ "locationName": "channelsIn",
+ "documentation": "Number of input channels to be used."
},
- "TimeStamp": {
- "shape": "__timestampIso8601",
- "locationName": "timeStamp",
- "documentation": "Time stamp for the latest thumbnail."
+ "ChannelsOut": {
+ "shape": "__integerMin1Max8",
+ "locationName": "channelsOut",
+ "documentation": "Number of output channels to be produced.\nValid values: 1, 2, 4, 6, 8"
}
},
- "documentation": "Details of a single thumbnail"
+ "documentation": "Remix Settings",
+ "required": [
+ "ChannelMappings"
+ ]
},
- "ThumbnailConfiguration": {
+ "RenewalSettings": {
"type": "structure",
"members": {
- "State": {
- "shape": "ThumbnailState",
- "locationName": "state",
- "documentation": "Enables the thumbnail feature. The feature generates thumbnails of the incoming video in each pipeline in the channel. AUTO turns the feature on, DISABLE turns the feature off."
+ "AutomaticRenewal": {
+ "shape": "ReservationAutomaticRenewal",
+ "locationName": "automaticRenewal",
+ "documentation": "Automatic renewal status for the reservation"
+ },
+ "RenewalCount": {
+ "shape": "__integerMin1",
+ "locationName": "renewalCount",
+ "documentation": "Count for the reservation renewal"
}
},
- "documentation": "Thumbnail Configuration",
- "required": [
- "State"
- ]
+ "documentation": "The Renewal settings for Reservations"
},
- "ThumbnailData": {
+ "Reservation": {
"type": "structure",
"members": {
- "Body": {
+ "Arn": {
"shape": "__string",
- "locationName": "body",
- "documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive."
- }
- },
- "documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive."
- },
- "ThumbnailDetail": {
- "type": "structure",
- "members": {
- "PipelineId": {
+ "locationName": "arn",
+ "documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'"
+ },
+ "Count": {
+ "shape": "__integer",
+ "locationName": "count",
+ "documentation": "Number of reserved resources"
+ },
+ "CurrencyCode": {
"shape": "__string",
- "locationName": "pipelineId",
- "documentation": "Pipeline ID"
+ "locationName": "currencyCode",
+ "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
},
- "Thumbnails": {
- "shape": "__listOfThumbnail",
- "locationName": "thumbnails",
- "documentation": "thumbnails of a single pipeline"
+ "Duration": {
+ "shape": "__integer",
+ "locationName": "duration",
+ "documentation": "Lease duration, e.g. '12'"
+ },
+ "DurationUnits": {
+ "shape": "OfferingDurationUnits",
+ "locationName": "durationUnits",
+ "documentation": "Units for duration, e.g. 'MONTHS'"
+ },
+ "End": {
+ "shape": "__string",
+ "locationName": "end",
+ "documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'"
+ },
+ "FixedPrice": {
+ "shape": "__double",
+ "locationName": "fixedPrice",
+ "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "User specified reservation name"
+ },
+ "OfferingDescription": {
+ "shape": "__string",
+ "locationName": "offeringDescription",
+ "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
+ },
+ "OfferingId": {
+ "shape": "__string",
+ "locationName": "offeringId",
+ "documentation": "Unique offering ID, e.g. '87654321'"
+ },
+ "OfferingType": {
+ "shape": "OfferingType",
+ "locationName": "offeringType",
+ "documentation": "Offering type, e.g. 'NO_UPFRONT'"
+ },
+ "Region": {
+ "shape": "__string",
+ "locationName": "region",
+ "documentation": "AWS region, e.g. 'us-west-2'"
+ },
+ "RenewalSettings": {
+ "shape": "RenewalSettings",
+ "locationName": "renewalSettings",
+ "documentation": "Renewal settings for the reservation"
+ },
+ "ReservationId": {
+ "shape": "__string",
+ "locationName": "reservationId",
+ "documentation": "Unique reservation ID, e.g. '1234567'"
+ },
+ "ResourceSpecification": {
+ "shape": "ReservationResourceSpecification",
+ "locationName": "resourceSpecification",
+ "documentation": "Resource configuration details"
+ },
+ "Start": {
+ "shape": "__string",
+ "locationName": "start",
+ "documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'"
+ },
+ "State": {
+ "shape": "ReservationState",
+ "locationName": "state",
+ "documentation": "Current state of reservation, e.g. 'ACTIVE'"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs"
+ },
+ "UsagePrice": {
+ "shape": "__double",
+ "locationName": "usagePrice",
+ "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
}
},
- "documentation": "Thumbnail details for one pipeline of a running channel."
+ "documentation": "Reserved resources available to use"
},
- "ThumbnailNoData": {
- "type": "structure",
- "members": {
- },
- "documentation": "Response when thumbnail has no data. It should have no message."
+ "ReservationAutomaticRenewal": {
+ "type": "string",
+ "documentation": "Automatic Renewal Status for Reservation",
+ "enum": [
+ "DISABLED",
+ "ENABLED",
+ "UNAVAILABLE"
+ ]
},
- "ThumbnailState": {
+ "ReservationCodec": {
"type": "string",
- "documentation": "Thumbnail State",
+ "documentation": "Codec, 'MPEG2', 'AVC', 'HEVC', 'AUDIO', 'LINK', or 'AV1'",
"enum": [
- "AUTO",
- "DISABLED"
+ "MPEG2",
+ "AVC",
+ "HEVC",
+ "AUDIO",
+ "LINK",
+ "AV1"
]
},
- "ThumbnailType": {
+ "ReservationMaximumBitrate": {
"type": "string",
- "documentation": "Thumbnail type.",
+ "documentation": "Maximum bitrate in megabits per second",
"enum": [
- "UNSPECIFIED",
- "CURRENT_ACTIVE"
+ "MAX_10_MBPS",
+ "MAX_20_MBPS",
+ "MAX_50_MBPS"
]
},
- "TimecodeBurninFontSize": {
+ "ReservationMaximumFramerate": {
"type": "string",
- "documentation": "Timecode Burnin Font Size",
+ "documentation": "Maximum framerate in frames per second (Outputs only)",
"enum": [
- "EXTRA_SMALL_10",
- "LARGE_48",
- "MEDIUM_32",
- "SMALL_16"
+ "MAX_30_FPS",
+ "MAX_60_FPS"
]
},
- "TimecodeBurninPosition": {
+ "ReservationResolution": {
"type": "string",
- "documentation": "Timecode Burnin Position",
+ "documentation": "Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, FHD is 1080 lines, UHD is greater than 1080 lines",
"enum": [
- "BOTTOM_CENTER",
- "BOTTOM_LEFT",
- "BOTTOM_RIGHT",
- "MIDDLE_CENTER",
- "MIDDLE_LEFT",
- "MIDDLE_RIGHT",
- "TOP_CENTER",
- "TOP_LEFT",
- "TOP_RIGHT"
+ "SD",
+ "HD",
+ "FHD",
+ "UHD"
]
},
- "TimecodeBurninSettings": {
+ "ReservationResourceSpecification": {
"type": "structure",
"members": {
- "FontSize": {
- "shape": "TimecodeBurninFontSize",
- "locationName": "fontSize",
- "documentation": "Choose a timecode burn-in font size"
+ "ChannelClass": {
+ "shape": "ChannelClass",
+ "locationName": "channelClass",
+ "documentation": "Channel class, e.g. 'STANDARD'"
},
- "Position": {
- "shape": "TimecodeBurninPosition",
- "locationName": "position",
- "documentation": "Choose a timecode burn-in output position"
+ "Codec": {
+ "shape": "ReservationCodec",
+ "locationName": "codec",
+ "documentation": "Codec, e.g. 'AVC'"
},
- "Prefix": {
- "shape": "__stringMax255",
- "locationName": "prefix",
- "documentation": "Create a timecode burn-in prefix (optional)"
+ "MaximumBitrate": {
+ "shape": "ReservationMaximumBitrate",
+ "locationName": "maximumBitrate",
+ "documentation": "Maximum bitrate, e.g. 'MAX_20_MBPS'"
+ },
+ "MaximumFramerate": {
+ "shape": "ReservationMaximumFramerate",
+ "locationName": "maximumFramerate",
+ "documentation": "Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)"
+ },
+ "Resolution": {
+ "shape": "ReservationResolution",
+ "locationName": "resolution",
+ "documentation": "Resolution, e.g. 'HD'"
+ },
+ "ResourceType": {
+ "shape": "ReservationResourceType",
+ "locationName": "resourceType",
+ "documentation": "Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'"
+ },
+ "SpecialFeature": {
+ "shape": "ReservationSpecialFeature",
+ "locationName": "specialFeature",
+ "documentation": "Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)"
+ },
+ "VideoQuality": {
+ "shape": "ReservationVideoQuality",
+ "locationName": "videoQuality",
+ "documentation": "Video quality, e.g. 'STANDARD' (Outputs only)"
}
},
- "documentation": "Timecode Burnin Settings",
- "required": [
- "Position",
- "FontSize"
+ "documentation": "Resource configuration (codec, resolution, bitrate, ...)"
+ },
+ "ReservationResourceType": {
+ "type": "string",
+ "documentation": "Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'",
+ "enum": [
+ "INPUT",
+ "OUTPUT",
+ "MULTIPLEX",
+ "CHANNEL"
]
},
- "TimecodeConfig": {
- "type": "structure",
- "members": {
- "Source": {
- "shape": "TimecodeConfigSource",
- "locationName": "source",
- "documentation": "Identifies the source for the timecode that will be associated with the events outputs.\n-Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using \"Start at 0\" (zerobased).\n-System Clock (systemclock): Use the UTC time.\n-Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00."
- },
- "SyncThreshold": {
- "shape": "__integerMin1Max1000000",
- "locationName": "syncThreshold",
- "documentation": "Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified."
- }
- },
- "documentation": "Timecode Config",
- "required": [
- "Source"
+ "ReservationSpecialFeature": {
+ "type": "string",
+ "documentation": "Special features, 'ADVANCED_AUDIO' 'AUDIO_NORMALIZATION' 'MGHD' or 'MGUHD'",
+ "enum": [
+ "ADVANCED_AUDIO",
+ "AUDIO_NORMALIZATION",
+ "MGHD",
+ "MGUHD"
]
},
- "TimecodeConfigSource": {
+ "ReservationState": {
"type": "string",
- "documentation": "Timecode Config Source",
+ "documentation": "Current reservation state",
"enum": [
- "EMBEDDED",
- "SYSTEMCLOCK",
- "ZEROBASED"
+ "ACTIVE",
+ "EXPIRED",
+ "CANCELED",
+ "DELETED"
]
},
- "TooManyRequestsException": {
+ "ReservationVideoQuality": {
+ "type": "string",
+ "documentation": "Video quality, e.g. 'STANDARD' (Outputs only)",
+ "enum": [
+ "STANDARD",
+ "ENHANCED",
+ "PREMIUM"
+ ]
+ },
+ "ResourceConflict": {
"type": "structure",
"members": {
"Message": {
@@ -17018,2770 +16495,6835 @@
"locationName": "message"
}
},
- "exception": true,
- "error": {
- "httpStatusCode": 429
- },
- "documentation": "Placeholder documentation for TooManyRequestsException"
+ "documentation": "Placeholder documentation for ResourceConflict"
},
- "TransferInputDevice": {
+ "ResourceNotFound": {
"type": "structure",
"members": {
- "TargetCustomerId": {
- "shape": "__string",
- "locationName": "targetCustomerId",
- "documentation": "The AWS account ID (12 digits) for the recipient of the device transfer."
- },
- "TargetRegion": {
- "shape": "__string",
- "locationName": "targetRegion",
- "documentation": "The target AWS region to transfer the device."
- },
- "TransferMessage": {
+ "Message": {
"shape": "__string",
- "locationName": "transferMessage",
- "documentation": "An optional message for the recipient. Maximum 280 characters."
+ "locationName": "message"
}
},
- "documentation": "The transfer details of the input device."
+ "documentation": "Placeholder documentation for ResourceNotFound"
},
- "TransferInputDeviceRequest": {
- "type": "structure",
- "members": {
- "InputDeviceId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputDeviceId",
- "documentation": "The unique ID of this input device. For example, hd-123456789abcdef."
- },
- "TargetCustomerId": {
- "shape": "__string",
- "locationName": "targetCustomerId",
- "documentation": "The AWS account ID (12 digits) for the recipient of the device transfer."
- },
- "TargetRegion": {
- "shape": "__string",
- "locationName": "targetRegion",
- "documentation": "The target AWS region to transfer the device."
- },
- "TransferMessage": {
- "shape": "__string",
- "locationName": "transferMessage",
- "documentation": "An optional message for the recipient. Maximum 280 characters."
- }
- },
- "documentation": "A request to transfer an input device.",
- "required": [
- "InputDeviceId"
+ "RtmpAdMarkers": {
+ "type": "string",
+ "documentation": "Rtmp Ad Markers",
+ "enum": [
+ "ON_CUE_POINT_SCTE35"
]
},
- "TransferInputDeviceResponse": {
- "type": "structure",
- "members": {
- },
- "documentation": "Placeholder documentation for TransferInputDeviceResponse"
- },
- "TransferringInputDeviceSummary": {
- "type": "structure",
- "members": {
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique ID of the input device."
- },
- "Message": {
- "shape": "__string",
- "locationName": "message",
- "documentation": "The optional message that the sender has attached to the transfer."
- },
- "TargetCustomerId": {
- "shape": "__string",
- "locationName": "targetCustomerId",
- "documentation": "The AWS account ID for the recipient of the input device transfer."
- },
- "TransferType": {
- "shape": "InputDeviceTransferType",
- "locationName": "transferType",
- "documentation": "The type (direction) of the input device transfer."
- }
- },
- "documentation": "Details about the input device that is being transferred."
- },
- "TtmlDestinationSettings": {
- "type": "structure",
- "members": {
- "StyleControl": {
- "shape": "TtmlDestinationStyleControl",
- "locationName": "styleControl",
- "documentation": "This field is not currently supported and will not affect the output styling. Leave the default value."
- }
- },
- "documentation": "Ttml Destination Settings"
+ "RtmpCacheFullBehavior": {
+ "type": "string",
+ "documentation": "Rtmp Cache Full Behavior",
+ "enum": [
+ "DISCONNECT_IMMEDIATELY",
+ "WAIT_FOR_SERVER"
+ ]
},
- "TtmlDestinationStyleControl": {
+ "RtmpCaptionData": {
"type": "string",
- "documentation": "Ttml Destination Style Control",
+ "documentation": "Rtmp Caption Data",
"enum": [
- "PASSTHROUGH",
- "USE_CONFIGURED"
+ "ALL",
+ "FIELD1_608",
+ "FIELD1_AND_FIELD2_608"
]
},
- "UdpContainerSettings": {
+ "RtmpCaptionInfoDestinationSettings": {
"type": "structure",
"members": {
- "M2tsSettings": {
- "shape": "M2tsSettings",
- "locationName": "m2tsSettings"
- }
},
- "documentation": "Udp Container Settings"
+ "documentation": "Rtmp Caption Info Destination Settings"
},
- "UdpGroupSettings": {
+ "RtmpGroupSettings": {
"type": "structure",
"members": {
+ "AdMarkers": {
+ "shape": "__listOfRtmpAdMarkers",
+ "locationName": "adMarkers",
+ "documentation": "Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream."
+ },
+ "AuthenticationScheme": {
+ "shape": "AuthenticationScheme",
+ "locationName": "authenticationScheme",
+ "documentation": "Authentication scheme to use when connecting with CDN"
+ },
+ "CacheFullBehavior": {
+ "shape": "RtmpCacheFullBehavior",
+ "locationName": "cacheFullBehavior",
+ "documentation": "Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again."
+ },
+ "CacheLength": {
+ "shape": "__integerMin30",
+ "locationName": "cacheLength",
+ "documentation": "Cache length, in seconds, is used to calculate buffer size."
+ },
+ "CaptionData": {
+ "shape": "RtmpCaptionData",
+ "locationName": "captionData",
+ "documentation": "Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed."
+ },
"InputLossAction": {
- "shape": "InputLossActionForUdpOut",
+ "shape": "InputLossActionForRtmpOut",
"locationName": "inputLossAction",
- "documentation": "Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video."
- },
- "TimedMetadataId3Frame": {
- "shape": "UdpTimedMetadataId3Frame",
- "locationName": "timedMetadataId3Frame",
- "documentation": "Indicates ID3 frame that has the timecode."
+ "documentation": "Controls the behavior of this RTMP group if input becomes unavailable.\n\n- emitOutput: Emit a slate until input returns.\n- pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection."
},
- "TimedMetadataId3Period": {
+ "RestartDelay": {
"shape": "__integerMin0",
- "locationName": "timedMetadataId3Period",
- "documentation": "Timed Metadata interval in seconds."
+ "locationName": "restartDelay",
+ "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart."
+ },
+ "IncludeFillerNalUnits": {
+ "shape": "IncludeFillerNalUnits",
+ "locationName": "includeFillerNalUnits",
+ "documentation": "Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto."
}
},
- "documentation": "Udp Group Settings"
+ "documentation": "Rtmp Group Settings"
},
- "UdpOutputSettings": {
+ "RtmpOutputCertificateMode": {
+ "type": "string",
+ "documentation": "Rtmp Output Certificate Mode",
+ "enum": [
+ "SELF_SIGNED",
+ "VERIFY_AUTHENTICITY"
+ ]
+ },
+ "RtmpOutputSettings": {
"type": "structure",
"members": {
- "BufferMsec": {
- "shape": "__integerMin0Max10000",
- "locationName": "bufferMsec",
- "documentation": "UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc."
+ "CertificateMode": {
+ "shape": "RtmpOutputCertificateMode",
+ "locationName": "certificateMode",
+ "documentation": "If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail."
},
- "ContainerSettings": {
- "shape": "UdpContainerSettings",
- "locationName": "containerSettings"
+ "ConnectionRetryInterval": {
+ "shape": "__integerMin1",
+ "locationName": "connectionRetryInterval",
+ "documentation": "Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost."
},
"Destination": {
"shape": "OutputLocationRef",
"locationName": "destination",
- "documentation": "Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002)."
+ "documentation": "The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers."
},
- "FecOutputSettings": {
- "shape": "FecOutputSettings",
- "locationName": "fecOutputSettings",
- "documentation": "Settings for enabling and adjusting Forward Error Correction on UDP outputs."
+ "NumRetries": {
+ "shape": "__integerMin0",
+ "locationName": "numRetries",
+ "documentation": "Number of retry attempts."
}
},
- "documentation": "Udp Output Settings",
+ "documentation": "Rtmp Output Settings",
"required": [
- "Destination",
- "ContainerSettings"
+ "Destination"
]
},
- "UdpTimedMetadataId3Frame": {
+ "S3CannedAcl": {
"type": "string",
- "documentation": "Udp Timed Metadata Id3 Frame",
+ "documentation": "S3 Canned Acl",
"enum": [
- "NONE",
- "PRIV",
- "TDRL"
+ "AUTHENTICATED_READ",
+ "BUCKET_OWNER_FULL_CONTROL",
+ "BUCKET_OWNER_READ",
+ "PUBLIC_READ"
]
},
- "UnprocessableEntityException": {
+ "ScheduleAction": {
"type": "structure",
"members": {
- "Message": {
+ "ActionName": {
"shape": "__string",
- "locationName": "message",
- "documentation": "The error message."
+ "locationName": "actionName",
+ "documentation": "The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused."
},
- "ValidationErrors": {
- "shape": "__listOfValidationError",
- "locationName": "validationErrors",
- "documentation": "A collection of validation error responses."
+ "ScheduleActionSettings": {
+ "shape": "ScheduleActionSettings",
+ "locationName": "scheduleActionSettings",
+ "documentation": "Settings for this schedule action."
+ },
+ "ScheduleActionStartSettings": {
+ "shape": "ScheduleActionStartSettings",
+ "locationName": "scheduleActionStartSettings",
+ "documentation": "The time for the action to start in the channel."
}
},
- "exception": true,
- "error": {
- "httpStatusCode": 422
- },
- "documentation": "Placeholder documentation for UnprocessableEntityException"
+ "documentation": "Contains information on a single schedule action.",
+ "required": [
+ "ActionName",
+ "ScheduleActionStartSettings",
+ "ScheduleActionSettings"
+ ]
},
- "UpdateAccountConfigurationRequest": {
+ "ScheduleActionSettings": {
"type": "structure",
"members": {
- "AccountConfiguration": {
- "shape": "AccountConfiguration",
- "locationName": "accountConfiguration"
+ "HlsId3SegmentTaggingSettings": {
+ "shape": "HlsId3SegmentTaggingScheduleActionSettings",
+ "locationName": "hlsId3SegmentTaggingSettings",
+ "documentation": "Action to insert HLS ID3 segment tagging"
+ },
+ "HlsTimedMetadataSettings": {
+ "shape": "HlsTimedMetadataScheduleActionSettings",
+ "locationName": "hlsTimedMetadataSettings",
+ "documentation": "Action to insert HLS metadata"
+ },
+ "InputPrepareSettings": {
+ "shape": "InputPrepareScheduleActionSettings",
+ "locationName": "inputPrepareSettings",
+ "documentation": "Action to prepare an input for a future immediate input switch"
+ },
+ "InputSwitchSettings": {
+ "shape": "InputSwitchScheduleActionSettings",
+ "locationName": "inputSwitchSettings",
+ "documentation": "Action to switch the input"
+ },
+ "MotionGraphicsImageActivateSettings": {
+ "shape": "MotionGraphicsActivateScheduleActionSettings",
+ "locationName": "motionGraphicsImageActivateSettings",
+ "documentation": "Action to activate a motion graphics image overlay"
+ },
+ "MotionGraphicsImageDeactivateSettings": {
+ "shape": "MotionGraphicsDeactivateScheduleActionSettings",
+ "locationName": "motionGraphicsImageDeactivateSettings",
+ "documentation": "Action to deactivate a motion graphics image overlay"
+ },
+ "PauseStateSettings": {
+ "shape": "PauseStateScheduleActionSettings",
+ "locationName": "pauseStateSettings",
+ "documentation": "Action to pause or unpause one or both channel pipelines"
+ },
+ "Scte35InputSettings": {
+ "shape": "Scte35InputScheduleActionSettings",
+ "locationName": "scte35InputSettings",
+ "documentation": "Action to specify scte35 input"
+ },
+ "Scte35ReturnToNetworkSettings": {
+ "shape": "Scte35ReturnToNetworkScheduleActionSettings",
+ "locationName": "scte35ReturnToNetworkSettings",
+ "documentation": "Action to insert SCTE-35 return_to_network message"
+ },
+ "Scte35SpliceInsertSettings": {
+ "shape": "Scte35SpliceInsertScheduleActionSettings",
+ "locationName": "scte35SpliceInsertSettings",
+ "documentation": "Action to insert SCTE-35 splice_insert message"
+ },
+ "Scte35TimeSignalSettings": {
+ "shape": "Scte35TimeSignalScheduleActionSettings",
+ "locationName": "scte35TimeSignalSettings",
+ "documentation": "Action to insert SCTE-35 time_signal message"
+ },
+ "StaticImageActivateSettings": {
+ "shape": "StaticImageActivateScheduleActionSettings",
+ "locationName": "staticImageActivateSettings",
+ "documentation": "Action to activate a static image overlay"
+ },
+ "StaticImageDeactivateSettings": {
+ "shape": "StaticImageDeactivateScheduleActionSettings",
+ "locationName": "staticImageDeactivateSettings",
+ "documentation": "Action to deactivate a static image overlay"
+ },
+ "StaticImageOutputActivateSettings": {
+ "shape": "StaticImageOutputActivateScheduleActionSettings",
+ "locationName": "staticImageOutputActivateSettings",
+ "documentation": "Action to activate a static image overlay in one or more specified outputs"
+ },
+ "StaticImageOutputDeactivateSettings": {
+ "shape": "StaticImageOutputDeactivateScheduleActionSettings",
+ "locationName": "staticImageOutputDeactivateSettings",
+ "documentation": "Action to deactivate a static image overlay in one or more specified outputs"
}
},
- "documentation": "List of account configuration parameters to update."
+ "documentation": "Holds the settings for a single schedule action."
},
- "UpdateAccountConfigurationRequestModel": {
+ "ScheduleActionStartSettings": {
"type": "structure",
"members": {
- "AccountConfiguration": {
- "shape": "AccountConfiguration",
- "locationName": "accountConfiguration"
+ "FixedModeScheduleActionStartSettings": {
+ "shape": "FixedModeScheduleActionStartSettings",
+ "locationName": "fixedModeScheduleActionStartSettings",
+ "documentation": "Option for specifying the start time for an action."
+ },
+ "FollowModeScheduleActionStartSettings": {
+ "shape": "FollowModeScheduleActionStartSettings",
+ "locationName": "followModeScheduleActionStartSettings",
+ "documentation": "Option for specifying an action as relative to another action."
+ },
+ "ImmediateModeScheduleActionStartSettings": {
+ "shape": "ImmediateModeScheduleActionStartSettings",
+ "locationName": "immediateModeScheduleActionStartSettings",
+ "documentation": "Option for specifying an action that should be applied immediately."
}
},
- "documentation": "The desired new account configuration."
+ "documentation": "Settings to specify when an action should occur. Only one of the options must be selected."
},
- "UpdateAccountConfigurationResponse": {
+ "ScheduleDeleteResultModel": {
"type": "structure",
"members": {
- "AccountConfiguration": {
- "shape": "AccountConfiguration",
- "locationName": "accountConfiguration"
- }
},
- "documentation": "Placeholder documentation for UpdateAccountConfigurationResponse"
+ "documentation": "Result of a schedule deletion."
},
- "UpdateAccountConfigurationResultModel": {
+ "ScheduleDescribeResultModel": {
"type": "structure",
"members": {
- "AccountConfiguration": {
- "shape": "AccountConfiguration",
- "locationName": "accountConfiguration"
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "The next token; for use in pagination."
+ },
+ "ScheduleActions": {
+ "shape": "__listOfScheduleAction",
+ "locationName": "scheduleActions",
+ "documentation": "The list of actions in the schedule."
}
},
- "documentation": "The account's updated configuration."
+ "documentation": "Results of a schedule describe.",
+ "required": [
+ "ScheduleActions"
+ ]
},
- "UpdateChannel": {
+ "Scte20Convert608To708": {
+ "type": "string",
+ "documentation": "Scte20 Convert608 To708",
+ "enum": [
+ "DISABLED",
+ "UPCONVERT"
+ ]
+ },
+ "Scte20PlusEmbeddedDestinationSettings": {
"type": "structure",
"members": {
- "CdiInputSpecification": {
- "shape": "CdiInputSpecification",
- "locationName": "cdiInputSpecification",
- "documentation": "Specification of CDI inputs for this channel"
- },
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of output destinations for this channel."
- },
- "EncoderSettings": {
- "shape": "EncoderSettings",
- "locationName": "encoderSettings",
- "documentation": "The encoder settings for this channel."
- },
- "InputAttachments": {
- "shape": "__listOfInputAttachment",
- "locationName": "inputAttachments"
- },
- "InputSpecification": {
- "shape": "InputSpecification",
- "locationName": "inputSpecification",
- "documentation": "Specification of network and file inputs for this channel"
- },
- "LogLevel": {
- "shape": "LogLevel",
- "locationName": "logLevel",
- "documentation": "The log level to write to CloudWatch Logs."
- },
- "Maintenance": {
- "shape": "MaintenanceUpdateSettings",
- "locationName": "maintenance",
- "documentation": "Maintenance settings for this channel."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "The name of the channel."
- },
- "RoleArn": {
- "shape": "__string",
- "locationName": "roleArn",
- "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed."
- }
},
- "documentation": "Placeholder documentation for UpdateChannel"
+ "documentation": "Scte20 Plus Embedded Destination Settings"
},
- "UpdateChannelClass": {
+ "Scte20SourceSettings": {
"type": "structure",
"members": {
- "ChannelClass": {
- "shape": "ChannelClass",
- "locationName": "channelClass",
- "documentation": "The channel class that you wish to update this channel to use."
+ "Convert608To708": {
+ "shape": "Scte20Convert608To708",
+ "locationName": "convert608To708",
+ "documentation": "If upconvert, 608 data is both passed through via the \"608 compatibility bytes\" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded."
},
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of output destinations for this channel."
+ "Source608ChannelNumber": {
+ "shape": "__integerMin1Max4",
+ "locationName": "source608ChannelNumber",
+ "documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough."
}
},
- "required": [
- "ChannelClass"
- ],
- "documentation": "Placeholder documentation for UpdateChannelClass"
+ "documentation": "Scte20 Source Settings"
},
- "UpdateChannelClassRequest": {
+ "Scte27DestinationSettings": {
"type": "structure",
"members": {
- "ChannelClass": {
- "shape": "ChannelClass",
- "locationName": "channelClass",
- "documentation": "The channel class that you wish to update this channel to use."
- },
- "ChannelId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "channelId",
- "documentation": "Channel Id of the channel whose class should be updated."
- },
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of output destinations for this channel."
- }
},
- "documentation": "Channel class that the channel should be updated to.",
- "required": [
- "ChannelId",
- "ChannelClass"
+ "documentation": "Scte27 Destination Settings"
+ },
+ "Scte27OcrLanguage": {
+ "type": "string",
+ "documentation": "Scte27 Ocr Language",
+ "enum": [
+ "DEU",
+ "ENG",
+ "FRA",
+ "NLD",
+ "POR",
+ "SPA"
]
},
- "UpdateChannelClassResponse": {
+ "Scte27SourceSettings": {
"type": "structure",
"members": {
- "Channel": {
- "shape": "Channel",
- "locationName": "channel"
+ "OcrLanguage": {
+ "shape": "Scte27OcrLanguage",
+ "locationName": "ocrLanguage",
+ "documentation": "If you will configure a WebVTT caption description that references this caption selector, use this field to\nprovide the language to consider when translating the image-based source to text."
+ },
+ "Pid": {
+ "shape": "__integerMin1",
+ "locationName": "pid",
+ "documentation": "The pid field is used in conjunction with the caption selector languageCode field as follows:\n - Specify PID and Language: Extracts captions from that PID; the language is \"informational\".\n - Specify PID and omit Language: Extracts the specified PID.\n - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be.\n - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through."
}
},
- "documentation": "Placeholder documentation for UpdateChannelClassResponse"
+ "documentation": "Scte27 Source Settings"
},
- "UpdateChannelRequest": {
+ "Scte35AposNoRegionalBlackoutBehavior": {
+ "type": "string",
+ "documentation": "Scte35 Apos No Regional Blackout Behavior",
+ "enum": [
+ "FOLLOW",
+ "IGNORE"
+ ]
+ },
+ "Scte35AposWebDeliveryAllowedBehavior": {
+ "type": "string",
+ "documentation": "Scte35 Apos Web Delivery Allowed Behavior",
+ "enum": [
+ "FOLLOW",
+ "IGNORE"
+ ]
+ },
+ "Scte35ArchiveAllowedFlag": {
+ "type": "string",
+ "documentation": "Corresponds to the archive_allowed parameter. A value of ARCHIVE_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the \"restriction\" flags then you must include all four of them.",
+ "enum": [
+ "ARCHIVE_NOT_ALLOWED",
+ "ARCHIVE_ALLOWED"
+ ]
+ },
+ "Scte35DeliveryRestrictions": {
"type": "structure",
"members": {
- "CdiInputSpecification": {
- "shape": "CdiInputSpecification",
- "locationName": "cdiInputSpecification",
- "documentation": "Specification of CDI inputs for this channel"
- },
- "ChannelId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "channelId",
- "documentation": "channel ID"
- },
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of output destinations for this channel."
- },
- "EncoderSettings": {
- "shape": "EncoderSettings",
- "locationName": "encoderSettings",
- "documentation": "The encoder settings for this channel."
- },
- "InputAttachments": {
- "shape": "__listOfInputAttachment",
- "locationName": "inputAttachments"
- },
- "InputSpecification": {
- "shape": "InputSpecification",
- "locationName": "inputSpecification",
- "documentation": "Specification of network and file inputs for this channel"
- },
- "LogLevel": {
- "shape": "LogLevel",
- "locationName": "logLevel",
- "documentation": "The log level to write to CloudWatch Logs."
+ "ArchiveAllowedFlag": {
+ "shape": "Scte35ArchiveAllowedFlag",
+ "locationName": "archiveAllowedFlag",
+ "documentation": "Corresponds to SCTE-35 archive_allowed_flag."
},
- "Maintenance": {
- "shape": "MaintenanceUpdateSettings",
- "locationName": "maintenance",
- "documentation": "Maintenance settings for this channel."
+ "DeviceRestrictions": {
+ "shape": "Scte35DeviceRestrictions",
+ "locationName": "deviceRestrictions",
+ "documentation": "Corresponds to SCTE-35 device_restrictions parameter."
},
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "The name of the channel."
+ "NoRegionalBlackoutFlag": {
+ "shape": "Scte35NoRegionalBlackoutFlag",
+ "locationName": "noRegionalBlackoutFlag",
+ "documentation": "Corresponds to SCTE-35 no_regional_blackout_flag parameter."
},
- "RoleArn": {
- "shape": "__string",
- "locationName": "roleArn",
- "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed."
+ "WebDeliveryAllowedFlag": {
+ "shape": "Scte35WebDeliveryAllowedFlag",
+ "locationName": "webDeliveryAllowedFlag",
+ "documentation": "Corresponds to SCTE-35 web_delivery_allowed_flag parameter."
}
},
- "documentation": "A request to update a channel.",
+ "documentation": "Corresponds to SCTE-35 delivery_not_restricted_flag parameter. To declare delivery restrictions, include this element and its four \"restriction\" flags. To declare that there are no restrictions, omit this element.",
"required": [
- "ChannelId"
+ "DeviceRestrictions",
+ "ArchiveAllowedFlag",
+ "WebDeliveryAllowedFlag",
+ "NoRegionalBlackoutFlag"
]
},
- "UpdateChannelResponse": {
+ "Scte35Descriptor": {
"type": "structure",
"members": {
- "Channel": {
- "shape": "Channel",
- "locationName": "channel"
+ "Scte35DescriptorSettings": {
+ "shape": "Scte35DescriptorSettings",
+ "locationName": "scte35DescriptorSettings",
+ "documentation": "SCTE-35 Descriptor Settings."
}
},
- "documentation": "Placeholder documentation for UpdateChannelResponse"
+ "documentation": "Holds one set of SCTE-35 Descriptor Settings.",
+ "required": [
+ "Scte35DescriptorSettings"
+ ]
},
- "UpdateChannelResultModel": {
+ "Scte35DescriptorSettings": {
"type": "structure",
"members": {
- "Channel": {
- "shape": "Channel",
- "locationName": "channel"
+ "SegmentationDescriptorScte35DescriptorSettings": {
+ "shape": "Scte35SegmentationDescriptor",
+ "locationName": "segmentationDescriptorScte35DescriptorSettings",
+ "documentation": "SCTE-35 Segmentation Descriptor."
}
},
- "documentation": "The updated channel's description."
+ "documentation": "SCTE-35 Descriptor settings.",
+ "required": [
+ "SegmentationDescriptorScte35DescriptorSettings"
+ ]
},
- "UpdateInput": {
+ "Scte35DeviceRestrictions": {
+ "type": "string",
+ "documentation": "Corresponds to the device_restrictions parameter in a segmentation_descriptor. If you include one of the \"restriction\" flags then you must include all four of them.",
+ "enum": [
+ "NONE",
+ "RESTRICT_GROUP0",
+ "RESTRICT_GROUP1",
+ "RESTRICT_GROUP2"
+ ]
+ },
+ "Scte35InputMode": {
+ "type": "string",
+ "documentation": "Whether the SCTE-35 input should be the active input or a fixed input.",
+ "enum": [
+ "FIXED",
+ "FOLLOW_ACTIVE"
+ ]
+ },
+ "Scte35InputScheduleActionSettings": {
"type": "structure",
"members": {
- "Destinations": {
- "shape": "__listOfInputDestinationRequest",
- "locationName": "destinations",
- "documentation": "Destination settings for PUSH type inputs."
- },
- "InputDevices": {
- "shape": "__listOfInputDeviceRequest",
- "locationName": "inputDevices",
- "documentation": "Settings for the devices."
- },
- "InputSecurityGroups": {
- "shape": "__listOf__string",
- "locationName": "inputSecurityGroups",
- "documentation": "A list of security groups referenced by IDs to attach to the input."
- },
- "MediaConnectFlows": {
- "shape": "__listOfMediaConnectFlowRequest",
- "locationName": "mediaConnectFlows",
- "documentation": "A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of the input."
- },
- "RoleArn": {
+ "InputAttachmentNameReference": {
"shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
- },
- "Sources": {
- "shape": "__listOfInputSourceRequest",
- "locationName": "sources",
- "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty."
+ "locationName": "inputAttachmentNameReference",
+ "documentation": "In fixed mode, enter the name of the input attachment that you want to use as a SCTE-35 input. (Don't enter the ID of the input.)\""
},
- "SrtSettings": {
- "shape": "SrtSettingsRequest",
- "locationName": "srtSettings",
- "documentation": "The settings associated with an SRT input."
+ "Mode": {
+ "shape": "Scte35InputMode",
+ "locationName": "mode",
+ "documentation": "Whether the SCTE-35 input should be the active input or a fixed input."
}
},
- "documentation": "Placeholder documentation for UpdateInput"
+ "documentation": "Scte35Input Schedule Action Settings",
+ "required": [
+ "Mode"
+ ]
},
- "UpdateInputDevice": {
+ "Scte35NoRegionalBlackoutFlag": {
+ "type": "string",
+ "documentation": "Corresponds to the no_regional_blackout_flag parameter. A value of REGIONAL_BLACKOUT corresponds to 0 (false) in the SCTE-35 specification. If you include one of the \"restriction\" flags then you must include all four of them.",
+ "enum": [
+ "REGIONAL_BLACKOUT",
+ "NO_REGIONAL_BLACKOUT"
+ ]
+ },
+ "Scte35ReturnToNetworkScheduleActionSettings": {
"type": "structure",
"members": {
- "HdDeviceSettings": {
- "shape": "InputDeviceConfigurableSettings",
- "locationName": "hdDeviceSettings",
- "documentation": "The settings that you want to apply to the HD input device."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "The name that you assigned to this input device (not the unique ID)."
- },
- "UhdDeviceSettings": {
- "shape": "InputDeviceConfigurableSettings",
- "locationName": "uhdDeviceSettings",
- "documentation": "The settings that you want to apply to the UHD input device."
- },
- "AvailabilityZone": {
- "shape": "__string",
- "locationName": "availabilityZone",
- "documentation": "The Availability Zone you want associated with this input device."
- }
- },
- "documentation": "Updates an input device."
- },
- "UpdateInputDeviceRequest": {
- "type": "structure",
- "members": {
- "HdDeviceSettings": {
- "shape": "InputDeviceConfigurableSettings",
- "locationName": "hdDeviceSettings",
- "documentation": "The settings that you want to apply to the HD input device."
- },
- "InputDeviceId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputDeviceId",
- "documentation": "The unique ID of the input device. For example, hd-123456789abcdef."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "The name that you assigned to this input device (not the unique ID)."
- },
- "UhdDeviceSettings": {
- "shape": "InputDeviceConfigurableSettings",
- "locationName": "uhdDeviceSettings",
- "documentation": "The settings that you want to apply to the UHD input device."
- },
- "AvailabilityZone": {
- "shape": "__string",
- "locationName": "availabilityZone",
- "documentation": "The Availability Zone you want associated with this input device."
+ "SpliceEventId": {
+ "shape": "__longMin0Max4294967295",
+ "locationName": "spliceEventId",
+ "documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35."
}
},
- "documentation": "A request to update an input device.",
+ "documentation": "Settings for a SCTE-35 return_to_network message.",
"required": [
- "InputDeviceId"
+ "SpliceEventId"
]
},
- "UpdateInputDeviceResponse": {
+ "Scte35SegmentationCancelIndicator": {
+ "type": "string",
+ "documentation": "Corresponds to SCTE-35 segmentation_event_cancel_indicator. SEGMENTATION_EVENT_NOT_CANCELED corresponds to 0 in the SCTE-35 specification and indicates that this is an insertion request. SEGMENTATION_EVENT_CANCELED corresponds to 1 in the SCTE-35 specification and indicates that this is a cancelation request, in which case complete this field and the existing event ID to cancel.",
+ "enum": [
+ "SEGMENTATION_EVENT_NOT_CANCELED",
+ "SEGMENTATION_EVENT_CANCELED"
+ ]
+ },
+ "Scte35SegmentationDescriptor": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__string",
- "locationName": "arn",
- "documentation": "The unique ARN of the input device."
- },
- "ConnectionState": {
- "shape": "InputDeviceConnectionState",
- "locationName": "connectionState",
- "documentation": "The state of the connection between the input device and AWS."
- },
- "DeviceSettingsSyncState": {
- "shape": "DeviceSettingsSyncState",
- "locationName": "deviceSettingsSyncState",
- "documentation": "The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration."
- },
- "DeviceUpdateStatus": {
- "shape": "DeviceUpdateStatus",
- "locationName": "deviceUpdateStatus",
- "documentation": "The status of software on the input device."
+ "DeliveryRestrictions": {
+ "shape": "Scte35DeliveryRestrictions",
+ "locationName": "deliveryRestrictions",
+ "documentation": "Holds the four SCTE-35 delivery restriction parameters."
},
- "HdDeviceSettings": {
- "shape": "InputDeviceHdSettings",
- "locationName": "hdDeviceSettings",
- "documentation": "Settings that describe an input device that is type HD."
+ "SegmentNum": {
+ "shape": "__integerMin0Max255",
+ "locationName": "segmentNum",
+ "documentation": "Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id."
},
- "Id": {
- "shape": "__string",
- "locationName": "id",
- "documentation": "The unique ID of the input device."
+ "SegmentationCancelIndicator": {
+ "shape": "Scte35SegmentationCancelIndicator",
+ "locationName": "segmentationCancelIndicator",
+ "documentation": "Corresponds to SCTE-35 segmentation_event_cancel_indicator."
},
- "MacAddress": {
- "shape": "__string",
- "locationName": "macAddress",
- "documentation": "The network MAC address of the input device."
+ "SegmentationDuration": {
+ "shape": "__longMin0Max1099511627775",
+ "locationName": "segmentationDuration",
+ "documentation": "Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message."
},
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "A name that you specify for the input device."
+ "SegmentationEventId": {
+ "shape": "__longMin0Max4294967295",
+ "locationName": "segmentationEventId",
+ "documentation": "Corresponds to SCTE-35 segmentation_event_id. "
},
- "NetworkSettings": {
- "shape": "InputDeviceNetworkSettings",
- "locationName": "networkSettings",
- "documentation": "The network settings for the input device."
+ "SegmentationTypeId": {
+ "shape": "__integerMin0Max255",
+ "locationName": "segmentationTypeId",
+ "documentation": "Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, \"52\"). In the CLI, API, or an SDK, enter the ID in hex (for example, \"0x34\") or decimal (for example, \"52\")."
},
- "SerialNumber": {
+ "SegmentationUpid": {
"shape": "__string",
- "locationName": "serialNumber",
- "documentation": "The unique serial number of the input device."
- },
- "Type": {
- "shape": "InputDeviceType",
- "locationName": "type",
- "documentation": "The type of the input device."
- },
- "UhdDeviceSettings": {
- "shape": "InputDeviceUhdSettings",
- "locationName": "uhdDeviceSettings",
- "documentation": "Settings that describe an input device that is type UHD."
+ "locationName": "segmentationUpid",
+ "documentation": "Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII \"ADS Information\" becomes hex \"41445320496e666f726d6174696f6e."
},
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "SegmentationUpidType": {
+ "shape": "__integerMin0Max255",
+ "locationName": "segmentationUpidType",
+ "documentation": "Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, \"0x0C\" hex from the specification is \"12\" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, \"0x0C\" ) or in decimal (for example, \"12\")."
},
- "AvailabilityZone": {
- "shape": "__string",
- "locationName": "availabilityZone",
- "documentation": "The Availability Zone associated with this input device."
+ "SegmentsExpected": {
+ "shape": "__integerMin0Max255",
+ "locationName": "segmentsExpected",
+ "documentation": "Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id."
},
- "MedialiveInputArns": {
- "shape": "__listOf__string",
- "locationName": "medialiveInputArns",
- "documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT."
+ "SubSegmentNum": {
+ "shape": "__integerMin0Max255",
+ "locationName": "subSegmentNum",
+ "documentation": "Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id."
},
- "OutputType": {
- "shape": "InputDeviceOutputType",
- "locationName": "outputType",
- "documentation": "The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input."
+ "SubSegmentsExpected": {
+ "shape": "__integerMin0Max255",
+ "locationName": "subSegmentsExpected",
+ "documentation": "Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id."
}
},
- "documentation": "Placeholder documentation for UpdateInputDeviceResponse"
+ "documentation": "Corresponds to SCTE-35 segmentation_descriptor.",
+ "required": [
+ "SegmentationEventId",
+ "SegmentationCancelIndicator"
+ ]
},
- "UpdateInputRequest": {
+ "Scte35SpliceInsert": {
"type": "structure",
"members": {
- "Destinations": {
- "shape": "__listOfInputDestinationRequest",
- "locationName": "destinations",
- "documentation": "Destination settings for PUSH type inputs."
- },
- "InputDevices": {
- "shape": "__listOfInputDeviceRequest",
- "locationName": "inputDevices",
- "documentation": "Settings for the devices."
- },
- "InputId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputId",
- "documentation": "Unique ID of the input."
- },
- "InputSecurityGroups": {
- "shape": "__listOf__string",
- "locationName": "inputSecurityGroups",
- "documentation": "A list of security groups referenced by IDs to attach to the input."
- },
- "MediaConnectFlows": {
- "shape": "__listOfMediaConnectFlowRequest",
- "locationName": "mediaConnectFlows",
- "documentation": "A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of the input."
- },
- "RoleArn": {
- "shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
+ "AdAvailOffset": {
+ "shape": "__integerMinNegative1000Max1000",
+ "locationName": "adAvailOffset",
+ "documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages."
},
- "Sources": {
- "shape": "__listOfInputSourceRequest",
- "locationName": "sources",
- "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty."
+ "NoRegionalBlackoutFlag": {
+ "shape": "Scte35SpliceInsertNoRegionalBlackoutBehavior",
+ "locationName": "noRegionalBlackoutFlag",
+ "documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates"
},
- "SrtSettings": {
- "shape": "SrtSettingsRequest",
- "locationName": "srtSettings",
- "documentation": "The settings associated with an SRT input."
+ "WebDeliveryAllowedFlag": {
+ "shape": "Scte35SpliceInsertWebDeliveryAllowedBehavior",
+ "locationName": "webDeliveryAllowedFlag",
+ "documentation": "When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates"
}
},
- "documentation": "A request to update an input.",
- "required": [
- "InputId"
+ "documentation": "Typical configuration that applies breaks on splice inserts in addition to time signal placement opportunities, breaks, and advertisements."
+ },
+ "Scte35SpliceInsertNoRegionalBlackoutBehavior": {
+ "type": "string",
+ "documentation": "Scte35 Splice Insert No Regional Blackout Behavior",
+ "enum": [
+ "FOLLOW",
+ "IGNORE"
]
},
- "UpdateInputResponse": {
+ "Scte35SpliceInsertScheduleActionSettings": {
"type": "structure",
"members": {
- "Input": {
- "shape": "Input",
- "locationName": "input"
- }
- },
- "documentation": "Placeholder documentation for UpdateInputResponse"
- },
- "UpdateInputResultModel": {
- "type": "structure",
- "members": {
- "Input": {
- "shape": "Input",
- "locationName": "input"
- }
- },
- "documentation": "Placeholder documentation for UpdateInputResultModel"
- },
- "UpdateInputSecurityGroupRequest": {
- "type": "structure",
- "members": {
- "InputSecurityGroupId": {
- "shape": "__string",
- "location": "uri",
- "locationName": "inputSecurityGroupId",
- "documentation": "The id of the Input Security Group to update."
- },
- "Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
+ "Duration": {
+ "shape": "__longMin0Max8589934591",
+ "locationName": "duration",
+ "documentation": "Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time."
},
- "WhitelistRules": {
- "shape": "__listOfInputWhitelistRuleCidr",
- "locationName": "whitelistRules",
- "documentation": "List of IPv4 CIDR addresses to whitelist"
+ "SpliceEventId": {
+ "shape": "__longMin0Max4294967295",
+ "locationName": "spliceEventId",
+ "documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35."
}
},
- "documentation": "The request to update some combination of the Input Security Group name and the IPv4 CIDRs the Input Security Group should allow.",
+ "documentation": "Settings for a SCTE-35 splice_insert message.",
"required": [
- "InputSecurityGroupId"
+ "SpliceEventId"
]
},
- "UpdateInputSecurityGroupResponse": {
- "type": "structure",
- "members": {
- "SecurityGroup": {
- "shape": "InputSecurityGroup",
- "locationName": "securityGroup"
- }
- },
- "documentation": "Placeholder documentation for UpdateInputSecurityGroupResponse"
+ "Scte35SpliceInsertWebDeliveryAllowedBehavior": {
+ "type": "string",
+ "documentation": "Scte35 Splice Insert Web Delivery Allowed Behavior",
+ "enum": [
+ "FOLLOW",
+ "IGNORE"
+ ]
},
- "UpdateInputSecurityGroupResultModel": {
+ "Scte35TimeSignalApos": {
"type": "structure",
"members": {
- "SecurityGroup": {
- "shape": "InputSecurityGroup",
- "locationName": "securityGroup"
+ "AdAvailOffset": {
+ "shape": "__integerMinNegative1000Max1000",
+ "locationName": "adAvailOffset",
+ "documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages."
+ },
+ "NoRegionalBlackoutFlag": {
+ "shape": "Scte35AposNoRegionalBlackoutBehavior",
+ "locationName": "noRegionalBlackoutFlag",
+ "documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates"
+ },
+ "WebDeliveryAllowedFlag": {
+ "shape": "Scte35AposWebDeliveryAllowedBehavior",
+ "locationName": "webDeliveryAllowedFlag",
+ "documentation": "When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates"
}
},
- "documentation": "Placeholder documentation for UpdateInputSecurityGroupResultModel"
+ "documentation": "Atypical configuration that applies segment breaks only on SCTE-35 time signal placement opportunities and breaks."
},
- "UpdateMultiplex": {
+ "Scte35TimeSignalScheduleActionSettings": {
"type": "structure",
"members": {
- "MultiplexSettings": {
- "shape": "MultiplexSettings",
- "locationName": "multiplexSettings",
- "documentation": "The new settings for a multiplex."
- },
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of the multiplex."
- },
- "PacketIdentifiersMapping": {
- "shape": "MultiplexPacketIdentifiersMapping",
- "locationName": "packetIdentifiersMapping"
+ "Scte35Descriptors": {
+ "shape": "__listOfScte35Descriptor",
+ "locationName": "scte35Descriptors",
+ "documentation": "The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal."
}
},
- "documentation": "Placeholder documentation for UpdateMultiplex"
+ "documentation": "Settings for a SCTE-35 time_signal.",
+ "required": [
+ "Scte35Descriptors"
+ ]
},
- "UpdateMultiplexProgram": {
+ "Scte35WebDeliveryAllowedFlag": {
+ "type": "string",
+ "documentation": "Corresponds to the web_delivery_allowed_flag parameter. A value of WEB_DELIVERY_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the \"restriction\" flags then you must include all four of them.",
+ "enum": [
+ "WEB_DELIVERY_NOT_ALLOWED",
+ "WEB_DELIVERY_ALLOWED"
+ ]
+ },
+ "SmoothGroupAudioOnlyTimecodeControl": {
+ "type": "string",
+ "documentation": "Smooth Group Audio Only Timecode Control",
+ "enum": [
+ "PASSTHROUGH",
+ "USE_CONFIGURED_CLOCK"
+ ]
+ },
+ "SmoothGroupCertificateMode": {
+ "type": "string",
+ "documentation": "Smooth Group Certificate Mode",
+ "enum": [
+ "SELF_SIGNED",
+ "VERIFY_AUTHENTICITY"
+ ]
+ },
+ "SmoothGroupEventIdMode": {
+ "type": "string",
+ "documentation": "Smooth Group Event Id Mode",
+ "enum": [
+ "NO_EVENT_ID",
+ "USE_CONFIGURED",
+ "USE_TIMESTAMP"
+ ]
+ },
+ "SmoothGroupEventStopBehavior": {
+ "type": "string",
+ "documentation": "Smooth Group Event Stop Behavior",
+ "enum": [
+ "NONE",
+ "SEND_EOS"
+ ]
+ },
+ "SmoothGroupSegmentationMode": {
+ "type": "string",
+ "documentation": "Smooth Group Segmentation Mode",
+ "enum": [
+ "USE_INPUT_SEGMENTATION",
+ "USE_SEGMENT_DURATION"
+ ]
+ },
+ "SmoothGroupSparseTrackType": {
+ "type": "string",
+ "documentation": "Smooth Group Sparse Track Type",
+ "enum": [
+ "NONE",
+ "SCTE_35",
+ "SCTE_35_WITHOUT_SEGMENTATION"
+ ]
+ },
+ "SmoothGroupStreamManifestBehavior": {
+ "type": "string",
+ "documentation": "Smooth Group Stream Manifest Behavior",
+ "enum": [
+ "DO_NOT_SEND",
+ "SEND"
+ ]
+ },
+ "SmoothGroupTimestampOffsetMode": {
+ "type": "string",
+ "documentation": "Smooth Group Timestamp Offset Mode",
+ "enum": [
+ "USE_CONFIGURED_OFFSET",
+ "USE_EVENT_START_DATE"
+ ]
+ },
+ "Smpte2038DataPreference": {
+ "type": "string",
+ "documentation": "Smpte2038 Data Preference",
+ "enum": [
+ "IGNORE",
+ "PREFER"
+ ]
+ },
+ "SmpteTtDestinationSettings": {
"type": "structure",
"members": {
- "MultiplexProgramSettings": {
- "shape": "MultiplexProgramSettings",
- "locationName": "multiplexProgramSettings",
- "documentation": "The new settings for a multiplex program."
- }
},
- "documentation": "Placeholder documentation for UpdateMultiplexProgram"
+ "documentation": "Smpte Tt Destination Settings"
},
- "UpdateMultiplexProgramRequest": {
+ "StandardHlsSettings": {
"type": "structure",
"members": {
- "MultiplexId": {
+ "AudioRenditionSets": {
"shape": "__string",
- "location": "uri",
- "locationName": "multiplexId",
- "documentation": "The ID of the multiplex of the program to update."
- },
- "MultiplexProgramSettings": {
- "shape": "MultiplexProgramSettings",
- "locationName": "multiplexProgramSettings",
- "documentation": "The new settings for a multiplex program."
+ "locationName": "audioRenditionSets",
+ "documentation": "List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','."
},
- "ProgramName": {
- "shape": "__string",
- "location": "uri",
- "locationName": "programName",
- "documentation": "The name of the program to update."
+ "M3u8Settings": {
+ "shape": "M3u8Settings",
+ "locationName": "m3u8Settings"
}
},
- "documentation": "A request to update a program in a multiplex.",
+ "documentation": "Standard Hls Settings",
"required": [
- "MultiplexId",
- "ProgramName"
+ "M3u8Settings"
]
},
- "UpdateMultiplexProgramResponse": {
- "type": "structure",
- "members": {
- "MultiplexProgram": {
- "shape": "MultiplexProgram",
- "locationName": "multiplexProgram",
- "documentation": "The updated multiplex program."
- }
- },
- "documentation": "Placeholder documentation for UpdateMultiplexProgramResponse"
- },
- "UpdateMultiplexProgramResultModel": {
+ "StartChannelRequest": {
"type": "structure",
"members": {
- "MultiplexProgram": {
- "shape": "MultiplexProgram",
- "locationName": "multiplexProgram",
- "documentation": "The updated multiplex program."
+ "ChannelId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelId",
+ "documentation": "A request to start a channel"
}
},
- "documentation": "Placeholder documentation for UpdateMultiplexProgramResultModel"
+ "required": [
+ "ChannelId"
+ ],
+ "documentation": "Placeholder documentation for StartChannelRequest"
},
- "UpdateMultiplexRequest": {
+ "StartChannelResponse": {
"type": "structure",
"members": {
- "MultiplexId": {
+ "Arn": {
"shape": "__string",
- "location": "uri",
- "locationName": "multiplexId",
- "documentation": "ID of the multiplex to update."
+ "locationName": "arn",
+ "documentation": "The unique arn of the channel."
},
- "MultiplexSettings": {
- "shape": "MultiplexSettings",
- "locationName": "multiplexSettings",
- "documentation": "The new settings for a multiplex."
+ "CdiInputSpecification": {
+ "shape": "CdiInputSpecification",
+ "locationName": "cdiInputSpecification",
+ "documentation": "Specification of CDI inputs for this channel"
+ },
+ "ChannelClass": {
+ "shape": "ChannelClass",
+ "locationName": "channelClass",
+ "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
+ },
+ "Destinations": {
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
+ },
+ "EgressEndpoints": {
+ "shape": "__listOfChannelEgressEndpoint",
+ "locationName": "egressEndpoints",
+ "documentation": "The endpoints where outgoing connections initiate from"
+ },
+ "EncoderSettings": {
+ "shape": "EncoderSettings",
+ "locationName": "encoderSettings"
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique id of the channel."
+ },
+ "InputAttachments": {
+ "shape": "__listOfInputAttachment",
+ "locationName": "inputAttachments",
+ "documentation": "List of input attachments for channel."
+ },
+ "InputSpecification": {
+ "shape": "InputSpecification",
+ "locationName": "inputSpecification",
+ "documentation": "Specification of network and file inputs for this channel"
+ },
+ "LogLevel": {
+ "shape": "LogLevel",
+ "locationName": "logLevel",
+ "documentation": "The log level being written to CloudWatch Logs."
+ },
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
},
"Name": {
"shape": "__string",
"locationName": "name",
- "documentation": "Name of the multiplex."
+ "documentation": "The name of the channel. (user-mutable)"
},
- "PacketIdentifiersMapping": {
- "shape": "MultiplexPacketIdentifiersMapping",
- "locationName": "packetIdentifiersMapping"
- }
- },
- "documentation": "A request to update a multiplex.",
- "required": [
- "MultiplexId"
- ]
- },
- "UpdateMultiplexResponse": {
- "type": "structure",
- "members": {
- "Multiplex": {
- "shape": "Multiplex",
- "locationName": "multiplex",
- "documentation": "The updated multiplex."
+ "PipelineDetails": {
+ "shape": "__listOfPipelineDetail",
+ "locationName": "pipelineDetails",
+ "documentation": "Runtime details for the pipelines of a running channel."
+ },
+ "PipelinesRunningCount": {
+ "shape": "__integer",
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
+ },
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
+ },
+ "State": {
+ "shape": "ChannelState",
+ "locationName": "state"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "Vpc": {
+ "shape": "VpcOutputSettingsDescription",
+ "locationName": "vpc",
+ "documentation": "Settings for VPC output"
+ },
+ "AnywhereSettings": {
+ "shape": "DescribeAnywhereSettings",
+ "locationName": "anywhereSettings",
+ "documentation": "Anywhere settings for this channel."
}
},
- "documentation": "Placeholder documentation for UpdateMultiplexResponse"
+ "documentation": "Placeholder documentation for StartChannelResponse"
},
- "UpdateMultiplexResultModel": {
+ "StartInputDeviceMaintenanceWindowRequest": {
"type": "structure",
"members": {
- "Multiplex": {
- "shape": "Multiplex",
- "locationName": "multiplex",
- "documentation": "The updated multiplex."
+ "InputDeviceId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputDeviceId",
+ "documentation": "The unique ID of the input device to start a maintenance window for. For example, hd-123456789abcdef."
}
},
- "documentation": "Placeholder documentation for UpdateMultiplexResultModel"
+ "required": [
+ "InputDeviceId"
+ ],
+ "documentation": "Placeholder documentation for StartInputDeviceMaintenanceWindowRequest"
},
- "UpdateReservation": {
+ "StartInputDeviceMaintenanceWindowResponse": {
"type": "structure",
"members": {
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of the reservation"
- },
- "RenewalSettings": {
- "shape": "RenewalSettings",
- "locationName": "renewalSettings",
- "documentation": "Renewal settings for the reservation"
- }
},
- "documentation": "UpdateReservation request"
+ "documentation": "Placeholder documentation for StartInputDeviceMaintenanceWindowResponse"
},
- "UpdateReservationRequest": {
+ "StartInputDeviceRequest": {
"type": "structure",
"members": {
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "Name of the reservation"
- },
- "RenewalSettings": {
- "shape": "RenewalSettings",
- "locationName": "renewalSettings",
- "documentation": "Renewal settings for the reservation"
- },
- "ReservationId": {
+ "InputDeviceId": {
"shape": "__string",
"location": "uri",
- "locationName": "reservationId",
- "documentation": "Unique reservation ID, e.g. '1234567'"
+ "locationName": "inputDeviceId",
+ "documentation": "The unique ID of the input device to start. For example, hd-123456789abcdef."
}
},
- "documentation": "Request to update a reservation",
"required": [
- "ReservationId"
- ]
+ "InputDeviceId"
+ ],
+ "documentation": "Placeholder documentation for StartInputDeviceRequest"
},
- "UpdateReservationResponse": {
+ "StartInputDeviceResponse": {
"type": "structure",
"members": {
- "Reservation": {
- "shape": "Reservation",
- "locationName": "reservation"
- }
},
- "documentation": "Placeholder documentation for UpdateReservationResponse"
+ "documentation": "Placeholder documentation for StartInputDeviceResponse"
},
- "UpdateReservationResultModel": {
+ "StartMultiplexRequest": {
"type": "structure",
"members": {
- "Reservation": {
- "shape": "Reservation",
- "locationName": "reservation"
+ "MultiplexId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "multiplexId",
+ "documentation": "The ID of the multiplex."
}
},
- "documentation": "UpdateReservation response"
+ "required": [
+ "MultiplexId"
+ ],
+ "documentation": "Placeholder documentation for StartMultiplexRequest"
},
- "ValidationError": {
+ "StartMultiplexResponse": {
"type": "structure",
"members": {
- "ElementPath": {
+ "Arn": {
"shape": "__string",
- "locationName": "elementPath",
- "documentation": "Path to the source of the error."
+ "locationName": "arn",
+ "documentation": "The unique arn of the multiplex."
},
- "ErrorMessage": {
+ "AvailabilityZones": {
+ "shape": "__listOf__string",
+ "locationName": "availabilityZones",
+ "documentation": "A list of availability zones for the multiplex."
+ },
+ "Destinations": {
+ "shape": "__listOfMultiplexOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of the multiplex output destinations."
+ },
+ "Id": {
"shape": "__string",
- "locationName": "errorMessage",
- "documentation": "The error message."
+ "locationName": "id",
+ "documentation": "The unique id of the multiplex."
+ },
+ "MultiplexSettings": {
+ "shape": "MultiplexSettings",
+ "locationName": "multiplexSettings",
+ "documentation": "Configuration for a multiplex event."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the multiplex."
+ },
+ "PipelinesRunningCount": {
+ "shape": "__integer",
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
+ },
+ "ProgramCount": {
+ "shape": "__integer",
+ "locationName": "programCount",
+ "documentation": "The number of programs in the multiplex."
+ },
+ "State": {
+ "shape": "MultiplexState",
+ "locationName": "state",
+ "documentation": "The current state of the multiplex."
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
}
},
- "documentation": "Placeholder documentation for ValidationError"
+ "documentation": "Placeholder documentation for StartMultiplexResponse"
},
- "VideoBlackFailoverSettings": {
+ "StartTimecode": {
"type": "structure",
"members": {
- "BlackDetectThreshold": {
- "shape": "__doubleMin0Max1",
- "locationName": "blackDetectThreshold",
- "documentation": "A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023*0.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255*0.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places."
- },
- "VideoBlackThresholdMsec": {
- "shape": "__integerMin1000",
- "locationName": "videoBlackThresholdMsec",
- "documentation": "The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs."
+ "Timecode": {
+ "shape": "__string",
+ "locationName": "timecode",
+ "documentation": "The timecode for the frame where you want to start the clip. Optional; if not specified, the clip starts at first frame in the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF."
}
},
- "documentation": "Placeholder documentation for VideoBlackFailoverSettings"
+ "documentation": "Settings to identify the start of the clip."
},
- "VideoCodecSettings": {
+ "StaticImageActivateScheduleActionSettings": {
"type": "structure",
"members": {
- "FrameCaptureSettings": {
- "shape": "FrameCaptureSettings",
- "locationName": "frameCaptureSettings"
- },
- "H264Settings": {
- "shape": "H264Settings",
- "locationName": "h264Settings"
+ "Duration": {
+ "shape": "__integerMin0",
+ "locationName": "duration",
+ "documentation": "The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated."
},
- "H265Settings": {
- "shape": "H265Settings",
- "locationName": "h265Settings"
+ "FadeIn": {
+ "shape": "__integerMin0",
+ "locationName": "fadeIn",
+ "documentation": "The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in)."
},
- "Mpeg2Settings": {
- "shape": "Mpeg2Settings",
- "locationName": "mpeg2Settings"
+ "FadeOut": {
+ "shape": "__integerMin0",
+ "locationName": "fadeOut",
+ "documentation": "Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out)."
+ },
+ "Height": {
+ "shape": "__integerMin1",
+ "locationName": "height",
+ "documentation": "The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay."
+ },
+ "Image": {
+ "shape": "InputLocation",
+ "locationName": "image",
+ "documentation": "The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video."
+ },
+ "ImageX": {
+ "shape": "__integerMin0",
+ "locationName": "imageX",
+ "documentation": "Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right."
+ },
+ "ImageY": {
+ "shape": "__integerMin0",
+ "locationName": "imageY",
+ "documentation": "Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom."
+ },
+ "Layer": {
+ "shape": "__integerMin0Max7",
+ "locationName": "layer",
+ "documentation": "The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0."
+ },
+ "Opacity": {
+ "shape": "__integerMin0Max100",
+ "locationName": "opacity",
+ "documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100."
+ },
+ "Width": {
+ "shape": "__integerMin1",
+ "locationName": "width",
+ "documentation": "The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay."
}
},
- "documentation": "Video Codec Settings"
+ "documentation": "Settings for the action to activate a static image.",
+ "required": [
+ "Image"
+ ]
},
- "VideoDescription": {
+ "StaticImageDeactivateScheduleActionSettings": {
"type": "structure",
"members": {
- "CodecSettings": {
- "shape": "VideoCodecSettings",
- "locationName": "codecSettings",
- "documentation": "Video codec settings."
+ "FadeOut": {
+ "shape": "__integerMin0",
+ "locationName": "fadeOut",
+ "documentation": "The time in milliseconds for the image to fade out. Default is 0 (no fade-out)."
+ },
+ "Layer": {
+ "shape": "__integerMin0Max7",
+ "locationName": "layer",
+ "documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0."
+ }
+ },
+ "documentation": "Settings for the action to deactivate the image in a specific layer."
+ },
+ "StaticImageOutputActivateScheduleActionSettings": {
+ "type": "structure",
+ "members": {
+ "Duration": {
+ "shape": "__integerMin0",
+ "locationName": "duration",
+ "documentation": "The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated."
+ },
+ "FadeIn": {
+ "shape": "__integerMin0",
+ "locationName": "fadeIn",
+ "documentation": "The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in)."
+ },
+ "FadeOut": {
+ "shape": "__integerMin0",
+ "locationName": "fadeOut",
+ "documentation": "Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out)."
},
"Height": {
- "shape": "__integer",
+ "shape": "__integerMin1",
"locationName": "height",
- "documentation": "Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required."
+ "documentation": "The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay."
},
- "Name": {
- "shape": "__string",
- "locationName": "name",
- "documentation": "The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event."
+ "Image": {
+ "shape": "InputLocation",
+ "locationName": "image",
+ "documentation": "The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video."
},
- "RespondToAfd": {
- "shape": "VideoDescriptionRespondToAfd",
- "locationName": "respondToAfd",
- "documentation": "Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH.\nRESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE.\nPASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output.\nNONE: MediaLive does not clip the input video and does not include the AFD values in the output"
+ "ImageX": {
+ "shape": "__integerMin0",
+ "locationName": "imageX",
+ "documentation": "Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right."
},
- "ScalingBehavior": {
- "shape": "VideoDescriptionScalingBehavior",
- "locationName": "scalingBehavior",
- "documentation": "STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution."
+ "ImageY": {
+ "shape": "__integerMin0",
+ "locationName": "imageY",
+ "documentation": "Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom."
},
- "Sharpness": {
+ "Layer": {
+ "shape": "__integerMin0Max7",
+ "locationName": "layer",
+ "documentation": "The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0."
+ },
+ "Opacity": {
"shape": "__integerMin0Max100",
- "locationName": "sharpness",
- "documentation": "Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content."
+ "locationName": "opacity",
+ "documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100."
+ },
+ "OutputNames": {
+ "shape": "__listOf__string",
+ "locationName": "outputNames",
+ "documentation": "The name(s) of the output(s) the activation should apply to."
},
"Width": {
- "shape": "__integer",
+ "shape": "__integerMin1",
"locationName": "width",
- "documentation": "Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required."
+ "documentation": "The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay."
}
},
- "documentation": "Video settings for this stream.",
+ "documentation": "Settings for the action to activate a static image.",
"required": [
- "Name"
- ]
- },
- "VideoDescriptionRespondToAfd": {
- "type": "string",
- "documentation": "Video Description Respond To Afd",
- "enum": [
- "NONE",
- "PASSTHROUGH",
- "RESPOND"
- ]
- },
- "VideoDescriptionScalingBehavior": {
- "type": "string",
- "documentation": "Video Description Scaling Behavior",
- "enum": [
- "DEFAULT",
- "STRETCH_TO_OUTPUT"
+ "OutputNames",
+ "Image"
]
},
- "VideoSelector": {
+ "StaticImageOutputDeactivateScheduleActionSettings": {
"type": "structure",
"members": {
- "ColorSpace": {
- "shape": "VideoSelectorColorSpace",
- "locationName": "colorSpace",
- "documentation": "Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed."
- },
- "ColorSpaceSettings": {
- "shape": "VideoSelectorColorSpaceSettings",
- "locationName": "colorSpaceSettings",
- "documentation": "Color space settings"
+ "FadeOut": {
+ "shape": "__integerMin0",
+ "locationName": "fadeOut",
+ "documentation": "The time in milliseconds for the image to fade out. Default is 0 (no fade-out)."
},
- "ColorSpaceUsage": {
- "shape": "VideoSelectorColorSpaceUsage",
- "locationName": "colorSpaceUsage",
- "documentation": "Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data."
+ "Layer": {
+ "shape": "__integerMin0Max7",
+ "locationName": "layer",
+ "documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0."
},
- "SelectorSettings": {
- "shape": "VideoSelectorSettings",
- "locationName": "selectorSettings",
- "documentation": "The video selector settings."
+ "OutputNames": {
+ "shape": "__listOf__string",
+ "locationName": "outputNames",
+ "documentation": "The name(s) of the output(s) the deactivation should apply to."
}
},
- "documentation": "Specifies a particular video stream within an input source. An input may have only a single video selector."
- },
- "VideoSelectorColorSpace": {
- "type": "string",
- "documentation": "Video Selector Color Space",
- "enum": [
- "FOLLOW",
- "HDR10",
- "HLG_2020",
- "REC_601",
- "REC_709"
+ "documentation": "Settings for the action to deactivate the image in a specific layer.",
+ "required": [
+ "OutputNames"
]
},
- "VideoSelectorColorSpaceSettings": {
+ "StaticKeySettings": {
"type": "structure",
"members": {
- "Hdr10Settings": {
- "shape": "Hdr10Settings",
- "locationName": "hdr10Settings"
+ "KeyProviderServer": {
+ "shape": "InputLocation",
+ "locationName": "keyProviderServer",
+ "documentation": "The URL of the license server used for protecting content."
+ },
+ "StaticKeyValue": {
+ "shape": "__stringMin32Max32",
+ "locationName": "staticKeyValue",
+ "documentation": "Static key value as a 32 character hexadecimal string."
}
},
- "documentation": "Video Selector Color Space Settings"
- },
- "VideoSelectorColorSpaceUsage": {
- "type": "string",
- "documentation": "Video Selector Color Space Usage",
- "enum": [
- "FALLBACK",
- "FORCE"
+ "documentation": "Static Key Settings",
+ "required": [
+ "StaticKeyValue"
]
},
- "VideoSelectorPid": {
+ "StopChannelRequest": {
"type": "structure",
"members": {
- "Pid": {
- "shape": "__integerMin0Max8191",
- "locationName": "pid",
- "documentation": "Selects a specific PID from within a video source."
+ "ChannelId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelId",
+ "documentation": "A request to stop a running channel"
}
},
- "documentation": "Video Selector Pid"
+ "required": [
+ "ChannelId"
+ ],
+ "documentation": "Placeholder documentation for StopChannelRequest"
},
- "VideoSelectorProgramId": {
+ "StopChannelResponse": {
"type": "structure",
"members": {
- "ProgramId": {
- "shape": "__integerMin0Max65536",
- "locationName": "programId",
- "documentation": "Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default."
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The unique arn of the channel."
+ },
+ "CdiInputSpecification": {
+ "shape": "CdiInputSpecification",
+ "locationName": "cdiInputSpecification",
+ "documentation": "Specification of CDI inputs for this channel"
+ },
+ "ChannelClass": {
+ "shape": "ChannelClass",
+ "locationName": "channelClass",
+ "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
+ },
+ "Destinations": {
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
+ },
+ "EgressEndpoints": {
+ "shape": "__listOfChannelEgressEndpoint",
+ "locationName": "egressEndpoints",
+ "documentation": "The endpoints where outgoing connections initiate from"
+ },
+ "EncoderSettings": {
+ "shape": "EncoderSettings",
+ "locationName": "encoderSettings"
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique id of the channel."
+ },
+ "InputAttachments": {
+ "shape": "__listOfInputAttachment",
+ "locationName": "inputAttachments",
+ "documentation": "List of input attachments for channel."
+ },
+ "InputSpecification": {
+ "shape": "InputSpecification",
+ "locationName": "inputSpecification",
+ "documentation": "Specification of network and file inputs for this channel"
+ },
+ "LogLevel": {
+ "shape": "LogLevel",
+ "locationName": "logLevel",
+ "documentation": "The log level being written to CloudWatch Logs."
+ },
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the channel. (user-mutable)"
+ },
+ "PipelineDetails": {
+ "shape": "__listOfPipelineDetail",
+ "locationName": "pipelineDetails",
+ "documentation": "Runtime details for the pipelines of a running channel."
+ },
+ "PipelinesRunningCount": {
+ "shape": "__integer",
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
+ },
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
+ },
+ "State": {
+ "shape": "ChannelState",
+ "locationName": "state"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "Vpc": {
+ "shape": "VpcOutputSettingsDescription",
+ "locationName": "vpc",
+ "documentation": "Settings for VPC output"
+ },
+ "AnywhereSettings": {
+ "shape": "DescribeAnywhereSettings",
+ "locationName": "anywhereSettings",
+ "documentation": "Anywhere settings for this channel."
}
},
- "documentation": "Video Selector Program Id"
+ "documentation": "Placeholder documentation for StopChannelResponse"
},
- "VideoSelectorSettings": {
+ "StopInputDeviceRequest": {
"type": "structure",
"members": {
- "VideoSelectorPid": {
- "shape": "VideoSelectorPid",
- "locationName": "videoSelectorPid"
- },
- "VideoSelectorProgramId": {
- "shape": "VideoSelectorProgramId",
- "locationName": "videoSelectorProgramId"
+ "InputDeviceId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputDeviceId",
+ "documentation": "The unique ID of the input device to stop. For example, hd-123456789abcdef."
}
},
- "documentation": "Video Selector Settings"
+ "required": [
+ "InputDeviceId"
+ ],
+ "documentation": "Placeholder documentation for StopInputDeviceRequest"
},
- "VpcOutputSettings": {
+ "StopInputDeviceResponse": {
"type": "structure",
"members": {
- "PublicAddressAllocationIds": {
- "shape": "__listOf__string",
- "locationName": "publicAddressAllocationIds",
- "documentation": "List of public address allocation ids to associate with ENIs that will be created in Output VPC.\nMust specify one for SINGLE_PIPELINE, two for STANDARD channels"
- },
- "SecurityGroupIds": {
- "shape": "__listOf__string",
- "locationName": "securityGroupIds",
- "documentation": "A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network interfaces.\nIf none are specified then the VPC default security group will be used"
- },
- "SubnetIds": {
- "shape": "__listOf__string",
- "locationName": "subnetIds",
- "documentation": "A list of VPC subnet IDs from the same VPC.\nIf STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ)."
+ },
+ "documentation": "Placeholder documentation for StopInputDeviceResponse"
+ },
+ "StopMultiplexRequest": {
+ "type": "structure",
+ "members": {
+ "MultiplexId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "multiplexId",
+ "documentation": "The ID of the multiplex."
}
},
- "documentation": "The properties for a private VPC Output\nWhen this property is specified, the output egress addresses will be created in a user specified VPC",
"required": [
- "SubnetIds"
- ]
+ "MultiplexId"
+ ],
+ "documentation": "Placeholder documentation for StopMultiplexRequest"
},
- "VpcOutputSettingsDescription": {
+ "StopMultiplexResponse": {
"type": "structure",
"members": {
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The unique arn of the multiplex."
+ },
"AvailabilityZones": {
"shape": "__listOf__string",
"locationName": "availabilityZones",
- "documentation": "The Availability Zones where the vpc subnets are located.\nThe first Availability Zone applies to the first subnet in the list of subnets.\nThe second Availability Zone applies to the second subnet."
+ "documentation": "A list of availability zones for the multiplex."
},
- "NetworkInterfaceIds": {
- "shape": "__listOf__string",
- "locationName": "networkInterfaceIds",
- "documentation": "A list of Elastic Network Interfaces created by MediaLive in the customer's VPC"
+ "Destinations": {
+ "shape": "__listOfMultiplexOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of the multiplex output destinations."
},
- "SecurityGroupIds": {
- "shape": "__listOf__string",
- "locationName": "securityGroupIds",
- "documentation": "A list of up EC2 VPC security group IDs attached to the Output VPC network interfaces."
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique id of the multiplex."
},
- "SubnetIds": {
- "shape": "__listOf__string",
- "locationName": "subnetIds",
- "documentation": "A list of VPC subnet IDs from the same VPC.\nIf STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ)."
+ "MultiplexSettings": {
+ "shape": "MultiplexSettings",
+ "locationName": "multiplexSettings",
+ "documentation": "Configuration for a multiplex event."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the multiplex."
+ },
+ "PipelinesRunningCount": {
+ "shape": "__integer",
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
+ },
+ "ProgramCount": {
+ "shape": "__integer",
+ "locationName": "programCount",
+ "documentation": "The number of programs in the multiplex."
+ },
+ "State": {
+ "shape": "MultiplexState",
+ "locationName": "state",
+ "documentation": "The current state of the multiplex."
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
}
},
- "documentation": "The properties for a private VPC Output"
- },
- "WavCodingMode": {
- "type": "string",
- "documentation": "Wav Coding Mode",
- "enum": [
- "CODING_MODE_1_0",
- "CODING_MODE_2_0",
- "CODING_MODE_4_0",
- "CODING_MODE_8_0"
- ]
+ "documentation": "Placeholder documentation for StopMultiplexResponse"
},
- "WavSettings": {
+ "StopTimecode": {
"type": "structure",
"members": {
- "BitDepth": {
- "shape": "__double",
- "locationName": "bitDepth",
- "documentation": "Bits per sample."
- },
- "CodingMode": {
- "shape": "WavCodingMode",
- "locationName": "codingMode",
- "documentation": "The audio coding mode for the WAV audio. The mode determines the number of channels in the audio."
+ "LastFrameClippingBehavior": {
+ "shape": "LastFrameClippingBehavior",
+ "locationName": "lastFrameClippingBehavior",
+ "documentation": "If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode."
},
- "SampleRate": {
- "shape": "__double",
- "locationName": "sampleRate",
- "documentation": "Sample rate in Hz."
+ "Timecode": {
+ "shape": "__string",
+ "locationName": "timecode",
+ "documentation": "The timecode for the frame where you want to stop the clip. Optional; if not specified, the clip continues to the end of the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF."
}
},
- "documentation": "Wav Settings"
+ "documentation": "Settings to identify the end of the clip."
},
- "WebvttDestinationSettings": {
- "type": "structure",
- "members": {
- "StyleControl": {
- "shape": "WebvttDestinationStyleControl",
- "locationName": "styleControl",
- "documentation": "Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO_STYLE_DATA - Don't pass through the style. The output captions will not contain any font styling information."
- }
+ "Tags": {
+ "type": "map",
+ "key": {
+ "shape": "__string"
},
- "documentation": "Webvtt Destination Settings"
+ "value": {
+ "shape": "__string"
+ },
+ "documentation": "Placeholder documentation for Tags"
},
- "WebvttDestinationStyleControl": {
+ "TagsModel": {
+ "type": "structure",
+ "members": {
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ },
+ "documentation": "Placeholder documentation for TagsModel"
+ },
+ "TeletextDestinationSettings": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Teletext Destination Settings"
+ },
+ "TeletextSourceSettings": {
+ "type": "structure",
+ "members": {
+ "OutputRectangle": {
+ "shape": "CaptionRectangle",
+ "locationName": "outputRectangle",
+ "documentation": "Optionally defines a region where TTML style captions will be displayed"
+ },
+ "PageNumber": {
+ "shape": "__string",
+ "locationName": "pageNumber",
+ "documentation": "Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no \"0x\" prefix."
+ }
+ },
+ "documentation": "Teletext Source Settings"
+ },
+ "TemporalFilterPostFilterSharpening": {
"type": "string",
- "documentation": "Webvtt Destination Style Control",
+ "documentation": "Temporal Filter Post Filter Sharpening",
"enum": [
- "NO_STYLE_DATA",
- "PASSTHROUGH"
+ "AUTO",
+ "DISABLED",
+ "ENABLED"
]
},
- "__boolean": {
- "type": "boolean",
- "documentation": "Placeholder documentation for __boolean"
- },
- "__double": {
- "type": "double",
- "documentation": "Placeholder documentation for __double"
- },
- "__doubleMin0": {
- "type": "double",
- "documentation": "Placeholder documentation for __doubleMin0"
+ "TemporalFilterSettings": {
+ "type": "structure",
+ "members": {
+ "PostFilterSharpening": {
+ "shape": "TemporalFilterPostFilterSharpening",
+ "locationName": "postFilterSharpening",
+ "documentation": "If you enable this filter, the results are the following:\n- If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source.\n- If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR."
+ },
+ "Strength": {
+ "shape": "TemporalFilterStrength",
+ "locationName": "strength",
+ "documentation": "Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft."
+ }
+ },
+ "documentation": "Temporal Filter Settings"
},
- "__doubleMin0Max1": {
- "type": "double",
- "documentation": "Placeholder documentation for __doubleMin0Max1"
+ "TemporalFilterStrength": {
+ "type": "string",
+ "documentation": "Temporal Filter Strength",
+ "enum": [
+ "AUTO",
+ "STRENGTH_1",
+ "STRENGTH_2",
+ "STRENGTH_3",
+ "STRENGTH_4",
+ "STRENGTH_5",
+ "STRENGTH_6",
+ "STRENGTH_7",
+ "STRENGTH_8",
+ "STRENGTH_9",
+ "STRENGTH_10",
+ "STRENGTH_11",
+ "STRENGTH_12",
+ "STRENGTH_13",
+ "STRENGTH_14",
+ "STRENGTH_15",
+ "STRENGTH_16"
+ ]
},
- "__doubleMin0Max100": {
- "type": "double",
- "documentation": "Placeholder documentation for __doubleMin0Max100"
+ "Thumbnail": {
+ "type": "structure",
+ "members": {
+ "Body": {
+ "shape": "__string",
+ "locationName": "body",
+ "documentation": "The binary data for the latest thumbnail."
+ },
+ "ContentType": {
+ "shape": "__string",
+ "locationName": "contentType",
+ "documentation": "The content type for the latest thumbnail."
+ },
+ "ThumbnailType": {
+ "shape": "ThumbnailType",
+ "locationName": "thumbnailType",
+ "documentation": "Thumbnail Type"
+ },
+ "TimeStamp": {
+ "shape": "__timestampIso8601",
+ "locationName": "timeStamp",
+ "documentation": "Time stamp for the latest thumbnail."
+ }
+ },
+ "documentation": "Details of a single thumbnail"
},
- "__doubleMin0Max5000": {
- "type": "double",
- "documentation": "Placeholder documentation for __doubleMin0Max5000"
+ "ThumbnailConfiguration": {
+ "type": "structure",
+ "members": {
+ "State": {
+ "shape": "ThumbnailState",
+ "locationName": "state",
+ "documentation": "Enables the thumbnail feature. The feature generates thumbnails of the incoming video in each pipeline in the channel. AUTO turns the feature on, DISABLE turns the feature off."
+ }
+ },
+ "documentation": "Thumbnail Configuration",
+ "required": [
+ "State"
+ ]
},
- "__doubleMin1": {
- "type": "double",
- "documentation": "Placeholder documentation for __doubleMin1"
+ "ThumbnailData": {
+ "type": "structure",
+ "members": {
+ "Body": {
+ "shape": "__string",
+ "locationName": "body",
+ "documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive."
+ }
+ },
+ "documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive."
},
- "__doubleMin1Max65535": {
- "type": "double",
- "documentation": "Placeholder documentation for __doubleMin1Max65535"
+ "ThumbnailDetail": {
+ "type": "structure",
+ "members": {
+ "PipelineId": {
+ "shape": "__string",
+ "locationName": "pipelineId",
+ "documentation": "Pipeline ID"
+ },
+ "Thumbnails": {
+ "shape": "__listOfThumbnail",
+ "locationName": "thumbnails",
+ "documentation": "thumbnails of a single pipeline"
+ }
+ },
+ "documentation": "Thumbnail details for one pipeline of a running channel."
},
- "__doubleMin250Max5000": {
- "type": "double",
- "documentation": "Placeholder documentation for __doubleMin250Max5000"
+ "ThumbnailNoData": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Response when thumbnail has no data. It should have no message."
},
- "__doubleMin32Max46": {
- "type": "double",
- "documentation": "Placeholder documentation for __doubleMin32Max46"
+ "ThumbnailState": {
+ "type": "string",
+ "documentation": "Thumbnail State",
+ "enum": [
+ "AUTO",
+ "DISABLED"
+ ]
},
- "__doubleMinNegative1Max5": {
- "type": "double",
- "documentation": "Placeholder documentation for __doubleMinNegative1Max5"
+ "ThumbnailType": {
+ "type": "string",
+ "documentation": "Thumbnail type.",
+ "enum": [
+ "UNSPECIFIED",
+ "CURRENT_ACTIVE"
+ ]
},
- "__doubleMinNegative59Max0": {
- "type": "double",
- "documentation": "Placeholder documentation for __doubleMinNegative59Max0"
+ "TimecodeBurninFontSize": {
+ "type": "string",
+ "documentation": "Timecode Burnin Font Size",
+ "enum": [
+ "EXTRA_SMALL_10",
+ "LARGE_48",
+ "MEDIUM_32",
+ "SMALL_16"
+ ]
},
- "__integer": {
- "type": "integer",
- "documentation": "Placeholder documentation for __integer"
+ "TimecodeBurninPosition": {
+ "type": "string",
+ "documentation": "Timecode Burnin Position",
+ "enum": [
+ "BOTTOM_CENTER",
+ "BOTTOM_LEFT",
+ "BOTTOM_RIGHT",
+ "MIDDLE_CENTER",
+ "MIDDLE_LEFT",
+ "MIDDLE_RIGHT",
+ "TOP_CENTER",
+ "TOP_LEFT",
+ "TOP_RIGHT"
+ ]
},
- "__integerMin0": {
- "type": "integer",
- "min": 0,
- "documentation": "Placeholder documentation for __integerMin0"
+ "TimecodeBurninSettings": {
+ "type": "structure",
+ "members": {
+ "FontSize": {
+ "shape": "TimecodeBurninFontSize",
+ "locationName": "fontSize",
+ "documentation": "Choose a timecode burn-in font size"
+ },
+ "Position": {
+ "shape": "TimecodeBurninPosition",
+ "locationName": "position",
+ "documentation": "Choose a timecode burn-in output position"
+ },
+ "Prefix": {
+ "shape": "__stringMax255",
+ "locationName": "prefix",
+ "documentation": "Create a timecode burn-in prefix (optional)"
+ }
+ },
+ "documentation": "Timecode Burnin Settings",
+ "required": [
+ "Position",
+ "FontSize"
+ ]
},
- "__integerMin0Max10": {
- "type": "integer",
- "min": 0,
- "max": 10,
- "documentation": "Placeholder documentation for __integerMin0Max10"
- },
- "__integerMin0Max100": {
- "type": "integer",
- "min": 0,
- "max": 100,
- "documentation": "Placeholder documentation for __integerMin0Max100"
+ "TimecodeConfig": {
+ "type": "structure",
+ "members": {
+ "Source": {
+ "shape": "TimecodeConfigSource",
+ "locationName": "source",
+ "documentation": "Identifies the source for the timecode that will be associated with the events outputs.\n-Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using \"Start at 0\" (zerobased).\n-System Clock (systemclock): Use the UTC time.\n-Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00."
+ },
+ "SyncThreshold": {
+ "shape": "__integerMin1Max1000000",
+ "locationName": "syncThreshold",
+ "documentation": "Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified."
+ }
+ },
+ "documentation": "Timecode Config",
+ "required": [
+ "Source"
+ ]
},
- "__integerMin0Max1000": {
- "type": "integer",
- "min": 0,
- "max": 1000,
- "documentation": "Placeholder documentation for __integerMin0Max1000"
+ "TimecodeConfigSource": {
+ "type": "string",
+ "documentation": "Timecode Config Source",
+ "enum": [
+ "EMBEDDED",
+ "SYSTEMCLOCK",
+ "ZEROBASED"
+ ]
},
- "__integerMin0Max10000": {
- "type": "integer",
- "min": 0,
- "max": 10000,
- "documentation": "Placeholder documentation for __integerMin0Max10000"
+ "TooManyRequestsException": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ },
+ "exception": true,
+ "error": {
+ "httpStatusCode": 429
+ },
+ "documentation": "Placeholder documentation for TooManyRequestsException"
},
- "__integerMin0Max1000000": {
- "type": "integer",
- "min": 0,
- "max": 1000000,
- "documentation": "Placeholder documentation for __integerMin0Max1000000"
+ "TransferInputDevice": {
+ "type": "structure",
+ "members": {
+ "TargetCustomerId": {
+ "shape": "__string",
+ "locationName": "targetCustomerId",
+ "documentation": "The AWS account ID (12 digits) for the recipient of the device transfer."
+ },
+ "TargetRegion": {
+ "shape": "__string",
+ "locationName": "targetRegion",
+ "documentation": "The target AWS region to transfer the device."
+ },
+ "TransferMessage": {
+ "shape": "__string",
+ "locationName": "transferMessage",
+ "documentation": "An optional message for the recipient. Maximum 280 characters."
+ }
+ },
+ "documentation": "The transfer details of the input device."
},
- "__integerMin0Max100000000": {
- "type": "integer",
- "min": 0,
- "max": 100000000,
- "documentation": "Placeholder documentation for __integerMin0Max100000000"
+ "TransferInputDeviceRequest": {
+ "type": "structure",
+ "members": {
+ "InputDeviceId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputDeviceId",
+ "documentation": "The unique ID of this input device. For example, hd-123456789abcdef."
+ },
+ "TargetCustomerId": {
+ "shape": "__string",
+ "locationName": "targetCustomerId",
+ "documentation": "The AWS account ID (12 digits) for the recipient of the device transfer."
+ },
+ "TargetRegion": {
+ "shape": "__string",
+ "locationName": "targetRegion",
+ "documentation": "The target AWS region to transfer the device."
+ },
+ "TransferMessage": {
+ "shape": "__string",
+ "locationName": "transferMessage",
+ "documentation": "An optional message for the recipient. Maximum 280 characters."
+ }
+ },
+ "documentation": "A request to transfer an input device.",
+ "required": [
+ "InputDeviceId"
+ ]
},
- "__integerMin0Max128": {
- "type": "integer",
- "min": 0,
- "max": 128,
- "documentation": "Placeholder documentation for __integerMin0Max128"
+ "TransferInputDeviceResponse": {
+ "type": "structure",
+ "members": {
+ },
+ "documentation": "Placeholder documentation for TransferInputDeviceResponse"
},
- "__integerMin0Max15": {
- "type": "integer",
- "min": 0,
- "max": 15,
- "documentation": "Placeholder documentation for __integerMin0Max15"
+ "TransferringInputDeviceSummary": {
+ "type": "structure",
+ "members": {
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique ID of the input device."
+ },
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "The optional message that the sender has attached to the transfer."
+ },
+ "TargetCustomerId": {
+ "shape": "__string",
+ "locationName": "targetCustomerId",
+ "documentation": "The AWS account ID for the recipient of the input device transfer."
+ },
+ "TransferType": {
+ "shape": "InputDeviceTransferType",
+ "locationName": "transferType",
+ "documentation": "The type (direction) of the input device transfer."
+ }
+ },
+ "documentation": "Details about the input device that is being transferred."
},
- "__integerMin0Max2000": {
- "type": "integer",
- "min": 0,
- "max": 2000,
- "documentation": "Placeholder documentation for __integerMin0Max2000"
+ "TtmlDestinationSettings": {
+ "type": "structure",
+ "members": {
+ "StyleControl": {
+ "shape": "TtmlDestinationStyleControl",
+ "locationName": "styleControl",
+ "documentation": "This field is not currently supported and will not affect the output styling. Leave the default value."
+ }
+ },
+ "documentation": "Ttml Destination Settings"
},
- "__integerMin0Max255": {
- "type": "integer",
- "min": 0,
- "max": 255,
- "documentation": "Placeholder documentation for __integerMin0Max255"
+ "TtmlDestinationStyleControl": {
+ "type": "string",
+ "documentation": "Ttml Destination Style Control",
+ "enum": [
+ "PASSTHROUGH",
+ "USE_CONFIGURED"
+ ]
},
- "__integerMin0Max30": {
- "type": "integer",
- "min": 0,
- "max": 30,
- "documentation": "Placeholder documentation for __integerMin0Max30"
+ "UdpContainerSettings": {
+ "type": "structure",
+ "members": {
+ "M2tsSettings": {
+ "shape": "M2tsSettings",
+ "locationName": "m2tsSettings"
+ }
+ },
+ "documentation": "Udp Container Settings"
},
- "__integerMin0Max32768": {
- "type": "integer",
- "min": 0,
- "max": 32768,
- "documentation": "Placeholder documentation for __integerMin0Max32768"
+ "UdpGroupSettings": {
+ "type": "structure",
+ "members": {
+ "InputLossAction": {
+ "shape": "InputLossActionForUdpOut",
+ "locationName": "inputLossAction",
+ "documentation": "Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video."
+ },
+ "TimedMetadataId3Frame": {
+ "shape": "UdpTimedMetadataId3Frame",
+ "locationName": "timedMetadataId3Frame",
+ "documentation": "Indicates ID3 frame that has the timecode."
+ },
+ "TimedMetadataId3Period": {
+ "shape": "__integerMin0",
+ "locationName": "timedMetadataId3Period",
+ "documentation": "Timed Metadata interval in seconds."
+ }
+ },
+ "documentation": "Udp Group Settings"
},
- "__integerMin0Max3600": {
- "type": "integer",
- "min": 0,
- "max": 3600,
- "documentation": "Placeholder documentation for __integerMin0Max3600"
+ "UdpOutputSettings": {
+ "type": "structure",
+ "members": {
+ "BufferMsec": {
+ "shape": "__integerMin0Max10000",
+ "locationName": "bufferMsec",
+ "documentation": "UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc."
+ },
+ "ContainerSettings": {
+ "shape": "UdpContainerSettings",
+ "locationName": "containerSettings"
+ },
+ "Destination": {
+ "shape": "OutputLocationRef",
+ "locationName": "destination",
+ "documentation": "Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002)."
+ },
+ "FecOutputSettings": {
+ "shape": "FecOutputSettings",
+ "locationName": "fecOutputSettings",
+ "documentation": "Settings for enabling and adjusting Forward Error Correction on UDP outputs."
+ }
+ },
+ "documentation": "Udp Output Settings",
+ "required": [
+ "Destination",
+ "ContainerSettings"
+ ]
},
- "__integerMin0Max500": {
- "type": "integer",
- "min": 0,
- "max": 500,
- "documentation": "Placeholder documentation for __integerMin0Max500"
- },
- "__integerMin0Max600": {
- "type": "integer",
- "min": 0,
- "max": 600,
- "documentation": "Placeholder documentation for __integerMin0Max600"
- },
- "__integerMin0Max65535": {
- "type": "integer",
- "min": 0,
- "max": 65535,
- "documentation": "Placeholder documentation for __integerMin0Max65535"
- },
- "__integerMin0Max65536": {
- "type": "integer",
- "min": 0,
- "max": 65536,
- "documentation": "Placeholder documentation for __integerMin0Max65536"
- },
- "__integerMin0Max7": {
- "type": "integer",
- "min": 0,
- "max": 7,
- "documentation": "Placeholder documentation for __integerMin0Max7"
- },
- "__integerMin0Max8191": {
- "type": "integer",
- "min": 0,
- "max": 8191,
- "documentation": "Placeholder documentation for __integerMin0Max8191"
- },
- "__integerMin1": {
- "type": "integer",
- "min": 1,
- "documentation": "Placeholder documentation for __integerMin1"
- },
- "__integerMin100": {
- "type": "integer",
- "min": 100,
- "documentation": "Placeholder documentation for __integerMin100"
- },
- "__integerMin1000": {
- "type": "integer",
- "min": 1000,
- "documentation": "Placeholder documentation for __integerMin1000"
+ "UdpTimedMetadataId3Frame": {
+ "type": "string",
+ "documentation": "Udp Timed Metadata Id3 Frame",
+ "enum": [
+ "NONE",
+ "PRIV",
+ "TDRL"
+ ]
},
- "__integerMin1000000Max100000000": {
- "type": "integer",
- "min": 1000000,
- "max": 100000000,
- "documentation": "Placeholder documentation for __integerMin1000000Max100000000"
+ "UnprocessableEntityException": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "The error message."
+ },
+ "ValidationErrors": {
+ "shape": "__listOfValidationError",
+ "locationName": "validationErrors",
+ "documentation": "A collection of validation error responses."
+ }
+ },
+ "exception": true,
+ "error": {
+ "httpStatusCode": 422
+ },
+ "documentation": "Placeholder documentation for UnprocessableEntityException"
},
- "__integerMin100000Max100000000": {
- "type": "integer",
- "min": 100000,
- "max": 100000000,
- "documentation": "Placeholder documentation for __integerMin100000Max100000000"
+ "UpdateAccountConfigurationRequest": {
+ "type": "structure",
+ "members": {
+ "AccountConfiguration": {
+ "shape": "AccountConfiguration",
+ "locationName": "accountConfiguration"
+ }
+ },
+ "documentation": "List of account configuration parameters to update."
},
- "__integerMin100000Max40000000": {
- "type": "integer",
- "min": 100000,
- "max": 40000000,
- "documentation": "Placeholder documentation for __integerMin100000Max40000000"
+ "UpdateAccountConfigurationRequestModel": {
+ "type": "structure",
+ "members": {
+ "AccountConfiguration": {
+ "shape": "AccountConfiguration",
+ "locationName": "accountConfiguration"
+ }
+ },
+ "documentation": "The desired new account configuration."
},
- "__integerMin100000Max80000000": {
- "type": "integer",
- "min": 100000,
- "max": 80000000,
- "documentation": "Placeholder documentation for __integerMin100000Max80000000"
+ "UpdateAccountConfigurationResponse": {
+ "type": "structure",
+ "members": {
+ "AccountConfiguration": {
+ "shape": "AccountConfiguration",
+ "locationName": "accountConfiguration"
+ }
+ },
+ "documentation": "Placeholder documentation for UpdateAccountConfigurationResponse"
},
- "__integerMin1000Max30000": {
- "type": "integer",
- "min": 1000,
- "max": 30000,
- "documentation": "Placeholder documentation for __integerMin1000Max30000"
+ "UpdateAccountConfigurationResultModel": {
+ "type": "structure",
+ "members": {
+ "AccountConfiguration": {
+ "shape": "AccountConfiguration",
+ "locationName": "accountConfiguration"
+ }
+ },
+ "documentation": "The account's updated configuration."
},
- "__integerMin1Max10": {
- "type": "integer",
- "min": 1,
- "max": 10,
- "documentation": "Placeholder documentation for __integerMin1Max10"
+ "UpdateChannel": {
+ "type": "structure",
+ "members": {
+ "CdiInputSpecification": {
+ "shape": "CdiInputSpecification",
+ "locationName": "cdiInputSpecification",
+ "documentation": "Specification of CDI inputs for this channel"
+ },
+ "Destinations": {
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of output destinations for this channel."
+ },
+ "EncoderSettings": {
+ "shape": "EncoderSettings",
+ "locationName": "encoderSettings",
+ "documentation": "The encoder settings for this channel."
+ },
+ "InputAttachments": {
+ "shape": "__listOfInputAttachment",
+ "locationName": "inputAttachments"
+ },
+ "InputSpecification": {
+ "shape": "InputSpecification",
+ "locationName": "inputSpecification",
+ "documentation": "Specification of network and file inputs for this channel"
+ },
+ "LogLevel": {
+ "shape": "LogLevel",
+ "locationName": "logLevel",
+ "documentation": "The log level to write to CloudWatch Logs."
+ },
+ "Maintenance": {
+ "shape": "MaintenanceUpdateSettings",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the channel."
+ },
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed."
+ }
+ },
+ "documentation": "Placeholder documentation for UpdateChannel"
},
- "__integerMin1Max1000000": {
- "type": "integer",
- "min": 1,
- "max": 1000000,
- "documentation": "Placeholder documentation for __integerMin1Max1000000"
+ "UpdateChannelClass": {
+ "type": "structure",
+ "members": {
+ "ChannelClass": {
+ "shape": "ChannelClass",
+ "locationName": "channelClass",
+ "documentation": "The channel class that you wish to update this channel to use."
+ },
+ "Destinations": {
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of output destinations for this channel."
+ }
+ },
+ "required": [
+ "ChannelClass"
+ ],
+ "documentation": "Placeholder documentation for UpdateChannelClass"
},
- "__integerMin1Max16": {
- "type": "integer",
- "min": 1,
- "max": 16,
- "documentation": "Placeholder documentation for __integerMin1Max16"
+ "UpdateChannelClassRequest": {
+ "type": "structure",
+ "members": {
+ "ChannelClass": {
+ "shape": "ChannelClass",
+ "locationName": "channelClass",
+ "documentation": "The channel class that you wish to update this channel to use."
+ },
+ "ChannelId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelId",
+ "documentation": "Channel Id of the channel whose class should be updated."
+ },
+ "Destinations": {
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of output destinations for this channel."
+ }
+ },
+ "documentation": "Channel class that the channel should be updated to.",
+ "required": [
+ "ChannelId",
+ "ChannelClass"
+ ]
},
- "__integerMin1Max20": {
- "type": "integer",
- "min": 1,
- "max": 20,
- "documentation": "Placeholder documentation for __integerMin1Max20"
+ "UpdateChannelClassResponse": {
+ "type": "structure",
+ "members": {
+ "Channel": {
+ "shape": "Channel",
+ "locationName": "channel"
+ }
+ },
+ "documentation": "Placeholder documentation for UpdateChannelClassResponse"
},
- "__integerMin1Max3003": {
- "type": "integer",
- "min": 1,
- "max": 3003,
- "documentation": "Placeholder documentation for __integerMin1Max3003"
- },
- "__integerMin1Max31": {
- "type": "integer",
- "min": 1,
- "max": 31,
- "documentation": "Placeholder documentation for __integerMin1Max31"
- },
- "__integerMin1Max32": {
- "type": "integer",
- "min": 1,
- "max": 32,
- "documentation": "Placeholder documentation for __integerMin1Max32"
- },
- "__integerMin1Max3600000": {
- "type": "integer",
- "min": 1,
- "max": 3600000,
- "documentation": "Placeholder documentation for __integerMin1Max3600000"
- },
- "__integerMin1Max4": {
- "type": "integer",
- "min": 1,
- "max": 4,
- "documentation": "Placeholder documentation for __integerMin1Max4"
- },
- "__integerMin1Max5": {
- "type": "integer",
- "min": 1,
- "max": 5,
- "documentation": "Placeholder documentation for __integerMin1Max5"
- },
- "__integerMin1Max6": {
- "type": "integer",
- "min": 1,
- "max": 6,
- "documentation": "Placeholder documentation for __integerMin1Max6"
- },
- "__integerMin1Max8": {
- "type": "integer",
- "min": 1,
- "max": 8,
- "documentation": "Placeholder documentation for __integerMin1Max8"
- },
- "__integerMin25Max10000": {
- "type": "integer",
- "min": 25,
- "max": 10000,
- "documentation": "Placeholder documentation for __integerMin25Max10000"
- },
- "__integerMin25Max2000": {
- "type": "integer",
- "min": 25,
- "max": 2000,
- "documentation": "Placeholder documentation for __integerMin25Max2000"
- },
- "__integerMin3": {
- "type": "integer",
- "min": 3,
- "documentation": "Placeholder documentation for __integerMin3"
- },
- "__integerMin30": {
- "type": "integer",
- "min": 30,
- "documentation": "Placeholder documentation for __integerMin30"
- },
- "__integerMin32Max8191": {
- "type": "integer",
- "min": 32,
- "max": 8191,
- "documentation": "Placeholder documentation for __integerMin32Max8191"
- },
- "__integerMin4Max20": {
- "type": "integer",
- "min": 4,
- "max": 20,
- "documentation": "Placeholder documentation for __integerMin4Max20"
- },
- "__integerMin800Max3000": {
- "type": "integer",
- "min": 800,
- "max": 3000,
- "documentation": "Placeholder documentation for __integerMin800Max3000"
- },
- "__integerMin96Max600": {
- "type": "integer",
- "min": 96,
- "max": 600,
- "documentation": "Placeholder documentation for __integerMin96Max600"
- },
- "__integerMinNegative1000Max1000": {
- "type": "integer",
- "min": -1000,
- "max": 1000,
- "documentation": "Placeholder documentation for __integerMinNegative1000Max1000"
- },
- "__integerMinNegative5Max5": {
- "type": "integer",
- "min": -5,
- "max": 5,
- "documentation": "Placeholder documentation for __integerMinNegative5Max5"
- },
- "__integerMinNegative60Max6": {
- "type": "integer",
- "min": -60,
- "max": 6,
- "documentation": "Placeholder documentation for __integerMinNegative60Max6"
- },
- "__integerMinNegative60Max60": {
- "type": "integer",
- "min": -60,
- "max": 60,
- "documentation": "Placeholder documentation for __integerMinNegative60Max60"
- },
- "__listOfAudioChannelMapping": {
- "type": "list",
- "member": {
- "shape": "AudioChannelMapping"
+ "UpdateChannelRequest": {
+ "type": "structure",
+ "members": {
+ "CdiInputSpecification": {
+ "shape": "CdiInputSpecification",
+ "locationName": "cdiInputSpecification",
+ "documentation": "Specification of CDI inputs for this channel"
+ },
+ "ChannelId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelId",
+ "documentation": "channel ID"
+ },
+ "Destinations": {
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of output destinations for this channel."
+ },
+ "EncoderSettings": {
+ "shape": "EncoderSettings",
+ "locationName": "encoderSettings",
+ "documentation": "The encoder settings for this channel."
+ },
+ "InputAttachments": {
+ "shape": "__listOfInputAttachment",
+ "locationName": "inputAttachments"
+ },
+ "InputSpecification": {
+ "shape": "InputSpecification",
+ "locationName": "inputSpecification",
+ "documentation": "Specification of network and file inputs for this channel"
+ },
+ "LogLevel": {
+ "shape": "LogLevel",
+ "locationName": "logLevel",
+ "documentation": "The log level to write to CloudWatch Logs."
+ },
+ "Maintenance": {
+ "shape": "MaintenanceUpdateSettings",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the channel."
+ },
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed."
+ }
},
- "documentation": "Placeholder documentation for __listOfAudioChannelMapping"
+ "documentation": "A request to update a channel.",
+ "required": [
+ "ChannelId"
+ ]
},
- "__listOfAudioDescription": {
- "type": "list",
- "member": {
- "shape": "AudioDescription"
+ "UpdateChannelResponse": {
+ "type": "structure",
+ "members": {
+ "Channel": {
+ "shape": "Channel",
+ "locationName": "channel"
+ }
},
- "documentation": "Placeholder documentation for __listOfAudioDescription"
+ "documentation": "Placeholder documentation for UpdateChannelResponse"
},
- "__listOfAudioSelector": {
- "type": "list",
- "member": {
- "shape": "AudioSelector"
+ "UpdateChannelResultModel": {
+ "type": "structure",
+ "members": {
+ "Channel": {
+ "shape": "Channel",
+ "locationName": "channel"
+ }
},
- "documentation": "Placeholder documentation for __listOfAudioSelector"
+ "documentation": "The updated channel's description."
},
- "__listOfAudioTrack": {
- "type": "list",
- "member": {
- "shape": "AudioTrack"
+ "UpdateInput": {
+ "type": "structure",
+ "members": {
+ "Destinations": {
+ "shape": "__listOfInputDestinationRequest",
+ "locationName": "destinations",
+ "documentation": "Destination settings for PUSH type inputs."
+ },
+ "InputDevices": {
+ "shape": "__listOfInputDeviceRequest",
+ "locationName": "inputDevices",
+ "documentation": "Settings for the devices."
+ },
+ "InputSecurityGroups": {
+ "shape": "__listOf__string",
+ "locationName": "inputSecurityGroups",
+ "documentation": "A list of security groups referenced by IDs to attach to the input."
+ },
+ "MediaConnectFlows": {
+ "shape": "__listOfMediaConnectFlowRequest",
+ "locationName": "mediaConnectFlows",
+ "documentation": "A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "Name of the input."
+ },
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
+ },
+ "Sources": {
+ "shape": "__listOfInputSourceRequest",
+ "locationName": "sources",
+ "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty."
+ },
+ "SrtSettings": {
+ "shape": "SrtSettingsRequest",
+ "locationName": "srtSettings",
+ "documentation": "The settings associated with an SRT input."
+ },
+ "MulticastSettings": {
+ "shape": "MulticastSettingsUpdateRequest",
+ "locationName": "multicastSettings",
+ "documentation": "Multicast Input settings."
+ }
},
- "documentation": "Placeholder documentation for __listOfAudioTrack"
+ "documentation": "Placeholder documentation for UpdateInput"
},
- "__listOfBatchFailedResultModel": {
- "type": "list",
- "member": {
- "shape": "BatchFailedResultModel"
- },
- "documentation": "Placeholder documentation for __listOfBatchFailedResultModel"
- },
- "__listOfBatchSuccessfulResultModel": {
- "type": "list",
- "member": {
- "shape": "BatchSuccessfulResultModel"
- },
- "documentation": "Placeholder documentation for __listOfBatchSuccessfulResultModel"
- },
- "__listOfCaptionDescription": {
- "type": "list",
- "member": {
- "shape": "CaptionDescription"
+ "UpdateInputDevice": {
+ "type": "structure",
+ "members": {
+ "HdDeviceSettings": {
+ "shape": "InputDeviceConfigurableSettings",
+ "locationName": "hdDeviceSettings",
+ "documentation": "The settings that you want to apply to the HD input device."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you assigned to this input device (not the unique ID)."
+ },
+ "UhdDeviceSettings": {
+ "shape": "InputDeviceConfigurableSettings",
+ "locationName": "uhdDeviceSettings",
+ "documentation": "The settings that you want to apply to the UHD input device."
+ },
+ "AvailabilityZone": {
+ "shape": "__string",
+ "locationName": "availabilityZone",
+ "documentation": "The Availability Zone you want associated with this input device."
+ }
},
- "documentation": "Placeholder documentation for __listOfCaptionDescription"
+ "documentation": "Updates an input device."
},
- "__listOfCaptionLanguageMapping": {
- "type": "list",
- "member": {
- "shape": "CaptionLanguageMapping"
+ "UpdateInputDeviceRequest": {
+ "type": "structure",
+ "members": {
+ "HdDeviceSettings": {
+ "shape": "InputDeviceConfigurableSettings",
+ "locationName": "hdDeviceSettings",
+ "documentation": "The settings that you want to apply to the HD input device."
+ },
+ "InputDeviceId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputDeviceId",
+ "documentation": "The unique ID of the input device. For example, hd-123456789abcdef."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you assigned to this input device (not the unique ID)."
+ },
+ "UhdDeviceSettings": {
+ "shape": "InputDeviceConfigurableSettings",
+ "locationName": "uhdDeviceSettings",
+ "documentation": "The settings that you want to apply to the UHD input device."
+ },
+ "AvailabilityZone": {
+ "shape": "__string",
+ "locationName": "availabilityZone",
+ "documentation": "The Availability Zone you want associated with this input device."
+ }
},
- "documentation": "Placeholder documentation for __listOfCaptionLanguageMapping"
+ "documentation": "A request to update an input device.",
+ "required": [
+ "InputDeviceId"
+ ]
},
- "__listOfCaptionSelector": {
- "type": "list",
- "member": {
- "shape": "CaptionSelector"
+ "UpdateInputDeviceResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The unique ARN of the input device."
+ },
+ "ConnectionState": {
+ "shape": "InputDeviceConnectionState",
+ "locationName": "connectionState",
+ "documentation": "The state of the connection between the input device and AWS."
+ },
+ "DeviceSettingsSyncState": {
+ "shape": "DeviceSettingsSyncState",
+ "locationName": "deviceSettingsSyncState",
+ "documentation": "The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration."
+ },
+ "DeviceUpdateStatus": {
+ "shape": "DeviceUpdateStatus",
+ "locationName": "deviceUpdateStatus",
+ "documentation": "The status of software on the input device."
+ },
+ "HdDeviceSettings": {
+ "shape": "InputDeviceHdSettings",
+ "locationName": "hdDeviceSettings",
+ "documentation": "Settings that describe an input device that is type HD."
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique ID of the input device."
+ },
+ "MacAddress": {
+ "shape": "__string",
+ "locationName": "macAddress",
+ "documentation": "The network MAC address of the input device."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "A name that you specify for the input device."
+ },
+ "NetworkSettings": {
+ "shape": "InputDeviceNetworkSettings",
+ "locationName": "networkSettings",
+ "documentation": "The network settings for the input device."
+ },
+ "SerialNumber": {
+ "shape": "__string",
+ "locationName": "serialNumber",
+ "documentation": "The unique serial number of the input device."
+ },
+ "Type": {
+ "shape": "InputDeviceType",
+ "locationName": "type",
+ "documentation": "The type of the input device."
+ },
+ "UhdDeviceSettings": {
+ "shape": "InputDeviceUhdSettings",
+ "locationName": "uhdDeviceSettings",
+ "documentation": "Settings that describe an input device that is type UHD."
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "AvailabilityZone": {
+ "shape": "__string",
+ "locationName": "availabilityZone",
+ "documentation": "The Availability Zone associated with this input device."
+ },
+ "MedialiveInputArns": {
+ "shape": "__listOf__string",
+ "locationName": "medialiveInputArns",
+ "documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT."
+ },
+ "OutputType": {
+ "shape": "InputDeviceOutputType",
+ "locationName": "outputType",
+ "documentation": "The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input."
+ }
},
- "documentation": "Placeholder documentation for __listOfCaptionSelector"
+ "documentation": "Placeholder documentation for UpdateInputDeviceResponse"
},
- "__listOfChannelEgressEndpoint": {
- "type": "list",
- "member": {
- "shape": "ChannelEgressEndpoint"
+ "UpdateInputRequest": {
+ "type": "structure",
+ "members": {
+ "Destinations": {
+ "shape": "__listOfInputDestinationRequest",
+ "locationName": "destinations",
+ "documentation": "Destination settings for PUSH type inputs."
+ },
+ "InputDevices": {
+ "shape": "__listOfInputDeviceRequest",
+ "locationName": "inputDevices",
+ "documentation": "Settings for the devices."
+ },
+ "InputId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputId",
+ "documentation": "Unique ID of the input."
+ },
+ "InputSecurityGroups": {
+ "shape": "__listOf__string",
+ "locationName": "inputSecurityGroups",
+ "documentation": "A list of security groups referenced by IDs to attach to the input."
+ },
+ "MediaConnectFlows": {
+ "shape": "__listOfMediaConnectFlowRequest",
+ "locationName": "mediaConnectFlows",
+ "documentation": "A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "Name of the input."
+ },
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation."
+ },
+ "Sources": {
+ "shape": "__listOfInputSourceRequest",
+ "locationName": "sources",
+ "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty."
+ },
+ "SrtSettings": {
+ "shape": "SrtSettingsRequest",
+ "locationName": "srtSettings",
+ "documentation": "The settings associated with an SRT input."
+ },
+ "MulticastSettings": {
+ "shape": "MulticastSettingsUpdateRequest",
+ "locationName": "multicastSettings",
+ "documentation": "Multicast Input settings."
+ }
},
- "documentation": "Placeholder documentation for __listOfChannelEgressEndpoint"
+ "documentation": "A request to update an input.",
+ "required": [
+ "InputId"
+ ]
},
- "__listOfChannelSummary": {
- "type": "list",
- "member": {
- "shape": "ChannelSummary"
+ "UpdateInputResponse": {
+ "type": "structure",
+ "members": {
+ "Input": {
+ "shape": "Input",
+ "locationName": "input"
+ }
},
- "documentation": "Placeholder documentation for __listOfChannelSummary"
+ "documentation": "Placeholder documentation for UpdateInputResponse"
},
- "__listOfColorCorrection": {
- "type": "list",
- "member": {
- "shape": "ColorCorrection"
+ "UpdateInputResultModel": {
+ "type": "structure",
+ "members": {
+ "Input": {
+ "shape": "Input",
+ "locationName": "input"
+ }
},
- "documentation": "Placeholder documentation for __listOfColorCorrection"
+ "documentation": "Placeholder documentation for UpdateInputResultModel"
},
- "__listOfFailoverCondition": {
- "type": "list",
- "member": {
- "shape": "FailoverCondition"
+ "UpdateInputSecurityGroupRequest": {
+ "type": "structure",
+ "members": {
+ "InputSecurityGroupId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "inputSecurityGroupId",
+ "documentation": "The id of the Input Security Group to update."
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "WhitelistRules": {
+ "shape": "__listOfInputWhitelistRuleCidr",
+ "locationName": "whitelistRules",
+ "documentation": "List of IPv4 CIDR addresses to whitelist"
+ }
},
- "documentation": "Placeholder documentation for __listOfFailoverCondition"
+ "documentation": "The request to update some combination of the Input Security Group name and the IPv4 CIDRs the Input Security Group should allow.",
+ "required": [
+ "InputSecurityGroupId"
+ ]
},
- "__listOfHlsAdMarkers": {
- "type": "list",
- "member": {
- "shape": "HlsAdMarkers"
+ "UpdateInputSecurityGroupResponse": {
+ "type": "structure",
+ "members": {
+ "SecurityGroup": {
+ "shape": "InputSecurityGroup",
+ "locationName": "securityGroup"
+ }
},
- "documentation": "Placeholder documentation for __listOfHlsAdMarkers"
+ "documentation": "Placeholder documentation for UpdateInputSecurityGroupResponse"
},
- "__listOfInput": {
- "type": "list",
- "member": {
- "shape": "Input"
+ "UpdateInputSecurityGroupResultModel": {
+ "type": "structure",
+ "members": {
+ "SecurityGroup": {
+ "shape": "InputSecurityGroup",
+ "locationName": "securityGroup"
+ }
},
- "documentation": "Placeholder documentation for __listOfInput"
+ "documentation": "Placeholder documentation for UpdateInputSecurityGroupResultModel"
},
- "__listOfInputAttachment": {
- "type": "list",
- "member": {
- "shape": "InputAttachment"
+ "UpdateMultiplex": {
+ "type": "structure",
+ "members": {
+ "MultiplexSettings": {
+ "shape": "MultiplexSettings",
+ "locationName": "multiplexSettings",
+ "documentation": "The new settings for a multiplex."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "Name of the multiplex."
+ },
+ "PacketIdentifiersMapping": {
+ "shape": "MultiplexPacketIdentifiersMapping",
+ "locationName": "packetIdentifiersMapping"
+ }
},
- "documentation": "Placeholder documentation for __listOfInputAttachment"
+ "documentation": "Placeholder documentation for UpdateMultiplex"
},
- "__listOfInputChannelLevel": {
- "type": "list",
- "member": {
- "shape": "InputChannelLevel"
+ "UpdateMultiplexProgram": {
+ "type": "structure",
+ "members": {
+ "MultiplexProgramSettings": {
+ "shape": "MultiplexProgramSettings",
+ "locationName": "multiplexProgramSettings",
+ "documentation": "The new settings for a multiplex program."
+ }
},
- "documentation": "Placeholder documentation for __listOfInputChannelLevel"
+ "documentation": "Placeholder documentation for UpdateMultiplexProgram"
},
- "__listOfInputDestination": {
- "type": "list",
- "member": {
- "shape": "InputDestination"
+ "UpdateMultiplexProgramRequest": {
+ "type": "structure",
+ "members": {
+ "MultiplexId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "multiplexId",
+ "documentation": "The ID of the multiplex of the program to update."
+ },
+ "MultiplexProgramSettings": {
+ "shape": "MultiplexProgramSettings",
+ "locationName": "multiplexProgramSettings",
+ "documentation": "The new settings for a multiplex program."
+ },
+ "ProgramName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "programName",
+ "documentation": "The name of the program to update."
+ }
},
- "documentation": "Placeholder documentation for __listOfInputDestination"
+ "documentation": "A request to update a program in a multiplex.",
+ "required": [
+ "MultiplexId",
+ "ProgramName"
+ ]
},
- "__listOfInputDestinationRequest": {
- "type": "list",
- "member": {
- "shape": "InputDestinationRequest"
+ "UpdateMultiplexProgramResponse": {
+ "type": "structure",
+ "members": {
+ "MultiplexProgram": {
+ "shape": "MultiplexProgram",
+ "locationName": "multiplexProgram",
+ "documentation": "The updated multiplex program."
+ }
},
- "documentation": "Placeholder documentation for __listOfInputDestinationRequest"
+ "documentation": "Placeholder documentation for UpdateMultiplexProgramResponse"
},
- "__listOfInputDeviceRequest": {
- "type": "list",
- "member": {
- "shape": "InputDeviceRequest"
+ "UpdateMultiplexProgramResultModel": {
+ "type": "structure",
+ "members": {
+ "MultiplexProgram": {
+ "shape": "MultiplexProgram",
+ "locationName": "multiplexProgram",
+ "documentation": "The updated multiplex program."
+ }
},
- "documentation": "Placeholder documentation for __listOfInputDeviceRequest"
+ "documentation": "Placeholder documentation for UpdateMultiplexProgramResultModel"
},
- "__listOfInputDeviceSettings": {
- "type": "list",
- "member": {
- "shape": "InputDeviceSettings"
+ "UpdateMultiplexRequest": {
+ "type": "structure",
+ "members": {
+ "MultiplexId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "multiplexId",
+ "documentation": "ID of the multiplex to update."
+ },
+ "MultiplexSettings": {
+ "shape": "MultiplexSettings",
+ "locationName": "multiplexSettings",
+ "documentation": "The new settings for a multiplex."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "Name of the multiplex."
+ },
+ "PacketIdentifiersMapping": {
+ "shape": "MultiplexPacketIdentifiersMapping",
+ "locationName": "packetIdentifiersMapping"
+ }
},
- "documentation": "Placeholder documentation for __listOfInputDeviceSettings"
+ "documentation": "A request to update a multiplex.",
+ "required": [
+ "MultiplexId"
+ ]
},
- "__listOfInputDeviceSummary": {
- "type": "list",
- "member": {
- "shape": "InputDeviceSummary"
+ "UpdateMultiplexResponse": {
+ "type": "structure",
+ "members": {
+ "Multiplex": {
+ "shape": "Multiplex",
+ "locationName": "multiplex",
+ "documentation": "The updated multiplex."
+ }
},
- "documentation": "Placeholder documentation for __listOfInputDeviceSummary"
+ "documentation": "Placeholder documentation for UpdateMultiplexResponse"
},
- "__listOfInputSecurityGroup": {
- "type": "list",
- "member": {
- "shape": "InputSecurityGroup"
+ "UpdateMultiplexResultModel": {
+ "type": "structure",
+ "members": {
+ "Multiplex": {
+ "shape": "Multiplex",
+ "locationName": "multiplex",
+ "documentation": "The updated multiplex."
+ }
},
- "documentation": "Placeholder documentation for __listOfInputSecurityGroup"
+ "documentation": "Placeholder documentation for UpdateMultiplexResultModel"
},
- "__listOfInputSource": {
- "type": "list",
- "member": {
- "shape": "InputSource"
+ "UpdateReservation": {
+ "type": "structure",
+ "members": {
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "Name of the reservation"
+ },
+ "RenewalSettings": {
+ "shape": "RenewalSettings",
+ "locationName": "renewalSettings",
+ "documentation": "Renewal settings for the reservation"
+ }
},
- "documentation": "Placeholder documentation for __listOfInputSource"
+ "documentation": "UpdateReservation request"
},
- "__listOfInputSourceRequest": {
- "type": "list",
- "member": {
- "shape": "InputSourceRequest"
+ "UpdateReservationRequest": {
+ "type": "structure",
+ "members": {
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "Name of the reservation"
+ },
+ "RenewalSettings": {
+ "shape": "RenewalSettings",
+ "locationName": "renewalSettings",
+ "documentation": "Renewal settings for the reservation"
+ },
+ "ReservationId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "reservationId",
+ "documentation": "Unique reservation ID, e.g. '1234567'"
+ }
},
- "documentation": "Placeholder documentation for __listOfInputSourceRequest"
+ "documentation": "Request to update a reservation",
+ "required": [
+ "ReservationId"
+ ]
},
- "__listOfInputWhitelistRule": {
- "type": "list",
- "member": {
- "shape": "InputWhitelistRule"
- },
- "documentation": "Placeholder documentation for __listOfInputWhitelistRule"
- },
- "__listOfInputWhitelistRuleCidr": {
- "type": "list",
- "member": {
- "shape": "InputWhitelistRuleCidr"
+ "UpdateReservationResponse": {
+ "type": "structure",
+ "members": {
+ "Reservation": {
+ "shape": "Reservation",
+ "locationName": "reservation"
+ }
},
- "documentation": "Placeholder documentation for __listOfInputWhitelistRuleCidr"
+ "documentation": "Placeholder documentation for UpdateReservationResponse"
},
- "__listOfMediaConnectFlow": {
- "type": "list",
- "member": {
- "shape": "MediaConnectFlow"
+ "UpdateReservationResultModel": {
+ "type": "structure",
+ "members": {
+ "Reservation": {
+ "shape": "Reservation",
+ "locationName": "reservation"
+ }
},
- "documentation": "Placeholder documentation for __listOfMediaConnectFlow"
+ "documentation": "UpdateReservation response"
},
- "__listOfMediaConnectFlowRequest": {
- "type": "list",
- "member": {
- "shape": "MediaConnectFlowRequest"
+ "ValidationError": {
+ "type": "structure",
+ "members": {
+ "ElementPath": {
+ "shape": "__string",
+ "locationName": "elementPath",
+ "documentation": "Path to the source of the error."
+ },
+ "ErrorMessage": {
+ "shape": "__string",
+ "locationName": "errorMessage",
+ "documentation": "The error message."
+ }
},
- "documentation": "Placeholder documentation for __listOfMediaConnectFlowRequest"
+ "documentation": "Placeholder documentation for ValidationError"
},
- "__listOfMediaPackageOutputDestinationSettings": {
- "type": "list",
- "member": {
- "shape": "MediaPackageOutputDestinationSettings"
+ "VideoBlackFailoverSettings": {
+ "type": "structure",
+ "members": {
+ "BlackDetectThreshold": {
+ "shape": "__doubleMin0Max1",
+ "locationName": "blackDetectThreshold",
+ "documentation": "A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023*0.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255*0.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places."
+ },
+ "VideoBlackThresholdMsec": {
+ "shape": "__integerMin1000",
+ "locationName": "videoBlackThresholdMsec",
+ "documentation": "The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs."
+ }
},
- "documentation": "Placeholder documentation for __listOfMediaPackageOutputDestinationSettings"
+ "documentation": "Placeholder documentation for VideoBlackFailoverSettings"
},
- "__listOfMultiplexOutputDestination": {
- "type": "list",
- "member": {
- "shape": "MultiplexOutputDestination"
+ "VideoCodecSettings": {
+ "type": "structure",
+ "members": {
+ "FrameCaptureSettings": {
+ "shape": "FrameCaptureSettings",
+ "locationName": "frameCaptureSettings"
+ },
+ "H264Settings": {
+ "shape": "H264Settings",
+ "locationName": "h264Settings"
+ },
+ "H265Settings": {
+ "shape": "H265Settings",
+ "locationName": "h265Settings"
+ },
+ "Mpeg2Settings": {
+ "shape": "Mpeg2Settings",
+ "locationName": "mpeg2Settings"
+ },
+ "Av1Settings": {
+ "shape": "Av1Settings",
+ "locationName": "av1Settings"
+ }
},
- "documentation": "Placeholder documentation for __listOfMultiplexOutputDestination"
+ "documentation": "Video Codec Settings"
},
- "__listOfMultiplexProgramPipelineDetail": {
- "type": "list",
- "member": {
- "shape": "MultiplexProgramPipelineDetail"
+ "VideoDescription": {
+ "type": "structure",
+ "members": {
+ "CodecSettings": {
+ "shape": "VideoCodecSettings",
+ "locationName": "codecSettings",
+ "documentation": "Video codec settings."
+ },
+ "Height": {
+ "shape": "__integer",
+ "locationName": "height",
+ "documentation": "Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event."
+ },
+ "RespondToAfd": {
+ "shape": "VideoDescriptionRespondToAfd",
+ "locationName": "respondToAfd",
+ "documentation": "Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH.\nRESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE.\nPASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output.\nNONE: MediaLive does not clip the input video and does not include the AFD values in the output"
+ },
+ "ScalingBehavior": {
+ "shape": "VideoDescriptionScalingBehavior",
+ "locationName": "scalingBehavior",
+ "documentation": "STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution."
+ },
+ "Sharpness": {
+ "shape": "__integerMin0Max100",
+ "locationName": "sharpness",
+ "documentation": "Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content."
+ },
+ "Width": {
+ "shape": "__integer",
+ "locationName": "width",
+ "documentation": "Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required."
+ }
},
- "documentation": "Placeholder documentation for __listOfMultiplexProgramPipelineDetail"
+ "documentation": "Video settings for this stream.",
+ "required": [
+ "Name"
+ ]
},
- "__listOfMultiplexProgramSummary": {
- "type": "list",
- "member": {
- "shape": "MultiplexProgramSummary"
- },
- "documentation": "Placeholder documentation for __listOfMultiplexProgramSummary"
+ "VideoDescriptionRespondToAfd": {
+ "type": "string",
+ "documentation": "Video Description Respond To Afd",
+ "enum": [
+ "NONE",
+ "PASSTHROUGH",
+ "RESPOND"
+ ]
},
- "__listOfMultiplexSummary": {
- "type": "list",
- "member": {
- "shape": "MultiplexSummary"
- },
- "documentation": "Placeholder documentation for __listOfMultiplexSummary"
+ "VideoDescriptionScalingBehavior": {
+ "type": "string",
+ "documentation": "Video Description Scaling Behavior",
+ "enum": [
+ "DEFAULT",
+ "STRETCH_TO_OUTPUT"
+ ]
},
- "__listOfOffering": {
- "type": "list",
- "member": {
- "shape": "Offering"
+ "VideoSelector": {
+ "type": "structure",
+ "members": {
+ "ColorSpace": {
+ "shape": "VideoSelectorColorSpace",
+ "locationName": "colorSpace",
+ "documentation": "Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed."
+ },
+ "ColorSpaceSettings": {
+ "shape": "VideoSelectorColorSpaceSettings",
+ "locationName": "colorSpaceSettings",
+ "documentation": "Color space settings"
+ },
+ "ColorSpaceUsage": {
+ "shape": "VideoSelectorColorSpaceUsage",
+ "locationName": "colorSpaceUsage",
+ "documentation": "Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data."
+ },
+ "SelectorSettings": {
+ "shape": "VideoSelectorSettings",
+ "locationName": "selectorSettings",
+ "documentation": "The video selector settings."
+ }
},
- "documentation": "Placeholder documentation for __listOfOffering"
+ "documentation": "Specifies a particular video stream within an input source. An input may have only a single video selector."
},
- "__listOfOutput": {
- "type": "list",
- "member": {
- "shape": "Output"
- },
- "documentation": "Placeholder documentation for __listOfOutput"
+ "VideoSelectorColorSpace": {
+ "type": "string",
+ "documentation": "Video Selector Color Space",
+ "enum": [
+ "FOLLOW",
+ "HDR10",
+ "HLG_2020",
+ "REC_601",
+ "REC_709"
+ ]
},
- "__listOfOutputDestination": {
- "type": "list",
- "member": {
- "shape": "OutputDestination"
+ "VideoSelectorColorSpaceSettings": {
+ "type": "structure",
+ "members": {
+ "Hdr10Settings": {
+ "shape": "Hdr10Settings",
+ "locationName": "hdr10Settings"
+ }
},
- "documentation": "Placeholder documentation for __listOfOutputDestination"
+ "documentation": "Video Selector Color Space Settings"
},
- "__listOfOutputDestinationSettings": {
- "type": "list",
- "member": {
- "shape": "OutputDestinationSettings"
- },
- "documentation": "Placeholder documentation for __listOfOutputDestinationSettings"
+ "VideoSelectorColorSpaceUsage": {
+ "type": "string",
+ "documentation": "Video Selector Color Space Usage",
+ "enum": [
+ "FALLBACK",
+ "FORCE"
+ ]
},
- "__listOfOutputGroup": {
- "type": "list",
- "member": {
- "shape": "OutputGroup"
+ "VideoSelectorPid": {
+ "type": "structure",
+ "members": {
+ "Pid": {
+ "shape": "__integerMin0Max8191",
+ "locationName": "pid",
+ "documentation": "Selects a specific PID from within a video source."
+ }
},
- "documentation": "Placeholder documentation for __listOfOutputGroup"
+ "documentation": "Video Selector Pid"
},
- "__listOfPipelineDetail": {
- "type": "list",
- "member": {
- "shape": "PipelineDetail"
+ "VideoSelectorProgramId": {
+ "type": "structure",
+ "members": {
+ "ProgramId": {
+ "shape": "__integerMin0Max65536",
+ "locationName": "programId",
+ "documentation": "Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default."
+ }
},
- "documentation": "Placeholder documentation for __listOfPipelineDetail"
+ "documentation": "Video Selector Program Id"
},
- "__listOfPipelinePauseStateSettings": {
- "type": "list",
- "member": {
- "shape": "PipelinePauseStateSettings"
+ "VideoSelectorSettings": {
+ "type": "structure",
+ "members": {
+ "VideoSelectorPid": {
+ "shape": "VideoSelectorPid",
+ "locationName": "videoSelectorPid"
+ },
+ "VideoSelectorProgramId": {
+ "shape": "VideoSelectorProgramId",
+ "locationName": "videoSelectorProgramId"
+ }
},
- "documentation": "Placeholder documentation for __listOfPipelinePauseStateSettings"
+ "documentation": "Video Selector Settings"
},
- "__listOfReservation": {
- "type": "list",
- "member": {
- "shape": "Reservation"
+ "VpcOutputSettings": {
+ "type": "structure",
+ "members": {
+ "PublicAddressAllocationIds": {
+ "shape": "__listOf__string",
+ "locationName": "publicAddressAllocationIds",
+ "documentation": "List of public address allocation ids to associate with ENIs that will be created in Output VPC.\nMust specify one for SINGLE_PIPELINE, two for STANDARD channels"
+ },
+ "SecurityGroupIds": {
+ "shape": "__listOf__string",
+ "locationName": "securityGroupIds",
+ "documentation": "A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network interfaces.\nIf none are specified then the VPC default security group will be used"
+ },
+ "SubnetIds": {
+ "shape": "__listOf__string",
+ "locationName": "subnetIds",
+ "documentation": "A list of VPC subnet IDs from the same VPC.\nIf STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ)."
+ }
},
- "documentation": "Placeholder documentation for __listOfReservation"
+ "documentation": "The properties for a private VPC Output\nWhen this property is specified, the output egress addresses will be created in a user specified VPC",
+ "required": [
+ "SubnetIds"
+ ]
},
- "__listOfRtmpAdMarkers": {
- "type": "list",
- "member": {
- "shape": "RtmpAdMarkers"
+ "VpcOutputSettingsDescription": {
+ "type": "structure",
+ "members": {
+ "AvailabilityZones": {
+ "shape": "__listOf__string",
+ "locationName": "availabilityZones",
+ "documentation": "The Availability Zones where the vpc subnets are located.\nThe first Availability Zone applies to the first subnet in the list of subnets.\nThe second Availability Zone applies to the second subnet."
+ },
+ "NetworkInterfaceIds": {
+ "shape": "__listOf__string",
+ "locationName": "networkInterfaceIds",
+ "documentation": "A list of Elastic Network Interfaces created by MediaLive in the customer's VPC"
+ },
+ "SecurityGroupIds": {
+ "shape": "__listOf__string",
+ "locationName": "securityGroupIds",
+ "documentation": "A list of up EC2 VPC security group IDs attached to the Output VPC network interfaces."
+ },
+ "SubnetIds": {
+ "shape": "__listOf__string",
+ "locationName": "subnetIds",
+ "documentation": "A list of VPC subnet IDs from the same VPC.\nIf STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ)."
+ }
},
- "documentation": "Placeholder documentation for __listOfRtmpAdMarkers"
+ "documentation": "The properties for a private VPC Output"
},
- "__listOfScheduleAction": {
- "type": "list",
- "member": {
- "shape": "ScheduleAction"
- },
- "documentation": "Placeholder documentation for __listOfScheduleAction"
+ "WavCodingMode": {
+ "type": "string",
+ "documentation": "Wav Coding Mode",
+ "enum": [
+ "CODING_MODE_1_0",
+ "CODING_MODE_2_0",
+ "CODING_MODE_4_0",
+ "CODING_MODE_8_0"
+ ]
},
- "__listOfScte35Descriptor": {
- "type": "list",
- "member": {
- "shape": "Scte35Descriptor"
+ "WavSettings": {
+ "type": "structure",
+ "members": {
+ "BitDepth": {
+ "shape": "__double",
+ "locationName": "bitDepth",
+ "documentation": "Bits per sample."
+ },
+ "CodingMode": {
+ "shape": "WavCodingMode",
+ "locationName": "codingMode",
+ "documentation": "The audio coding mode for the WAV audio. The mode determines the number of channels in the audio."
+ },
+ "SampleRate": {
+ "shape": "__double",
+ "locationName": "sampleRate",
+ "documentation": "Sample rate in Hz."
+ }
},
- "documentation": "Placeholder documentation for __listOfScte35Descriptor"
+ "documentation": "Wav Settings"
},
- "__listOfThumbnail": {
- "type": "list",
- "member": {
- "shape": "Thumbnail"
+ "WebvttDestinationSettings": {
+ "type": "structure",
+ "members": {
+ "StyleControl": {
+ "shape": "WebvttDestinationStyleControl",
+ "locationName": "styleControl",
+ "documentation": "Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO_STYLE_DATA - Don't pass through the style. The output captions will not contain any font styling information."
+ }
},
- "documentation": "Placeholder documentation for __listOfThumbnail"
+ "documentation": "Webvtt Destination Settings"
},
- "__listOfThumbnailDetail": {
- "type": "list",
- "member": {
- "shape": "ThumbnailDetail"
- },
- "documentation": "Placeholder documentation for __listOfThumbnailDetail"
+ "WebvttDestinationStyleControl": {
+ "type": "string",
+ "documentation": "Webvtt Destination Style Control",
+ "enum": [
+ "NO_STYLE_DATA",
+ "PASSTHROUGH"
+ ]
},
- "__listOfTransferringInputDeviceSummary": {
- "type": "list",
- "member": {
- "shape": "TransferringInputDeviceSummary"
- },
- "documentation": "Placeholder documentation for __listOfTransferringInputDeviceSummary"
+ "__boolean": {
+ "type": "boolean",
+ "documentation": "Placeholder documentation for __boolean"
},
- "__listOfValidationError": {
- "type": "list",
- "member": {
- "shape": "ValidationError"
- },
- "documentation": "Placeholder documentation for __listOfValidationError"
+ "__double": {
+ "type": "double",
+ "documentation": "Placeholder documentation for __double"
},
- "__listOfVideoDescription": {
- "type": "list",
- "member": {
- "shape": "VideoDescription"
- },
- "documentation": "Placeholder documentation for __listOfVideoDescription"
+ "__doubleMin0": {
+ "type": "double",
+ "documentation": "Placeholder documentation for __doubleMin0"
},
- "__listOf__integer": {
- "type": "list",
- "member": {
- "shape": "__integer"
- },
- "documentation": "Placeholder documentation for __listOf__integer"
+ "__doubleMin0Max1": {
+ "type": "double",
+ "documentation": "Placeholder documentation for __doubleMin0Max1"
},
- "__listOf__string": {
- "type": "list",
- "member": {
- "shape": "__string"
- },
- "documentation": "Placeholder documentation for __listOf__string"
+ "__doubleMin0Max100": {
+ "type": "double",
+ "documentation": "Placeholder documentation for __doubleMin0Max100"
},
- "__long": {
- "type": "long",
- "documentation": "Placeholder documentation for __long"
+ "__doubleMin0Max5000": {
+ "type": "double",
+ "documentation": "Placeholder documentation for __doubleMin0Max5000"
},
- "__longMin0Max1099511627775": {
- "type": "long",
- "min": 0,
- "max": 1099511627775,
- "documentation": "Placeholder documentation for __longMin0Max1099511627775"
+ "__doubleMin1": {
+ "type": "double",
+ "documentation": "Placeholder documentation for __doubleMin1"
},
- "__longMin0Max4294967295": {
- "type": "long",
- "min": 0,
- "max": 4294967295,
- "documentation": "Placeholder documentation for __longMin0Max4294967295"
+ "__doubleMin1Max65535": {
+ "type": "double",
+ "documentation": "Placeholder documentation for __doubleMin1Max65535"
},
- "__longMin0Max8589934591": {
- "type": "long",
- "min": 0,
- "max": 8589934591,
- "documentation": "Placeholder documentation for __longMin0Max8589934591"
+ "__doubleMin250Max5000": {
+ "type": "double",
+ "documentation": "Placeholder documentation for __doubleMin250Max5000"
},
- "__longMin0Max86400000": {
- "type": "long",
- "min": 0,
- "max": 86400000,
- "documentation": "Placeholder documentation for __longMin0Max86400000"
+ "__doubleMin32Max46": {
+ "type": "double",
+ "documentation": "Placeholder documentation for __doubleMin32Max46"
},
- "__string": {
- "type": "string",
- "documentation": "Placeholder documentation for __string"
+ "__doubleMinNegative1Max5": {
+ "type": "double",
+ "documentation": "Placeholder documentation for __doubleMinNegative1Max5"
},
- "__stringMax1000": {
- "type": "string",
- "max": 1000,
- "documentation": "Placeholder documentation for __stringMax1000"
+ "__doubleMinNegative59Max0": {
+ "type": "double",
+ "documentation": "Placeholder documentation for __doubleMinNegative59Max0"
},
- "__stringMax2048": {
- "type": "string",
- "max": 2048,
- "documentation": "Placeholder documentation for __stringMax2048"
+ "__integer": {
+ "type": "integer",
+ "documentation": "Placeholder documentation for __integer"
},
- "__stringMax255": {
- "type": "string",
- "max": 255,
- "documentation": "Placeholder documentation for __stringMax255"
+ "__integerMin0": {
+ "type": "integer",
+ "min": 0,
+ "documentation": "Placeholder documentation for __integerMin0"
},
- "__stringMax256": {
- "type": "string",
- "max": 256,
- "documentation": "Placeholder documentation for __stringMax256"
+ "__integerMin0Max10": {
+ "type": "integer",
+ "min": 0,
+ "max": 10,
+ "documentation": "Placeholder documentation for __integerMin0Max10"
},
- "__stringMax32": {
- "type": "string",
- "max": 32,
- "documentation": "Placeholder documentation for __stringMax32"
+ "__integerMin0Max100": {
+ "type": "integer",
+ "min": 0,
+ "max": 100,
+ "documentation": "Placeholder documentation for __integerMin0Max100"
},
- "__stringMin1": {
- "type": "string",
- "min": 1,
- "documentation": "Placeholder documentation for __stringMin1"
+ "__integerMin0Max1000": {
+ "type": "integer",
+ "min": 0,
+ "max": 1000,
+ "documentation": "Placeholder documentation for __integerMin0Max1000"
},
- "__stringMin1Max255": {
- "type": "string",
- "min": 1,
+ "__integerMin0Max10000": {
+ "type": "integer",
+ "min": 0,
+ "max": 10000,
+ "documentation": "Placeholder documentation for __integerMin0Max10000"
+ },
+ "__integerMin0Max1000000": {
+ "type": "integer",
+ "min": 0,
+ "max": 1000000,
+ "documentation": "Placeholder documentation for __integerMin0Max1000000"
+ },
+ "__integerMin0Max100000000": {
+ "type": "integer",
+ "min": 0,
+ "max": 100000000,
+ "documentation": "Placeholder documentation for __integerMin0Max100000000"
+ },
+ "__integerMin0Max128": {
+ "type": "integer",
+ "min": 0,
+ "max": 128,
+ "documentation": "Placeholder documentation for __integerMin0Max128"
+ },
+ "__integerMin0Max15": {
+ "type": "integer",
+ "min": 0,
+ "max": 15,
+ "documentation": "Placeholder documentation for __integerMin0Max15"
+ },
+ "__integerMin0Max2000": {
+ "type": "integer",
+ "min": 0,
+ "max": 2000,
+ "documentation": "Placeholder documentation for __integerMin0Max2000"
+ },
+ "__integerMin0Max255": {
+ "type": "integer",
+ "min": 0,
"max": 255,
- "documentation": "Placeholder documentation for __stringMin1Max255"
+ "documentation": "Placeholder documentation for __integerMin0Max255"
},
- "__stringMin1Max256": {
- "type": "string",
- "min": 1,
- "max": 256,
- "documentation": "Placeholder documentation for __stringMin1Max256"
+ "__integerMin0Max30": {
+ "type": "integer",
+ "min": 0,
+ "max": 30,
+ "documentation": "Placeholder documentation for __integerMin0Max30"
},
- "__stringMin1Max35": {
- "type": "string",
- "min": 1,
- "max": 35,
- "documentation": "Placeholder documentation for __stringMin1Max35"
+ "__integerMin0Max32768": {
+ "type": "integer",
+ "min": 0,
+ "max": 32768,
+ "documentation": "Placeholder documentation for __integerMin0Max32768"
},
- "__stringMin1Max7": {
- "type": "string",
- "min": 1,
+ "__integerMin0Max3600": {
+ "type": "integer",
+ "min": 0,
+ "max": 3600,
+ "documentation": "Placeholder documentation for __integerMin0Max3600"
+ },
+ "__integerMin0Max500": {
+ "type": "integer",
+ "min": 0,
+ "max": 500,
+ "documentation": "Placeholder documentation for __integerMin0Max500"
+ },
+ "__integerMin0Max600": {
+ "type": "integer",
+ "min": 0,
+ "max": 600,
+ "documentation": "Placeholder documentation for __integerMin0Max600"
+ },
+ "__integerMin0Max65535": {
+ "type": "integer",
+ "min": 0,
+ "max": 65535,
+ "documentation": "Placeholder documentation for __integerMin0Max65535"
+ },
+ "__integerMin0Max65536": {
+ "type": "integer",
+ "min": 0,
+ "max": 65536,
+ "documentation": "Placeholder documentation for __integerMin0Max65536"
+ },
+ "__integerMin0Max7": {
+ "type": "integer",
+ "min": 0,
"max": 7,
- "documentation": "Placeholder documentation for __stringMin1Max7"
+ "documentation": "Placeholder documentation for __integerMin0Max7"
},
- "__stringMin2Max2": {
- "type": "string",
- "min": 2,
- "max": 2,
- "documentation": "Placeholder documentation for __stringMin2Max2"
+ "__integerMin0Max8191": {
+ "type": "integer",
+ "min": 0,
+ "max": 8191,
+ "documentation": "Placeholder documentation for __integerMin0Max8191"
},
- "__stringMin32Max32": {
- "type": "string",
- "min": 32,
- "max": 32,
- "documentation": "Placeholder documentation for __stringMin32Max32"
+ "__integerMin1": {
+ "type": "integer",
+ "min": 1,
+ "documentation": "Placeholder documentation for __integerMin1"
},
- "__stringMin34Max34": {
- "type": "string",
- "min": 34,
- "max": 34,
- "documentation": "Placeholder documentation for __stringMin34Max34"
+ "__integerMin100": {
+ "type": "integer",
+ "min": 100,
+ "documentation": "Placeholder documentation for __integerMin100"
},
- "__stringMin3Max3": {
- "type": "string",
- "min": 3,
- "max": 3,
- "documentation": "Placeholder documentation for __stringMin3Max3"
+ "__integerMin1000": {
+ "type": "integer",
+ "min": 1000,
+ "documentation": "Placeholder documentation for __integerMin1000"
},
- "__stringMin6Max6": {
- "type": "string",
- "min": 6,
- "max": 6,
- "documentation": "Placeholder documentation for __stringMin6Max6"
+ "__integerMin1000000Max100000000": {
+ "type": "integer",
+ "min": 1000000,
+ "max": 100000000,
+ "documentation": "Placeholder documentation for __integerMin1000000Max100000000"
},
- "__stringPattern010920300": {
- "type": "string",
- "pattern": "^([0,1]?[0-9]|2[0-3]):00$",
- "documentation": "Placeholder documentation for __stringPattern010920300"
+ "__integerMin100000Max100000000": {
+ "type": "integer",
+ "min": 100000,
+ "max": 100000000,
+ "documentation": "Placeholder documentation for __integerMin100000Max100000000"
},
- "__timestampIso8601": {
- "type": "timestamp",
- "timestampFormat": "iso8601",
- "documentation": "Placeholder documentation for __timestampIso8601"
+ "__integerMin100000Max40000000": {
+ "type": "integer",
+ "min": 100000,
+ "max": 40000000,
+ "documentation": "Placeholder documentation for __integerMin100000Max40000000"
},
- "__timestampUnix": {
- "type": "timestamp",
- "timestampFormat": "unixTimestamp",
- "documentation": "Placeholder documentation for __timestampUnix"
+ "__integerMin100000Max80000000": {
+ "type": "integer",
+ "min": 100000,
+ "max": 80000000,
+ "documentation": "Placeholder documentation for __integerMin100000Max80000000"
},
- "InputDeviceThumbnail": {
- "type": "blob",
- "streaming": true,
- "documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive."
+ "__integerMin1000Max30000": {
+ "type": "integer",
+ "min": 1000,
+ "max": 30000,
+ "documentation": "Placeholder documentation for __integerMin1000Max30000"
},
- "AcceptHeader": {
- "type": "string",
- "enum": [
- "image/jpeg"
+ "__integerMin1Max10": {
+ "type": "integer",
+ "min": 1,
+ "max": 10,
+ "documentation": "Placeholder documentation for __integerMin1Max10"
+ },
+ "__integerMin1Max1000000": {
+ "type": "integer",
+ "min": 1,
+ "max": 1000000,
+ "documentation": "Placeholder documentation for __integerMin1Max1000000"
+ },
+ "__integerMin1Max16": {
+ "type": "integer",
+ "min": 1,
+ "max": 16,
+ "documentation": "Placeholder documentation for __integerMin1Max16"
+ },
+ "__integerMin1Max20": {
+ "type": "integer",
+ "min": 1,
+ "max": 20,
+ "documentation": "Placeholder documentation for __integerMin1Max20"
+ },
+ "__integerMin1Max3003": {
+ "type": "integer",
+ "min": 1,
+ "max": 3003,
+ "documentation": "Placeholder documentation for __integerMin1Max3003"
+ },
+ "__integerMin1Max31": {
+ "type": "integer",
+ "min": 1,
+ "max": 31,
+ "documentation": "Placeholder documentation for __integerMin1Max31"
+ },
+ "__integerMin1Max32": {
+ "type": "integer",
+ "min": 1,
+ "max": 32,
+ "documentation": "Placeholder documentation for __integerMin1Max32"
+ },
+ "__integerMin1Max3600000": {
+ "type": "integer",
+ "min": 1,
+ "max": 3600000,
+ "documentation": "Placeholder documentation for __integerMin1Max3600000"
+ },
+ "__integerMin1Max4": {
+ "type": "integer",
+ "min": 1,
+ "max": 4,
+ "documentation": "Placeholder documentation for __integerMin1Max4"
+ },
+ "__integerMin1Max5": {
+ "type": "integer",
+ "min": 1,
+ "max": 5,
+ "documentation": "Placeholder documentation for __integerMin1Max5"
+ },
+ "__integerMin1Max6": {
+ "type": "integer",
+ "min": 1,
+ "max": 6,
+ "documentation": "Placeholder documentation for __integerMin1Max6"
+ },
+ "__integerMin1Max8": {
+ "type": "integer",
+ "min": 1,
+ "max": 8,
+ "documentation": "Placeholder documentation for __integerMin1Max8"
+ },
+ "__integerMin25Max10000": {
+ "type": "integer",
+ "min": 25,
+ "max": 10000,
+ "documentation": "Placeholder documentation for __integerMin25Max10000"
+ },
+ "__integerMin25Max2000": {
+ "type": "integer",
+ "min": 25,
+ "max": 2000,
+ "documentation": "Placeholder documentation for __integerMin25Max2000"
+ },
+ "__integerMin3": {
+ "type": "integer",
+ "min": 3,
+ "documentation": "Placeholder documentation for __integerMin3"
+ },
+ "__integerMin30": {
+ "type": "integer",
+ "min": 30,
+ "documentation": "Placeholder documentation for __integerMin30"
+ },
+ "__integerMin32Max8191": {
+ "type": "integer",
+ "min": 32,
+ "max": 8191,
+ "documentation": "Placeholder documentation for __integerMin32Max8191"
+ },
+ "__integerMin4Max20": {
+ "type": "integer",
+ "min": 4,
+ "max": 20,
+ "documentation": "Placeholder documentation for __integerMin4Max20"
+ },
+ "__integerMin800Max3000": {
+ "type": "integer",
+ "min": 800,
+ "max": 3000,
+ "documentation": "Placeholder documentation for __integerMin800Max3000"
+ },
+ "__integerMin96Max600": {
+ "type": "integer",
+ "min": 96,
+ "max": 600,
+ "documentation": "Placeholder documentation for __integerMin96Max600"
+ },
+ "__integerMinNegative1000Max1000": {
+ "type": "integer",
+ "min": -1000,
+ "max": 1000,
+ "documentation": "Placeholder documentation for __integerMinNegative1000Max1000"
+ },
+ "__integerMinNegative5Max5": {
+ "type": "integer",
+ "min": -5,
+ "max": 5,
+ "documentation": "Placeholder documentation for __integerMinNegative5Max5"
+ },
+ "__integerMinNegative60Max6": {
+ "type": "integer",
+ "min": -60,
+ "max": 6,
+ "documentation": "Placeholder documentation for __integerMinNegative60Max6"
+ },
+ "__integerMinNegative60Max60": {
+ "type": "integer",
+ "min": -60,
+ "max": 60,
+ "documentation": "Placeholder documentation for __integerMinNegative60Max60"
+ },
+ "__listOfAudioChannelMapping": {
+ "type": "list",
+ "member": {
+ "shape": "AudioChannelMapping"
+ },
+ "documentation": "Placeholder documentation for __listOfAudioChannelMapping"
+ },
+ "__listOfAudioDescription": {
+ "type": "list",
+ "member": {
+ "shape": "AudioDescription"
+ },
+ "documentation": "Placeholder documentation for __listOfAudioDescription"
+ },
+ "__listOfAudioSelector": {
+ "type": "list",
+ "member": {
+ "shape": "AudioSelector"
+ },
+ "documentation": "Placeholder documentation for __listOfAudioSelector"
+ },
+ "__listOfAudioTrack": {
+ "type": "list",
+ "member": {
+ "shape": "AudioTrack"
+ },
+ "documentation": "Placeholder documentation for __listOfAudioTrack"
+ },
+ "__listOfBatchFailedResultModel": {
+ "type": "list",
+ "member": {
+ "shape": "BatchFailedResultModel"
+ },
+ "documentation": "Placeholder documentation for __listOfBatchFailedResultModel"
+ },
+ "__listOfBatchSuccessfulResultModel": {
+ "type": "list",
+ "member": {
+ "shape": "BatchSuccessfulResultModel"
+ },
+ "documentation": "Placeholder documentation for __listOfBatchSuccessfulResultModel"
+ },
+ "__listOfCaptionDescription": {
+ "type": "list",
+ "member": {
+ "shape": "CaptionDescription"
+ },
+ "documentation": "Placeholder documentation for __listOfCaptionDescription"
+ },
+ "__listOfCaptionLanguageMapping": {
+ "type": "list",
+ "member": {
+ "shape": "CaptionLanguageMapping"
+ },
+ "documentation": "Placeholder documentation for __listOfCaptionLanguageMapping"
+ },
+ "__listOfCaptionSelector": {
+ "type": "list",
+ "member": {
+ "shape": "CaptionSelector"
+ },
+ "documentation": "Placeholder documentation for __listOfCaptionSelector"
+ },
+ "__listOfChannelEgressEndpoint": {
+ "type": "list",
+ "member": {
+ "shape": "ChannelEgressEndpoint"
+ },
+ "documentation": "Placeholder documentation for __listOfChannelEgressEndpoint"
+ },
+ "__listOfChannelSummary": {
+ "type": "list",
+ "member": {
+ "shape": "ChannelSummary"
+ },
+ "documentation": "Placeholder documentation for __listOfChannelSummary"
+ },
+ "__listOfColorCorrection": {
+ "type": "list",
+ "member": {
+ "shape": "ColorCorrection"
+ },
+ "documentation": "Placeholder documentation for __listOfColorCorrection"
+ },
+ "__listOfFailoverCondition": {
+ "type": "list",
+ "member": {
+ "shape": "FailoverCondition"
+ },
+ "documentation": "Placeholder documentation for __listOfFailoverCondition"
+ },
+ "__listOfHlsAdMarkers": {
+ "type": "list",
+ "member": {
+ "shape": "HlsAdMarkers"
+ },
+ "documentation": "Placeholder documentation for __listOfHlsAdMarkers"
+ },
+ "__listOfInput": {
+ "type": "list",
+ "member": {
+ "shape": "Input"
+ },
+ "documentation": "Placeholder documentation for __listOfInput"
+ },
+ "__listOfInputAttachment": {
+ "type": "list",
+ "member": {
+ "shape": "InputAttachment"
+ },
+ "documentation": "Placeholder documentation for __listOfInputAttachment"
+ },
+ "__listOfInputChannelLevel": {
+ "type": "list",
+ "member": {
+ "shape": "InputChannelLevel"
+ },
+ "documentation": "Placeholder documentation for __listOfInputChannelLevel"
+ },
+ "__listOfInputDestination": {
+ "type": "list",
+ "member": {
+ "shape": "InputDestination"
+ },
+ "documentation": "Placeholder documentation for __listOfInputDestination"
+ },
+ "__listOfInputDestinationRequest": {
+ "type": "list",
+ "member": {
+ "shape": "InputDestinationRequest"
+ },
+ "documentation": "Placeholder documentation for __listOfInputDestinationRequest"
+ },
+ "__listOfInputDeviceRequest": {
+ "type": "list",
+ "member": {
+ "shape": "InputDeviceRequest"
+ },
+ "documentation": "Placeholder documentation for __listOfInputDeviceRequest"
+ },
+ "__listOfInputDeviceSettings": {
+ "type": "list",
+ "member": {
+ "shape": "InputDeviceSettings"
+ },
+ "documentation": "Placeholder documentation for __listOfInputDeviceSettings"
+ },
+ "__listOfInputDeviceSummary": {
+ "type": "list",
+ "member": {
+ "shape": "InputDeviceSummary"
+ },
+ "documentation": "Placeholder documentation for __listOfInputDeviceSummary"
+ },
+ "__listOfInputSecurityGroup": {
+ "type": "list",
+ "member": {
+ "shape": "InputSecurityGroup"
+ },
+ "documentation": "Placeholder documentation for __listOfInputSecurityGroup"
+ },
+ "__listOfInputSource": {
+ "type": "list",
+ "member": {
+ "shape": "InputSource"
+ },
+ "documentation": "Placeholder documentation for __listOfInputSource"
+ },
+ "__listOfInputSourceRequest": {
+ "type": "list",
+ "member": {
+ "shape": "InputSourceRequest"
+ },
+ "documentation": "Placeholder documentation for __listOfInputSourceRequest"
+ },
+ "__listOfInputWhitelistRule": {
+ "type": "list",
+ "member": {
+ "shape": "InputWhitelistRule"
+ },
+ "documentation": "Placeholder documentation for __listOfInputWhitelistRule"
+ },
+ "__listOfInputWhitelistRuleCidr": {
+ "type": "list",
+ "member": {
+ "shape": "InputWhitelistRuleCidr"
+ },
+ "documentation": "Placeholder documentation for __listOfInputWhitelistRuleCidr"
+ },
+ "__listOfMediaConnectFlow": {
+ "type": "list",
+ "member": {
+ "shape": "MediaConnectFlow"
+ },
+ "documentation": "Placeholder documentation for __listOfMediaConnectFlow"
+ },
+ "__listOfMediaConnectFlowRequest": {
+ "type": "list",
+ "member": {
+ "shape": "MediaConnectFlowRequest"
+ },
+ "documentation": "Placeholder documentation for __listOfMediaConnectFlowRequest"
+ },
+ "__listOfMediaPackageOutputDestinationSettings": {
+ "type": "list",
+ "member": {
+ "shape": "MediaPackageOutputDestinationSettings"
+ },
+ "documentation": "Placeholder documentation for __listOfMediaPackageOutputDestinationSettings"
+ },
+ "__listOfMultiplexOutputDestination": {
+ "type": "list",
+ "member": {
+ "shape": "MultiplexOutputDestination"
+ },
+ "documentation": "Placeholder documentation for __listOfMultiplexOutputDestination"
+ },
+ "__listOfMultiplexProgramPipelineDetail": {
+ "type": "list",
+ "member": {
+ "shape": "MultiplexProgramPipelineDetail"
+ },
+ "documentation": "Placeholder documentation for __listOfMultiplexProgramPipelineDetail"
+ },
+ "__listOfMultiplexProgramSummary": {
+ "type": "list",
+ "member": {
+ "shape": "MultiplexProgramSummary"
+ },
+ "documentation": "Placeholder documentation for __listOfMultiplexProgramSummary"
+ },
+ "__listOfMultiplexSummary": {
+ "type": "list",
+ "member": {
+ "shape": "MultiplexSummary"
+ },
+ "documentation": "Placeholder documentation for __listOfMultiplexSummary"
+ },
+ "__listOfOffering": {
+ "type": "list",
+ "member": {
+ "shape": "Offering"
+ },
+ "documentation": "Placeholder documentation for __listOfOffering"
+ },
+ "__listOfOutput": {
+ "type": "list",
+ "member": {
+ "shape": "Output"
+ },
+ "documentation": "Placeholder documentation for __listOfOutput"
+ },
+ "__listOfOutputDestination": {
+ "type": "list",
+ "member": {
+ "shape": "OutputDestination"
+ },
+ "documentation": "Placeholder documentation for __listOfOutputDestination"
+ },
+ "__listOfOutputDestinationSettings": {
+ "type": "list",
+ "member": {
+ "shape": "OutputDestinationSettings"
+ },
+ "documentation": "Placeholder documentation for __listOfOutputDestinationSettings"
+ },
+ "__listOfOutputGroup": {
+ "type": "list",
+ "member": {
+ "shape": "OutputGroup"
+ },
+ "documentation": "Placeholder documentation for __listOfOutputGroup"
+ },
+ "__listOfPipelineDetail": {
+ "type": "list",
+ "member": {
+ "shape": "PipelineDetail"
+ },
+ "documentation": "Placeholder documentation for __listOfPipelineDetail"
+ },
+ "__listOfPipelinePauseStateSettings": {
+ "type": "list",
+ "member": {
+ "shape": "PipelinePauseStateSettings"
+ },
+ "documentation": "Placeholder documentation for __listOfPipelinePauseStateSettings"
+ },
+ "__listOfReservation": {
+ "type": "list",
+ "member": {
+ "shape": "Reservation"
+ },
+ "documentation": "Placeholder documentation for __listOfReservation"
+ },
+ "__listOfRtmpAdMarkers": {
+ "type": "list",
+ "member": {
+ "shape": "RtmpAdMarkers"
+ },
+ "documentation": "Placeholder documentation for __listOfRtmpAdMarkers"
+ },
+ "__listOfScheduleAction": {
+ "type": "list",
+ "member": {
+ "shape": "ScheduleAction"
+ },
+ "documentation": "Placeholder documentation for __listOfScheduleAction"
+ },
+ "__listOfScte35Descriptor": {
+ "type": "list",
+ "member": {
+ "shape": "Scte35Descriptor"
+ },
+ "documentation": "Placeholder documentation for __listOfScte35Descriptor"
+ },
+ "__listOfThumbnail": {
+ "type": "list",
+ "member": {
+ "shape": "Thumbnail"
+ },
+ "documentation": "Placeholder documentation for __listOfThumbnail"
+ },
+ "__listOfThumbnailDetail": {
+ "type": "list",
+ "member": {
+ "shape": "ThumbnailDetail"
+ },
+ "documentation": "Placeholder documentation for __listOfThumbnailDetail"
+ },
+ "__listOfTransferringInputDeviceSummary": {
+ "type": "list",
+ "member": {
+ "shape": "TransferringInputDeviceSummary"
+ },
+ "documentation": "Placeholder documentation for __listOfTransferringInputDeviceSummary"
+ },
+ "__listOfValidationError": {
+ "type": "list",
+ "member": {
+ "shape": "ValidationError"
+ },
+ "documentation": "Placeholder documentation for __listOfValidationError"
+ },
+ "__listOfVideoDescription": {
+ "type": "list",
+ "member": {
+ "shape": "VideoDescription"
+ },
+ "documentation": "Placeholder documentation for __listOfVideoDescription"
+ },
+ "__listOf__integer": {
+ "type": "list",
+ "member": {
+ "shape": "__integer"
+ },
+ "documentation": "Placeholder documentation for __listOf__integer"
+ },
+ "__listOf__string": {
+ "type": "list",
+ "member": {
+ "shape": "__string"
+ },
+ "documentation": "Placeholder documentation for __listOf__string"
+ },
+ "__long": {
+ "type": "long",
+ "documentation": "Placeholder documentation for __long"
+ },
+ "__longMin0Max1099511627775": {
+ "type": "long",
+ "min": 0,
+ "max": 1099511627775,
+ "documentation": "Placeholder documentation for __longMin0Max1099511627775"
+ },
+ "__longMin0Max4294967295": {
+ "type": "long",
+ "min": 0,
+ "max": 4294967295,
+ "documentation": "Placeholder documentation for __longMin0Max4294967295"
+ },
+ "__longMin0Max8589934591": {
+ "type": "long",
+ "min": 0,
+ "max": 8589934591,
+ "documentation": "Placeholder documentation for __longMin0Max8589934591"
+ },
+ "__longMin0Max86400000": {
+ "type": "long",
+ "min": 0,
+ "max": 86400000,
+ "documentation": "Placeholder documentation for __longMin0Max86400000"
+ },
+ "__string": {
+ "type": "string",
+ "documentation": "Placeholder documentation for __string"
+ },
+ "__stringMax1000": {
+ "type": "string",
+ "max": 1000,
+ "documentation": "Placeholder documentation for __stringMax1000"
+ },
+ "__stringMax2048": {
+ "type": "string",
+ "max": 2048,
+ "documentation": "Placeholder documentation for __stringMax2048"
+ },
+ "__stringMax255": {
+ "type": "string",
+ "max": 255,
+ "documentation": "Placeholder documentation for __stringMax255"
+ },
+ "__stringMax256": {
+ "type": "string",
+ "max": 256,
+ "documentation": "Placeholder documentation for __stringMax256"
+ },
+ "__stringMax32": {
+ "type": "string",
+ "max": 32,
+ "documentation": "Placeholder documentation for __stringMax32"
+ },
+ "__stringMin1": {
+ "type": "string",
+ "min": 1,
+ "documentation": "Placeholder documentation for __stringMin1"
+ },
+ "__stringMin1Max255": {
+ "type": "string",
+ "min": 1,
+ "max": 255,
+ "documentation": "Placeholder documentation for __stringMin1Max255"
+ },
+ "__stringMin1Max256": {
+ "type": "string",
+ "min": 1,
+ "max": 256,
+ "documentation": "Placeholder documentation for __stringMin1Max256"
+ },
+ "__stringMin1Max35": {
+ "type": "string",
+ "min": 1,
+ "max": 35,
+ "documentation": "Placeholder documentation for __stringMin1Max35"
+ },
+ "__stringMin1Max7": {
+ "type": "string",
+ "min": 1,
+ "max": 7,
+ "documentation": "Placeholder documentation for __stringMin1Max7"
+ },
+ "__stringMin2Max2": {
+ "type": "string",
+ "min": 2,
+ "max": 2,
+ "documentation": "Placeholder documentation for __stringMin2Max2"
+ },
+ "__stringMin32Max32": {
+ "type": "string",
+ "min": 32,
+ "max": 32,
+ "documentation": "Placeholder documentation for __stringMin32Max32"
+ },
+ "__stringMin34Max34": {
+ "type": "string",
+ "min": 34,
+ "max": 34,
+ "documentation": "Placeholder documentation for __stringMin34Max34"
+ },
+ "__stringMin3Max3": {
+ "type": "string",
+ "min": 3,
+ "max": 3,
+ "documentation": "Placeholder documentation for __stringMin3Max3"
+ },
+ "__stringMin6Max6": {
+ "type": "string",
+ "min": 6,
+ "max": 6,
+ "documentation": "Placeholder documentation for __stringMin6Max6"
+ },
+ "__stringPattern010920300": {
+ "type": "string",
+ "pattern": "^([0,1]?[0-9]|2[0-3]):00$",
+ "documentation": "Placeholder documentation for __stringPattern010920300"
+ },
+ "__timestampIso8601": {
+ "type": "timestamp",
+ "timestampFormat": "iso8601",
+ "documentation": "Placeholder documentation for __timestampIso8601"
+ },
+ "__timestampUnix": {
+ "type": "timestamp",
+ "timestampFormat": "unixTimestamp",
+ "documentation": "Placeholder documentation for __timestampUnix"
+ },
+ "InputDeviceThumbnail": {
+ "type": "blob",
+ "streaming": true,
+ "documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive."
+ },
+ "AcceptHeader": {
+ "type": "string",
+ "enum": [
+ "image/jpeg"
+ ],
+ "documentation": "The HTTP Accept header. Indicates the requested type fothe thumbnail."
+ },
+ "ContentType": {
+ "type": "string",
+ "enum": [
+ "image/jpeg"
+ ],
+ "documentation": "Specifies the media type of the thumbnail."
+ },
+ "__timestamp": {
+ "type": "timestamp",
+ "documentation": "Placeholder documentation for __timestamp"
+ },
+ "InputDeviceConfigurableAudioChannelPairConfig": {
+ "type": "structure",
+ "members": {
+ "Id": {
+ "shape": "__integer",
+ "locationName": "id",
+ "documentation": "The ID for one audio pair configuration, a value from 1 to 8."
+ },
+ "Profile": {
+ "shape": "InputDeviceConfigurableAudioChannelPairProfile",
+ "locationName": "profile",
+ "documentation": "The profile to set for one audio pair configuration. Choose an enumeration value. Each value describes one audio configuration using the format (rate control algorithm)-(codec)_(quality)-(bitrate in bytes). For example, CBR-AAC_HQ-192000. Or choose DISABLED, in which case the device won't produce audio for this pair."
+ }
+ },
+ "documentation": "One audio configuration that specifies the format for one audio pair that the device produces as output."
+ },
+ "InputDeviceConfigurableAudioChannelPairProfile": {
+ "type": "string",
+ "documentation": "Property of InputDeviceConfigurableAudioChannelPairConfig, which configures one audio channel that the device produces.",
+ "enum": [
+ "DISABLED",
+ "VBR-AAC_HHE-16000",
+ "VBR-AAC_HE-64000",
+ "VBR-AAC_LC-128000",
+ "CBR-AAC_HQ-192000",
+ "CBR-AAC_HQ-256000",
+ "CBR-AAC_HQ-384000",
+ "CBR-AAC_HQ-512000"
+ ]
+ },
+ "InputDeviceUhdAudioChannelPairConfig": {
+ "type": "structure",
+ "members": {
+ "Id": {
+ "shape": "__integer",
+ "locationName": "id",
+ "documentation": "The ID for one audio pair configuration, a value from 1 to 8."
+ },
+ "Profile": {
+ "shape": "InputDeviceUhdAudioChannelPairProfile",
+ "locationName": "profile",
+ "documentation": "The profile for one audio pair configuration. This property describes one audio configuration in the format (rate control algorithm)-(codec)_(quality)-(bitrate in bytes). For example, CBR-AAC_HQ-192000. Or DISABLED, in which case the device won't produce audio for this pair."
+ }
+ },
+ "documentation": "One audio configuration that specifies the format for one audio pair that the device produces as output."
+ },
+ "InputDeviceUhdAudioChannelPairProfile": {
+ "type": "string",
+ "documentation": "Property of InputDeviceUhdAudioChannelPairConfig, which describes one audio channel that the device is configured to produce.",
+ "enum": [
+ "DISABLED",
+ "VBR-AAC_HHE-16000",
+ "VBR-AAC_HE-64000",
+ "VBR-AAC_LC-128000",
+ "CBR-AAC_HQ-192000",
+ "CBR-AAC_HQ-256000",
+ "CBR-AAC_HQ-384000",
+ "CBR-AAC_HQ-512000"
+ ]
+ },
+ "__listOfInputDeviceConfigurableAudioChannelPairConfig": {
+ "type": "list",
+ "member": {
+ "shape": "InputDeviceConfigurableAudioChannelPairConfig"
+ },
+ "documentation": "Placeholder documentation for __listOfInputDeviceConfigurableAudioChannelPairConfig"
+ },
+ "__listOfInputDeviceUhdAudioChannelPairConfig": {
+ "type": "list",
+ "member": {
+ "shape": "InputDeviceUhdAudioChannelPairConfig"
+ },
+ "documentation": "Placeholder documentation for __listOfInputDeviceUhdAudioChannelPairConfig"
+ },
+ "ChannelPipelineIdToRestart": {
+ "type": "string",
+ "documentation": "Property of RestartChannelPipelinesRequest",
+ "enum": [
+ "PIPELINE_0",
+ "PIPELINE_1"
+ ]
+ },
+ "RestartChannelPipelinesRequest": {
+ "type": "structure",
+ "members": {
+ "ChannelId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelId",
+ "documentation": "ID of channel"
+ },
+ "PipelineIds": {
+ "shape": "__listOfChannelPipelineIdToRestart",
+ "locationName": "pipelineIds",
+ "documentation": "An array of pipelines to restart in this channel. Format PIPELINE_0 or PIPELINE_1."
+ }
+ },
+ "documentation": "Pipelines to restart.",
+ "required": [
+ "ChannelId"
+ ]
+ },
+ "RestartChannelPipelinesResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The unique arn of the channel."
+ },
+ "CdiInputSpecification": {
+ "shape": "CdiInputSpecification",
+ "locationName": "cdiInputSpecification",
+ "documentation": "Specification of CDI inputs for this channel"
+ },
+ "ChannelClass": {
+ "shape": "ChannelClass",
+ "locationName": "channelClass",
+ "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
+ },
+ "Destinations": {
+ "shape": "__listOfOutputDestination",
+ "locationName": "destinations",
+ "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
+ },
+ "EgressEndpoints": {
+ "shape": "__listOfChannelEgressEndpoint",
+ "locationName": "egressEndpoints",
+ "documentation": "The endpoints where outgoing connections initiate from"
+ },
+ "EncoderSettings": {
+ "shape": "EncoderSettings",
+ "locationName": "encoderSettings"
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique id of the channel."
+ },
+ "InputAttachments": {
+ "shape": "__listOfInputAttachment",
+ "locationName": "inputAttachments",
+ "documentation": "List of input attachments for channel."
+ },
+ "InputSpecification": {
+ "shape": "InputSpecification",
+ "locationName": "inputSpecification",
+ "documentation": "Specification of network and file inputs for this channel"
+ },
+ "LogLevel": {
+ "shape": "LogLevel",
+ "locationName": "logLevel",
+ "documentation": "The log level being written to CloudWatch Logs."
+ },
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
+ "MaintenanceStatus": {
+ "shape": "__string",
+ "locationName": "maintenanceStatus",
+ "documentation": "The time in milliseconds by when the PVRE restart must occur."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name of the channel. (user-mutable)"
+ },
+ "PipelineDetails": {
+ "shape": "__listOfPipelineDetail",
+ "locationName": "pipelineDetails",
+ "documentation": "Runtime details for the pipelines of a running channel."
+ },
+ "PipelinesRunningCount": {
+ "shape": "__integer",
+ "locationName": "pipelinesRunningCount",
+ "documentation": "The number of currently healthy pipelines."
+ },
+ "RoleArn": {
+ "shape": "__string",
+ "locationName": "roleArn",
+ "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
+ },
+ "State": {
+ "shape": "ChannelState",
+ "locationName": "state"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
+ },
+ "Vpc": {
+ "shape": "VpcOutputSettingsDescription",
+ "locationName": "vpc",
+ "documentation": "Settings for VPC output"
+ },
+ "AnywhereSettings": {
+ "shape": "DescribeAnywhereSettings",
+ "locationName": "anywhereSettings",
+ "documentation": "Anywhere settings for this channel."
+ }
+ },
+ "documentation": "Placeholder documentation for RestartChannelPipelinesResponse"
+ },
+ "__listOfChannelPipelineIdToRestart": {
+ "type": "list",
+ "member": {
+ "shape": "ChannelPipelineIdToRestart"
+ },
+ "documentation": "Placeholder documentation for __listOfChannelPipelineIdToRestart"
+ },
+ "H265MvOverPictureBoundaries": {
+ "type": "string",
+ "documentation": "H265 Mv Over Picture Boundaries",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
+ },
+ "H265MvTemporalPredictor": {
+ "type": "string",
+ "documentation": "H265 Mv Temporal Predictor",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
+ },
+ "H265TilePadding": {
+ "type": "string",
+ "documentation": "H265 Tile Padding",
+ "enum": [
+ "NONE",
+ "PADDED"
+ ]
+ },
+ "H265TreeblockSize": {
+ "type": "string",
+ "documentation": "H265 Treeblock Size",
+ "enum": [
+ "AUTO",
+ "TREE_SIZE_32X32"
+ ]
+ },
+ "__integerMin256Max3840": {
+ "type": "integer",
+ "min": 256,
+ "max": 3840,
+ "documentation": "Placeholder documentation for __integerMin256Max3840"
+ },
+ "__integerMin64Max2160": {
+ "type": "integer",
+ "min": 64,
+ "max": 2160,
+ "documentation": "Placeholder documentation for __integerMin64Max2160"
+ },
+ "CmafIngestGroupSettings": {
+ "type": "structure",
+ "members": {
+ "Destination": {
+ "shape": "OutputLocationRef",
+ "locationName": "destination",
+ "documentation": "A HTTP destination for the tracks"
+ },
+ "NielsenId3Behavior": {
+ "shape": "CmafNielsenId3Behavior",
+ "locationName": "nielsenId3Behavior",
+ "documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output."
+ },
+ "Scte35Type": {
+ "shape": "Scte35Type",
+ "locationName": "scte35Type",
+ "documentation": "Type of scte35 track to add. none or scte35WithoutSegmentation"
+ },
+ "SegmentLength": {
+ "shape": "__integerMin1",
+ "locationName": "segmentLength",
+ "documentation": "The nominal duration of segments. The units are specified in SegmentLengthUnits. The segments will end on the next keyframe after the specified duration, so the actual segment length might be longer, and it might be a fraction of the units."
+ },
+ "SegmentLengthUnits": {
+ "shape": "CmafIngestSegmentLengthUnits",
+ "locationName": "segmentLengthUnits",
+ "documentation": "Time unit for segment length parameter."
+ },
+ "SendDelayMs": {
+ "shape": "__integerMin0Max2000",
+ "locationName": "sendDelayMs",
+ "documentation": "Number of milliseconds to delay the output from the second pipeline."
+ }
+ },
+ "documentation": "Cmaf Ingest Group Settings",
+ "required": [
+ "Destination"
+ ]
+ },
+ "CmafIngestOutputSettings": {
+ "type": "structure",
+ "members": {
+ "NameModifier": {
+ "shape": "__string",
+ "locationName": "nameModifier",
+ "documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type."
+ }
+ },
+ "documentation": "Cmaf Ingest Output Settings"
+ },
+ "CmafIngestSegmentLengthUnits": {
+ "type": "string",
+ "documentation": "Cmaf Ingest Segment Length Units",
+ "enum": [
+ "MILLISECONDS",
+ "SECONDS"
+ ]
+ },
+ "CmafNielsenId3Behavior": {
+ "type": "string",
+ "documentation": "Cmaf Nielsen Id3 Behavior",
+ "enum": [
+ "NO_PASSTHROUGH",
+ "PASSTHROUGH"
+ ]
+ },
+ "DashRoleAudio": {
+ "type": "string",
+ "documentation": "Dash Role Audio",
+ "enum": [
+ "ALTERNATE",
+ "COMMENTARY",
+ "DESCRIPTION",
+ "DUB",
+ "EMERGENCY",
+ "ENHANCED-AUDIO-INTELLIGIBILITY",
+ "KARAOKE",
+ "MAIN",
+ "SUPPLEMENTARY"
+ ]
+ },
+ "DashRoleCaption": {
+ "type": "string",
+ "documentation": "Dash Role Caption",
+ "enum": [
+ "ALTERNATE",
+ "CAPTION",
+ "COMMENTARY",
+ "DESCRIPTION",
+ "DUB",
+ "EASYREADER",
+ "EMERGENCY",
+ "FORCED-SUBTITLE",
+ "KARAOKE",
+ "MAIN",
+ "METADATA",
+ "SUBTITLE",
+ "SUPPLEMENTARY"
+ ]
+ },
+ "DvbDashAccessibility": {
+ "type": "string",
+ "documentation": "Dvb Dash Accessibility",
+ "enum": [
+ "DVBDASH_1_VISUALLY_IMPAIRED",
+ "DVBDASH_2_HARD_OF_HEARING",
+ "DVBDASH_3_SUPPLEMENTAL_COMMENTARY",
+ "DVBDASH_4_DIRECTORS_COMMENTARY",
+ "DVBDASH_5_EDUCATIONAL_NOTES",
+ "DVBDASH_6_MAIN_PROGRAM",
+ "DVBDASH_7_CLEAN_FEED"
+ ]
+ },
+ "__listOfDashRoleAudio": {
+ "type": "list",
+ "member": {
+ "shape": "DashRoleAudio"
+ },
+ "documentation": "Placeholder documentation for __listOfDashRoleAudio"
+ },
+ "__listOfDashRoleCaption": {
+ "type": "list",
+ "member": {
+ "shape": "DashRoleCaption"
+ },
+ "documentation": "Placeholder documentation for __listOfDashRoleCaption"
+ },
+ "Scte35Type": {
+ "type": "string",
+ "documentation": "Scte35 Type",
+ "enum": [
+ "NONE",
+ "SCTE_35_WITHOUT_SEGMENTATION"
+ ]
+ },
+ "BadRequestExceptionResponseContent": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "Exception error message."
+ }
+ },
+ "documentation": "The input fails to satisfy the constraints specified by an AWS service."
+ },
+ "CloudWatchAlarmTemplateComparisonOperator": {
+ "type": "string",
+ "documentation": "The comparison operator used to compare the specified statistic and the threshold.",
+ "enum": [
+ "GreaterThanOrEqualToThreshold",
+ "GreaterThanThreshold",
+ "LessThanThreshold",
+ "LessThanOrEqualToThreshold"
+ ]
+ },
+ "CloudWatchAlarmTemplateGroupSummary": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
+ "locationName": "arn",
+ "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ },
+ "TemplateCount": {
+ "shape": "__integer",
+ "locationName": "templateCount",
+ "documentation": "The number of templates in a group."
+ }
+ },
+ "required": [
+ "TemplateCount",
+ "CreatedAt",
+ "Id",
+ "Arn",
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for CloudWatchAlarmTemplateGroupSummary"
+ },
+ "CloudWatchAlarmTemplateStatistic": {
+ "type": "string",
+ "documentation": "The statistic to apply to the alarm's metric data.",
+ "enum": [
+ "SampleCount",
+ "Average",
+ "Sum",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ "CloudWatchAlarmTemplateSummary": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
+ "locationName": "arn",
+ "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
+ },
+ "ComparisonOperator": {
+ "shape": "CloudWatchAlarmTemplateComparisonOperator",
+ "locationName": "comparisonOperator"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "DatapointsToAlarm": {
+ "shape": "__integerMin1",
+ "locationName": "datapointsToAlarm",
+ "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EvaluationPeriods": {
+ "shape": "__integerMin1",
+ "locationName": "evaluationPeriods",
+ "documentation": "The number of periods over which data is compared to the specified threshold."
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
+ },
+ "MetricName": {
+ "shape": "__stringMax64",
+ "locationName": "metricName",
+ "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Period": {
+ "shape": "__integerMin10Max86400",
+ "locationName": "period",
+ "documentation": "The period, in seconds, over which the specified statistic is applied."
+ },
+ "Statistic": {
+ "shape": "CloudWatchAlarmTemplateStatistic",
+ "locationName": "statistic"
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ },
+ "TargetResourceType": {
+ "shape": "CloudWatchAlarmTemplateTargetResourceType",
+ "locationName": "targetResourceType"
+ },
+ "Threshold": {
+ "shape": "__double",
+ "locationName": "threshold",
+ "documentation": "The threshold value to compare with the specified statistic."
+ },
+ "TreatMissingData": {
+ "shape": "CloudWatchAlarmTemplateTreatMissingData",
+ "locationName": "treatMissingData"
+ }
+ },
+ "required": [
+ "TargetResourceType",
+ "TreatMissingData",
+ "ComparisonOperator",
+ "CreatedAt",
+ "Period",
+ "EvaluationPeriods",
+ "Name",
+ "GroupId",
+ "MetricName",
+ "Statistic",
+ "Id",
+ "Arn",
+ "Threshold"
+ ],
+ "documentation": "Placeholder documentation for CloudWatchAlarmTemplateSummary"
+ },
+ "CloudWatchAlarmTemplateTargetResourceType": {
+ "type": "string",
+ "documentation": "The resource type this template should dynamically generate cloudwatch metric alarms for.",
+ "enum": [
+ "CLOUDFRONT_DISTRIBUTION",
+ "MEDIALIVE_MULTIPLEX",
+ "MEDIALIVE_CHANNEL",
+ "MEDIALIVE_INPUT_DEVICE",
+ "MEDIAPACKAGE_CHANNEL",
+ "MEDIAPACKAGE_ORIGIN_ENDPOINT",
+ "MEDIACONNECT_FLOW",
+ "S3_BUCKET"
+ ]
+ },
+ "CloudWatchAlarmTemplateTreatMissingData": {
+ "type": "string",
+ "documentation": "Specifies how missing data points are treated when evaluating the alarm's condition.",
+ "enum": [
+ "notBreaching",
+ "breaching",
+ "ignore",
+ "missing"
+ ]
+ },
+ "ConflictExceptionResponseContent": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "Exception error message."
+ }
+ },
+ "documentation": "Updating or deleting a resource can cause an inconsistent state."
+ },
+ "CreateCloudWatchAlarmTemplateGroupRequest": {
+ "type": "structure",
+ "members": {
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateGroupRequest"
+ },
+ "CreateCloudWatchAlarmTemplateGroupRequestContent": {
+ "type": "structure",
+ "members": {
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateGroupRequestContent"
+ },
+ "CreateCloudWatchAlarmTemplateGroupResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
+ "locationName": "arn",
+ "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateGroupResponse"
+ },
+ "CreateCloudWatchAlarmTemplateGroupResponseContent": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
+ "locationName": "arn",
+ "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "CreatedAt",
+ "Id",
+ "Arn",
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateGroupResponseContent"
+ },
+ "CreateCloudWatchAlarmTemplateRequest": {
+ "type": "structure",
+ "members": {
+ "ComparisonOperator": {
+ "shape": "CloudWatchAlarmTemplateComparisonOperator",
+ "locationName": "comparisonOperator"
+ },
+ "DatapointsToAlarm": {
+ "shape": "__integerMin1",
+ "locationName": "datapointsToAlarm",
+ "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EvaluationPeriods": {
+ "shape": "__integerMin1",
+ "locationName": "evaluationPeriods",
+ "documentation": "The number of periods over which data is compared to the specified threshold."
+ },
+ "GroupIdentifier": {
+ "shape": "__stringPatternS",
+ "locationName": "groupIdentifier",
+ "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
+ },
+ "MetricName": {
+ "shape": "__stringMax64",
+ "locationName": "metricName",
+ "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Period": {
+ "shape": "__integerMin10Max86400",
+ "locationName": "period",
+ "documentation": "The period, in seconds, over which the specified statistic is applied."
+ },
+ "Statistic": {
+ "shape": "CloudWatchAlarmTemplateStatistic",
+ "locationName": "statistic"
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ },
+ "TargetResourceType": {
+ "shape": "CloudWatchAlarmTemplateTargetResourceType",
+ "locationName": "targetResourceType"
+ },
+ "Threshold": {
+ "shape": "__double",
+ "locationName": "threshold",
+ "documentation": "The threshold value to compare with the specified statistic."
+ },
+ "TreatMissingData": {
+ "shape": "CloudWatchAlarmTemplateTreatMissingData",
+ "locationName": "treatMissingData"
+ }
+ },
+ "required": [
+ "TargetResourceType",
+ "MetricName",
+ "TreatMissingData",
+ "ComparisonOperator",
+ "Statistic",
+ "Period",
+ "EvaluationPeriods",
+ "Threshold",
+ "Name",
+ "GroupIdentifier"
+ ],
+ "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateRequest"
+ },
+ "CreateCloudWatchAlarmTemplateRequestContent": {
+ "type": "structure",
+ "members": {
+ "ComparisonOperator": {
+ "shape": "CloudWatchAlarmTemplateComparisonOperator",
+ "locationName": "comparisonOperator"
+ },
+ "DatapointsToAlarm": {
+ "shape": "__integerMin1",
+ "locationName": "datapointsToAlarm",
+ "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EvaluationPeriods": {
+ "shape": "__integerMin1",
+ "locationName": "evaluationPeriods",
+ "documentation": "The number of periods over which data is compared to the specified threshold."
+ },
+ "GroupIdentifier": {
+ "shape": "__stringPatternS",
+ "locationName": "groupIdentifier",
+ "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
+ },
+ "MetricName": {
+ "shape": "__stringMax64",
+ "locationName": "metricName",
+ "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Period": {
+ "shape": "__integerMin10Max86400",
+ "locationName": "period",
+ "documentation": "The period, in seconds, over which the specified statistic is applied."
+ },
+ "Statistic": {
+ "shape": "CloudWatchAlarmTemplateStatistic",
+ "locationName": "statistic"
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ },
+ "TargetResourceType": {
+ "shape": "CloudWatchAlarmTemplateTargetResourceType",
+ "locationName": "targetResourceType"
+ },
+ "Threshold": {
+ "shape": "__double",
+ "locationName": "threshold",
+ "documentation": "The threshold value to compare with the specified statistic."
+ },
+ "TreatMissingData": {
+ "shape": "CloudWatchAlarmTemplateTreatMissingData",
+ "locationName": "treatMissingData"
+ }
+ },
+ "required": [
+ "TargetResourceType",
+ "MetricName",
+ "TreatMissingData",
+ "ComparisonOperator",
+ "Statistic",
+ "Period",
+ "EvaluationPeriods",
+ "Threshold",
+ "Name",
+ "GroupIdentifier"
+ ],
+ "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateRequestContent"
+ },
+ "CreateCloudWatchAlarmTemplateResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
+ "locationName": "arn",
+ "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
+ },
+ "ComparisonOperator": {
+ "shape": "CloudWatchAlarmTemplateComparisonOperator",
+ "locationName": "comparisonOperator"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "DatapointsToAlarm": {
+ "shape": "__integerMin1",
+ "locationName": "datapointsToAlarm",
+ "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EvaluationPeriods": {
+ "shape": "__integerMin1",
+ "locationName": "evaluationPeriods",
+ "documentation": "The number of periods over which data is compared to the specified threshold."
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
+ },
+ "MetricName": {
+ "shape": "__stringMax64",
+ "locationName": "metricName",
+ "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Period": {
+ "shape": "__integerMin10Max86400",
+ "locationName": "period",
+ "documentation": "The period, in seconds, over which the specified statistic is applied."
+ },
+ "Statistic": {
+ "shape": "CloudWatchAlarmTemplateStatistic",
+ "locationName": "statistic"
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ },
+ "TargetResourceType": {
+ "shape": "CloudWatchAlarmTemplateTargetResourceType",
+ "locationName": "targetResourceType"
+ },
+ "Threshold": {
+ "shape": "__double",
+ "locationName": "threshold",
+ "documentation": "The threshold value to compare with the specified statistic."
+ },
+ "TreatMissingData": {
+ "shape": "CloudWatchAlarmTemplateTreatMissingData",
+ "locationName": "treatMissingData"
+ }
+ },
+ "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateResponse"
+ },
+ "CreateCloudWatchAlarmTemplateResponseContent": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
+ "locationName": "arn",
+ "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
+ },
+ "ComparisonOperator": {
+ "shape": "CloudWatchAlarmTemplateComparisonOperator",
+ "locationName": "comparisonOperator"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "DatapointsToAlarm": {
+ "shape": "__integerMin1",
+ "locationName": "datapointsToAlarm",
+ "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EvaluationPeriods": {
+ "shape": "__integerMin1",
+ "locationName": "evaluationPeriods",
+ "documentation": "The number of periods over which data is compared to the specified threshold."
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
+ },
+ "MetricName": {
+ "shape": "__stringMax64",
+ "locationName": "metricName",
+ "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Period": {
+ "shape": "__integerMin10Max86400",
+ "locationName": "period",
+ "documentation": "The period, in seconds, over which the specified statistic is applied."
+ },
+ "Statistic": {
+ "shape": "CloudWatchAlarmTemplateStatistic",
+ "locationName": "statistic"
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ },
+ "TargetResourceType": {
+ "shape": "CloudWatchAlarmTemplateTargetResourceType",
+ "locationName": "targetResourceType"
+ },
+ "Threshold": {
+ "shape": "__double",
+ "locationName": "threshold",
+ "documentation": "The threshold value to compare with the specified statistic."
+ },
+ "TreatMissingData": {
+ "shape": "CloudWatchAlarmTemplateTreatMissingData",
+ "locationName": "treatMissingData"
+ }
+ },
+ "required": [
+ "TargetResourceType",
+ "TreatMissingData",
+ "ComparisonOperator",
+ "CreatedAt",
+ "Period",
+ "EvaluationPeriods",
+ "Name",
+ "GroupId",
+ "MetricName",
+ "Statistic",
+ "Id",
+ "Arn",
+ "Threshold"
+ ],
+ "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateResponseContent"
+ },
+ "CreateEventBridgeRuleTemplateGroupRequest": {
+ "type": "structure",
+ "members": {
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateGroupRequest"
+ },
+ "CreateEventBridgeRuleTemplateGroupRequestContent": {
+ "type": "structure",
+ "members": {
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateGroupRequestContent"
+ },
+ "CreateEventBridgeRuleTemplateGroupResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
+ "locationName": "arn",
+ "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateGroupResponse"
+ },
+ "CreateEventBridgeRuleTemplateGroupResponseContent": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
+ "locationName": "arn",
+ "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "CreatedAt",
+ "Id",
+ "Arn",
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateGroupResponseContent"
+ },
+ "CreateEventBridgeRuleTemplateRequest": {
+ "type": "structure",
+ "members": {
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EventTargets": {
+ "shape": "__listOfEventBridgeRuleTemplateTarget",
+ "locationName": "eventTargets"
+ },
+ "EventType": {
+ "shape": "EventBridgeRuleTemplateEventType",
+ "locationName": "eventType"
+ },
+ "GroupIdentifier": {
+ "shape": "__stringPatternS",
+ "locationName": "groupIdentifier",
+ "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "EventType",
+ "Name",
+ "GroupIdentifier"
+ ],
+ "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateRequest"
+ },
+ "CreateEventBridgeRuleTemplateRequestContent": {
+ "type": "structure",
+ "members": {
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EventTargets": {
+ "shape": "__listOfEventBridgeRuleTemplateTarget",
+ "locationName": "eventTargets"
+ },
+ "EventType": {
+ "shape": "EventBridgeRuleTemplateEventType",
+ "locationName": "eventType"
+ },
+ "GroupIdentifier": {
+ "shape": "__stringPatternS",
+ "locationName": "groupIdentifier",
+ "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "EventType",
+ "Name",
+ "GroupIdentifier"
+ ],
+ "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateRequestContent"
+ },
+ "CreateEventBridgeRuleTemplateResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
+ "locationName": "arn",
+ "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EventTargets": {
+ "shape": "__listOfEventBridgeRuleTemplateTarget",
+ "locationName": "eventTargets"
+ },
+ "EventType": {
+ "shape": "EventBridgeRuleTemplateEventType",
+ "locationName": "eventType"
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateResponse"
+ },
+ "CreateEventBridgeRuleTemplateResponseContent": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
+ "locationName": "arn",
+ "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EventTargets": {
+ "shape": "__listOfEventBridgeRuleTemplateTarget",
+ "locationName": "eventTargets"
+ },
+ "EventType": {
+ "shape": "EventBridgeRuleTemplateEventType",
+ "locationName": "eventType"
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "EventType",
+ "CreatedAt",
+ "Id",
+ "Arn",
+ "Name",
+ "GroupId"
+ ],
+ "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateResponseContent"
+ },
+ "CreateSignalMapRequest": {
+ "type": "structure",
+ "members": {
+ "CloudWatchAlarmTemplateGroupIdentifiers": {
+ "shape": "__listOf__stringPatternS",
+ "locationName": "cloudWatchAlarmTemplateGroupIdentifiers"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ },
+ "EventBridgeRuleTemplateGroupIdentifiers": {
+ "shape": "__listOf__stringPatternS",
+ "locationName": "eventBridgeRuleTemplateGroupIdentifiers"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "DiscoveryEntryPointArn",
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for CreateSignalMapRequest"
+ },
+ "CreateSignalMapRequestContent": {
+ "type": "structure",
+ "members": {
+ "CloudWatchAlarmTemplateGroupIdentifiers": {
+ "shape": "__listOf__stringPatternS",
+ "locationName": "cloudWatchAlarmTemplateGroupIdentifiers"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ },
+ "EventBridgeRuleTemplateGroupIdentifiers": {
+ "shape": "__listOf__stringPatternS",
+ "locationName": "eventBridgeRuleTemplateGroupIdentifiers"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "DiscoveryEntryPointArn",
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for CreateSignalMapRequestContent"
+ },
+ "CreateSignalMapResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveSignalMap",
+ "locationName": "arn",
+ "documentation": "A signal map's ARN (Amazon Resource Name)"
+ },
+ "CloudWatchAlarmTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "cloudWatchAlarmTemplateGroupIds"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ },
+ "ErrorMessage": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "errorMessage",
+ "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ },
+ "EventBridgeRuleTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "eventBridgeRuleTemplateGroupIds"
+ },
+ "FailedMediaResourceMap": {
+ "shape": "FailedMediaResourceMap",
+ "locationName": "failedMediaResourceMap"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A signal map's id."
+ },
+ "LastDiscoveredAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "lastDiscoveredAt"
+ },
+ "LastSuccessfulMonitorDeployment": {
+ "shape": "SuccessfulMonitorDeployment",
+ "locationName": "lastSuccessfulMonitorDeployment"
+ },
+ "MediaResourceMap": {
+ "shape": "MediaResourceMap",
+ "locationName": "mediaResourceMap"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "MonitorChangesPendingDeployment": {
+ "shape": "__boolean",
+ "locationName": "monitorChangesPendingDeployment",
+ "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ },
+ "MonitorDeployment": {
+ "shape": "MonitorDeployment",
+ "locationName": "monitorDeployment"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Status": {
+ "shape": "SignalMapStatus",
+ "locationName": "status"
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "documentation": "Placeholder documentation for CreateSignalMapResponse"
+ },
+ "CreateSignalMapResponseContent": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveSignalMap",
+ "locationName": "arn",
+ "documentation": "A signal map's ARN (Amazon Resource Name)"
+ },
+ "CloudWatchAlarmTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "cloudWatchAlarmTemplateGroupIds"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ },
+ "ErrorMessage": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "errorMessage",
+ "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ },
+ "EventBridgeRuleTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "eventBridgeRuleTemplateGroupIds"
+ },
+ "FailedMediaResourceMap": {
+ "shape": "FailedMediaResourceMap",
+ "locationName": "failedMediaResourceMap"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A signal map's id."
+ },
+ "LastDiscoveredAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "lastDiscoveredAt"
+ },
+ "LastSuccessfulMonitorDeployment": {
+ "shape": "SuccessfulMonitorDeployment",
+ "locationName": "lastSuccessfulMonitorDeployment"
+ },
+ "MediaResourceMap": {
+ "shape": "MediaResourceMap",
+ "locationName": "mediaResourceMap"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "MonitorChangesPendingDeployment": {
+ "shape": "__boolean",
+ "locationName": "monitorChangesPendingDeployment",
+ "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ },
+ "MonitorDeployment": {
+ "shape": "MonitorDeployment",
+ "locationName": "monitorDeployment"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Status": {
+ "shape": "SignalMapStatus",
+ "locationName": "status"
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "Status",
+ "CreatedAt",
+ "Name",
+ "Id",
+ "Arn",
+ "DiscoveryEntryPointArn",
+ "MonitorChangesPendingDeployment"
+ ],
+ "documentation": "Placeholder documentation for CreateSignalMapResponseContent"
+ },
+ "DeleteCloudWatchAlarmTemplateGroupRequest": {
+ "type": "structure",
+ "members": {
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for DeleteCloudWatchAlarmTemplateGroupRequest"
+ },
+ "DeleteCloudWatchAlarmTemplateRequest": {
+ "type": "structure",
+ "members": {
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "A cloudwatch alarm template's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for DeleteCloudWatchAlarmTemplateRequest"
+ },
+ "DeleteEventBridgeRuleTemplateGroupRequest": {
+ "type": "structure",
+ "members": {
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for DeleteEventBridgeRuleTemplateGroupRequest"
+ },
+ "DeleteEventBridgeRuleTemplateRequest": {
+ "type": "structure",
+ "members": {
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "An eventbridge rule template's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for DeleteEventBridgeRuleTemplateRequest"
+ },
+ "DeleteSignalMapRequest": {
+ "type": "structure",
+ "members": {
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "A signal map's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for DeleteSignalMapRequest"
+ },
+ "EventBridgeRuleTemplateEventType": {
+ "type": "string",
+ "documentation": "The type of event to match with the rule.",
+ "enum": [
+ "MEDIALIVE_MULTIPLEX_ALERT",
+ "MEDIALIVE_MULTIPLEX_STATE_CHANGE",
+ "MEDIALIVE_CHANNEL_ALERT",
+ "MEDIALIVE_CHANNEL_INPUT_CHANGE",
+ "MEDIALIVE_CHANNEL_STATE_CHANGE",
+ "MEDIAPACKAGE_INPUT_NOTIFICATION",
+ "MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION",
+ "MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION",
+ "SIGNAL_MAP_ACTIVE_ALARM",
+ "MEDIACONNECT_ALERT",
+ "MEDIACONNECT_SOURCE_HEALTH",
+ "MEDIACONNECT_OUTPUT_HEALTH",
+ "MEDIACONNECT_FLOW_STATUS_CHANGE"
+ ]
+ },
+ "EventBridgeRuleTemplateGroupSummary": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
+ "locationName": "arn",
+ "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ },
+ "TemplateCount": {
+ "shape": "__integer",
+ "locationName": "templateCount",
+ "documentation": "The number of templates in a group."
+ }
+ },
+ "required": [
+ "TemplateCount",
+ "CreatedAt",
+ "Id",
+ "Arn",
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for EventBridgeRuleTemplateGroupSummary"
+ },
+ "EventBridgeRuleTemplateSummary": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
+ "locationName": "arn",
+ "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EventTargetCount": {
+ "shape": "__integerMax5",
+ "locationName": "eventTargetCount",
+ "documentation": "The number of targets configured to send matching events."
+ },
+ "EventType": {
+ "shape": "EventBridgeRuleTemplateEventType",
+ "locationName": "eventType"
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "EventType",
+ "CreatedAt",
+ "EventTargetCount",
+ "Id",
+ "Arn",
+ "Name",
+ "GroupId"
+ ],
+ "documentation": "Placeholder documentation for EventBridgeRuleTemplateSummary"
+ },
+ "EventBridgeRuleTemplateTarget": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringMin1Max2048PatternArn",
+ "locationName": "arn",
+ "documentation": "Target ARNs must be either an SNS topic or CloudWatch log group."
+ }
+ },
+ "documentation": "The target to which to send matching events.",
+ "required": [
+ "Arn"
+ ]
+ },
+ "FailedMediaResourceMap": {
+ "type": "map",
+ "documentation": "A map representing an incomplete AWS media workflow as a graph.",
+ "key": {
+ "shape": "__string"
+ },
+ "value": {
+ "shape": "MediaResource"
+ }
+ },
+ "ForbiddenExceptionResponseContent": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "Exception error message."
+ }
+ },
+ "documentation": "User does not have sufficient access to perform this action."
+ },
+ "GetCloudWatchAlarmTemplateGroupRequest": {
+ "type": "structure",
+ "members": {
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateGroupRequest"
+ },
+ "GetCloudWatchAlarmTemplateGroupResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
+ "locationName": "arn",
+ "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateGroupResponse"
+ },
+ "GetCloudWatchAlarmTemplateGroupResponseContent": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
+ "locationName": "arn",
+ "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "CreatedAt",
+ "Id",
+ "Arn",
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateGroupResponseContent"
+ },
+ "GetCloudWatchAlarmTemplateRequest": {
+ "type": "structure",
+ "members": {
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "A cloudwatch alarm template's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateRequest"
+ },
+ "GetCloudWatchAlarmTemplateResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
+ "locationName": "arn",
+ "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
+ },
+ "ComparisonOperator": {
+ "shape": "CloudWatchAlarmTemplateComparisonOperator",
+ "locationName": "comparisonOperator"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "DatapointsToAlarm": {
+ "shape": "__integerMin1",
+ "locationName": "datapointsToAlarm",
+ "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EvaluationPeriods": {
+ "shape": "__integerMin1",
+ "locationName": "evaluationPeriods",
+ "documentation": "The number of periods over which data is compared to the specified threshold."
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
+ },
+ "MetricName": {
+ "shape": "__stringMax64",
+ "locationName": "metricName",
+ "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Period": {
+ "shape": "__integerMin10Max86400",
+ "locationName": "period",
+ "documentation": "The period, in seconds, over which the specified statistic is applied."
+ },
+ "Statistic": {
+ "shape": "CloudWatchAlarmTemplateStatistic",
+ "locationName": "statistic"
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ },
+ "TargetResourceType": {
+ "shape": "CloudWatchAlarmTemplateTargetResourceType",
+ "locationName": "targetResourceType"
+ },
+ "Threshold": {
+ "shape": "__double",
+ "locationName": "threshold",
+ "documentation": "The threshold value to compare with the specified statistic."
+ },
+ "TreatMissingData": {
+ "shape": "CloudWatchAlarmTemplateTreatMissingData",
+ "locationName": "treatMissingData"
+ }
+ },
+ "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateResponse"
+ },
+ "GetCloudWatchAlarmTemplateResponseContent": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
+ "locationName": "arn",
+ "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
+ },
+ "ComparisonOperator": {
+ "shape": "CloudWatchAlarmTemplateComparisonOperator",
+ "locationName": "comparisonOperator"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "DatapointsToAlarm": {
+ "shape": "__integerMin1",
+ "locationName": "datapointsToAlarm",
+ "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EvaluationPeriods": {
+ "shape": "__integerMin1",
+ "locationName": "evaluationPeriods",
+ "documentation": "The number of periods over which data is compared to the specified threshold."
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
+ },
+ "MetricName": {
+ "shape": "__stringMax64",
+ "locationName": "metricName",
+ "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Period": {
+ "shape": "__integerMin10Max86400",
+ "locationName": "period",
+ "documentation": "The period, in seconds, over which the specified statistic is applied."
+ },
+ "Statistic": {
+ "shape": "CloudWatchAlarmTemplateStatistic",
+ "locationName": "statistic"
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ },
+ "TargetResourceType": {
+ "shape": "CloudWatchAlarmTemplateTargetResourceType",
+ "locationName": "targetResourceType"
+ },
+ "Threshold": {
+ "shape": "__double",
+ "locationName": "threshold",
+ "documentation": "The threshold value to compare with the specified statistic."
+ },
+ "TreatMissingData": {
+ "shape": "CloudWatchAlarmTemplateTreatMissingData",
+ "locationName": "treatMissingData"
+ }
+ },
+ "required": [
+ "TargetResourceType",
+ "TreatMissingData",
+ "ComparisonOperator",
+ "CreatedAt",
+ "Period",
+ "EvaluationPeriods",
+ "Name",
+ "GroupId",
+ "MetricName",
+ "Statistic",
+ "Id",
+ "Arn",
+ "Threshold"
+ ],
+ "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateResponseContent"
+ },
+ "GetEventBridgeRuleTemplateGroupRequest": {
+ "type": "structure",
+ "members": {
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateGroupRequest"
+ },
+ "GetEventBridgeRuleTemplateGroupResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
+ "locationName": "arn",
+ "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateGroupResponse"
+ },
+ "GetEventBridgeRuleTemplateGroupResponseContent": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
+ "locationName": "arn",
+ "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "CreatedAt",
+ "Id",
+ "Arn",
+ "Name"
],
- "documentation": "The HTTP Accept header. Indicates the requested type fothe thumbnail."
+ "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateGroupResponseContent"
},
- "ContentType": {
- "type": "string",
- "enum": [
- "image/jpeg"
+ "GetEventBridgeRuleTemplateRequest": {
+ "type": "structure",
+ "members": {
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "An eventbridge rule template's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
],
- "documentation": "Specifies the media type of the thumbnail."
- },
- "__timestamp": {
- "type": "timestamp",
- "documentation": "Placeholder documentation for __timestamp"
+ "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateRequest"
},
- "InputDeviceConfigurableAudioChannelPairConfig": {
+ "GetEventBridgeRuleTemplateResponse": {
"type": "structure",
"members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
+ "locationName": "arn",
+ "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EventTargets": {
+ "shape": "__listOfEventBridgeRuleTemplateTarget",
+ "locationName": "eventTargets"
+ },
+ "EventType": {
+ "shape": "EventBridgeRuleTemplateEventType",
+ "locationName": "eventType"
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
"Id": {
- "shape": "__integer",
+ "shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "The ID for one audio pair configuration, a value from 1 to 8."
+ "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
},
- "Profile": {
- "shape": "InputDeviceConfigurableAudioChannelPairProfile",
- "locationName": "profile",
- "documentation": "The profile to set for one audio pair configuration. Choose an enumeration value. Each value describes one audio configuration using the format (rate control algorithm)-(codec)_(quality)-(bitrate in bytes). For example, CBR-AAC_HQ-192000. Or choose DISABLED, in which case the device won't produce audio for this pair."
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
}
},
- "documentation": "One audio configuration that specifies the format for one audio pair that the device produces as output."
- },
- "InputDeviceConfigurableAudioChannelPairProfile": {
- "type": "string",
- "documentation": "Property of InputDeviceConfigurableAudioChannelPairConfig, which configures one audio channel that the device produces.",
- "enum": [
- "DISABLED",
- "VBR-AAC_HHE-16000",
- "VBR-AAC_HE-64000",
- "VBR-AAC_LC-128000",
- "CBR-AAC_HQ-192000",
- "CBR-AAC_HQ-256000",
- "CBR-AAC_HQ-384000",
- "CBR-AAC_HQ-512000"
- ]
+ "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateResponse"
},
- "InputDeviceUhdAudioChannelPairConfig": {
+ "GetEventBridgeRuleTemplateResponseContent": {
"type": "structure",
"members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
+ "locationName": "arn",
+ "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EventTargets": {
+ "shape": "__listOfEventBridgeRuleTemplateTarget",
+ "locationName": "eventTargets"
+ },
+ "EventType": {
+ "shape": "EventBridgeRuleTemplateEventType",
+ "locationName": "eventType"
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
"Id": {
- "shape": "__integer",
+ "shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "The ID for one audio pair configuration, a value from 1 to 8."
+ "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
},
- "Profile": {
- "shape": "InputDeviceUhdAudioChannelPairProfile",
- "locationName": "profile",
- "documentation": "The profile for one audio pair configuration. This property describes one audio configuration in the format (rate control algorithm)-(codec)_(quality)-(bitrate in bytes). For example, CBR-AAC_HQ-192000. Or DISABLED, in which case the device won't produce audio for this pair."
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
}
},
- "documentation": "One audio configuration that specifies the format for one audio pair that the device produces as output."
- },
- "InputDeviceUhdAudioChannelPairProfile": {
- "type": "string",
- "documentation": "Property of InputDeviceUhdAudioChannelPairConfig, which describes one audio channel that the device is configured to produce.",
- "enum": [
- "DISABLED",
- "VBR-AAC_HHE-16000",
- "VBR-AAC_HE-64000",
- "VBR-AAC_LC-128000",
- "CBR-AAC_HQ-192000",
- "CBR-AAC_HQ-256000",
- "CBR-AAC_HQ-384000",
- "CBR-AAC_HQ-512000"
- ]
- },
- "__listOfInputDeviceConfigurableAudioChannelPairConfig": {
- "type": "list",
- "member": {
- "shape": "InputDeviceConfigurableAudioChannelPairConfig"
- },
- "documentation": "Placeholder documentation for __listOfInputDeviceConfigurableAudioChannelPairConfig"
- },
- "__listOfInputDeviceUhdAudioChannelPairConfig": {
- "type": "list",
- "member": {
- "shape": "InputDeviceUhdAudioChannelPairConfig"
- },
- "documentation": "Placeholder documentation for __listOfInputDeviceUhdAudioChannelPairConfig"
- },
- "ChannelPipelineIdToRestart": {
- "type": "string",
- "documentation": "Property of RestartChannelPipelinesRequest",
- "enum": [
- "PIPELINE_0",
- "PIPELINE_1"
- ]
+ "required": [
+ "EventType",
+ "CreatedAt",
+ "Id",
+ "Arn",
+ "Name",
+ "GroupId"
+ ],
+ "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateResponseContent"
},
- "RestartChannelPipelinesRequest": {
+ "GetSignalMapRequest": {
"type": "structure",
"members": {
- "ChannelId": {
+ "Identifier": {
"shape": "__string",
"location": "uri",
- "locationName": "channelId",
- "documentation": "ID of channel"
+ "locationName": "identifier",
+ "documentation": "A signal map's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for GetSignalMapRequest"
+ },
+ "GetSignalMapResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveSignalMap",
+ "locationName": "arn",
+ "documentation": "A signal map's ARN (Amazon Resource Name)"
+ },
+ "CloudWatchAlarmTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "cloudWatchAlarmTemplateGroupIds"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
+ },
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ },
+ "ErrorMessage": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "errorMessage",
+ "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ },
+ "EventBridgeRuleTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "eventBridgeRuleTemplateGroupIds"
+ },
+ "FailedMediaResourceMap": {
+ "shape": "FailedMediaResourceMap",
+ "locationName": "failedMediaResourceMap"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A signal map's id."
+ },
+ "LastDiscoveredAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "lastDiscoveredAt"
+ },
+ "LastSuccessfulMonitorDeployment": {
+ "shape": "SuccessfulMonitorDeployment",
+ "locationName": "lastSuccessfulMonitorDeployment"
+ },
+ "MediaResourceMap": {
+ "shape": "MediaResourceMap",
+ "locationName": "mediaResourceMap"
},
- "PipelineIds": {
- "shape": "__listOfChannelPipelineIdToRestart",
- "locationName": "pipelineIds",
- "documentation": "An array of pipelines to restart in this channel. Format PIPELINE_0 or PIPELINE_1."
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "MonitorChangesPendingDeployment": {
+ "shape": "__boolean",
+ "locationName": "monitorChangesPendingDeployment",
+ "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ },
+ "MonitorDeployment": {
+ "shape": "MonitorDeployment",
+ "locationName": "monitorDeployment"
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ },
+ "Status": {
+ "shape": "SignalMapStatus",
+ "locationName": "status"
+ },
+ "Tags": {
+ "shape": "TagMap",
+ "locationName": "tags"
}
},
- "documentation": "Pipelines to restart.",
- "required": [
- "ChannelId"
- ]
+ "documentation": "Placeholder documentation for GetSignalMapResponse"
},
- "RestartChannelPipelinesResponse": {
+ "GetSignalMapResponseContent": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__string",
+ "shape": "__stringPatternArnMedialiveSignalMap",
"locationName": "arn",
- "documentation": "The unique arn of the channel."
+ "documentation": "A signal map's ARN (Amazon Resource Name)"
},
- "CdiInputSpecification": {
- "shape": "CdiInputSpecification",
- "locationName": "cdiInputSpecification",
- "documentation": "Specification of CDI inputs for this channel"
+ "CloudWatchAlarmTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "cloudWatchAlarmTemplateGroupIds"
},
- "ChannelClass": {
- "shape": "ChannelClass",
- "locationName": "channelClass",
- "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
},
- "Destinations": {
- "shape": "__listOfOutputDestination",
- "locationName": "destinations",
- "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager."
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
},
- "EgressEndpoints": {
- "shape": "__listOfChannelEgressEndpoint",
- "locationName": "egressEndpoints",
- "documentation": "The endpoints where outgoing connections initiate from"
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
},
- "EncoderSettings": {
- "shape": "EncoderSettings",
- "locationName": "encoderSettings"
+ "ErrorMessage": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "errorMessage",
+ "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ },
+ "EventBridgeRuleTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "eventBridgeRuleTemplateGroupIds"
+ },
+ "FailedMediaResourceMap": {
+ "shape": "FailedMediaResourceMap",
+ "locationName": "failedMediaResourceMap"
},
"Id": {
- "shape": "__string",
+ "shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "The unique id of the channel."
+ "documentation": "A signal map's id."
},
- "InputAttachments": {
- "shape": "__listOfInputAttachment",
- "locationName": "inputAttachments",
- "documentation": "List of input attachments for channel."
+ "LastDiscoveredAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "lastDiscoveredAt"
},
- "InputSpecification": {
- "shape": "InputSpecification",
- "locationName": "inputSpecification",
- "documentation": "Specification of network and file inputs for this channel"
+ "LastSuccessfulMonitorDeployment": {
+ "shape": "SuccessfulMonitorDeployment",
+ "locationName": "lastSuccessfulMonitorDeployment"
},
- "LogLevel": {
- "shape": "LogLevel",
- "locationName": "logLevel",
- "documentation": "The log level being written to CloudWatch Logs."
+ "MediaResourceMap": {
+ "shape": "MediaResourceMap",
+ "locationName": "mediaResourceMap"
},
- "Maintenance": {
- "shape": "MaintenanceStatus",
- "locationName": "maintenance",
- "documentation": "Maintenance settings for this channel."
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
},
- "MaintenanceStatus": {
- "shape": "__string",
- "locationName": "maintenanceStatus",
- "documentation": "The time in milliseconds by when the PVRE restart must occur."
+ "MonitorChangesPendingDeployment": {
+ "shape": "__boolean",
+ "locationName": "monitorChangesPendingDeployment",
+ "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ },
+ "MonitorDeployment": {
+ "shape": "MonitorDeployment",
+ "locationName": "monitorDeployment"
},
"Name": {
- "shape": "__string",
+ "shape": "__stringMin1Max255PatternS",
"locationName": "name",
- "documentation": "The name of the channel. (user-mutable)"
- },
- "PipelineDetails": {
- "shape": "__listOfPipelineDetail",
- "locationName": "pipelineDetails",
- "documentation": "Runtime details for the pipelines of a running channel."
- },
- "PipelinesRunningCount": {
- "shape": "__integer",
- "locationName": "pipelinesRunningCount",
- "documentation": "The number of currently healthy pipelines."
- },
- "RoleArn": {
- "shape": "__string",
- "locationName": "roleArn",
- "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
- "State": {
- "shape": "ChannelState",
- "locationName": "state"
+ "Status": {
+ "shape": "SignalMapStatus",
+ "locationName": "status"
},
"Tags": {
- "shape": "Tags",
- "locationName": "tags",
- "documentation": "A collection of key-value pairs."
- },
- "Vpc": {
- "shape": "VpcOutputSettingsDescription",
- "locationName": "vpc",
- "documentation": "Settings for VPC output"
+ "shape": "TagMap",
+ "locationName": "tags"
}
},
- "documentation": "Placeholder documentation for RestartChannelPipelinesResponse"
+ "required": [
+ "Status",
+ "CreatedAt",
+ "Name",
+ "Id",
+ "Arn",
+ "DiscoveryEntryPointArn",
+ "MonitorChangesPendingDeployment"
+ ],
+ "documentation": "Placeholder documentation for GetSignalMapResponseContent"
},
- "__listOfChannelPipelineIdToRestart": {
- "type": "list",
- "member": {
- "shape": "ChannelPipelineIdToRestart"
+ "InternalServerErrorExceptionResponseContent": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "Exception error message."
+ }
},
- "documentation": "Placeholder documentation for __listOfChannelPipelineIdToRestart"
- },
- "H265MvOverPictureBoundaries": {
- "type": "string",
- "documentation": "H265 Mv Over Picture Boundaries",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "H265MvTemporalPredictor": {
- "type": "string",
- "documentation": "H265 Mv Temporal Predictor",
- "enum": [
- "DISABLED",
- "ENABLED"
- ]
- },
- "H265TilePadding": {
- "type": "string",
- "documentation": "H265 Tile Padding",
- "enum": [
- "NONE",
- "PADDED"
- ]
- },
- "H265TreeblockSize": {
- "type": "string",
- "documentation": "H265 Treeblock Size",
- "enum": [
- "AUTO",
- "TREE_SIZE_32X32"
- ]
+ "documentation": "Unexpected error during processing of request."
},
- "__integerMin256Max3840": {
- "type": "integer",
- "min": 256,
- "max": 3840,
- "documentation": "Placeholder documentation for __integerMin256Max3840"
+ "ListCloudWatchAlarmTemplateGroupsRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ },
+ "Scope": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "scope",
+ "documentation": "Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources."
+ },
+ "SignalMapIdentifier": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "signalMapIdentifier",
+ "documentation": "A signal map's identifier. Can be either be its id or current name."
+ }
+ },
+ "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplateGroupsRequest"
},
- "__integerMin64Max2160": {
- "type": "integer",
- "min": 64,
- "max": 2160,
- "documentation": "Placeholder documentation for __integerMin64Max2160"
+ "ListCloudWatchAlarmTemplateGroupsResponse": {
+ "type": "structure",
+ "members": {
+ "CloudWatchAlarmTemplateGroups": {
+ "shape": "__listOfCloudWatchAlarmTemplateGroupSummary",
+ "locationName": "cloudWatchAlarmTemplateGroups"
+ },
+ "NextToken": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ }
+ },
+ "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplateGroupsResponse"
},
- "CmafIngestGroupSettings": {
+ "ListCloudWatchAlarmTemplateGroupsResponseContent": {
"type": "structure",
"members": {
- "Destination": {
- "shape": "OutputLocationRef",
- "locationName": "destination",
- "documentation": "A HTTP destination for the tracks"
+ "CloudWatchAlarmTemplateGroups": {
+ "shape": "__listOfCloudWatchAlarmTemplateGroupSummary",
+ "locationName": "cloudWatchAlarmTemplateGroups"
},
- "NielsenId3Behavior": {
- "shape": "CmafNielsenId3Behavior",
- "locationName": "nielsenId3Behavior",
- "documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output."
+ "NextToken": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ }
+ },
+ "required": [
+ "CloudWatchAlarmTemplateGroups"
+ ],
+ "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplateGroupsResponseContent"
+ },
+ "ListCloudWatchAlarmTemplatesRequest": {
+ "type": "structure",
+ "members": {
+ "GroupIdentifier": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "groupIdentifier",
+ "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
},
- "Scte35Type": {
- "shape": "Scte35Type",
- "locationName": "scte35Type",
- "documentation": "Type of scte35 track to add. none or scte35WithoutSegmentation"
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
},
- "SegmentLength": {
- "shape": "__integerMin1",
- "locationName": "segmentLength",
- "documentation": "The nominal duration of segments. The units are specified in SegmentLengthUnits. The segments will end on the next keyframe after the specified duration, so the actual segment length might be longer, and it might be a fraction of the units."
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
},
- "SegmentLengthUnits": {
- "shape": "CmafIngestSegmentLengthUnits",
- "locationName": "segmentLengthUnits",
- "documentation": "Time unit for segment length parameter."
+ "Scope": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "scope",
+ "documentation": "Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources."
},
- "SendDelayMs": {
- "shape": "__integerMin0Max2000",
- "locationName": "sendDelayMs",
- "documentation": "Number of milliseconds to delay the output from the second pipeline."
+ "SignalMapIdentifier": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "signalMapIdentifier",
+ "documentation": "A signal map's identifier. Can be either be its id or current name."
}
},
- "documentation": "Cmaf Ingest Group Settings",
- "required": [
- "Destination"
- ]
+ "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplatesRequest"
},
- "CmafIngestOutputSettings": {
+ "ListCloudWatchAlarmTemplatesResponse": {
"type": "structure",
"members": {
- "NameModifier": {
- "shape": "__string",
- "locationName": "nameModifier",
- "documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type."
+ "CloudWatchAlarmTemplates": {
+ "shape": "__listOfCloudWatchAlarmTemplateSummary",
+ "locationName": "cloudWatchAlarmTemplates"
+ },
+ "NextToken": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
}
},
- "documentation": "Cmaf Ingest Output Settings"
- },
- "CmafIngestSegmentLengthUnits": {
- "type": "string",
- "documentation": "Cmaf Ingest Segment Length Units",
- "enum": [
- "MILLISECONDS",
- "SECONDS"
- ]
- },
- "CmafNielsenId3Behavior": {
- "type": "string",
- "documentation": "Cmaf Nielsen Id3 Behavior",
- "enum": [
- "NO_PASSTHROUGH",
- "PASSTHROUGH"
- ]
- },
- "DashRoleAudio": {
- "type": "string",
- "documentation": "Dash Role Audio",
- "enum": [
- "ALTERNATE",
- "COMMENTARY",
- "DESCRIPTION",
- "DUB",
- "EMERGENCY",
- "ENHANCED-AUDIO-INTELLIGIBILITY",
- "KARAOKE",
- "MAIN",
- "SUPPLEMENTARY"
- ]
- },
- "DashRoleCaption": {
- "type": "string",
- "documentation": "Dash Role Caption",
- "enum": [
- "ALTERNATE",
- "CAPTION",
- "COMMENTARY",
- "DESCRIPTION",
- "DUB",
- "EASYREADER",
- "EMERGENCY",
- "FORCED-SUBTITLE",
- "KARAOKE",
- "MAIN",
- "METADATA",
- "SUBTITLE",
- "SUPPLEMENTARY"
- ]
+ "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplatesResponse"
},
- "DvbDashAccessibility": {
- "type": "string",
- "documentation": "Dvb Dash Accessibility",
- "enum": [
- "DVBDASH_1_VISUALLY_IMPAIRED",
- "DVBDASH_2_HARD_OF_HEARING",
- "DVBDASH_3_SUPPLEMENTAL_COMMENTARY",
- "DVBDASH_4_DIRECTORS_COMMENTARY",
- "DVBDASH_5_EDUCATIONAL_NOTES",
- "DVBDASH_6_MAIN_PROGRAM",
- "DVBDASH_7_CLEAN_FEED"
- ]
+ "ListCloudWatchAlarmTemplatesResponseContent": {
+ "type": "structure",
+ "members": {
+ "CloudWatchAlarmTemplates": {
+ "shape": "__listOfCloudWatchAlarmTemplateSummary",
+ "locationName": "cloudWatchAlarmTemplates"
+ },
+ "NextToken": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ }
+ },
+ "required": [
+ "CloudWatchAlarmTemplates"
+ ],
+ "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplatesResponseContent"
},
- "__listOfDashRoleAudio": {
- "type": "list",
- "member": {
- "shape": "DashRoleAudio"
+ "ListEventBridgeRuleTemplateGroupsRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ },
+ "SignalMapIdentifier": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "signalMapIdentifier",
+ "documentation": "A signal map's identifier. Can be either be its id or current name."
+ }
},
- "documentation": "Placeholder documentation for __listOfDashRoleAudio"
+ "documentation": "Placeholder documentation for ListEventBridgeRuleTemplateGroupsRequest"
},
- "__listOfDashRoleCaption": {
- "type": "list",
- "member": {
- "shape": "DashRoleCaption"
+ "ListEventBridgeRuleTemplateGroupsResponse": {
+ "type": "structure",
+ "members": {
+ "EventBridgeRuleTemplateGroups": {
+ "shape": "__listOfEventBridgeRuleTemplateGroupSummary",
+ "locationName": "eventBridgeRuleTemplateGroups"
+ },
+ "NextToken": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ }
},
- "documentation": "Placeholder documentation for __listOfDashRoleCaption"
+ "documentation": "Placeholder documentation for ListEventBridgeRuleTemplateGroupsResponse"
},
- "Scte35Type": {
- "type": "string",
- "documentation": "Scte35 Type",
- "enum": [
- "NONE",
- "SCTE_35_WITHOUT_SEGMENTATION"
- ]
+ "ListEventBridgeRuleTemplateGroupsResponseContent": {
+ "type": "structure",
+ "members": {
+ "EventBridgeRuleTemplateGroups": {
+ "shape": "__listOfEventBridgeRuleTemplateGroupSummary",
+ "locationName": "eventBridgeRuleTemplateGroups"
+ },
+ "NextToken": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ }
+ },
+ "required": [
+ "EventBridgeRuleTemplateGroups"
+ ],
+ "documentation": "Placeholder documentation for ListEventBridgeRuleTemplateGroupsResponseContent"
},
- "BadRequestExceptionResponseContent": {
+ "ListEventBridgeRuleTemplatesRequest": {
"type": "structure",
"members": {
- "Message": {
+ "GroupIdentifier": {
"shape": "__string",
- "locationName": "message",
- "documentation": "Exception error message."
+ "location": "querystring",
+ "locationName": "groupIdentifier",
+ "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ },
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ },
+ "SignalMapIdentifier": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "signalMapIdentifier",
+ "documentation": "A signal map's identifier. Can be either be its id or current name."
}
},
- "documentation": "The input fails to satisfy the constraints specified by an AWS service."
- },
- "CloudWatchAlarmTemplateComparisonOperator": {
- "type": "string",
- "documentation": "The comparison operator used to compare the specified statistic and the threshold.",
- "enum": [
- "GreaterThanOrEqualToThreshold",
- "GreaterThanThreshold",
- "LessThanThreshold",
- "LessThanOrEqualToThreshold"
- ]
+ "documentation": "Placeholder documentation for ListEventBridgeRuleTemplatesRequest"
},
- "CloudWatchAlarmTemplateGroupSummary": {
+ "ListEventBridgeRuleTemplatesResponse": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
- "locationName": "arn",
- "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "EventBridgeRuleTemplates": {
+ "shape": "__listOfEventBridgeRuleTemplateSummary",
+ "locationName": "eventBridgeRuleTemplates"
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "NextToken": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ }
+ },
+ "documentation": "Placeholder documentation for ListEventBridgeRuleTemplatesResponse"
+ },
+ "ListEventBridgeRuleTemplatesResponseContent": {
+ "type": "structure",
+ "members": {
+ "EventBridgeRuleTemplates": {
+ "shape": "__listOfEventBridgeRuleTemplateSummary",
+ "locationName": "eventBridgeRuleTemplates"
},
- "TemplateCount": {
- "shape": "__integer",
- "locationName": "templateCount",
- "documentation": "The number of templates in a group."
+ "NextToken": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
}
},
"required": [
- "TemplateCount",
- "CreatedAt",
- "Id",
- "Arn",
- "Name"
+ "EventBridgeRuleTemplates"
],
- "documentation": "Placeholder documentation for CloudWatchAlarmTemplateGroupSummary"
- },
- "CloudWatchAlarmTemplateStatistic": {
- "type": "string",
- "documentation": "The statistic to apply to the alarm's metric data.",
- "enum": [
- "SampleCount",
- "Average",
- "Sum",
- "Minimum",
- "Maximum"
- ]
+ "documentation": "Placeholder documentation for ListEventBridgeRuleTemplatesResponseContent"
},
- "CloudWatchAlarmTemplateSummary": {
+ "ListSignalMapsRequest": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
- "locationName": "arn",
- "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
- },
- "ComparisonOperator": {
- "shape": "CloudWatchAlarmTemplateComparisonOperator",
- "locationName": "comparisonOperator"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "DatapointsToAlarm": {
- "shape": "__integerMin1",
- "locationName": "datapointsToAlarm",
- "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "EvaluationPeriods": {
- "shape": "__integerMin1",
- "locationName": "evaluationPeriods",
- "documentation": "The number of periods over which data is compared to the specified threshold."
- },
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
- },
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
- },
- "MetricName": {
- "shape": "__stringMax64",
- "locationName": "metricName",
- "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Period": {
- "shape": "__integerMin10Max86400",
- "locationName": "period",
- "documentation": "The period, in seconds, over which the specified statistic is applied."
- },
- "Statistic": {
- "shape": "CloudWatchAlarmTemplateStatistic",
- "locationName": "statistic"
- },
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "CloudWatchAlarmTemplateGroupIdentifier": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "cloudWatchAlarmTemplateGroupIdentifier",
+ "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
},
- "TargetResourceType": {
- "shape": "CloudWatchAlarmTemplateTargetResourceType",
- "locationName": "targetResourceType"
+ "EventBridgeRuleTemplateGroupIdentifier": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "eventBridgeRuleTemplateGroupIdentifier",
+ "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
},
- "Threshold": {
- "shape": "__double",
- "locationName": "threshold",
- "documentation": "The threshold value to compare with the specified statistic."
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
},
- "TreatMissingData": {
- "shape": "CloudWatchAlarmTemplateTreatMissingData",
- "locationName": "treatMissingData"
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
}
},
- "required": [
- "TargetResourceType",
- "TreatMissingData",
- "ComparisonOperator",
- "CreatedAt",
- "Period",
- "EvaluationPeriods",
- "Name",
- "GroupId",
- "MetricName",
- "Statistic",
- "Id",
- "Arn",
- "Threshold"
- ],
- "documentation": "Placeholder documentation for CloudWatchAlarmTemplateSummary"
- },
- "CloudWatchAlarmTemplateTargetResourceType": {
- "type": "string",
- "documentation": "The resource type this template should dynamically generate cloudwatch metric alarms for.",
- "enum": [
- "CLOUDFRONT_DISTRIBUTION",
- "MEDIALIVE_MULTIPLEX",
- "MEDIALIVE_CHANNEL",
- "MEDIALIVE_INPUT_DEVICE",
- "MEDIAPACKAGE_CHANNEL",
- "MEDIAPACKAGE_ORIGIN_ENDPOINT",
- "MEDIACONNECT_FLOW",
- "S3_BUCKET"
- ]
+ "documentation": "Placeholder documentation for ListSignalMapsRequest"
},
- "CloudWatchAlarmTemplateTreatMissingData": {
- "type": "string",
- "documentation": "Specifies how missing data points are treated when evaluating the alarm's condition.",
- "enum": [
- "notBreaching",
- "breaching",
- "ignore",
- "missing"
- ]
+ "ListSignalMapsResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ },
+ "SignalMaps": {
+ "shape": "__listOfSignalMapSummary",
+ "locationName": "signalMaps"
+ }
+ },
+ "documentation": "Placeholder documentation for ListSignalMapsResponse"
},
- "ConflictExceptionResponseContent": {
+ "ListSignalMapsResponseContent": {
"type": "structure",
"members": {
- "Message": {
- "shape": "__string",
- "locationName": "message",
- "documentation": "Exception error message."
+ "NextToken": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "nextToken",
+ "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ },
+ "SignalMaps": {
+ "shape": "__listOfSignalMapSummary",
+ "locationName": "signalMaps"
}
},
- "documentation": "Updating or deleting a resource can cause an inconsistent state."
+ "required": [
+ "SignalMaps"
+ ],
+ "documentation": "Placeholder documentation for ListSignalMapsResponseContent"
},
- "CreateCloudWatchAlarmTemplateGroupRequest": {
+ "MediaResource": {
"type": "structure",
"members": {
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "Destinations": {
+ "shape": "__listOfMediaResourceNeighbor",
+ "locationName": "destinations"
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__stringMin1Max256",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The logical name of an AWS media resource."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "Sources": {
+ "shape": "__listOfMediaResourceNeighbor",
+ "locationName": "sources"
}
},
- "required": [
- "Name"
- ],
- "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateGroupRequest"
+ "documentation": "An AWS resource used in media workflows."
},
- "CreateCloudWatchAlarmTemplateGroupRequestContent": {
+ "MediaResourceMap": {
+ "type": "map",
+ "documentation": "A map representing an AWS media workflow as a graph.",
+ "key": {
+ "shape": "__string"
+ },
+ "value": {
+ "shape": "MediaResource"
+ }
+ },
+ "MediaResourceNeighbor": {
"type": "structure",
"members": {
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "Arn": {
+ "shape": "__stringMin1Max2048PatternArn",
+ "locationName": "arn",
+ "documentation": "The ARN of a resource used in AWS media workflows."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__stringMin1Max256",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The logical name of an AWS media resource."
+ }
+ },
+ "documentation": "A direct source or destination neighbor to an AWS media resource.",
+ "required": [
+ "Arn"
+ ]
+ },
+ "MonitorDeployment": {
+ "type": "structure",
+ "members": {
+ "DetailsUri": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "detailsUri",
+ "documentation": "URI associated with a signal map's monitor deployment."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "ErrorMessage": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "errorMessage",
+ "documentation": "Error message associated with a failed monitor deployment of a signal map."
+ },
+ "Status": {
+ "shape": "SignalMapMonitorDeploymentStatus",
+ "locationName": "status"
}
},
+ "documentation": "Represents the latest monitor deployment of a signal map.",
"required": [
- "Name"
- ],
- "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateGroupRequestContent"
+ "Status"
+ ]
},
- "CreateCloudWatchAlarmTemplateGroupResponse": {
+ "NotFoundExceptionResponseContent": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "Exception error message."
+ }
+ },
+ "documentation": "Request references a resource which does not exist."
+ },
+ "SignalMapMonitorDeploymentStatus": {
+ "type": "string",
+ "documentation": "A signal map's monitor deployment status.",
+ "enum": [
+ "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"
+ ]
+ },
+ "SignalMapStatus": {
+ "type": "string",
+ "documentation": "A signal map's current status which is dependent on its lifecycle actions or associated jobs.",
+ "enum": [
+ "CREATE_IN_PROGRESS",
+ "CREATE_COMPLETE",
+ "CREATE_FAILED",
+ "UPDATE_IN_PROGRESS",
+ "UPDATE_COMPLETE",
+ "UPDATE_REVERTED",
+ "UPDATE_FAILED",
+ "READY",
+ "NOT_READY"
+ ]
+ },
+ "SignalMapSummary": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
+ "shape": "__stringPatternArnMedialiveSignalMap",
"locationName": "arn",
- "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
+ "documentation": "A signal map's ARN (Amazon Resource Name)"
},
"CreatedAt": {
"shape": "__timestampIso8601",
@@ -19795,31 +23337,66 @@
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ "documentation": "A signal map's id."
},
"ModifiedAt": {
"shape": "__timestampIso8601",
"locationName": "modifiedAt"
},
+ "MonitorDeploymentStatus": {
+ "shape": "SignalMapMonitorDeploymentStatus",
+ "locationName": "monitorDeploymentStatus"
+ },
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
+ "Status": {
+ "shape": "SignalMapStatus",
+ "locationName": "status"
+ },
"Tags": {
"shape": "TagMap",
"locationName": "tags"
}
},
- "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateGroupResponse"
+ "required": [
+ "Status",
+ "MonitorDeploymentStatus",
+ "CreatedAt",
+ "Id",
+ "Arn",
+ "Name"
+ ],
+ "documentation": "Placeholder documentation for SignalMapSummary"
},
- "CreateCloudWatchAlarmTemplateGroupResponseContent": {
+ "StartDeleteMonitorDeploymentRequest": {
+ "type": "structure",
+ "members": {
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "A signal map's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for StartDeleteMonitorDeploymentRequest"
+ },
+ "StartDeleteMonitorDeploymentResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
+ "shape": "__stringPatternArnMedialiveSignalMap",
"locationName": "arn",
- "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
+ "documentation": "A signal map's ARN (Amazon Resource Name)"
+ },
+ "CloudWatchAlarmTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "cloudWatchAlarmTemplateGroupIds"
},
"CreatedAt": {
"shape": "__timestampIso8601",
@@ -19830,425 +23407,460 @@
"locationName": "description",
"documentation": "A resource's optional description."
},
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ },
+ "ErrorMessage": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "errorMessage",
+ "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ },
+ "EventBridgeRuleTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "eventBridgeRuleTemplateGroupIds"
+ },
+ "FailedMediaResourceMap": {
+ "shape": "FailedMediaResourceMap",
+ "locationName": "failedMediaResourceMap"
+ },
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ "documentation": "A signal map's id."
},
- "ModifiedAt": {
+ "LastDiscoveredAt": {
"shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
- }
- },
- "required": [
- "CreatedAt",
- "Id",
- "Arn",
- "Name"
- ],
- "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateGroupResponseContent"
- },
- "CreateCloudWatchAlarmTemplateRequest": {
- "type": "structure",
- "members": {
- "ComparisonOperator": {
- "shape": "CloudWatchAlarmTemplateComparisonOperator",
- "locationName": "comparisonOperator"
+ "locationName": "lastDiscoveredAt"
},
- "DatapointsToAlarm": {
- "shape": "__integerMin1",
- "locationName": "datapointsToAlarm",
- "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ "LastSuccessfulMonitorDeployment": {
+ "shape": "SuccessfulMonitorDeployment",
+ "locationName": "lastSuccessfulMonitorDeployment"
},
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "MediaResourceMap": {
+ "shape": "MediaResourceMap",
+ "locationName": "mediaResourceMap"
},
- "EvaluationPeriods": {
- "shape": "__integerMin1",
- "locationName": "evaluationPeriods",
- "documentation": "The number of periods over which data is compared to the specified threshold."
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
},
- "GroupIdentifier": {
- "shape": "__stringPatternS",
- "locationName": "groupIdentifier",
- "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
+ "MonitorChangesPendingDeployment": {
+ "shape": "__boolean",
+ "locationName": "monitorChangesPendingDeployment",
+ "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
},
- "MetricName": {
- "shape": "__stringMax64",
- "locationName": "metricName",
- "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ "MonitorDeployment": {
+ "shape": "MonitorDeployment",
+ "locationName": "monitorDeployment"
},
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
- "Period": {
- "shape": "__integerMin10Max86400",
- "locationName": "period",
- "documentation": "The period, in seconds, over which the specified statistic is applied."
- },
- "Statistic": {
- "shape": "CloudWatchAlarmTemplateStatistic",
- "locationName": "statistic"
+ "Status": {
+ "shape": "SignalMapStatus",
+ "locationName": "status"
},
"Tags": {
"shape": "TagMap",
"locationName": "tags"
- },
- "TargetResourceType": {
- "shape": "CloudWatchAlarmTemplateTargetResourceType",
- "locationName": "targetResourceType"
- },
- "Threshold": {
- "shape": "__double",
- "locationName": "threshold",
- "documentation": "The threshold value to compare with the specified statistic."
- },
- "TreatMissingData": {
- "shape": "CloudWatchAlarmTemplateTreatMissingData",
- "locationName": "treatMissingData"
}
},
- "required": [
- "TargetResourceType",
- "MetricName",
- "TreatMissingData",
- "ComparisonOperator",
- "Statistic",
- "Period",
- "EvaluationPeriods",
- "Threshold",
- "Name",
- "GroupIdentifier"
- ],
- "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateRequest"
+ "documentation": "Placeholder documentation for StartDeleteMonitorDeploymentResponse"
},
- "CreateCloudWatchAlarmTemplateRequestContent": {
+ "StartDeleteMonitorDeploymentResponseContent": {
"type": "structure",
"members": {
- "ComparisonOperator": {
- "shape": "CloudWatchAlarmTemplateComparisonOperator",
- "locationName": "comparisonOperator"
+ "Arn": {
+ "shape": "__stringPatternArnMedialiveSignalMap",
+ "locationName": "arn",
+ "documentation": "A signal map's ARN (Amazon Resource Name)"
},
- "DatapointsToAlarm": {
- "shape": "__integerMin1",
- "locationName": "datapointsToAlarm",
- "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ "CloudWatchAlarmTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "cloudWatchAlarmTemplateGroupIds"
+ },
+ "CreatedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "createdAt"
},
"Description": {
"shape": "__stringMin0Max1024",
"locationName": "description",
"documentation": "A resource's optional description."
},
- "EvaluationPeriods": {
- "shape": "__integerMin1",
- "locationName": "evaluationPeriods",
- "documentation": "The number of periods over which data is compared to the specified threshold."
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
},
- "GroupIdentifier": {
- "shape": "__stringPatternS",
- "locationName": "groupIdentifier",
- "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
+ "ErrorMessage": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "errorMessage",
+ "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
},
- "MetricName": {
- "shape": "__stringMax64",
- "locationName": "metricName",
- "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ "EventBridgeRuleTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "eventBridgeRuleTemplateGroupIds"
+ },
+ "FailedMediaResourceMap": {
+ "shape": "FailedMediaResourceMap",
+ "locationName": "failedMediaResourceMap"
+ },
+ "Id": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "id",
+ "documentation": "A signal map's id."
+ },
+ "LastDiscoveredAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "lastDiscoveredAt"
+ },
+ "LastSuccessfulMonitorDeployment": {
+ "shape": "SuccessfulMonitorDeployment",
+ "locationName": "lastSuccessfulMonitorDeployment"
+ },
+ "MediaResourceMap": {
+ "shape": "MediaResourceMap",
+ "locationName": "mediaResourceMap"
+ },
+ "ModifiedAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "modifiedAt"
+ },
+ "MonitorChangesPendingDeployment": {
+ "shape": "__boolean",
+ "locationName": "monitorChangesPendingDeployment",
+ "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ },
+ "MonitorDeployment": {
+ "shape": "MonitorDeployment",
+ "locationName": "monitorDeployment"
},
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
- "Period": {
- "shape": "__integerMin10Max86400",
- "locationName": "period",
- "documentation": "The period, in seconds, over which the specified statistic is applied."
- },
- "Statistic": {
- "shape": "CloudWatchAlarmTemplateStatistic",
- "locationName": "statistic"
+ "Status": {
+ "shape": "SignalMapStatus",
+ "locationName": "status"
},
"Tags": {
"shape": "TagMap",
"locationName": "tags"
- },
- "TargetResourceType": {
- "shape": "CloudWatchAlarmTemplateTargetResourceType",
- "locationName": "targetResourceType"
- },
- "Threshold": {
- "shape": "__double",
- "locationName": "threshold",
- "documentation": "The threshold value to compare with the specified statistic."
- },
- "TreatMissingData": {
- "shape": "CloudWatchAlarmTemplateTreatMissingData",
- "locationName": "treatMissingData"
}
},
"required": [
- "TargetResourceType",
- "MetricName",
- "TreatMissingData",
- "ComparisonOperator",
- "Statistic",
- "Period",
- "EvaluationPeriods",
- "Threshold",
+ "Status",
+ "CreatedAt",
"Name",
- "GroupIdentifier"
+ "Id",
+ "Arn",
+ "DiscoveryEntryPointArn",
+ "MonitorChangesPendingDeployment"
],
- "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateRequestContent"
+ "documentation": "Placeholder documentation for StartDeleteMonitorDeploymentResponseContent"
},
- "CreateCloudWatchAlarmTemplateResponse": {
+ "StartMonitorDeploymentRequest": {
+ "type": "structure",
+ "members": {
+ "DryRun": {
+ "shape": "__boolean",
+ "locationName": "dryRun"
+ },
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "A signal map's identifier. Can be either be its id or current name."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for StartMonitorDeploymentRequest"
+ },
+ "StartMonitorDeploymentRequestContent": {
+ "type": "structure",
+ "members": {
+ "DryRun": {
+ "shape": "__boolean",
+ "locationName": "dryRun"
+ }
+ },
+ "documentation": "Placeholder documentation for StartMonitorDeploymentRequestContent"
+ },
+ "StartMonitorDeploymentResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
+ "shape": "__stringPatternArnMedialiveSignalMap",
"locationName": "arn",
- "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
+ "documentation": "A signal map's ARN (Amazon Resource Name)"
},
- "ComparisonOperator": {
- "shape": "CloudWatchAlarmTemplateComparisonOperator",
- "locationName": "comparisonOperator"
+ "CloudWatchAlarmTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "cloudWatchAlarmTemplateGroupIds"
},
"CreatedAt": {
"shape": "__timestampIso8601",
"locationName": "createdAt"
},
- "DatapointsToAlarm": {
- "shape": "__integerMin1",
- "locationName": "datapointsToAlarm",
- "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
- },
"Description": {
"shape": "__stringMin0Max1024",
"locationName": "description",
"documentation": "A resource's optional description."
},
- "EvaluationPeriods": {
- "shape": "__integerMin1",
- "locationName": "evaluationPeriods",
- "documentation": "The number of periods over which data is compared to the specified threshold."
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
},
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ "ErrorMessage": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "errorMessage",
+ "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ },
+ "EventBridgeRuleTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "eventBridgeRuleTemplateGroupIds"
+ },
+ "FailedMediaResourceMap": {
+ "shape": "FailedMediaResourceMap",
+ "locationName": "failedMediaResourceMap"
},
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
+ "documentation": "A signal map's id."
+ },
+ "LastDiscoveredAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "lastDiscoveredAt"
},
- "MetricName": {
- "shape": "__stringMax64",
- "locationName": "metricName",
- "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ "LastSuccessfulMonitorDeployment": {
+ "shape": "SuccessfulMonitorDeployment",
+ "locationName": "lastSuccessfulMonitorDeployment"
+ },
+ "MediaResourceMap": {
+ "shape": "MediaResourceMap",
+ "locationName": "mediaResourceMap"
},
"ModifiedAt": {
"shape": "__timestampIso8601",
"locationName": "modifiedAt"
},
+ "MonitorChangesPendingDeployment": {
+ "shape": "__boolean",
+ "locationName": "monitorChangesPendingDeployment",
+ "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ },
+ "MonitorDeployment": {
+ "shape": "MonitorDeployment",
+ "locationName": "monitorDeployment"
+ },
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
- "Period": {
- "shape": "__integerMin10Max86400",
- "locationName": "period",
- "documentation": "The period, in seconds, over which the specified statistic is applied."
- },
- "Statistic": {
- "shape": "CloudWatchAlarmTemplateStatistic",
- "locationName": "statistic"
+ "Status": {
+ "shape": "SignalMapStatus",
+ "locationName": "status"
},
"Tags": {
"shape": "TagMap",
"locationName": "tags"
- },
- "TargetResourceType": {
- "shape": "CloudWatchAlarmTemplateTargetResourceType",
- "locationName": "targetResourceType"
- },
- "Threshold": {
- "shape": "__double",
- "locationName": "threshold",
- "documentation": "The threshold value to compare with the specified statistic."
- },
- "TreatMissingData": {
- "shape": "CloudWatchAlarmTemplateTreatMissingData",
- "locationName": "treatMissingData"
}
},
- "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateResponse"
+ "documentation": "Placeholder documentation for StartMonitorDeploymentResponse"
},
- "CreateCloudWatchAlarmTemplateResponseContent": {
+ "StartMonitorDeploymentResponseContent": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
+ "shape": "__stringPatternArnMedialiveSignalMap",
"locationName": "arn",
- "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
+ "documentation": "A signal map's ARN (Amazon Resource Name)"
},
- "ComparisonOperator": {
- "shape": "CloudWatchAlarmTemplateComparisonOperator",
- "locationName": "comparisonOperator"
+ "CloudWatchAlarmTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "cloudWatchAlarmTemplateGroupIds"
},
"CreatedAt": {
"shape": "__timestampIso8601",
"locationName": "createdAt"
},
- "DatapointsToAlarm": {
- "shape": "__integerMin1",
- "locationName": "datapointsToAlarm",
- "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
- },
"Description": {
"shape": "__stringMin0Max1024",
"locationName": "description",
"documentation": "A resource's optional description."
},
- "EvaluationPeriods": {
- "shape": "__integerMin1",
- "locationName": "evaluationPeriods",
- "documentation": "The number of periods over which data is compared to the specified threshold."
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
},
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ "ErrorMessage": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "errorMessage",
+ "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ },
+ "EventBridgeRuleTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "eventBridgeRuleTemplateGroupIds"
+ },
+ "FailedMediaResourceMap": {
+ "shape": "FailedMediaResourceMap",
+ "locationName": "failedMediaResourceMap"
},
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
+ "documentation": "A signal map's id."
},
- "MetricName": {
- "shape": "__stringMax64",
- "locationName": "metricName",
- "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ "LastDiscoveredAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "lastDiscoveredAt"
+ },
+ "LastSuccessfulMonitorDeployment": {
+ "shape": "SuccessfulMonitorDeployment",
+ "locationName": "lastSuccessfulMonitorDeployment"
+ },
+ "MediaResourceMap": {
+ "shape": "MediaResourceMap",
+ "locationName": "mediaResourceMap"
},
"ModifiedAt": {
"shape": "__timestampIso8601",
"locationName": "modifiedAt"
},
+ "MonitorChangesPendingDeployment": {
+ "shape": "__boolean",
+ "locationName": "monitorChangesPendingDeployment",
+ "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ },
+ "MonitorDeployment": {
+ "shape": "MonitorDeployment",
+ "locationName": "monitorDeployment"
+ },
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
- "Period": {
- "shape": "__integerMin10Max86400",
- "locationName": "period",
- "documentation": "The period, in seconds, over which the specified statistic is applied."
- },
- "Statistic": {
- "shape": "CloudWatchAlarmTemplateStatistic",
- "locationName": "statistic"
+ "Status": {
+ "shape": "SignalMapStatus",
+ "locationName": "status"
},
"Tags": {
"shape": "TagMap",
"locationName": "tags"
- },
- "TargetResourceType": {
- "shape": "CloudWatchAlarmTemplateTargetResourceType",
- "locationName": "targetResourceType"
- },
- "Threshold": {
- "shape": "__double",
- "locationName": "threshold",
- "documentation": "The threshold value to compare with the specified statistic."
- },
- "TreatMissingData": {
- "shape": "CloudWatchAlarmTemplateTreatMissingData",
- "locationName": "treatMissingData"
}
},
"required": [
- "TargetResourceType",
- "TreatMissingData",
- "ComparisonOperator",
+ "Status",
"CreatedAt",
- "Period",
- "EvaluationPeriods",
"Name",
- "GroupId",
- "MetricName",
- "Statistic",
"Id",
"Arn",
- "Threshold"
+ "DiscoveryEntryPointArn",
+ "MonitorChangesPendingDeployment"
],
- "documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateResponseContent"
+ "documentation": "Placeholder documentation for StartMonitorDeploymentResponseContent"
},
- "CreateEventBridgeRuleTemplateGroupRequest": {
+ "StartUpdateSignalMapRequest": {
"type": "structure",
"members": {
+ "CloudWatchAlarmTemplateGroupIdentifiers": {
+ "shape": "__listOf__stringPatternS",
+ "locationName": "cloudWatchAlarmTemplateGroupIdentifiers"
+ },
"Description": {
"shape": "__stringMin0Max1024",
"locationName": "description",
"documentation": "A resource's optional description."
},
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ },
+ "EventBridgeRuleTemplateGroupIdentifiers": {
+ "shape": "__listOf__stringPatternS",
+ "locationName": "eventBridgeRuleTemplateGroupIdentifiers"
+ },
+ "ForceRediscovery": {
+ "shape": "__boolean",
+ "locationName": "forceRediscovery",
+ "documentation": "If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided."
+ },
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "A signal map's identifier. Can be either be its id or current name."
+ },
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
}
},
"required": [
- "Name"
+ "Identifier"
],
- "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateGroupRequest"
+ "documentation": "Placeholder documentation for StartUpdateSignalMapRequest"
},
- "CreateEventBridgeRuleTemplateGroupRequestContent": {
+ "StartUpdateSignalMapRequestContent": {
"type": "structure",
"members": {
+ "CloudWatchAlarmTemplateGroupIdentifiers": {
+ "shape": "__listOf__stringPatternS",
+ "locationName": "cloudWatchAlarmTemplateGroupIdentifiers"
+ },
"Description": {
"shape": "__stringMin0Max1024",
"locationName": "description",
"documentation": "A resource's optional description."
},
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ },
+ "EventBridgeRuleTemplateGroupIdentifiers": {
+ "shape": "__listOf__stringPatternS",
+ "locationName": "eventBridgeRuleTemplateGroupIdentifiers"
+ },
+ "ForceRediscovery": {
+ "shape": "__boolean",
+ "locationName": "forceRediscovery",
+ "documentation": "If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided."
+ },
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
}
},
- "required": [
- "Name"
- ],
- "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateGroupRequestContent"
+ "documentation": "Placeholder documentation for StartUpdateSignalMapRequestContent"
},
- "CreateEventBridgeRuleTemplateGroupResponse": {
+ "StartUpdateSignalMapResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
+ "shape": "__stringPatternArnMedialiveSignalMap",
"locationName": "arn",
- "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
+ "documentation": "A signal map's ARN (Amazon Resource Name)"
+ },
+ "CloudWatchAlarmTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "cloudWatchAlarmTemplateGroupIds"
},
"CreatedAt": {
"shape": "__timestampIso8601",
@@ -20259,34 +23871,81 @@
"locationName": "description",
"documentation": "A resource's optional description."
},
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ },
+ "ErrorMessage": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "errorMessage",
+ "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ },
+ "EventBridgeRuleTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "eventBridgeRuleTemplateGroupIds"
+ },
+ "FailedMediaResourceMap": {
+ "shape": "FailedMediaResourceMap",
+ "locationName": "failedMediaResourceMap"
+ },
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ "documentation": "A signal map's id."
+ },
+ "LastDiscoveredAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "lastDiscoveredAt"
+ },
+ "LastSuccessfulMonitorDeployment": {
+ "shape": "SuccessfulMonitorDeployment",
+ "locationName": "lastSuccessfulMonitorDeployment"
+ },
+ "MediaResourceMap": {
+ "shape": "MediaResourceMap",
+ "locationName": "mediaResourceMap"
},
"ModifiedAt": {
"shape": "__timestampIso8601",
"locationName": "modifiedAt"
},
+ "MonitorChangesPendingDeployment": {
+ "shape": "__boolean",
+ "locationName": "monitorChangesPendingDeployment",
+ "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ },
+ "MonitorDeployment": {
+ "shape": "MonitorDeployment",
+ "locationName": "monitorDeployment"
+ },
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
+ "Status": {
+ "shape": "SignalMapStatus",
+ "locationName": "status"
+ },
"Tags": {
"shape": "TagMap",
"locationName": "tags"
}
},
- "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateGroupResponse"
+ "documentation": "Placeholder documentation for StartUpdateSignalMapResponse"
},
- "CreateEventBridgeRuleTemplateGroupResponseContent": {
+ "StartUpdateSignalMapResponseContent": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
+ "shape": "__stringPatternArnMedialiveSignalMap",
"locationName": "arn",
- "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
+ "documentation": "A signal map's ARN (Amazon Resource Name)"
+ },
+ "CloudWatchAlarmTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "cloudWatchAlarmTemplateGroupIds"
},
"CreatedAt": {
"shape": "__timestampIso8601",
@@ -20297,34 +23956,120 @@
"locationName": "description",
"documentation": "A resource's optional description."
},
+ "DiscoveryEntryPointArn": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "discoveryEntryPointArn",
+ "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ },
+ "ErrorMessage": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "errorMessage",
+ "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ },
+ "EventBridgeRuleTemplateGroupIds": {
+ "shape": "__listOf__stringMin7Max11PatternAws097",
+ "locationName": "eventBridgeRuleTemplateGroupIds"
+ },
+ "FailedMediaResourceMap": {
+ "shape": "FailedMediaResourceMap",
+ "locationName": "failedMediaResourceMap"
+ },
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ "documentation": "A signal map's id."
+ },
+ "LastDiscoveredAt": {
+ "shape": "__timestampIso8601",
+ "locationName": "lastDiscoveredAt"
+ },
+ "LastSuccessfulMonitorDeployment": {
+ "shape": "SuccessfulMonitorDeployment",
+ "locationName": "lastSuccessfulMonitorDeployment"
+ },
+ "MediaResourceMap": {
+ "shape": "MediaResourceMap",
+ "locationName": "mediaResourceMap"
},
"ModifiedAt": {
"shape": "__timestampIso8601",
"locationName": "modifiedAt"
},
+ "MonitorChangesPendingDeployment": {
+ "shape": "__boolean",
+ "locationName": "monitorChangesPendingDeployment",
+ "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ },
+ "MonitorDeployment": {
+ "shape": "MonitorDeployment",
+ "locationName": "monitorDeployment"
+ },
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
+ "Status": {
+ "shape": "SignalMapStatus",
+ "locationName": "status"
+ },
"Tags": {
"shape": "TagMap",
"locationName": "tags"
}
},
"required": [
+ "Status",
"CreatedAt",
+ "Name",
"Id",
"Arn",
- "Name"
+ "DiscoveryEntryPointArn",
+ "MonitorChangesPendingDeployment"
],
- "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateGroupResponseContent"
+ "documentation": "Placeholder documentation for StartUpdateSignalMapResponseContent"
},
- "CreateEventBridgeRuleTemplateRequest": {
+ "SuccessfulMonitorDeployment": {
+ "type": "structure",
+ "members": {
+ "DetailsUri": {
+ "shape": "__stringMin1Max2048",
+ "locationName": "detailsUri",
+ "documentation": "URI associated with a signal map's monitor deployment."
+ },
+ "Status": {
+ "shape": "SignalMapMonitorDeploymentStatus",
+ "locationName": "status"
+ }
+ },
+ "documentation": "Represents the latest successful monitor deployment of a signal map.",
+ "required": [
+ "DetailsUri",
+ "Status"
+ ]
+ },
+ "TagMap": {
+ "type": "map",
+ "documentation": "Represents the tags associated with a resource.",
+ "key": {
+ "shape": "__string"
+ },
+ "value": {
+ "shape": "__string"
+ }
+ },
+ "TooManyRequestsExceptionResponseContent": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "Exception error message."
+ }
+ },
+ "documentation": "Request was denied due to request throttling."
+ },
+ "UpdateCloudWatchAlarmTemplateGroupRequest": {
"type": "structure",
"members": {
"Description": {
@@ -20332,81 +24077,36 @@
"locationName": "description",
"documentation": "A resource's optional description."
},
- "EventTargets": {
- "shape": "__listOfEventBridgeRuleTemplateTarget",
- "locationName": "eventTargets"
- },
- "EventType": {
- "shape": "EventBridgeRuleTemplateEventType",
- "locationName": "eventType"
- },
- "GroupIdentifier": {
- "shape": "__stringPatternS",
- "locationName": "groupIdentifier",
- "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
- },
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
}
},
"required": [
- "EventType",
- "Name",
- "GroupIdentifier"
+ "Identifier"
],
- "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateRequest"
+ "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateGroupRequest"
},
- "CreateEventBridgeRuleTemplateRequestContent": {
+ "UpdateCloudWatchAlarmTemplateGroupRequestContent": {
"type": "structure",
"members": {
"Description": {
"shape": "__stringMin0Max1024",
"locationName": "description",
"documentation": "A resource's optional description."
- },
- "EventTargets": {
- "shape": "__listOfEventBridgeRuleTemplateTarget",
- "locationName": "eventTargets"
- },
- "EventType": {
- "shape": "EventBridgeRuleTemplateEventType",
- "locationName": "eventType"
- },
- "GroupIdentifier": {
- "shape": "__stringPatternS",
- "locationName": "groupIdentifier",
- "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
- },
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
}
},
- "required": [
- "EventType",
- "Name",
- "GroupIdentifier"
- ],
- "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateRequestContent"
+ "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateGroupRequestContent"
},
- "CreateEventBridgeRuleTemplateResponse": {
+ "UpdateCloudWatchAlarmTemplateGroupResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
"locationName": "arn",
- "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
+ "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
},
"CreatedAt": {
"shape": "__timestampIso8601",
@@ -20417,23 +24117,10 @@
"locationName": "description",
"documentation": "A resource's optional description."
},
- "EventTargets": {
- "shape": "__listOfEventBridgeRuleTemplateTarget",
- "locationName": "eventTargets"
- },
- "EventType": {
- "shape": "EventBridgeRuleTemplateEventType",
- "locationName": "eventType"
- },
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
- },
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
},
"ModifiedAt": {
"shape": "__timestampIso8601",
@@ -20449,15 +24136,15 @@
"locationName": "tags"
}
},
- "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateResponse"
+ "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateGroupResponse"
},
- "CreateEventBridgeRuleTemplateResponseContent": {
+ "UpdateCloudWatchAlarmTemplateGroupResponseContent": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
"locationName": "arn",
- "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
+ "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
},
"CreatedAt": {
"shape": "__timestampIso8601",
@@ -20468,23 +24155,10 @@
"locationName": "description",
"documentation": "A resource's optional description."
},
- "EventTargets": {
- "shape": "__listOfEventBridgeRuleTemplateTarget",
- "locationName": "eventTargets"
- },
- "EventType": {
- "shape": "EventBridgeRuleTemplateEventType",
- "locationName": "eventType"
- },
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
- },
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
},
"ModifiedAt": {
"shape": "__timestampIso8601",
@@ -20501,301 +24175,337 @@
}
},
"required": [
- "EventType",
"CreatedAt",
"Id",
"Arn",
- "Name",
- "GroupId"
+ "Name"
],
- "documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateResponseContent"
+ "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateGroupResponseContent"
},
- "CreateSignalMapRequest": {
+ "UpdateCloudWatchAlarmTemplateRequest": {
"type": "structure",
"members": {
- "CloudWatchAlarmTemplateGroupIdentifiers": {
- "shape": "__listOf__stringPatternS",
- "locationName": "cloudWatchAlarmTemplateGroupIdentifiers"
+ "ComparisonOperator": {
+ "shape": "CloudWatchAlarmTemplateComparisonOperator",
+ "locationName": "comparisonOperator"
+ },
+ "DatapointsToAlarm": {
+ "shape": "__integerMin1",
+ "locationName": "datapointsToAlarm",
+ "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
},
"Description": {
"shape": "__stringMin0Max1024",
"locationName": "description",
"documentation": "A resource's optional description."
},
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ "EvaluationPeriods": {
+ "shape": "__integerMin1",
+ "locationName": "evaluationPeriods",
+ "documentation": "The number of periods over which data is compared to the specified threshold."
+ },
+ "GroupIdentifier": {
+ "shape": "__stringPatternS",
+ "locationName": "groupIdentifier",
+ "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
+ },
+ "Identifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "identifier",
+ "documentation": "A cloudwatch alarm template's identifier. Can be either be its id or current name."
},
- "EventBridgeRuleTemplateGroupIdentifiers": {
- "shape": "__listOf__stringPatternS",
- "locationName": "eventBridgeRuleTemplateGroupIdentifiers"
+ "MetricName": {
+ "shape": "__stringMax64",
+ "locationName": "metricName",
+ "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
},
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "Period": {
+ "shape": "__integerMin10Max86400",
+ "locationName": "period",
+ "documentation": "The period, in seconds, over which the specified statistic is applied."
+ },
+ "Statistic": {
+ "shape": "CloudWatchAlarmTemplateStatistic",
+ "locationName": "statistic"
+ },
+ "TargetResourceType": {
+ "shape": "CloudWatchAlarmTemplateTargetResourceType",
+ "locationName": "targetResourceType"
+ },
+ "Threshold": {
+ "shape": "__double",
+ "locationName": "threshold",
+ "documentation": "The threshold value to compare with the specified statistic."
+ },
+ "TreatMissingData": {
+ "shape": "CloudWatchAlarmTemplateTreatMissingData",
+ "locationName": "treatMissingData"
}
},
"required": [
- "DiscoveryEntryPointArn",
- "Name"
+ "Identifier"
],
- "documentation": "Placeholder documentation for CreateSignalMapRequest"
+ "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateRequest"
},
- "CreateSignalMapRequestContent": {
+ "UpdateCloudWatchAlarmTemplateRequestContent": {
"type": "structure",
"members": {
- "CloudWatchAlarmTemplateGroupIdentifiers": {
- "shape": "__listOf__stringPatternS",
- "locationName": "cloudWatchAlarmTemplateGroupIdentifiers"
+ "ComparisonOperator": {
+ "shape": "CloudWatchAlarmTemplateComparisonOperator",
+ "locationName": "comparisonOperator"
+ },
+ "DatapointsToAlarm": {
+ "shape": "__integerMin1",
+ "locationName": "datapointsToAlarm",
+ "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
},
"Description": {
"shape": "__stringMin0Max1024",
"locationName": "description",
"documentation": "A resource's optional description."
},
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ "EvaluationPeriods": {
+ "shape": "__integerMin1",
+ "locationName": "evaluationPeriods",
+ "documentation": "The number of periods over which data is compared to the specified threshold."
},
- "EventBridgeRuleTemplateGroupIdentifiers": {
- "shape": "__listOf__stringPatternS",
- "locationName": "eventBridgeRuleTemplateGroupIdentifiers"
+ "GroupIdentifier": {
+ "shape": "__stringPatternS",
+ "locationName": "groupIdentifier",
+ "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
+ },
+ "MetricName": {
+ "shape": "__stringMax64",
+ "locationName": "metricName",
+ "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
},
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "Period": {
+ "shape": "__integerMin10Max86400",
+ "locationName": "period",
+ "documentation": "The period, in seconds, over which the specified statistic is applied."
+ },
+ "Statistic": {
+ "shape": "CloudWatchAlarmTemplateStatistic",
+ "locationName": "statistic"
+ },
+ "TargetResourceType": {
+ "shape": "CloudWatchAlarmTemplateTargetResourceType",
+ "locationName": "targetResourceType"
+ },
+ "Threshold": {
+ "shape": "__double",
+ "locationName": "threshold",
+ "documentation": "The threshold value to compare with the specified statistic."
+ },
+ "TreatMissingData": {
+ "shape": "CloudWatchAlarmTemplateTreatMissingData",
+ "locationName": "treatMissingData"
}
},
- "required": [
- "DiscoveryEntryPointArn",
- "Name"
- ],
- "documentation": "Placeholder documentation for CreateSignalMapRequestContent"
+ "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateRequestContent"
},
- "CreateSignalMapResponse": {
+ "UpdateCloudWatchAlarmTemplateResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveSignalMap",
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
"locationName": "arn",
- "documentation": "A signal map's ARN (Amazon Resource Name)"
+ "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
},
- "CloudWatchAlarmTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "cloudWatchAlarmTemplateGroupIds"
+ "ComparisonOperator": {
+ "shape": "CloudWatchAlarmTemplateComparisonOperator",
+ "locationName": "comparisonOperator"
},
"CreatedAt": {
"shape": "__timestampIso8601",
"locationName": "createdAt"
},
+ "DatapointsToAlarm": {
+ "shape": "__integerMin1",
+ "locationName": "datapointsToAlarm",
+ "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ },
"Description": {
"shape": "__stringMin0Max1024",
"locationName": "description",
"documentation": "A resource's optional description."
},
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
- },
- "ErrorMessage": {
- "shape": "__stringMin1Max2048",
- "locationName": "errorMessage",
- "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
- },
- "EventBridgeRuleTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "eventBridgeRuleTemplateGroupIds"
+ "EvaluationPeriods": {
+ "shape": "__integerMin1",
+ "locationName": "evaluationPeriods",
+ "documentation": "The number of periods over which data is compared to the specified threshold."
},
- "FailedMediaResourceMap": {
- "shape": "FailedMediaResourceMap",
- "locationName": "failedMediaResourceMap"
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
},
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "A signal map's id."
- },
- "LastDiscoveredAt": {
- "shape": "__timestampIso8601",
- "locationName": "lastDiscoveredAt"
- },
- "LastSuccessfulMonitorDeployment": {
- "shape": "SuccessfulMonitorDeployment",
- "locationName": "lastSuccessfulMonitorDeployment"
+ "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
},
- "MediaResourceMap": {
- "shape": "MediaResourceMap",
- "locationName": "mediaResourceMap"
+ "MetricName": {
+ "shape": "__stringMax64",
+ "locationName": "metricName",
+ "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
},
"ModifiedAt": {
"shape": "__timestampIso8601",
"locationName": "modifiedAt"
},
- "MonitorChangesPendingDeployment": {
- "shape": "__boolean",
- "locationName": "monitorChangesPendingDeployment",
- "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
- },
- "MonitorDeployment": {
- "shape": "MonitorDeployment",
- "locationName": "monitorDeployment"
- },
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
- "Status": {
- "shape": "SignalMapStatus",
- "locationName": "status"
+ "Period": {
+ "shape": "__integerMin10Max86400",
+ "locationName": "period",
+ "documentation": "The period, in seconds, over which the specified statistic is applied."
+ },
+ "Statistic": {
+ "shape": "CloudWatchAlarmTemplateStatistic",
+ "locationName": "statistic"
},
"Tags": {
"shape": "TagMap",
"locationName": "tags"
+ },
+ "TargetResourceType": {
+ "shape": "CloudWatchAlarmTemplateTargetResourceType",
+ "locationName": "targetResourceType"
+ },
+ "Threshold": {
+ "shape": "__double",
+ "locationName": "threshold",
+ "documentation": "The threshold value to compare with the specified statistic."
+ },
+ "TreatMissingData": {
+ "shape": "CloudWatchAlarmTemplateTreatMissingData",
+ "locationName": "treatMissingData"
}
},
- "documentation": "Placeholder documentation for CreateSignalMapResponse"
+ "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateResponse"
},
- "CreateSignalMapResponseContent": {
+ "UpdateCloudWatchAlarmTemplateResponseContent": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveSignalMap",
+ "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
"locationName": "arn",
- "documentation": "A signal map's ARN (Amazon Resource Name)"
+ "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
},
- "CloudWatchAlarmTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "cloudWatchAlarmTemplateGroupIds"
+ "ComparisonOperator": {
+ "shape": "CloudWatchAlarmTemplateComparisonOperator",
+ "locationName": "comparisonOperator"
},
"CreatedAt": {
"shape": "__timestampIso8601",
"locationName": "createdAt"
},
+ "DatapointsToAlarm": {
+ "shape": "__integerMin1",
+ "locationName": "datapointsToAlarm",
+ "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ },
"Description": {
"shape": "__stringMin0Max1024",
"locationName": "description",
"documentation": "A resource's optional description."
},
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
- },
- "ErrorMessage": {
- "shape": "__stringMin1Max2048",
- "locationName": "errorMessage",
- "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
- },
- "EventBridgeRuleTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "eventBridgeRuleTemplateGroupIds"
+ "EvaluationPeriods": {
+ "shape": "__integerMin1",
+ "locationName": "evaluationPeriods",
+ "documentation": "The number of periods over which data is compared to the specified threshold."
},
- "FailedMediaResourceMap": {
- "shape": "FailedMediaResourceMap",
- "locationName": "failedMediaResourceMap"
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
},
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "A signal map's id."
- },
- "LastDiscoveredAt": {
- "shape": "__timestampIso8601",
- "locationName": "lastDiscoveredAt"
- },
- "LastSuccessfulMonitorDeployment": {
- "shape": "SuccessfulMonitorDeployment",
- "locationName": "lastSuccessfulMonitorDeployment"
- },
- "MediaResourceMap": {
- "shape": "MediaResourceMap",
- "locationName": "mediaResourceMap"
+ "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
+ },
+ "MetricName": {
+ "shape": "__stringMax64",
+ "locationName": "metricName",
+ "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
},
"ModifiedAt": {
"shape": "__timestampIso8601",
"locationName": "modifiedAt"
},
- "MonitorChangesPendingDeployment": {
- "shape": "__boolean",
- "locationName": "monitorChangesPendingDeployment",
- "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
- },
- "MonitorDeployment": {
- "shape": "MonitorDeployment",
- "locationName": "monitorDeployment"
- },
"Name": {
"shape": "__stringMin1Max255PatternS",
"locationName": "name",
"documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
},
- "Status": {
- "shape": "SignalMapStatus",
- "locationName": "status"
+ "Period": {
+ "shape": "__integerMin10Max86400",
+ "locationName": "period",
+ "documentation": "The period, in seconds, over which the specified statistic is applied."
+ },
+ "Statistic": {
+ "shape": "CloudWatchAlarmTemplateStatistic",
+ "locationName": "statistic"
},
"Tags": {
"shape": "TagMap",
"locationName": "tags"
+ },
+ "TargetResourceType": {
+ "shape": "CloudWatchAlarmTemplateTargetResourceType",
+ "locationName": "targetResourceType"
+ },
+ "Threshold": {
+ "shape": "__double",
+ "locationName": "threshold",
+ "documentation": "The threshold value to compare with the specified statistic."
+ },
+ "TreatMissingData": {
+ "shape": "CloudWatchAlarmTemplateTreatMissingData",
+ "locationName": "treatMissingData"
}
},
"required": [
- "Status",
+ "TargetResourceType",
+ "TreatMissingData",
+ "ComparisonOperator",
"CreatedAt",
+ "Period",
+ "EvaluationPeriods",
"Name",
+ "GroupId",
+ "MetricName",
+ "Statistic",
"Id",
"Arn",
- "DiscoveryEntryPointArn",
- "MonitorChangesPendingDeployment"
- ],
- "documentation": "Placeholder documentation for CreateSignalMapResponseContent"
- },
- "DeleteCloudWatchAlarmTemplateGroupRequest": {
- "type": "structure",
- "members": {
- "Identifier": {
- "shape": "__string",
- "location": "uri",
- "locationName": "identifier",
- "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
- }
- },
- "required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for DeleteCloudWatchAlarmTemplateGroupRequest"
- },
- "DeleteCloudWatchAlarmTemplateRequest": {
- "type": "structure",
- "members": {
- "Identifier": {
- "shape": "__string",
- "location": "uri",
- "locationName": "identifier",
- "documentation": "A cloudwatch alarm template's identifier. Can be either be its id or current name."
- }
- },
- "required": [
- "Identifier"
+ "Threshold"
],
- "documentation": "Placeholder documentation for DeleteCloudWatchAlarmTemplateRequest"
+ "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateResponseContent"
},
- "DeleteEventBridgeRuleTemplateGroupRequest": {
+ "UpdateEventBridgeRuleTemplateGroupRequest": {
"type": "structure",
"members": {
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
"Identifier": {
"shape": "__string",
"location": "uri",
@@ -20806,58 +24516,20 @@
"required": [
"Identifier"
],
- "documentation": "Placeholder documentation for DeleteEventBridgeRuleTemplateGroupRequest"
- },
- "DeleteEventBridgeRuleTemplateRequest": {
- "type": "structure",
- "members": {
- "Identifier": {
- "shape": "__string",
- "location": "uri",
- "locationName": "identifier",
- "documentation": "An eventbridge rule template's identifier. Can be either be its id or current name."
- }
- },
- "required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for DeleteEventBridgeRuleTemplateRequest"
+ "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateGroupRequest"
},
- "DeleteSignalMapRequest": {
+ "UpdateEventBridgeRuleTemplateGroupRequestContent": {
"type": "structure",
"members": {
- "Identifier": {
- "shape": "__string",
- "location": "uri",
- "locationName": "identifier",
- "documentation": "A signal map's identifier. Can be either be its id or current name."
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
}
},
- "required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for DeleteSignalMapRequest"
- },
- "EventBridgeRuleTemplateEventType": {
- "type": "string",
- "documentation": "The type of event to match with the rule.",
- "enum": [
- "MEDIALIVE_MULTIPLEX_ALERT",
- "MEDIALIVE_MULTIPLEX_STATE_CHANGE",
- "MEDIALIVE_CHANNEL_ALERT",
- "MEDIALIVE_CHANNEL_INPUT_CHANGE",
- "MEDIALIVE_CHANNEL_STATE_CHANGE",
- "MEDIAPACKAGE_INPUT_NOTIFICATION",
- "MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION",
- "MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION",
- "SIGNAL_MAP_ACTIVE_ALARM",
- "MEDIACONNECT_ALERT",
- "MEDIACONNECT_SOURCE_HEALTH",
- "MEDIACONNECT_OUTPUT_HEALTH",
- "MEDIACONNECT_FLOW_STATUS_CHANGE"
- ]
+ "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateGroupRequestContent"
},
- "EventBridgeRuleTemplateGroupSummary": {
+ "UpdateEventBridgeRuleTemplateGroupResponse": {
"type": "structure",
"members": {
"Arn": {
@@ -20891,29 +24563,17 @@
"Tags": {
"shape": "TagMap",
"locationName": "tags"
- },
- "TemplateCount": {
- "shape": "__integer",
- "locationName": "templateCount",
- "documentation": "The number of templates in a group."
}
},
- "required": [
- "TemplateCount",
- "CreatedAt",
- "Id",
- "Arn",
- "Name"
- ],
- "documentation": "Placeholder documentation for EventBridgeRuleTemplateGroupSummary"
+ "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateGroupResponse"
},
- "EventBridgeRuleTemplateSummary": {
+ "UpdateEventBridgeRuleTemplateGroupResponseContent": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
"locationName": "arn",
- "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
+ "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
},
"CreatedAt": {
"shape": "__timestampIso8601",
@@ -20924,24 +24584,10 @@
"locationName": "description",
"documentation": "A resource's optional description."
},
- "EventTargetCount": {
- "shape": "__integerMax5",
- "locationName": "eventTargetCount",
- "documentation": "The number of targets configured to send matching events."
- },
- "EventType": {
- "shape": "EventBridgeRuleTemplateEventType",
- "locationName": "eventType"
- },
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
- },
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
},
"ModifiedAt": {
"shape": "__timestampIso8601",
@@ -20958,73 +24604,87 @@
}
},
"required": [
- "EventType",
"CreatedAt",
- "EventTargetCount",
"Id",
"Arn",
- "Name",
- "GroupId"
+ "Name"
],
- "documentation": "Placeholder documentation for EventBridgeRuleTemplateSummary"
- },
- "EventBridgeRuleTemplateTarget": {
- "type": "structure",
- "members": {
- "Arn": {
- "shape": "__stringMin1Max2048PatternArn",
- "locationName": "arn",
- "documentation": "Target ARNs must be either an SNS topic or CloudWatch log group."
- }
- },
- "documentation": "The target to which to send matching events.",
- "required": [
- "Arn"
- ]
- },
- "FailedMediaResourceMap": {
- "type": "map",
- "documentation": "A map representing an incomplete AWS media workflow as a graph.",
- "key": {
- "shape": "__string"
- },
- "value": {
- "shape": "MediaResource"
- }
- },
- "ForbiddenExceptionResponseContent": {
- "type": "structure",
- "members": {
- "Message": {
- "shape": "__string",
- "locationName": "message",
- "documentation": "Exception error message."
- }
- },
- "documentation": "User does not have sufficient access to perform this action."
+ "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateGroupResponseContent"
},
- "GetCloudWatchAlarmTemplateGroupRequest": {
+ "UpdateEventBridgeRuleTemplateRequest": {
"type": "structure",
"members": {
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EventTargets": {
+ "shape": "__listOfEventBridgeRuleTemplateTarget",
+ "locationName": "eventTargets"
+ },
+ "EventType": {
+ "shape": "EventBridgeRuleTemplateEventType",
+ "locationName": "eventType"
+ },
+ "GroupIdentifier": {
+ "shape": "__stringPatternS",
+ "locationName": "groupIdentifier",
+ "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ },
"Identifier": {
"shape": "__string",
"location": "uri",
"locationName": "identifier",
- "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
+ "documentation": "An eventbridge rule template's identifier. Can be either be its id or current name."
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ }
+ },
+ "required": [
+ "Identifier"
+ ],
+ "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateRequest"
+ },
+ "UpdateEventBridgeRuleTemplateRequestContent": {
+ "type": "structure",
+ "members": {
+ "Description": {
+ "shape": "__stringMin0Max1024",
+ "locationName": "description",
+ "documentation": "A resource's optional description."
+ },
+ "EventTargets": {
+ "shape": "__listOfEventBridgeRuleTemplateTarget",
+ "locationName": "eventTargets"
+ },
+ "EventType": {
+ "shape": "EventBridgeRuleTemplateEventType",
+ "locationName": "eventType"
+ },
+ "GroupIdentifier": {
+ "shape": "__stringPatternS",
+ "locationName": "groupIdentifier",
+ "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ },
+ "Name": {
+ "shape": "__stringMin1Max255PatternS",
+ "locationName": "name",
+ "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
}
},
- "required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateGroupRequest"
+ "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateRequestContent"
},
- "GetCloudWatchAlarmTemplateGroupResponse": {
+ "UpdateEventBridgeRuleTemplateResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
"locationName": "arn",
- "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
+ "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
},
"CreatedAt": {
"shape": "__timestampIso8601",
@@ -21035,10 +24695,23 @@
"locationName": "description",
"documentation": "A resource's optional description."
},
+ "EventTargets": {
+ "shape": "__listOfEventBridgeRuleTemplateTarget",
+ "locationName": "eventTargets"
+ },
+ "EventType": {
+ "shape": "EventBridgeRuleTemplateEventType",
+ "locationName": "eventType"
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
},
"ModifiedAt": {
"shape": "__timestampIso8601",
@@ -21054,15 +24727,15 @@
"locationName": "tags"
}
},
- "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateGroupResponse"
+ "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateResponse"
},
- "GetCloudWatchAlarmTemplateGroupResponseContent": {
+ "UpdateEventBridgeRuleTemplateResponseContent": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
+ "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
"locationName": "arn",
- "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
+ "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
},
"CreatedAt": {
"shape": "__timestampIso8601",
@@ -21073,10 +24746,23 @@
"locationName": "description",
"documentation": "A resource's optional description."
},
+ "EventTargets": {
+ "shape": "__listOfEventBridgeRuleTemplateTarget",
+ "locationName": "eventTargets"
+ },
+ "EventType": {
+ "shape": "EventBridgeRuleTemplateEventType",
+ "locationName": "eventType"
+ },
+ "GroupId": {
+ "shape": "__stringMin7Max11PatternAws097",
+ "locationName": "groupId",
+ "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ },
"Id": {
"shape": "__stringMin7Max11PatternAws097",
"locationName": "id",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
},
"ModifiedAt": {
"shape": "__timestampIso8601",
@@ -21092,2833 +24778,3172 @@
"locationName": "tags"
}
},
- "required": [
- "CreatedAt",
- "Id",
- "Arn",
- "Name"
- ],
- "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateGroupResponseContent"
+ "required": [
+ "EventType",
+ "CreatedAt",
+ "Id",
+ "Arn",
+ "Name",
+ "GroupId"
+ ],
+ "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateResponseContent"
+ },
+ "__integerMax5": {
+ "type": "integer",
+ "max": 5,
+ "documentation": "Placeholder documentation for __integerMax5"
+ },
+ "__integerMin10Max86400": {
+ "type": "integer",
+ "min": 10,
+ "max": 86400,
+ "documentation": "Placeholder documentation for __integerMin10Max86400"
+ },
+ "__listOfCloudWatchAlarmTemplateGroupSummary": {
+ "type": "list",
+ "member": {
+ "shape": "CloudWatchAlarmTemplateGroupSummary"
+ },
+ "documentation": "Placeholder documentation for __listOfCloudWatchAlarmTemplateGroupSummary"
+ },
+ "__listOfCloudWatchAlarmTemplateSummary": {
+ "type": "list",
+ "member": {
+ "shape": "CloudWatchAlarmTemplateSummary"
+ },
+ "documentation": "Placeholder documentation for __listOfCloudWatchAlarmTemplateSummary"
+ },
+ "__listOfEventBridgeRuleTemplateGroupSummary": {
+ "type": "list",
+ "member": {
+ "shape": "EventBridgeRuleTemplateGroupSummary"
+ },
+ "documentation": "Placeholder documentation for __listOfEventBridgeRuleTemplateGroupSummary"
+ },
+ "__listOfEventBridgeRuleTemplateSummary": {
+ "type": "list",
+ "member": {
+ "shape": "EventBridgeRuleTemplateSummary"
+ },
+ "documentation": "Placeholder documentation for __listOfEventBridgeRuleTemplateSummary"
+ },
+ "__listOfEventBridgeRuleTemplateTarget": {
+ "type": "list",
+ "member": {
+ "shape": "EventBridgeRuleTemplateTarget"
+ },
+ "documentation": "Placeholder documentation for __listOfEventBridgeRuleTemplateTarget"
+ },
+ "__listOfMediaResourceNeighbor": {
+ "type": "list",
+ "member": {
+ "shape": "MediaResourceNeighbor"
+ },
+ "documentation": "Placeholder documentation for __listOfMediaResourceNeighbor"
+ },
+ "__listOfSignalMapSummary": {
+ "type": "list",
+ "member": {
+ "shape": "SignalMapSummary"
+ },
+ "documentation": "Placeholder documentation for __listOfSignalMapSummary"
+ },
+ "__listOf__stringMin7Max11PatternAws097": {
+ "type": "list",
+ "member": {
+ "shape": "__stringMin7Max11PatternAws097"
+ },
+ "documentation": "Placeholder documentation for __listOf__stringMin7Max11PatternAws097"
+ },
+ "__listOf__stringPatternS": {
+ "type": "list",
+ "member": {
+ "shape": "__stringPatternS"
+ },
+ "documentation": "Placeholder documentation for __listOf__stringPatternS"
+ },
+ "__stringMax64": {
+ "type": "string",
+ "max": 64,
+ "documentation": "Placeholder documentation for __stringMax64"
+ },
+ "__stringMin0Max1024": {
+ "type": "string",
+ "min": 0,
+ "max": 1024,
+ "documentation": "Placeholder documentation for __stringMin0Max1024"
+ },
+ "__stringMin1Max2048": {
+ "type": "string",
+ "min": 1,
+ "max": 2048,
+ "documentation": "Placeholder documentation for __stringMin1Max2048"
+ },
+ "__stringMin1Max2048PatternArn": {
+ "type": "string",
+ "min": 1,
+ "max": 2048,
+ "pattern": "^arn.+$",
+ "documentation": "Placeholder documentation for __stringMin1Max2048PatternArn"
+ },
+ "__stringMin1Max255PatternS": {
+ "type": "string",
+ "min": 1,
+ "max": 255,
+ "pattern": "^[^\\s]+$",
+ "documentation": "Placeholder documentation for __stringMin1Max255PatternS"
+ },
+ "__stringMin7Max11PatternAws097": {
+ "type": "string",
+ "min": 7,
+ "max": 11,
+ "pattern": "^(aws-)?[0-9]{7}$",
+ "documentation": "Placeholder documentation for __stringMin7Max11PatternAws097"
+ },
+ "__stringPatternArnMedialiveCloudwatchAlarmTemplate": {
+ "type": "string",
+ "pattern": "^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$",
+ "documentation": "Placeholder documentation for __stringPatternArnMedialiveCloudwatchAlarmTemplate"
+ },
+ "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup": {
+ "type": "string",
+ "pattern": "^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$",
+ "documentation": "Placeholder documentation for __stringPatternArnMedialiveCloudwatchAlarmTemplateGroup"
+ },
+ "__stringPatternArnMedialiveEventbridgeRuleTemplate": {
+ "type": "string",
+ "pattern": "^arn:.+:medialive:.+:eventbridge-rule-template:.+$",
+ "documentation": "Placeholder documentation for __stringPatternArnMedialiveEventbridgeRuleTemplate"
+ },
+ "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup": {
+ "type": "string",
+ "pattern": "^arn:.+:medialive:.+:eventbridge-rule-template-group:.+$",
+ "documentation": "Placeholder documentation for __stringPatternArnMedialiveEventbridgeRuleTemplateGroup"
+ },
+ "__stringPatternArnMedialiveSignalMap": {
+ "type": "string",
+ "pattern": "^arn:.+:medialive:.+:signal-map:.+$",
+ "documentation": "Placeholder documentation for __stringPatternArnMedialiveSignalMap"
+ },
+ "__stringPatternS": {
+ "type": "string",
+ "pattern": "^[^\\s]+$",
+ "documentation": "Placeholder documentation for __stringPatternS"
+ },
+ "Scte35SegmentationScope": {
+ "type": "string",
+ "documentation": "Scte35 Segmentation Scope",
+ "enum": [
+ "ALL_OUTPUT_GROUPS",
+ "SCTE35_ENABLED_OUTPUT_GROUPS"
+ ]
+ },
+ "Algorithm": {
+ "type": "string",
+ "enum": [
+ "AES128",
+ "AES192",
+ "AES256"
+ ],
+ "documentation": "Placeholder documentation for Algorithm"
+ },
+ "SrtCallerDecryption": {
+ "type": "structure",
+ "members": {
+ "Algorithm": {
+ "shape": "Algorithm",
+ "locationName": "algorithm",
+ "documentation": "The algorithm used to encrypt content."
+ },
+ "PassphraseSecretArn": {
+ "shape": "__string",
+ "locationName": "passphraseSecretArn",
+ "documentation": "The ARN for the secret in Secrets Manager. Someone in your organization must create a secret and provide you with its ARN. The secret holds the passphrase that MediaLive uses to decrypt the source content."
+ }
+ },
+ "documentation": "The decryption settings for the SRT caller source. Present only if the source has decryption enabled."
},
- "GetCloudWatchAlarmTemplateRequest": {
+ "SrtCallerDecryptionRequest": {
"type": "structure",
"members": {
- "Identifier": {
+ "Algorithm": {
+ "shape": "Algorithm",
+ "locationName": "algorithm",
+ "documentation": "The algorithm used to encrypt content."
+ },
+ "PassphraseSecretArn": {
"shape": "__string",
- "location": "uri",
- "locationName": "identifier",
- "documentation": "A cloudwatch alarm template's identifier. Can be either be its id or current name."
+ "locationName": "passphraseSecretArn",
+ "documentation": "The ARN for the secret in Secrets Manager. Someone in your organization must create a secret and provide you with its ARN. This secret holds the passphrase that MediaLive will use to decrypt the source content."
}
},
- "required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateRequest"
+ "documentation": "Complete these parameters only if the content is encrypted."
},
- "GetCloudWatchAlarmTemplateResponse": {
+ "SrtCallerSource": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
- "locationName": "arn",
- "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
- },
- "ComparisonOperator": {
- "shape": "CloudWatchAlarmTemplateComparisonOperator",
- "locationName": "comparisonOperator"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "DatapointsToAlarm": {
- "shape": "__integerMin1",
- "locationName": "datapointsToAlarm",
- "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "EvaluationPeriods": {
- "shape": "__integerMin1",
- "locationName": "evaluationPeriods",
- "documentation": "The number of periods over which data is compared to the specified threshold."
- },
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
- },
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
- },
- "MetricName": {
- "shape": "__stringMax64",
- "locationName": "metricName",
- "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Period": {
- "shape": "__integerMin10Max86400",
- "locationName": "period",
- "documentation": "The period, in seconds, over which the specified statistic is applied."
- },
- "Statistic": {
- "shape": "CloudWatchAlarmTemplateStatistic",
- "locationName": "statistic"
+ "Decryption": {
+ "shape": "SrtCallerDecryption",
+ "locationName": "decryption"
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "MinimumLatency": {
+ "shape": "__integer",
+ "locationName": "minimumLatency",
+ "documentation": "The preferred latency (in milliseconds) for implementing packet loss and recovery. Packet recovery is a key feature of SRT."
},
- "TargetResourceType": {
- "shape": "CloudWatchAlarmTemplateTargetResourceType",
- "locationName": "targetResourceType"
+ "SrtListenerAddress": {
+ "shape": "__string",
+ "locationName": "srtListenerAddress",
+ "documentation": "The IP address at the upstream system (the listener) that MediaLive (the caller) connects to."
},
- "Threshold": {
- "shape": "__double",
- "locationName": "threshold",
- "documentation": "The threshold value to compare with the specified statistic."
+ "SrtListenerPort": {
+ "shape": "__string",
+ "locationName": "srtListenerPort",
+ "documentation": "The port at the upstream system (the listener) that MediaLive (the caller) connects to."
},
- "TreatMissingData": {
- "shape": "CloudWatchAlarmTemplateTreatMissingData",
- "locationName": "treatMissingData"
+ "StreamId": {
+ "shape": "__string",
+ "locationName": "streamId",
+ "documentation": "The stream ID, if the upstream system uses this identifier."
}
},
- "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateResponse"
+ "documentation": "The configuration for a source that uses SRT as the connection protocol. In terms of establishing the connection, MediaLive is always caller and the upstream system is always the listener. In terms of transmission of the source content, MediaLive is always the receiver and the upstream system is always the sender."
},
- "GetCloudWatchAlarmTemplateResponseContent": {
+ "SrtCallerSourceRequest": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
- "locationName": "arn",
- "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
- },
- "ComparisonOperator": {
- "shape": "CloudWatchAlarmTemplateComparisonOperator",
- "locationName": "comparisonOperator"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "DatapointsToAlarm": {
- "shape": "__integerMin1",
- "locationName": "datapointsToAlarm",
- "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "EvaluationPeriods": {
- "shape": "__integerMin1",
- "locationName": "evaluationPeriods",
- "documentation": "The number of periods over which data is compared to the specified threshold."
- },
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
- },
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
- },
- "MetricName": {
- "shape": "__stringMax64",
- "locationName": "metricName",
- "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Period": {
- "shape": "__integerMin10Max86400",
- "locationName": "period",
- "documentation": "The period, in seconds, over which the specified statistic is applied."
- },
- "Statistic": {
- "shape": "CloudWatchAlarmTemplateStatistic",
- "locationName": "statistic"
+ "Decryption": {
+ "shape": "SrtCallerDecryptionRequest",
+ "locationName": "decryption"
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "MinimumLatency": {
+ "shape": "__integer",
+ "locationName": "minimumLatency",
+ "documentation": "The preferred latency (in milliseconds) for implementing packet loss and recovery. Packet recovery is a key feature of SRT. Obtain this value from the operator at the upstream system."
},
- "TargetResourceType": {
- "shape": "CloudWatchAlarmTemplateTargetResourceType",
- "locationName": "targetResourceType"
+ "SrtListenerAddress": {
+ "shape": "__string",
+ "locationName": "srtListenerAddress",
+ "documentation": "The IP address at the upstream system (the listener) that MediaLive (the caller) will connect to."
},
- "Threshold": {
- "shape": "__double",
- "locationName": "threshold",
- "documentation": "The threshold value to compare with the specified statistic."
+ "SrtListenerPort": {
+ "shape": "__string",
+ "locationName": "srtListenerPort",
+ "documentation": "The port at the upstream system (the listener) that MediaLive (the caller) will connect to."
},
- "TreatMissingData": {
- "shape": "CloudWatchAlarmTemplateTreatMissingData",
- "locationName": "treatMissingData"
+ "StreamId": {
+ "shape": "__string",
+ "locationName": "streamId",
+ "documentation": "This value is required if the upstream system uses this identifier because without it, the SRT handshake between MediaLive (the caller) and the upstream system (the listener) might fail."
+ }
+ },
+ "documentation": "Configures the connection for a source that uses SRT as the connection protocol. In terms of establishing the connection, MediaLive is always the caller and the upstream system is always the listener. In terms of transmission of the source content, MediaLive is always the receiver and the upstream system is always the sender."
+ },
+ "SrtSettings": {
+ "type": "structure",
+ "members": {
+ "SrtCallerSources": {
+ "shape": "__listOfSrtCallerSource",
+ "locationName": "srtCallerSources"
+ }
+ },
+ "documentation": "The configured sources for this SRT input."
+ },
+ "SrtSettingsRequest": {
+ "type": "structure",
+ "members": {
+ "SrtCallerSources": {
+ "shape": "__listOfSrtCallerSourceRequest",
+ "locationName": "srtCallerSources"
}
},
- "required": [
- "TargetResourceType",
- "TreatMissingData",
- "ComparisonOperator",
- "CreatedAt",
- "Period",
- "EvaluationPeriods",
- "Name",
- "GroupId",
- "MetricName",
- "Statistic",
- "Id",
- "Arn",
- "Threshold"
- ],
- "documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateResponseContent"
+ "documentation": "Configures the sources for this SRT input. For a single-pipeline input, include one srtCallerSource in the array. For a standard-pipeline input, include two srtCallerSource."
+ },
+ "__listOfSrtCallerSource": {
+ "type": "list",
+ "member": {
+ "shape": "SrtCallerSource"
+ },
+ "documentation": "Placeholder documentation for __listOfSrtCallerSource"
+ },
+ "__listOfSrtCallerSourceRequest": {
+ "type": "list",
+ "member": {
+ "shape": "SrtCallerSourceRequest"
+ },
+ "documentation": "Placeholder documentation for __listOfSrtCallerSourceRequest"
+ },
+ "MultiplexPacketIdentifiersMapping": {
+ "type": "map",
+ "key": {
+ "shape": "__string"
+ },
+ "value": {
+ "shape": "MultiplexProgramPacketIdentifiersMap"
+ },
+ "documentation": "Placeholder documentation for MultiplexPacketIdentifiersMapping"
},
- "GetEventBridgeRuleTemplateGroupRequest": {
+ "__integerMin1Max51": {
+ "type": "integer",
+ "min": 1,
+ "max": 51,
+ "documentation": "Placeholder documentation for __integerMin1Max51"
+ },
+ "AnywhereSettings": {
"type": "structure",
"members": {
- "Identifier": {
+ "ChannelPlacementGroupId": {
"shape": "__string",
- "location": "uri",
- "locationName": "identifier",
- "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ "locationName": "channelPlacementGroupId",
+ "documentation": "The ID of the channel placement group for the channel."
+ },
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster for the channel."
}
},
- "required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateGroupRequest"
+ "documentation": "Elemental anywhere settings"
},
- "GetEventBridgeRuleTemplateGroupResponse": {
+ "Av1ColorSpaceSettings": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
- "locationName": "arn",
- "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ "ColorSpacePassthroughSettings": {
+ "shape": "ColorSpacePassthroughSettings",
+ "locationName": "colorSpacePassthroughSettings"
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "Hdr10Settings": {
+ "shape": "Hdr10Settings",
+ "locationName": "hdr10Settings"
},
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "Rec601Settings": {
+ "shape": "Rec601Settings",
+ "locationName": "rec601Settings"
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "Rec709Settings": {
+ "shape": "Rec709Settings",
+ "locationName": "rec709Settings"
}
},
- "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateGroupResponse"
+ "documentation": "Av1 Color Space Settings"
},
- "GetEventBridgeRuleTemplateGroupResponseContent": {
+ "Av1GopSizeUnits": {
+ "type": "string",
+ "documentation": "Av1 Gop Size Units",
+ "enum": [
+ "FRAMES",
+ "SECONDS"
+ ]
+ },
+ "Av1Level": {
+ "type": "string",
+ "documentation": "Av1 Level",
+ "enum": [
+ "AV1_LEVEL_2",
+ "AV1_LEVEL_2_1",
+ "AV1_LEVEL_3",
+ "AV1_LEVEL_3_1",
+ "AV1_LEVEL_4",
+ "AV1_LEVEL_4_1",
+ "AV1_LEVEL_5",
+ "AV1_LEVEL_5_1",
+ "AV1_LEVEL_5_2",
+ "AV1_LEVEL_5_3",
+ "AV1_LEVEL_6",
+ "AV1_LEVEL_6_1",
+ "AV1_LEVEL_6_2",
+ "AV1_LEVEL_6_3",
+ "AV1_LEVEL_AUTO"
+ ]
+ },
+ "Av1LookAheadRateControl": {
+ "type": "string",
+ "documentation": "Av1 Look Ahead Rate Control",
+ "enum": [
+ "HIGH",
+ "LOW",
+ "MEDIUM"
+ ]
+ },
+ "Av1SceneChangeDetect": {
+ "type": "string",
+ "documentation": "Av1 Scene Change Detect",
+ "enum": [
+ "DISABLED",
+ "ENABLED"
+ ]
+ },
+ "Av1Settings": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
- "locationName": "arn",
- "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
+ "AfdSignaling": {
+ "shape": "AfdSignaling",
+ "locationName": "afdSignaling",
+ "documentation": "Configures whether MediaLive will write AFD values into the video.\nAUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid).\nFIXED: the AFD value will be the value configured in the fixedAfd parameter.\nNONE: MediaLive won't write AFD into the video"
},
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
+ "BufSize": {
+ "shape": "__integerMin50000Max16000000",
+ "locationName": "bufSize",
+ "documentation": "The size of the buffer (HRD buffer model) in bits."
},
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "ColorSpaceSettings": {
+ "shape": "Av1ColorSpaceSettings",
+ "locationName": "colorSpaceSettings",
+ "documentation": "Color Space settings"
},
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ "FixedAfd": {
+ "shape": "FixedAfd",
+ "locationName": "fixedAfd",
+ "documentation": "Complete this property only if you set the afdSignaling property to FIXED. Choose the AFD value (4 bits) to write on all frames of the video encode."
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "FramerateDenominator": {
+ "shape": "__integerMin1Max3003",
+ "locationName": "framerateDenominator",
+ "documentation": "The denominator for the framerate. Framerate is a fraction, for example, 24000 / 1001."
},
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "FramerateNumerator": {
+ "shape": "__integerMin1",
+ "locationName": "framerateNumerator",
+ "documentation": "The numerator for the framerate. Framerate is a fraction, for example, 24000 / 1001."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "GopSize": {
+ "shape": "__doubleMin0",
+ "locationName": "gopSize",
+ "documentation": "The GOP size (keyframe interval).\nIf GopSizeUnits is frames, GopSize must be a whole number and must be greater than or equal to 1.\nIf GopSizeUnits is seconds, GopSize must be greater than 0, but it can be a decimal."
+ },
+ "GopSizeUnits": {
+ "shape": "Av1GopSizeUnits",
+ "locationName": "gopSizeUnits",
+ "documentation": "Choose the units for the GOP size: FRAMES or SECONDS. For SECONDS, MediaLive converts the size into a frame count at run time."
+ },
+ "Level": {
+ "shape": "Av1Level",
+ "locationName": "level",
+ "documentation": "Sets the level. This parameter is one of the properties of the encoding scheme for AV1."
+ },
+ "LookAheadRateControl": {
+ "shape": "Av1LookAheadRateControl",
+ "locationName": "lookAheadRateControl",
+ "documentation": "Sets the amount of lookahead. A value of LOW can decrease latency and memory usage. A value of HIGH can produce better quality for certain content."
+ },
+ "MaxBitrate": {
+ "shape": "__integerMin50000Max8000000",
+ "locationName": "maxBitrate",
+ "documentation": "The maximum bitrate to assign.\nFor recommendations, see the description for qvbrQualityLevel."
+ },
+ "MinIInterval": {
+ "shape": "__integerMin0Max30",
+ "locationName": "minIInterval",
+ "documentation": "Applies only if you enable SceneChangeDetect. Sets the interval between frames. This property ensures a minimum separation between repeated (cadence) I-frames and any I-frames inserted by scene change detection (SCD frames).\nEnter a number for the interval, measured in number of frames.\nIf an SCD frame and a cadence frame are closer than the specified number of frames, MediaLive shrinks or stretches the GOP to include the SCD frame. Then normal cadence resumes in the next GOP. For GOP stretch to succeed, you must enable LookAheadRateControl.\nNote that the maximum GOP stretch = (GOP size) + (Minimum I-interval) - 1"
+ },
+ "ParDenominator": {
+ "shape": "__integerMin1",
+ "locationName": "parDenominator",
+ "documentation": "The denominator for the output pixel aspect ratio (PAR)."
+ },
+ "ParNumerator": {
+ "shape": "__integerMin1",
+ "locationName": "parNumerator",
+ "documentation": "The numerator for the output pixel aspect ratio (PAR)."
+ },
+ "QvbrQualityLevel": {
+ "shape": "__integerMin1Max10",
+ "locationName": "qvbrQualityLevel",
+ "documentation": "Controls the target quality for the video encode. With QVBR rate control mode, the final quality is the target quality, constrained by the maxBitrate.\nSet values for the qvbrQualityLevel property and maxBitrate property that suit your most important viewing devices.\nTo let MediaLive set the quality level (AUTO mode), leave the qvbrQualityLevel field empty. In this case, MediaLive uses the maximum bitrate, and the quality follows from that: more complex content might have a lower quality.\nOr set a target quality level and a maximum bitrate. With more complex content, MediaLive will try to achieve the target quality, but it won't exceed the maximum bitrate. With less complex content, This option will use only the bitrate needed to reach the target quality.\nRecommended values are:\nPrimary screen: qvbrQualityLevel: Leave empty. maxBitrate: 4,000,000\nPC or tablet: qvbrQualityLevel: Leave empty. maxBitrate: 1,500,000 to 3,000,000\nSmartphone: qvbrQualityLevel: Leave empty. maxBitrate: 1,000,000 to 1,500,000"
+ },
+ "SceneChangeDetect": {
+ "shape": "Av1SceneChangeDetect",
+ "locationName": "sceneChangeDetect",
+ "documentation": "Controls whether MediaLive inserts I-frames when it detects a scene change. ENABLED or DISABLED."
+ },
+ "TimecodeBurninSettings": {
+ "shape": "TimecodeBurninSettings",
+ "locationName": "timecodeBurninSettings",
+ "documentation": "Configures the timecode burn-in feature. If you enable this feature, the timecode will become part of the video."
}
},
+ "documentation": "Av1 Settings",
"required": [
- "CreatedAt",
- "Id",
- "Arn",
- "Name"
- ],
- "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateGroupResponseContent"
+ "FramerateNumerator",
+ "FramerateDenominator"
+ ]
},
- "GetEventBridgeRuleTemplateRequest": {
+ "ChannelPlacementGroupState": {
+ "type": "string",
+ "documentation": "Used in DescribeChannelPlacementGroupResult",
+ "enum": [
+ "UNASSIGNED",
+ "ASSIGNING",
+ "ASSIGNED",
+ "DELETING",
+ "DELETE_FAILED",
+ "DELETED",
+ "UNASSIGNING"
+ ]
+ },
+ "ClusterNetworkSettings": {
"type": "structure",
"members": {
- "Identifier": {
+ "DefaultRoute": {
"shape": "__string",
- "location": "uri",
- "locationName": "identifier",
- "documentation": "An eventbridge rule template's identifier. Can be either be its id or current name."
+ "locationName": "defaultRoute",
+ "documentation": "The network interface that is the default route for traffic to and from the node. MediaLive Anywhere uses this default when the destination for the traffic isn't covered by the route table for any of the networks. Specify the value of the appropriate logicalInterfaceName parameter that you create in the interfaceMappings."
+ },
+ "InterfaceMappings": {
+ "shape": "__listOfInterfaceMapping",
+ "locationName": "interfaceMappings",
+ "documentation": "An array of interfaceMapping objects for this Cluster. Each mapping logically connects one interface on the nodes with one Network. You need only one mapping for each interface because all the Nodes share the mapping."
}
},
- "required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateRequest"
+ "documentation": "Used in DescribeClusterResult, DescribeClusterSummary, UpdateClusterResult."
},
- "GetEventBridgeRuleTemplateResponse": {
+ "ClusterNetworkSettingsCreateRequest": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
- "locationName": "arn",
- "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "EventTargets": {
- "shape": "__listOfEventBridgeRuleTemplateTarget",
- "locationName": "eventTargets"
- },
- "EventType": {
- "shape": "EventBridgeRuleTemplateEventType",
- "locationName": "eventType"
- },
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
- },
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "DefaultRoute": {
+ "shape": "__string",
+ "locationName": "defaultRoute",
+ "documentation": "Specify one network interface as the default route for traffic to and from the Node. MediaLive Anywhere uses this default when the destination for the traffic isn't covered by the route table for any of the networks. Specify the value of the appropriate logicalInterfaceName parameter that you create in the interfaceMappings."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "InterfaceMappings": {
+ "shape": "__listOfInterfaceMappingCreateRequest",
+ "locationName": "interfaceMappings",
+ "documentation": "An array of interfaceMapping objects for this Cluster. You must create a mapping for node interfaces that you plan to use for encoding traffic. You typically don't create a mapping for the management interface. You define this mapping in the Cluster so that the mapping can be used by all the Nodes. Each mapping logically connects one interface on the nodes with one Network. Each mapping consists of a pair of parameters. The logicalInterfaceName parameter creates a logical name for the Node interface that handles a specific type of traffic. For example, my-Inputs-Interface. The networkID parameter refers to the ID of the network. When you create the Nodes in this Cluster, you will associate the logicalInterfaceName with the appropriate physical interface."
}
},
- "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateResponse"
+ "documentation": "Used in a CreateClusterRequest."
},
- "GetEventBridgeRuleTemplateResponseContent": {
+ "ClusterNetworkSettingsUpdateRequest": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
- "locationName": "arn",
- "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "EventTargets": {
- "shape": "__listOfEventBridgeRuleTemplateTarget",
- "locationName": "eventTargets"
- },
- "EventType": {
- "shape": "EventBridgeRuleTemplateEventType",
- "locationName": "eventType"
- },
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
- },
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "DefaultRoute": {
+ "shape": "__string",
+ "locationName": "defaultRoute",
+ "documentation": "Include this parameter only if you want to change the default route for the Cluster. Specify one network interface as the default route for traffic to and from the node. MediaLive Anywhere uses this default when the destination for the traffic isn't covered by the route table for any of the networks. Specify the value of the appropriate logicalInterfaceName parameter that you create in the interfaceMappings."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "InterfaceMappings": {
+ "shape": "__listOfInterfaceMappingUpdateRequest",
+ "locationName": "interfaceMappings",
+ "documentation": "An array of interfaceMapping objects for this Cluster. Include this parameter only if you want to change the interface mappings for the Cluster. Typically, you change the interface mappings only to fix an error you made when creating the mapping. In an update request, make sure that you enter the entire set of mappings again, not just the mappings that you want to add or change. You define this mapping so that the mapping can be used by all the Nodes. Each mapping logically connects one interface on the nodes with one Network. Each mapping consists of a pair of parameters. The logicalInterfaceName parameter creates a logical name for the Node interface that handles a specific type of traffic. For example, my-Inputs-Interface. The networkID parameter refers to the ID of the network. When you create the Nodes in this Cluster, you will associate the logicalInterfaceName with the appropriate physical interface."
}
},
- "required": [
- "EventType",
- "CreatedAt",
- "Id",
- "Arn",
- "Name",
- "GroupId"
- ],
- "documentation": "Placeholder documentation for GetEventBridgeRuleTemplateResponseContent"
+ "documentation": "Placeholder documentation for ClusterNetworkSettingsUpdateRequest"
},
- "GetSignalMapRequest": {
+ "ClusterState": {
+ "type": "string",
+ "documentation": "Used in DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult.",
+ "enum": [
+ "CREATING",
+ "CREATE_FAILED",
+ "ACTIVE",
+ "DELETING",
+ "DELETE_FAILED",
+ "DELETED"
+ ]
+ },
+ "ClusterType": {
+ "type": "string",
+ "documentation": "Used in CreateClusterSummary, DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult.",
+ "enum": [
+ "ON_PREMISES"
+ ]
+ },
+ "CreateChannelPlacementGroupRequest": {
"type": "structure",
"members": {
- "Identifier": {
+ "ClusterId": {
"shape": "__string",
"location": "uri",
- "locationName": "identifier",
- "documentation": "A signal map's identifier. Can be either be its id or current name."
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive."
+ },
+ "Nodes": {
+ "shape": "__listOf__string",
+ "locationName": "nodes",
+ "documentation": "An array of one ID for the Node that you want to associate with the ChannelPlacementGroup. (You can't associate more than one Node with the ChannelPlacementGroup.) The Node and the ChannelPlacementGroup must be in the same Cluster."
+ },
+ "RequestId": {
+ "shape": "__string",
+ "locationName": "requestId",
+ "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources. the request.",
+ "idempotencyToken": true
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
}
},
+ "documentation": "A request to create a channel placement group.",
"required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for GetSignalMapRequest"
+ "ClusterId"
+ ]
},
- "GetSignalMapResponse": {
+ "CreateChannelPlacementGroupResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveSignalMap",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "A signal map's ARN (Amazon Resource Name)"
- },
- "CloudWatchAlarmTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "cloudWatchAlarmTemplateGroupIds"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
- },
- "ErrorMessage": {
- "shape": "__stringMin1Max2048",
- "locationName": "errorMessage",
- "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ "documentation": "The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created."
},
- "EventBridgeRuleTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "eventBridgeRuleTemplateGroupIds"
+ "Channels": {
+ "shape": "__listOf__string",
+ "locationName": "channels",
+ "documentation": "Used in ListChannelPlacementGroupsResult"
},
- "FailedMediaResourceMap": {
- "shape": "FailedMediaResourceMap",
- "locationName": "failedMediaResourceMap"
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "A signal map's id."
- },
- "LastDiscoveredAt": {
- "shape": "__timestampIso8601",
- "locationName": "lastDiscoveredAt"
+ "documentation": "The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
- "LastSuccessfulMonitorDeployment": {
- "shape": "SuccessfulMonitorDeployment",
- "locationName": "lastSuccessfulMonitorDeployment"
- },
- "MediaResourceMap": {
- "shape": "MediaResourceMap",
- "locationName": "mediaResourceMap"
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you specified for the ChannelPlacementGroup."
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "Nodes": {
+ "shape": "__listOf__string",
+ "locationName": "nodes",
+ "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup."
},
- "MonitorChangesPendingDeployment": {
- "shape": "__boolean",
- "locationName": "monitorChangesPendingDeployment",
- "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ "State": {
+ "shape": "ChannelPlacementGroupState",
+ "locationName": "state",
+ "documentation": "The current state of the ChannelPlacementGroup."
+ }
+ },
+ "documentation": "Placeholder documentation for CreateChannelPlacementGroupResponse"
+ },
+ "CreateClusterRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterType": {
+ "shape": "ClusterType",
+ "locationName": "clusterType",
+ "documentation": "Specify a type. All the Nodes that you later add to this Cluster must be this type of hardware. One Cluster instance can't contain different hardware types. You won't be able to change this parameter after you create the Cluster."
},
- "MonitorDeployment": {
- "shape": "MonitorDeployment",
- "locationName": "monitorDeployment"
+ "InstanceRoleArn": {
+ "shape": "__string",
+ "locationName": "instanceRoleArn",
+ "documentation": "The ARN of the IAM role for the Node in this Cluster. The role must include all the operations that you expect these Node to perform. If necessary, create a role in IAM, then attach it here."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "Specify a name that is unique in the AWS account. We recommend that you assign a name that hints at the types of Nodes in the Cluster. Names are case-sensitive."
},
- "Status": {
- "shape": "SignalMapStatus",
- "locationName": "status"
+ "NetworkSettings": {
+ "shape": "ClusterNetworkSettingsCreateRequest",
+ "locationName": "networkSettings",
+ "documentation": "Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with."
+ },
+ "RequestId": {
+ "shape": "__string",
+ "locationName": "requestId",
+ "documentation": "The unique ID of the request.",
+ "idempotencyToken": true
},
"Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
}
},
- "documentation": "Placeholder documentation for GetSignalMapResponse"
+ "documentation": "Create as many Clusters as you want, but create at least one. Each Cluster groups together Nodes that you want to treat as a collection. Within the Cluster, you will set up some Nodes as active Nodes, and some as backup Nodes, for Node failover purposes. Each Node can belong to only one Cluster."
},
- "GetSignalMapResponseContent": {
+ "CreateClusterResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveSignalMap",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "A signal map's ARN (Amazon Resource Name)"
- },
- "CloudWatchAlarmTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "cloudWatchAlarmTemplateGroupIds"
+ "documentation": "The ARN of this Cluster. It is automatically assigned when the Cluster is created."
},
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
- },
- "ErrorMessage": {
- "shape": "__stringMin1Max2048",
- "locationName": "errorMessage",
- "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
- },
- "EventBridgeRuleTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "eventBridgeRuleTemplateGroupIds"
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds"
},
- "FailedMediaResourceMap": {
- "shape": "FailedMediaResourceMap",
- "locationName": "failedMediaResourceMap"
+ "ClusterType": {
+ "shape": "ClusterType",
+ "locationName": "clusterType",
+ "documentation": "The hardware type for the Cluster"
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "A signal map's id."
- },
- "LastDiscoveredAt": {
- "shape": "__timestampIso8601",
- "locationName": "lastDiscoveredAt"
- },
- "LastSuccessfulMonitorDeployment": {
- "shape": "SuccessfulMonitorDeployment",
- "locationName": "lastSuccessfulMonitorDeployment"
+ "documentation": "The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
- "MediaResourceMap": {
- "shape": "MediaResourceMap",
- "locationName": "mediaResourceMap"
+ "InstanceRoleArn": {
+ "shape": "__string",
+ "locationName": "instanceRoleArn",
+ "documentation": "The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform."
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you specified for the Cluster."
},
- "MonitorChangesPendingDeployment": {
- "shape": "__boolean",
- "locationName": "monitorChangesPendingDeployment",
- "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ "NetworkSettings": {
+ "shape": "ClusterNetworkSettings",
+ "locationName": "networkSettings",
+ "documentation": "Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with."
},
- "MonitorDeployment": {
- "shape": "MonitorDeployment",
- "locationName": "monitorDeployment"
+ "State": {
+ "shape": "ClusterState",
+ "locationName": "state",
+ "documentation": "The current state of the Cluster."
+ }
+ },
+ "documentation": "Placeholder documentation for CreateClusterResponse"
+ },
+ "CreateNetworkRequest": {
+ "type": "structure",
+ "members": {
+ "IpPools": {
+ "shape": "__listOfIpPoolCreateRequest",
+ "locationName": "ipPools",
+ "documentation": "An array of IpPoolCreateRequests that identify a collection of IP addresses in your network that you want to reserve for use in MediaLive Anywhere. MediaLiveAnywhere uses these IP addresses for Push inputs (in both Bridge and NATnetworks) and for output destinations (only in Bridge networks). EachIpPoolUpdateRequest specifies one CIDR block."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "Specify a name that is unique in the AWS account. We recommend that you assign a name that hints at the type of traffic on the network. Names are case-sensitive."
},
- "Status": {
- "shape": "SignalMapStatus",
- "locationName": "status"
+ "RequestId": {
+ "shape": "__string",
+ "locationName": "requestId",
+ "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.",
+ "idempotencyToken": true
+ },
+ "Routes": {
+ "shape": "__listOfRouteCreateRequest",
+ "locationName": "routes",
+ "documentation": "An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic."
},
"Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
}
},
- "required": [
- "Status",
- "CreatedAt",
- "Name",
- "Id",
- "Arn",
- "DiscoveryEntryPointArn",
- "MonitorChangesPendingDeployment"
- ],
- "documentation": "Placeholder documentation for GetSignalMapResponseContent"
+ "documentation": "A request to create a Network."
},
- "InternalServerErrorExceptionResponseContent": {
+ "CreateNetworkResponse": {
"type": "structure",
"members": {
- "Message": {
+ "Arn": {
"shape": "__string",
- "locationName": "message",
- "documentation": "Exception error message."
+ "locationName": "arn",
+ "documentation": "The ARN of this Network. It is automatically assigned when the Network is created."
+ },
+ "AssociatedClusterIds": {
+ "shape": "__listOf__string",
+ "locationName": "associatedClusterIds"
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN."
+ },
+ "IpPools": {
+ "shape": "__listOfIpPool",
+ "locationName": "ipPools",
+ "documentation": "An array of IpPools in your organization's network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you specified for the Network."
+ },
+ "Routes": {
+ "shape": "__listOfRoute",
+ "locationName": "routes",
+ "documentation": "An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic."
+ },
+ "State": {
+ "shape": "NetworkState",
+ "locationName": "state",
+ "documentation": "The current state of the Network. Only MediaLive Anywhere can change the state."
}
},
- "documentation": "Unexpected error during processing of request."
+ "documentation": "Placeholder documentation for CreateNetworkResponse"
},
- "ListCloudWatchAlarmTemplateGroupsRequest": {
+ "CreateNodeRegistrationScriptRequest": {
"type": "structure",
"members": {
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
+ "ClusterId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster"
},
- "NextToken": {
+ "Id": {
"shape": "__string",
- "location": "querystring",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "locationName": "id",
+ "documentation": "If you're generating a re-registration script for an already existing node, this is where you provide the id."
},
- "Scope": {
+ "Name": {
"shape": "__string",
- "location": "querystring",
- "locationName": "scope",
- "documentation": "Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources."
+ "locationName": "name",
+ "documentation": "Specify a pattern for MediaLive Anywhere to use to assign a name to each Node in the Cluster. The pattern can include the variables $hn (hostname of the node hardware) and $ts for the date and time that the Node is created, in UTC (for example, 2024-08-20T23:35:12Z)."
},
- "SignalMapIdentifier": {
+ "NodeInterfaceMappings": {
+ "shape": "__listOfNodeInterfaceMapping",
+ "locationName": "nodeInterfaceMappings",
+ "documentation": "Documentation update needed"
+ },
+ "RequestId": {
"shape": "__string",
- "location": "querystring",
- "locationName": "signalMapIdentifier",
- "documentation": "A signal map's identifier. Can be either be its id or current name."
+ "locationName": "requestId",
+ "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.",
+ "idempotencyToken": true
+ },
+ "Role": {
+ "shape": "NodeRole",
+ "locationName": "role",
+ "documentation": "The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails."
}
},
- "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplateGroupsRequest"
+ "documentation": "A request to create a new node registration script.",
+ "required": [
+ "ClusterId"
+ ]
},
- "ListCloudWatchAlarmTemplateGroupsResponse": {
+ "CreateNodeRegistrationScriptResponse": {
"type": "structure",
"members": {
- "CloudWatchAlarmTemplateGroups": {
- "shape": "__listOfCloudWatchAlarmTemplateGroupSummary",
- "locationName": "cloudWatchAlarmTemplateGroups"
- },
- "NextToken": {
- "shape": "__stringMin1Max2048",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "NodeRegistrationScript": {
+ "shape": "__string",
+ "locationName": "nodeRegistrationScript",
+ "documentation": "A script that can be run on a Bring Your Own Device Elemental Anywhere system to create a node in a cluster."
}
},
- "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplateGroupsResponse"
+ "documentation": "Placeholder documentation for CreateNodeRegistrationScriptResponse"
},
- "ListCloudWatchAlarmTemplateGroupsResponseContent": {
+ "CreateNodeRegistrationScriptResult": {
"type": "structure",
"members": {
- "CloudWatchAlarmTemplateGroups": {
- "shape": "__listOfCloudWatchAlarmTemplateGroupSummary",
- "locationName": "cloudWatchAlarmTemplateGroups"
- },
- "NextToken": {
- "shape": "__stringMin1Max2048",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "NodeRegistrationScript": {
+ "shape": "__string",
+ "locationName": "nodeRegistrationScript",
+ "documentation": "A script that can be run on a Bring Your Own Device Elemental Anywhere system to create a node in a cluster."
}
},
- "required": [
- "CloudWatchAlarmTemplateGroups"
- ],
- "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplateGroupsResponseContent"
+ "documentation": "Contains the response for CreateNodeRegistrationScript."
},
- "ListCloudWatchAlarmTemplatesRequest": {
+ "CreateNodeRequest": {
"type": "structure",
"members": {
- "GroupIdentifier": {
+ "ClusterId": {
"shape": "__string",
- "location": "querystring",
- "locationName": "groupIdentifier",
- "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
- },
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster."
},
- "NextToken": {
+ "Name": {
"shape": "__string",
- "location": "querystring",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "locationName": "name",
+ "documentation": "The user-specified name of the Node to be created."
},
- "Scope": {
- "shape": "__string",
- "location": "querystring",
- "locationName": "scope",
- "documentation": "Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources."
+ "NodeInterfaceMappings": {
+ "shape": "__listOfNodeInterfaceMappingCreateRequest",
+ "locationName": "nodeInterfaceMappings",
+ "documentation": "Documentation update needed"
},
- "SignalMapIdentifier": {
+ "RequestId": {
"shape": "__string",
- "location": "querystring",
- "locationName": "signalMapIdentifier",
- "documentation": "A signal map's identifier. Can be either be its id or current name."
+ "locationName": "requestId",
+ "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.",
+ "idempotencyToken": true
+ },
+ "Role": {
+ "shape": "NodeRole",
+ "locationName": "role",
+ "documentation": "The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails."
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags",
+ "documentation": "A collection of key-value pairs."
}
},
- "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplatesRequest"
+ "documentation": "A request to create a node",
+ "required": [
+ "ClusterId"
+ ]
},
- "ListCloudWatchAlarmTemplatesResponse": {
+ "CreateNodeResponse": {
"type": "structure",
"members": {
- "CloudWatchAlarmTemplates": {
- "shape": "__listOfCloudWatchAlarmTemplateSummary",
- "locationName": "cloudWatchAlarmTemplates"
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The ARN of the Node. It is automatically assigned when the Node is created."
},
- "NextToken": {
- "shape": "__stringMin1Max2048",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "ChannelPlacementGroups": {
+ "shape": "__listOf__string",
+ "locationName": "channelPlacementGroups",
+ "documentation": "An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups."
+ },
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
+ },
+ "ConnectionState": {
+ "shape": "NodeConnectionState",
+ "locationName": "connectionState",
+ "documentation": "The current connection state of the Node."
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN."
+ },
+ "InstanceArn": {
+ "shape": "__string",
+ "locationName": "instanceArn",
+ "documentation": "The ARN of the EC2 instance hosting the Node."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you specified for the Node."
+ },
+ "NodeInterfaceMappings": {
+ "shape": "__listOfNodeInterfaceMapping",
+ "locationName": "nodeInterfaceMappings",
+ "documentation": "Documentation update needed"
+ },
+ "Role": {
+ "shape": "NodeRole",
+ "locationName": "role",
+ "documentation": "The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails."
+ },
+ "State": {
+ "shape": "NodeState",
+ "locationName": "state",
+ "documentation": "The current state of the Node."
}
},
- "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplatesResponse"
+ "documentation": "Placeholder documentation for CreateNodeResponse"
},
- "ListCloudWatchAlarmTemplatesResponseContent": {
+ "DeleteChannelPlacementGroupRequest": {
"type": "structure",
"members": {
- "CloudWatchAlarmTemplates": {
- "shape": "__listOfCloudWatchAlarmTemplateSummary",
- "locationName": "cloudWatchAlarmTemplates"
+ "ChannelPlacementGroupId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelPlacementGroupId",
+ "documentation": "The ID of the channel placement group."
},
- "NextToken": {
- "shape": "__stringMin1Max2048",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "ClusterId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster."
}
},
"required": [
- "CloudWatchAlarmTemplates"
+ "ClusterId",
+ "ChannelPlacementGroupId"
],
- "documentation": "Placeholder documentation for ListCloudWatchAlarmTemplatesResponseContent"
+ "documentation": "Placeholder documentation for DeleteChannelPlacementGroupRequest"
},
- "ListEventBridgeRuleTemplateGroupsRequest": {
+ "DeleteChannelPlacementGroupResponse": {
"type": "structure",
"members": {
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created."
},
- "NextToken": {
+ "Channels": {
+ "shape": "__listOf__string",
+ "locationName": "channels",
+ "documentation": "Used in ListChannelPlacementGroupsResult"
+ },
+ "ClusterId": {
"shape": "__string",
- "location": "querystring",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
},
- "SignalMapIdentifier": {
+ "Id": {
"shape": "__string",
- "location": "querystring",
- "locationName": "signalMapIdentifier",
- "documentation": "A signal map's identifier. Can be either be its id or current name."
+ "locationName": "id",
+ "documentation": "The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you specified for the ChannelPlacementGroup."
+ },
+ "Nodes": {
+ "shape": "__listOf__string",
+ "locationName": "nodes",
+ "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup."
+ },
+ "State": {
+ "shape": "ChannelPlacementGroupState",
+ "locationName": "state",
+ "documentation": "The current state of the ChannelPlacementGroup."
}
},
- "documentation": "Placeholder documentation for ListEventBridgeRuleTemplateGroupsRequest"
+ "documentation": "Placeholder documentation for DeleteChannelPlacementGroupResponse"
},
- "ListEventBridgeRuleTemplateGroupsResponse": {
+ "DeleteClusterRequest": {
"type": "structure",
"members": {
- "EventBridgeRuleTemplateGroups": {
- "shape": "__listOfEventBridgeRuleTemplateGroupSummary",
- "locationName": "eventBridgeRuleTemplateGroups"
+ "ClusterId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster."
+ }
+ },
+ "required": [
+ "ClusterId"
+ ],
+ "documentation": "Placeholder documentation for DeleteClusterRequest"
+ },
+ "DeleteClusterResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The ARN of this Cluster. It is automatically assigned when the Cluster is created."
+ },
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds"
+ },
+ "ClusterType": {
+ "shape": "ClusterType",
+ "locationName": "clusterType",
+ "documentation": "The hardware type for the Cluster"
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN."
+ },
+ "InstanceRoleArn": {
+ "shape": "__string",
+ "locationName": "instanceRoleArn",
+ "documentation": "The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you specified for the Cluster."
+ },
+ "NetworkSettings": {
+ "shape": "ClusterNetworkSettings",
+ "locationName": "networkSettings",
+ "documentation": "Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with."
},
- "NextToken": {
- "shape": "__stringMin1Max2048",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "State": {
+ "shape": "ClusterState",
+ "locationName": "state",
+ "documentation": "The current state of the Cluster."
}
},
- "documentation": "Placeholder documentation for ListEventBridgeRuleTemplateGroupsResponse"
+ "documentation": "Placeholder documentation for DeleteClusterResponse"
},
- "ListEventBridgeRuleTemplateGroupsResponseContent": {
+ "DeleteNetworkRequest": {
"type": "structure",
"members": {
- "EventBridgeRuleTemplateGroups": {
- "shape": "__listOfEventBridgeRuleTemplateGroupSummary",
- "locationName": "eventBridgeRuleTemplateGroups"
- },
- "NextToken": {
- "shape": "__stringMin1Max2048",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "NetworkId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "networkId",
+ "documentation": "The ID of the network."
}
},
"required": [
- "EventBridgeRuleTemplateGroups"
+ "NetworkId"
],
- "documentation": "Placeholder documentation for ListEventBridgeRuleTemplateGroupsResponseContent"
+ "documentation": "Placeholder documentation for DeleteNetworkRequest"
},
- "ListEventBridgeRuleTemplatesRequest": {
+ "DeleteNetworkResponse": {
"type": "structure",
"members": {
- "GroupIdentifier": {
+ "Arn": {
"shape": "__string",
- "location": "querystring",
- "locationName": "groupIdentifier",
- "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ "locationName": "arn",
+ "documentation": "The ARN of this Network. It is automatically assigned when the Network is created."
},
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
+ "AssociatedClusterIds": {
+ "shape": "__listOf__string",
+ "locationName": "associatedClusterIds"
},
- "NextToken": {
+ "Id": {
"shape": "__string",
- "location": "querystring",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "locationName": "id",
+ "documentation": "The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
- "SignalMapIdentifier": {
+ "IpPools": {
+ "shape": "__listOfIpPool",
+ "locationName": "ipPools",
+ "documentation": "An array of IpPools in your organization's network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block."
+ },
+ "Name": {
"shape": "__string",
- "location": "querystring",
- "locationName": "signalMapIdentifier",
- "documentation": "A signal map's identifier. Can be either be its id or current name."
- }
- },
- "documentation": "Placeholder documentation for ListEventBridgeRuleTemplatesRequest"
- },
- "ListEventBridgeRuleTemplatesResponse": {
- "type": "structure",
- "members": {
- "EventBridgeRuleTemplates": {
- "shape": "__listOfEventBridgeRuleTemplateSummary",
- "locationName": "eventBridgeRuleTemplates"
+ "locationName": "name",
+ "documentation": "The name that you specified for the Network."
},
- "NextToken": {
- "shape": "__stringMin1Max2048",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "Routes": {
+ "shape": "__listOfRoute",
+ "locationName": "routes",
+ "documentation": "An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic."
+ },
+ "State": {
+ "shape": "NetworkState",
+ "locationName": "state",
+ "documentation": "The current state of the Network. Only MediaLive Anywhere can change the state."
}
},
- "documentation": "Placeholder documentation for ListEventBridgeRuleTemplatesResponse"
+ "documentation": "Placeholder documentation for DeleteNetworkResponse"
},
- "ListEventBridgeRuleTemplatesResponseContent": {
+ "DeleteNodeRequest": {
"type": "structure",
"members": {
- "EventBridgeRuleTemplates": {
- "shape": "__listOfEventBridgeRuleTemplateSummary",
- "locationName": "eventBridgeRuleTemplates"
+ "ClusterId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster"
},
- "NextToken": {
- "shape": "__stringMin1Max2048",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "NodeId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "nodeId",
+ "documentation": "The ID of the node."
}
},
"required": [
- "EventBridgeRuleTemplates"
+ "NodeId",
+ "ClusterId"
],
- "documentation": "Placeholder documentation for ListEventBridgeRuleTemplatesResponseContent"
+ "documentation": "Placeholder documentation for DeleteNodeRequest"
},
- "ListSignalMapsRequest": {
+ "DeleteNodeResponse": {
"type": "structure",
"members": {
- "CloudWatchAlarmTemplateGroupIdentifier": {
+ "Arn": {
"shape": "__string",
- "location": "querystring",
- "locationName": "cloudWatchAlarmTemplateGroupIdentifier",
- "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
+ "locationName": "arn",
+ "documentation": "The ARN of the Node. It is automatically assigned when the Node is created."
},
- "EventBridgeRuleTemplateGroupIdentifier": {
+ "ChannelPlacementGroups": {
+ "shape": "__listOf__string",
+ "locationName": "channelPlacementGroups",
+ "documentation": "An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups."
+ },
+ "ClusterId": {
"shape": "__string",
- "location": "querystring",
- "locationName": "eventBridgeRuleTemplateGroupIdentifier",
- "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
},
- "MaxResults": {
- "shape": "MaxResults",
- "location": "querystring",
- "locationName": "maxResults"
+ "ConnectionState": {
+ "shape": "NodeConnectionState",
+ "locationName": "connectionState",
+ "documentation": "The current connection state of the Node."
},
- "NextToken": {
+ "Id": {
"shape": "__string",
- "location": "querystring",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "locationName": "id",
+ "documentation": "The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN."
+ },
+ "InstanceArn": {
+ "shape": "__string",
+ "locationName": "instanceArn",
+ "documentation": "The ARN of the EC2 instance hosting the Node."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you specified for the Node."
+ },
+ "NodeInterfaceMappings": {
+ "shape": "__listOfNodeInterfaceMapping",
+ "locationName": "nodeInterfaceMappings",
+ "documentation": "Documentation update needed"
+ },
+ "Role": {
+ "shape": "NodeRole",
+ "locationName": "role",
+ "documentation": "The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails."
+ },
+ "State": {
+ "shape": "NodeState",
+ "locationName": "state",
+ "documentation": "The current state of the Node."
}
},
- "documentation": "Placeholder documentation for ListSignalMapsRequest"
+ "documentation": "Placeholder documentation for DeleteNodeResponse"
},
- "ListSignalMapsResponse": {
+ "DescribeAnywhereSettings": {
"type": "structure",
"members": {
- "NextToken": {
- "shape": "__stringMin1Max2048",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "ChannelPlacementGroupId": {
+ "shape": "__string",
+ "locationName": "channelPlacementGroupId",
+ "documentation": "The ID of the channel placement group for the channel."
},
- "SignalMaps": {
- "shape": "__listOfSignalMapSummary",
- "locationName": "signalMaps"
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster for the channel."
}
},
- "documentation": "Placeholder documentation for ListSignalMapsResponse"
+ "documentation": "Elemental anywhere settings"
},
- "ListSignalMapsResponseContent": {
+ "DescribeChannelPlacementGroupRequest": {
"type": "structure",
"members": {
- "NextToken": {
- "shape": "__stringMin1Max2048",
- "locationName": "nextToken",
- "documentation": "A token used to retrieve the next set of results in paginated list responses."
+ "ChannelPlacementGroupId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelPlacementGroupId",
+ "documentation": "The ID of the channel placement group."
},
- "SignalMaps": {
- "shape": "__listOfSignalMapSummary",
- "locationName": "signalMaps"
+ "ClusterId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster."
}
},
"required": [
- "SignalMaps"
+ "ClusterId",
+ "ChannelPlacementGroupId"
],
- "documentation": "Placeholder documentation for ListSignalMapsResponseContent"
- },
- "MediaResource": {
- "type": "structure",
- "members": {
- "Destinations": {
- "shape": "__listOfMediaResourceNeighbor",
- "locationName": "destinations"
- },
- "Name": {
- "shape": "__stringMin1Max256",
- "locationName": "name",
- "documentation": "The logical name of an AWS media resource."
- },
- "Sources": {
- "shape": "__listOfMediaResourceNeighbor",
- "locationName": "sources"
- }
- },
- "documentation": "An AWS resource used in media workflows."
- },
- "MediaResourceMap": {
- "type": "map",
- "documentation": "A map representing an AWS media workflow as a graph.",
- "key": {
- "shape": "__string"
- },
- "value": {
- "shape": "MediaResource"
- }
+ "documentation": "Placeholder documentation for DescribeChannelPlacementGroupRequest"
},
- "MediaResourceNeighbor": {
+ "DescribeChannelPlacementGroupResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringMin1Max2048PatternArn",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "The ARN of a resource used in AWS media workflows."
+ "documentation": "The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created."
+ },
+ "Channels": {
+ "shape": "__listOf__string",
+ "locationName": "channels",
+ "documentation": "Used in ListChannelPlacementGroupsResult"
+ },
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
"Name": {
- "shape": "__stringMin1Max256",
+ "shape": "__string",
"locationName": "name",
- "documentation": "The logical name of an AWS media resource."
- }
- },
- "documentation": "A direct source or destination neighbor to an AWS media resource.",
- "required": [
- "Arn"
- ]
- },
- "MonitorDeployment": {
- "type": "structure",
- "members": {
- "DetailsUri": {
- "shape": "__stringMin1Max2048",
- "locationName": "detailsUri",
- "documentation": "URI associated with a signal map's monitor deployment."
+ "documentation": "The name that you specified for the ChannelPlacementGroup."
},
- "ErrorMessage": {
- "shape": "__stringMin1Max2048",
- "locationName": "errorMessage",
- "documentation": "Error message associated with a failed monitor deployment of a signal map."
+ "Nodes": {
+ "shape": "__listOf__string",
+ "locationName": "nodes",
+ "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup."
},
- "Status": {
- "shape": "SignalMapMonitorDeploymentStatus",
- "locationName": "status"
+ "State": {
+ "shape": "ChannelPlacementGroupState",
+ "locationName": "state",
+ "documentation": "The current state of the ChannelPlacementGroup."
}
},
- "documentation": "Represents the latest monitor deployment of a signal map.",
- "required": [
- "Status"
- ]
+ "documentation": "Placeholder documentation for DescribeChannelPlacementGroupResponse"
},
- "NotFoundExceptionResponseContent": {
+ "DescribeChannelPlacementGroupResult": {
"type": "structure",
"members": {
- "Message": {
+ "Arn": {
"shape": "__string",
- "locationName": "message",
- "documentation": "Exception error message."
- }
- },
- "documentation": "Request references a resource which does not exist."
- },
- "SignalMapMonitorDeploymentStatus": {
- "type": "string",
- "documentation": "A signal map's monitor deployment status.",
- "enum": [
- "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"
- ]
- },
- "SignalMapStatus": {
- "type": "string",
- "documentation": "A signal map's current status which is dependent on its lifecycle actions or associated jobs.",
- "enum": [
- "CREATE_IN_PROGRESS",
- "CREATE_COMPLETE",
- "CREATE_FAILED",
- "UPDATE_IN_PROGRESS",
- "UPDATE_COMPLETE",
- "UPDATE_REVERTED",
- "UPDATE_FAILED",
- "READY",
- "NOT_READY"
- ]
+ "locationName": "arn",
+ "documentation": "The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created."
+ },
+ "Channels": {
+ "shape": "__listOf__string",
+ "locationName": "channels",
+ "documentation": "Used in ListChannelPlacementGroupsResult"
+ },
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you specified for the ChannelPlacementGroup."
+ },
+ "Nodes": {
+ "shape": "__listOf__string",
+ "locationName": "nodes",
+ "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup."
+ },
+ "State": {
+ "shape": "ChannelPlacementGroupState",
+ "locationName": "state",
+ "documentation": "The current state of the ChannelPlacementGroup."
+ }
+ },
+ "documentation": "Contains the response for CreateChannelPlacementGroup, DescribeChannelPlacementGroup, DeleteChannelPlacementGroup, UpdateChannelPlacementGroup"
},
- "SignalMapSummary": {
+ "DescribeChannelPlacementGroupSummary": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveSignalMap",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "A signal map's ARN (Amazon Resource Name)"
+ "documentation": "The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created."
},
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
+ "Channels": {
+ "shape": "__listOf__string",
+ "locationName": "channels",
+ "documentation": "Used in ListChannelPlacementGroupsResult"
},
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "A signal map's id."
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "MonitorDeploymentStatus": {
- "shape": "SignalMapMonitorDeploymentStatus",
- "locationName": "monitorDeploymentStatus"
+ "documentation": "The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The name that you specified for the ChannelPlacementGroup."
},
- "Status": {
- "shape": "SignalMapStatus",
- "locationName": "status"
+ "Nodes": {
+ "shape": "__listOf__string",
+ "locationName": "nodes",
+ "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "State": {
+ "shape": "ChannelPlacementGroupState",
+ "locationName": "state",
+ "documentation": "The current state of the ChannelPlacementGroup."
}
},
- "required": [
- "Status",
- "MonitorDeploymentStatus",
- "CreatedAt",
- "Id",
- "Arn",
- "Name"
- ],
- "documentation": "Placeholder documentation for SignalMapSummary"
+ "documentation": "Contains the response for ListChannelPlacementGroups"
},
- "StartDeleteMonitorDeploymentRequest": {
+ "DescribeClusterRequest": {
"type": "structure",
"members": {
- "Identifier": {
+ "ClusterId": {
"shape": "__string",
"location": "uri",
- "locationName": "identifier",
- "documentation": "A signal map's identifier. Can be either be its id or current name."
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster."
}
},
"required": [
- "Identifier"
+ "ClusterId"
],
- "documentation": "Placeholder documentation for StartDeleteMonitorDeploymentRequest"
+ "documentation": "Placeholder documentation for DescribeClusterRequest"
},
- "StartDeleteMonitorDeploymentResponse": {
+ "DescribeClusterResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveSignalMap",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "A signal map's ARN (Amazon Resource Name)"
- },
- "CloudWatchAlarmTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "cloudWatchAlarmTemplateGroupIds"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
- },
- "ErrorMessage": {
- "shape": "__stringMin1Max2048",
- "locationName": "errorMessage",
- "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ "documentation": "The ARN of this Cluster. It is automatically assigned when the Cluster is created."
},
- "EventBridgeRuleTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "eventBridgeRuleTemplateGroupIds"
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds"
},
- "FailedMediaResourceMap": {
- "shape": "FailedMediaResourceMap",
- "locationName": "failedMediaResourceMap"
+ "ClusterType": {
+ "shape": "ClusterType",
+ "locationName": "clusterType",
+ "documentation": "The hardware type for the Cluster"
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "A signal map's id."
- },
- "LastDiscoveredAt": {
- "shape": "__timestampIso8601",
- "locationName": "lastDiscoveredAt"
- },
- "LastSuccessfulMonitorDeployment": {
- "shape": "SuccessfulMonitorDeployment",
- "locationName": "lastSuccessfulMonitorDeployment"
- },
- "MediaResourceMap": {
- "shape": "MediaResourceMap",
- "locationName": "mediaResourceMap"
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "MonitorChangesPendingDeployment": {
- "shape": "__boolean",
- "locationName": "monitorChangesPendingDeployment",
- "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ "documentation": "The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
- "MonitorDeployment": {
- "shape": "MonitorDeployment",
- "locationName": "monitorDeployment"
+ "InstanceRoleArn": {
+ "shape": "__string",
+ "locationName": "instanceRoleArn",
+ "documentation": "The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The name that you specified for the Cluster."
},
- "Status": {
- "shape": "SignalMapStatus",
- "locationName": "status"
+ "NetworkSettings": {
+ "shape": "ClusterNetworkSettings",
+ "locationName": "networkSettings",
+ "documentation": "Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "State": {
+ "shape": "ClusterState",
+ "locationName": "state",
+ "documentation": "The current state of the Cluster."
}
},
- "documentation": "Placeholder documentation for StartDeleteMonitorDeploymentResponse"
+ "documentation": "Placeholder documentation for DescribeClusterResponse"
},
- "StartDeleteMonitorDeploymentResponseContent": {
+ "DescribeClusterResult": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveSignalMap",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "A signal map's ARN (Amazon Resource Name)"
- },
- "CloudWatchAlarmTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "cloudWatchAlarmTemplateGroupIds"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
- },
- "ErrorMessage": {
- "shape": "__stringMin1Max2048",
- "locationName": "errorMessage",
- "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ "documentation": "The ARN of this Cluster. It is automatically assigned when the Cluster is created."
},
- "EventBridgeRuleTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "eventBridgeRuleTemplateGroupIds"
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds"
},
- "FailedMediaResourceMap": {
- "shape": "FailedMediaResourceMap",
- "locationName": "failedMediaResourceMap"
+ "ClusterType": {
+ "shape": "ClusterType",
+ "locationName": "clusterType",
+ "documentation": "The hardware type for the Cluster"
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "A signal map's id."
+ "documentation": "The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
- "LastDiscoveredAt": {
- "shape": "__timestampIso8601",
- "locationName": "lastDiscoveredAt"
+ "InstanceRoleArn": {
+ "shape": "__string",
+ "locationName": "instanceRoleArn",
+ "documentation": "The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform."
},
- "LastSuccessfulMonitorDeployment": {
- "shape": "SuccessfulMonitorDeployment",
- "locationName": "lastSuccessfulMonitorDeployment"
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you specified for the Cluster."
},
- "MediaResourceMap": {
- "shape": "MediaResourceMap",
- "locationName": "mediaResourceMap"
+ "NetworkSettings": {
+ "shape": "ClusterNetworkSettings",
+ "locationName": "networkSettings",
+ "documentation": "Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with."
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "State": {
+ "shape": "ClusterState",
+ "locationName": "state",
+ "documentation": "The current state of the Cluster."
+ }
+ },
+ "documentation": "Contains the response for CreateCluster, DescribeCluster, DeleteCluster, UpdateCluster"
+ },
+ "DescribeClusterSummary": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The ARN of this Cluster. It is automatically assigned when the Cluster is created."
},
- "MonitorChangesPendingDeployment": {
- "shape": "__boolean",
- "locationName": "monitorChangesPendingDeployment",
- "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds",
+ "documentation": "An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster."
},
- "MonitorDeployment": {
- "shape": "MonitorDeployment",
- "locationName": "monitorDeployment"
+ "ClusterType": {
+ "shape": "ClusterType",
+ "locationName": "clusterType",
+ "documentation": "The hardware type for the Cluster."
+ },
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN."
+ },
+ "InstanceRoleArn": {
+ "shape": "__string",
+ "locationName": "instanceRoleArn",
+ "documentation": "The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The name that you specified for the Cluster."
},
- "Status": {
- "shape": "SignalMapStatus",
- "locationName": "status"
+ "NetworkSettings": {
+ "shape": "ClusterNetworkSettings",
+ "locationName": "networkSettings",
+ "documentation": "Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
- }
- },
- "required": [
- "Status",
- "CreatedAt",
- "Name",
- "Id",
- "Arn",
- "DiscoveryEntryPointArn",
- "MonitorChangesPendingDeployment"
- ],
- "documentation": "Placeholder documentation for StartDeleteMonitorDeploymentResponseContent"
+ "State": {
+ "shape": "ClusterState",
+ "locationName": "state",
+ "documentation": "The current state of the Cluster."
+ }
+ },
+ "documentation": "Used in ListClustersResult."
},
- "StartMonitorDeploymentRequest": {
+ "DescribeNetworkRequest": {
"type": "structure",
"members": {
- "DryRun": {
- "shape": "__boolean",
- "locationName": "dryRun"
- },
- "Identifier": {
+ "NetworkId": {
"shape": "__string",
"location": "uri",
- "locationName": "identifier",
- "documentation": "A signal map's identifier. Can be either be its id or current name."
+ "locationName": "networkId",
+ "documentation": "The ID of the network."
}
},
"required": [
- "Identifier"
+ "NetworkId"
],
- "documentation": "Placeholder documentation for StartMonitorDeploymentRequest"
- },
- "StartMonitorDeploymentRequestContent": {
- "type": "structure",
- "members": {
- "DryRun": {
- "shape": "__boolean",
- "locationName": "dryRun"
- }
- },
- "documentation": "Placeholder documentation for StartMonitorDeploymentRequestContent"
+ "documentation": "Placeholder documentation for DescribeNetworkRequest"
},
- "StartMonitorDeploymentResponse": {
+ "DescribeNetworkResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveSignalMap",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "A signal map's ARN (Amazon Resource Name)"
- },
- "CloudWatchAlarmTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "cloudWatchAlarmTemplateGroupIds"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
- },
- "ErrorMessage": {
- "shape": "__stringMin1Max2048",
- "locationName": "errorMessage",
- "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
- },
- "EventBridgeRuleTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "eventBridgeRuleTemplateGroupIds"
+ "documentation": "The ARN of this Network. It is automatically assigned when the Network is created."
},
- "FailedMediaResourceMap": {
- "shape": "FailedMediaResourceMap",
- "locationName": "failedMediaResourceMap"
+ "AssociatedClusterIds": {
+ "shape": "__listOf__string",
+ "locationName": "associatedClusterIds"
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "A signal map's id."
- },
- "LastDiscoveredAt": {
- "shape": "__timestampIso8601",
- "locationName": "lastDiscoveredAt"
- },
- "LastSuccessfulMonitorDeployment": {
- "shape": "SuccessfulMonitorDeployment",
- "locationName": "lastSuccessfulMonitorDeployment"
- },
- "MediaResourceMap": {
- "shape": "MediaResourceMap",
- "locationName": "mediaResourceMap"
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "MonitorChangesPendingDeployment": {
- "shape": "__boolean",
- "locationName": "monitorChangesPendingDeployment",
- "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ "documentation": "The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
- "MonitorDeployment": {
- "shape": "MonitorDeployment",
- "locationName": "monitorDeployment"
+ "IpPools": {
+ "shape": "__listOfIpPool",
+ "locationName": "ipPools",
+ "documentation": "An array of IpPools in your organization's network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The name that you specified for the Network."
},
- "Status": {
- "shape": "SignalMapStatus",
- "locationName": "status"
+ "Routes": {
+ "shape": "__listOfRoute",
+ "locationName": "routes",
+ "documentation": "An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "State": {
+ "shape": "NetworkState",
+ "locationName": "state",
+ "documentation": "The current state of the Network. Only MediaLive Anywhere can change the state."
}
},
- "documentation": "Placeholder documentation for StartMonitorDeploymentResponse"
+ "documentation": "Placeholder documentation for DescribeNetworkResponse"
},
- "StartMonitorDeploymentResponseContent": {
+ "DescribeNetworkResult": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveSignalMap",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "A signal map's ARN (Amazon Resource Name)"
+ "documentation": "The ARN of this Network. It is automatically assigned when the Network is created."
},
- "CloudWatchAlarmTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "cloudWatchAlarmTemplateGroupIds"
+ "AssociatedClusterIds": {
+ "shape": "__listOf__string",
+ "locationName": "associatedClusterIds"
},
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "IpPools": {
+ "shape": "__listOfIpPool",
+ "locationName": "ipPools",
+ "documentation": "An array of IpPools in your organization's network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block."
},
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you specified for the Network."
},
- "ErrorMessage": {
- "shape": "__stringMin1Max2048",
- "locationName": "errorMessage",
- "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ "Routes": {
+ "shape": "__listOfRoute",
+ "locationName": "routes",
+ "documentation": "An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic."
},
- "EventBridgeRuleTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "eventBridgeRuleTemplateGroupIds"
+ "State": {
+ "shape": "NetworkState",
+ "locationName": "state",
+ "documentation": "The current state of the Network. Only MediaLive Anywhere can change the state."
+ }
+ },
+ "documentation": "Contains the response for CreateNetwork, DescribeNetwork, DeleteNetwork, UpdateNetwork."
+ },
+ "DescribeNetworkSummary": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The ARN of this Network. It is automatically assigned when the Network is created."
},
- "FailedMediaResourceMap": {
- "shape": "FailedMediaResourceMap",
- "locationName": "failedMediaResourceMap"
+ "AssociatedClusterIds": {
+ "shape": "__listOf__string",
+ "locationName": "associatedClusterIds"
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "A signal map's id."
- },
- "LastDiscoveredAt": {
- "shape": "__timestampIso8601",
- "locationName": "lastDiscoveredAt"
- },
- "LastSuccessfulMonitorDeployment": {
- "shape": "SuccessfulMonitorDeployment",
- "locationName": "lastSuccessfulMonitorDeployment"
- },
- "MediaResourceMap": {
- "shape": "MediaResourceMap",
- "locationName": "mediaResourceMap"
+ "documentation": "The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "MonitorChangesPendingDeployment": {
- "shape": "__boolean",
- "locationName": "monitorChangesPendingDeployment",
- "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
- },
- "MonitorDeployment": {
- "shape": "MonitorDeployment",
- "locationName": "monitorDeployment"
+ "IpPools": {
+ "shape": "__listOfIpPool",
+ "locationName": "ipPools",
+ "documentation": "An array of IpPools in your organization's network that identify a collection of IP addresses in your organization's network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The name that you specified for this Network."
},
- "Status": {
- "shape": "SignalMapStatus",
- "locationName": "status"
+ "Routes": {
+ "shape": "__listOfRoute",
+ "locationName": "routes",
+ "documentation": "An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "State": {
+ "shape": "NetworkState",
+ "locationName": "state",
+ "documentation": "The current state of the Network. Only MediaLive Anywhere can change the state."
+ }
+ },
+ "documentation": "Used in ListNetworksResult."
+ },
+ "DescribeNodeRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster"
+ },
+ "NodeId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "nodeId",
+ "documentation": "The ID of the node."
}
},
"required": [
- "Status",
- "CreatedAt",
- "Name",
- "Id",
- "Arn",
- "DiscoveryEntryPointArn",
- "MonitorChangesPendingDeployment"
+ "NodeId",
+ "ClusterId"
],
- "documentation": "Placeholder documentation for StartMonitorDeploymentResponseContent"
+ "documentation": "Placeholder documentation for DescribeNodeRequest"
},
- "StartUpdateSignalMapRequest": {
+ "DescribeNodeResponse": {
"type": "structure",
"members": {
- "CloudWatchAlarmTemplateGroupIdentifiers": {
- "shape": "__listOf__stringPatternS",
- "locationName": "cloudWatchAlarmTemplateGroupIdentifiers"
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The ARN of the Node. It is automatically assigned when the Node is created."
},
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "ChannelPlacementGroups": {
+ "shape": "__listOf__string",
+ "locationName": "channelPlacementGroups",
+ "documentation": "An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups."
},
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
},
- "EventBridgeRuleTemplateGroupIdentifiers": {
- "shape": "__listOf__stringPatternS",
- "locationName": "eventBridgeRuleTemplateGroupIdentifiers"
+ "ConnectionState": {
+ "shape": "NodeConnectionState",
+ "locationName": "connectionState",
+ "documentation": "The current connection state of the Node."
},
- "ForceRediscovery": {
- "shape": "__boolean",
- "locationName": "forceRediscovery",
- "documentation": "If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided."
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN."
},
- "Identifier": {
+ "InstanceArn": {
"shape": "__string",
- "location": "uri",
- "locationName": "identifier",
- "documentation": "A signal map's identifier. Can be either be its id or current name."
+ "locationName": "instanceArn",
+ "documentation": "The ARN of the EC2 instance hosting the Node."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The name that you specified for the Node."
+ },
+ "NodeInterfaceMappings": {
+ "shape": "__listOfNodeInterfaceMapping",
+ "locationName": "nodeInterfaceMappings",
+ "documentation": "Documentation update needed"
+ },
+ "Role": {
+ "shape": "NodeRole",
+ "locationName": "role",
+ "documentation": "The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails."
+ },
+ "State": {
+ "shape": "NodeState",
+ "locationName": "state",
+ "documentation": "The current state of the Node."
}
},
- "required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for StartUpdateSignalMapRequest"
+ "documentation": "Placeholder documentation for DescribeNodeResponse"
},
- "StartUpdateSignalMapRequestContent": {
+ "DescribeNodeResult": {
"type": "structure",
"members": {
- "CloudWatchAlarmTemplateGroupIdentifiers": {
- "shape": "__listOf__stringPatternS",
- "locationName": "cloudWatchAlarmTemplateGroupIdentifiers"
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The ARN of the Node. It is automatically assigned when the Node is created."
+ },
+ "ChannelPlacementGroups": {
+ "shape": "__listOf__string",
+ "locationName": "channelPlacementGroups",
+ "documentation": "An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups."
},
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
},
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ "ConnectionState": {
+ "shape": "NodeConnectionState",
+ "locationName": "connectionState",
+ "documentation": "The current connection state of the Node."
},
- "EventBridgeRuleTemplateGroupIdentifiers": {
- "shape": "__listOf__stringPatternS",
- "locationName": "eventBridgeRuleTemplateGroupIdentifiers"
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN."
},
- "ForceRediscovery": {
- "shape": "__boolean",
- "locationName": "forceRediscovery",
- "documentation": "If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided."
+ "InstanceArn": {
+ "shape": "__string",
+ "locationName": "instanceArn",
+ "documentation": "The ARN of the EC2 instance hosting the Node."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The name that you specified for the Node."
+ },
+ "NodeInterfaceMappings": {
+ "shape": "__listOfNodeInterfaceMapping",
+ "locationName": "nodeInterfaceMappings",
+ "documentation": "Documentation update needed"
+ },
+ "Role": {
+ "shape": "NodeRole",
+ "locationName": "role",
+ "documentation": "The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails."
+ },
+ "State": {
+ "shape": "NodeState",
+ "locationName": "state",
+ "documentation": "The current state of the Node."
}
},
- "documentation": "Placeholder documentation for StartUpdateSignalMapRequestContent"
+ "documentation": "Contains the response for CreateNode, DescribeNode, DeleteNode, UpdateNode"
},
- "StartUpdateSignalMapResponse": {
+ "DescribeNodeSummary": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveSignalMap",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "A signal map's ARN (Amazon Resource Name)"
+ "documentation": "The ARN of the Node. It is automatically assigned when the Node is created."
},
- "CloudWatchAlarmTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "cloudWatchAlarmTemplateGroupIds"
+ "ChannelPlacementGroups": {
+ "shape": "__listOf__string",
+ "locationName": "channelPlacementGroups",
+ "documentation": "An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups."
},
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
},
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "ConnectionState": {
+ "shape": "NodeConnectionState",
+ "locationName": "connectionState",
+ "documentation": "The current connection state of the Node."
},
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
+ "Id": {
+ "shape": "__string",
+ "locationName": "id",
+ "documentation": "The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN."
},
- "ErrorMessage": {
- "shape": "__stringMin1Max2048",
- "locationName": "errorMessage",
- "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
+ "InstanceArn": {
+ "shape": "__string",
+ "locationName": "instanceArn",
+ "documentation": "The EC2 ARN of the Instance associated with the Node."
},
- "EventBridgeRuleTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "eventBridgeRuleTemplateGroupIds"
+ "ManagedInstanceId": {
+ "shape": "__string",
+ "locationName": "managedInstanceId",
+ "documentation": "At the routing layer will get it from the callerId/context for use with bring your own device."
},
- "FailedMediaResourceMap": {
- "shape": "FailedMediaResourceMap",
- "locationName": "failedMediaResourceMap"
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The name that you specified for the Node."
},
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "A signal map's id."
+ "NodeInterfaceMappings": {
+ "shape": "__listOfNodeInterfaceMapping",
+ "locationName": "nodeInterfaceMappings",
+ "documentation": "Documentation update needed"
},
- "LastDiscoveredAt": {
- "shape": "__timestampIso8601",
- "locationName": "lastDiscoveredAt"
+ "Role": {
+ "shape": "NodeRole",
+ "locationName": "role",
+ "documentation": "The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails."
},
- "LastSuccessfulMonitorDeployment": {
- "shape": "SuccessfulMonitorDeployment",
- "locationName": "lastSuccessfulMonitorDeployment"
+ "State": {
+ "shape": "NodeState",
+ "locationName": "state",
+ "documentation": "The current state of the Node."
+ }
+ },
+ "documentation": "Placeholder documentation for DescribeNodeSummary"
+ },
+ "InputDestinationRoute": {
+ "type": "structure",
+ "members": {
+ "Cidr": {
+ "shape": "__string",
+ "locationName": "cidr",
+ "documentation": "The CIDR of the route."
},
- "MediaResourceMap": {
- "shape": "MediaResourceMap",
- "locationName": "mediaResourceMap"
+ "Gateway": {
+ "shape": "__string",
+ "locationName": "gateway",
+ "documentation": "An optional gateway for the route."
+ }
+ },
+ "documentation": "A network route configuration."
+ },
+ "InputNetworkLocation": {
+ "type": "string",
+ "documentation": "With the introduction of MediaLive OnPrem, a MediaLive input can now exist in two different places: AWS or\ninside an on-premise datacenter. By default all inputs will continue to be AWS inputs.",
+ "enum": [
+ "AWS",
+ "ON_PREMISE",
+ "ON_PREMISES"
+ ]
+ },
+ "InputRequestDestinationRoute": {
+ "type": "structure",
+ "members": {
+ "Cidr": {
+ "shape": "__string",
+ "locationName": "cidr",
+ "documentation": "The CIDR of the route."
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "Gateway": {
+ "shape": "__string",
+ "locationName": "gateway",
+ "documentation": "An optional gateway for the route."
+ }
+ },
+ "documentation": "A network route configuration."
+ },
+ "InterfaceMapping": {
+ "type": "structure",
+ "members": {
+ "LogicalInterfaceName": {
+ "shape": "__string",
+ "locationName": "logicalInterfaceName",
+ "documentation": "The logical name for one interface (on every Node) that handles a specific type of traffic. We recommend that the name hints at the physical interface it applies to. For example, it could refer to the traffic that the physical interface handles. For example, my-Inputs-Interface."
},
- "MonitorChangesPendingDeployment": {
- "shape": "__boolean",
- "locationName": "monitorChangesPendingDeployment",
- "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ "NetworkId": {
+ "shape": "__string",
+ "locationName": "networkId",
+ "documentation": "The ID of the network that you want to connect to the specified logicalInterfaceName."
+ }
+ },
+ "documentation": "Used in ClusterNetworkSettings"
+ },
+ "InterfaceMappingCreateRequest": {
+ "type": "structure",
+ "members": {
+ "LogicalInterfaceName": {
+ "shape": "__string",
+ "locationName": "logicalInterfaceName",
+ "documentation": "The logical name for one interface (on every Node) that handles a specific type of traffic. We recommend that the name hints at the physical interface it applies to. For example, it could refer to the traffic that the physical interface handles. For example, my-Inputs-Interface."
},
- "MonitorDeployment": {
- "shape": "MonitorDeployment",
- "locationName": "monitorDeployment"
+ "NetworkId": {
+ "shape": "__string",
+ "locationName": "networkId",
+ "documentation": "The ID of the network that you want to connect to the specified logicalInterfaceName."
+ }
+ },
+ "documentation": "Used in ClusterNetworkSettingsCreateRequest."
+ },
+ "InterfaceMappingUpdateRequest": {
+ "type": "structure",
+ "members": {
+ "LogicalInterfaceName": {
+ "shape": "__string",
+ "locationName": "logicalInterfaceName",
+ "documentation": "The logical name for one interface (on every Node) that handles a specific type of traffic. We recommend that the name hints at the physical interface it applies to. For example, it could refer to the traffic that the physical interface handles. For example, my-Inputs-Interface."
},
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "NetworkId": {
+ "shape": "__string",
+ "locationName": "networkId",
+ "documentation": "The ID of the network that you want to connect to the specified logicalInterfaceName. You can use the ListNetworks operation to discover all the IDs."
+ }
+ },
+ "documentation": "Placeholder documentation for InterfaceMappingUpdateRequest"
+ },
+ "IpPool": {
+ "type": "structure",
+ "members": {
+ "Cidr": {
+ "shape": "__string",
+ "locationName": "cidr",
+ "documentation": "A CIDR block of IP addresses that are reserved for MediaLive Anywhere."
+ }
+ },
+ "documentation": "Used in DescribeNetworkResult, DescribeNetworkSummary, UpdateNetworkResult."
+ },
+ "IpPoolCreateRequest": {
+ "type": "structure",
+ "members": {
+ "Cidr": {
+ "shape": "__string",
+ "locationName": "cidr",
+ "documentation": "A CIDR block of IP addresses to reserve for MediaLive Anywhere."
+ }
+ },
+ "documentation": "Used in CreateNetworkRequest."
+ },
+ "IpPoolUpdateRequest": {
+ "type": "structure",
+ "members": {
+ "Cidr": {
+ "shape": "__string",
+ "locationName": "cidr",
+ "documentation": "A CIDR block of IP addresses to reserve for MediaLive Anywhere."
+ }
+ },
+ "documentation": "Used in UpdateNetworkRequest."
+ },
+ "ListChannelPlacementGroupsRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster"
},
- "Status": {
- "shape": "SignalMapStatus",
- "locationName": "status"
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults",
+ "documentation": "The maximum number of items to return."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "The token to retrieve the next page of results."
+ }
+ },
+ "required": [
+ "ClusterId"
+ ],
+ "documentation": "Placeholder documentation for ListChannelPlacementGroupsRequest"
+ },
+ "ListChannelPlacementGroupsResponse": {
+ "type": "structure",
+ "members": {
+ "ChannelPlacementGroups": {
+ "shape": "__listOfDescribeChannelPlacementGroupSummary",
+ "locationName": "channelPlacementGroups",
+ "documentation": "An array of ChannelPlacementGroups that exist in the Cluster."
+ },
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token for the next result."
+ }
+ },
+ "documentation": "Placeholder documentation for ListChannelPlacementGroupsResponse"
+ },
+ "ListChannelPlacementGroupsResult": {
+ "type": "structure",
+ "members": {
+ "ChannelPlacementGroups": {
+ "shape": "__listOfDescribeChannelPlacementGroupSummary",
+ "locationName": "channelPlacementGroups",
+ "documentation": "An array of ChannelPlacementGroups that exist in the Cluster."
+ },
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token for the next result."
+ }
+ },
+ "documentation": "Contains the response for ListChannelPlacementGroups."
+ },
+ "ListClustersRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults",
+ "documentation": "The maximum number of items to return."
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "The token to retrieve the next page of results."
+ }
+ },
+ "documentation": "Placeholder documentation for ListClustersRequest"
+ },
+ "ListClustersResponse": {
+ "type": "structure",
+ "members": {
+ "Clusters": {
+ "shape": "__listOfDescribeClusterSummary",
+ "locationName": "clusters",
+ "documentation": "A list of the Clusters that exist in your AWS account."
+ },
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token for the next result."
+ }
+ },
+ "documentation": "Placeholder documentation for ListClustersResponse"
+ },
+ "ListClustersResult": {
+ "type": "structure",
+ "members": {
+ "Clusters": {
+ "shape": "__listOfDescribeClusterSummary",
+ "locationName": "clusters",
+ "documentation": "A list of the Clusters that exist in your AWS account."
+ },
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token for the next result."
}
},
- "documentation": "Placeholder documentation for StartUpdateSignalMapResponse"
+ "documentation": "Contains the response for ListClusters."
},
- "StartUpdateSignalMapResponseContent": {
+ "ListNetworksRequest": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveSignalMap",
- "locationName": "arn",
- "documentation": "A signal map's ARN (Amazon Resource Name)"
- },
- "CloudWatchAlarmTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "cloudWatchAlarmTemplateGroupIds"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "DiscoveryEntryPointArn": {
- "shape": "__stringMin1Max2048",
- "locationName": "discoveryEntryPointArn",
- "documentation": "A top-level supported AWS resource ARN to discovery a signal map from."
- },
- "ErrorMessage": {
- "shape": "__stringMin1Max2048",
- "locationName": "errorMessage",
- "documentation": "Error message associated with a failed creation or failed update attempt of a signal map."
- },
- "EventBridgeRuleTemplateGroupIds": {
- "shape": "__listOf__stringMin7Max11PatternAws097",
- "locationName": "eventBridgeRuleTemplateGroupIds"
- },
- "FailedMediaResourceMap": {
- "shape": "FailedMediaResourceMap",
- "locationName": "failedMediaResourceMap"
- },
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "A signal map's id."
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults",
+ "documentation": "The maximum number of items to return."
},
- "LastDiscoveredAt": {
- "shape": "__timestampIso8601",
- "locationName": "lastDiscoveredAt"
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "The token to retrieve the next page of results."
+ }
+ },
+ "documentation": "Placeholder documentation for ListNetworksRequest"
+ },
+ "ListNetworksResponse": {
+ "type": "structure",
+ "members": {
+ "Networks": {
+ "shape": "__listOfDescribeNetworkSummary",
+ "locationName": "networks",
+ "documentation": "An array of networks that you have created."
},
- "LastSuccessfulMonitorDeployment": {
- "shape": "SuccessfulMonitorDeployment",
- "locationName": "lastSuccessfulMonitorDeployment"
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token for the next ListNetworks request."
+ }
+ },
+ "documentation": "Placeholder documentation for ListNetworksResponse"
+ },
+ "ListNetworksResult": {
+ "type": "structure",
+ "members": {
+ "Networks": {
+ "shape": "__listOfDescribeNetworkSummary",
+ "locationName": "networks",
+ "documentation": "An array of networks that you have created."
},
- "MediaResourceMap": {
- "shape": "MediaResourceMap",
- "locationName": "mediaResourceMap"
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token for the next ListNetworks request."
+ }
+ },
+ "documentation": "Contains the response for ListNetworks"
+ },
+ "ListNodesRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster"
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults",
+ "documentation": "The maximum number of items to return."
},
- "MonitorChangesPendingDeployment": {
- "shape": "__boolean",
- "locationName": "monitorChangesPendingDeployment",
- "documentation": "If true, there are pending monitor changes for this signal map that can be deployed."
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken",
+ "documentation": "The token to retrieve the next page of results."
+ }
+ },
+ "required": [
+ "ClusterId"
+ ],
+ "documentation": "Placeholder documentation for ListNodesRequest"
+ },
+ "ListNodesResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token for the next result."
},
- "MonitorDeployment": {
- "shape": "MonitorDeployment",
- "locationName": "monitorDeployment"
+ "Nodes": {
+ "shape": "__listOfDescribeNodeSummary",
+ "locationName": "nodes",
+ "documentation": "An array of Nodes that exist in the Cluster."
+ }
+ },
+ "documentation": "Placeholder documentation for ListNodesResponse"
+ },
+ "ListNodesResult": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken",
+ "documentation": "Token for the next result."
},
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "Nodes": {
+ "shape": "__listOfDescribeNodeSummary",
+ "locationName": "nodes",
+ "documentation": "An array of Nodes that exist in the Cluster."
+ }
+ },
+ "documentation": "Contains the response for ListNodes."
+ },
+ "MulticastInputSettings": {
+ "type": "structure",
+ "members": {
+ "SourceIpAddress": {
+ "shape": "__string",
+ "locationName": "sourceIpAddress",
+ "documentation": "Optionally, a source ip address to filter by for Source-specific Multicast (SSM)"
+ }
+ },
+ "documentation": "Multicast-specific input settings."
+ },
+ "MulticastSettings": {
+ "type": "structure",
+ "members": {
+ "Sources": {
+ "shape": "__listOfMulticastSource",
+ "locationName": "sources"
+ }
+ },
+ "documentation": "Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses."
+ },
+ "MulticastSettingsCreateRequest": {
+ "type": "structure",
+ "members": {
+ "Sources": {
+ "shape": "__listOfMulticastSourceCreateRequest",
+ "locationName": "sources"
+ }
+ },
+ "documentation": "Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses."
+ },
+ "MulticastSettingsUpdateRequest": {
+ "type": "structure",
+ "members": {
+ "Sources": {
+ "shape": "__listOfMulticastSourceUpdateRequest",
+ "locationName": "sources"
+ }
+ },
+ "documentation": "Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses."
+ },
+ "MulticastSource": {
+ "type": "structure",
+ "members": {
+ "SourceIp": {
+ "shape": "__string",
+ "locationName": "sourceIp",
+ "documentation": "This represents the ip address of the device sending the multicast stream."
},
- "Status": {
- "shape": "SignalMapStatus",
- "locationName": "status"
+ "Url": {
+ "shape": "__string",
+ "locationName": "url",
+ "documentation": "This represents the customer's source URL where multicast stream is pulled from."
+ }
+ },
+ "documentation": "Pair of multicast url and source ip address (optional) that make up a multicast source.",
+ "required": [
+ "Url"
+ ]
+ },
+ "MulticastSourceCreateRequest": {
+ "type": "structure",
+ "members": {
+ "SourceIp": {
+ "shape": "__string",
+ "locationName": "sourceIp",
+ "documentation": "This represents the ip address of the device sending the multicast stream."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "Url": {
+ "shape": "__string",
+ "locationName": "url",
+ "documentation": "This represents the customer's source URL where multicast stream is pulled from."
}
},
+ "documentation": "Pair of multicast url and source ip address (optional) that make up a multicast source.",
"required": [
- "Status",
- "CreatedAt",
- "Name",
- "Id",
- "Arn",
- "DiscoveryEntryPointArn",
- "MonitorChangesPendingDeployment"
- ],
- "documentation": "Placeholder documentation for StartUpdateSignalMapResponseContent"
+ "Url"
+ ]
},
- "SuccessfulMonitorDeployment": {
+ "MulticastSourceUpdateRequest": {
"type": "structure",
"members": {
- "DetailsUri": {
- "shape": "__stringMin1Max2048",
- "locationName": "detailsUri",
- "documentation": "URI associated with a signal map's monitor deployment."
+ "SourceIp": {
+ "shape": "__string",
+ "locationName": "sourceIp",
+ "documentation": "This represents the ip address of the device sending the multicast stream."
},
- "Status": {
- "shape": "SignalMapMonitorDeploymentStatus",
- "locationName": "status"
+ "Url": {
+ "shape": "__string",
+ "locationName": "url",
+ "documentation": "This represents the customer's source URL where multicast stream is pulled from."
}
},
- "documentation": "Represents the latest successful monitor deployment of a signal map.",
+ "documentation": "Pair of multicast url and source ip address (optional) that make up a multicast source.",
"required": [
- "DetailsUri",
- "Status"
+ "Url"
]
},
- "TagMap": {
- "type": "map",
- "documentation": "Represents the tags associated with a resource.",
- "key": {
- "shape": "__string"
+ "NetworkInterfaceMode": {
+ "type": "string",
+ "documentation": "Used in NodeInterfaceMapping and NodeInterfaceMappingCreateRequest",
+ "enum": [
+ "NAT",
+ "BRIDGE"
+ ]
+ },
+ "NetworkState": {
+ "type": "string",
+ "documentation": "Used in DescribeNetworkResult, DescribeNetworkSummary, UpdateNetworkResult.",
+ "enum": [
+ "CREATING",
+ "CREATE_FAILED",
+ "ACTIVE",
+ "DELETING",
+ "IDLE",
+ "IN_USE",
+ "UPDATING",
+ "DELETE_FAILED",
+ "DELETED"
+ ]
+ },
+ "NodeConfigurationValidationError": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message",
+ "documentation": "The error message."
+ },
+ "ValidationErrors": {
+ "shape": "__listOfValidationError",
+ "locationName": "validationErrors",
+ "documentation": "A collection of validation error responses."
+ }
+ },
+ "documentation": "Details about a configuration error on the Node."
+ },
+ "NodeConnectionState": {
+ "type": "string",
+ "documentation": "Used in DescribeNodeSummary.",
+ "enum": [
+ "CONNECTED",
+ "DISCONNECTED"
+ ]
+ },
+ "NodeInterfaceMapping": {
+ "type": "structure",
+ "members": {
+ "LogicalInterfaceName": {
+ "shape": "__string",
+ "locationName": "logicalInterfaceName",
+ "documentation": "A uniform logical interface name to address in a MediaLive channel configuration."
+ },
+ "NetworkInterfaceMode": {
+ "shape": "NetworkInterfaceMode",
+ "locationName": "networkInterfaceMode"
+ },
+ "PhysicalInterfaceName": {
+ "shape": "__string",
+ "locationName": "physicalInterfaceName",
+ "documentation": "The name of the physical interface on the hardware that will be running Elemental anywhere."
+ }
},
- "value": {
- "shape": "__string"
- }
+ "documentation": "A mapping that's used to pair a logical network interface name on a Node with the physical interface name exposed in the operating system."
},
- "TooManyRequestsExceptionResponseContent": {
+ "NodeInterfaceMappingCreateRequest": {
"type": "structure",
"members": {
- "Message": {
+ "LogicalInterfaceName": {
"shape": "__string",
- "locationName": "message",
- "documentation": "Exception error message."
+ "locationName": "logicalInterfaceName",
+ "documentation": "Specify one of the logicalInterfaceNames that you created in the Cluster that this node belongs to. For example, my-Inputs-Interface."
+ },
+ "NetworkInterfaceMode": {
+ "shape": "NetworkInterfaceMode",
+ "locationName": "networkInterfaceMode",
+ "documentation": "The style of the network -- NAT or BRIDGE."
+ },
+ "PhysicalInterfaceName": {
+ "shape": "__string",
+ "locationName": "physicalInterfaceName",
+ "documentation": "Specify the physical name that corresponds to the logicalInterfaceName that you specified in this interface mapping. For example, Eth1 or ENO1234EXAMPLE."
}
},
- "documentation": "Request was denied due to request throttling."
+ "documentation": "Used in CreateNodeRequest."
},
- "UpdateCloudWatchAlarmTemplateGroupRequest": {
+ "NodeRole": {
+ "type": "string",
+ "documentation": "Used in CreateNodeRequest, CreateNodeRegistrationScriptRequest, DescribeNodeResult, DescribeNodeSummary, UpdateNodeRequest.",
+ "enum": [
+ "BACKUP",
+ "ACTIVE"
+ ]
+ },
+ "NodeState": {
+ "type": "string",
+ "documentation": "Used in DescribeNodeSummary.",
+ "enum": [
+ "CREATED",
+ "REGISTERING",
+ "READY_TO_ACTIVATE",
+ "REGISTRATION_FAILED",
+ "ACTIVATION_FAILED",
+ "ACTIVE",
+ "READY",
+ "IN_USE",
+ "DEREGISTERING",
+ "DRAINING",
+ "DEREGISTRATION_FAILED",
+ "DEREGISTERED"
+ ]
+ },
+ "Route": {
"type": "structure",
"members": {
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "Cidr": {
+ "shape": "__string",
+ "locationName": "cidr",
+ "documentation": "A CIDR block for one Route."
},
- "Identifier": {
+ "Gateway": {
"shape": "__string",
- "location": "uri",
- "locationName": "identifier",
- "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
+ "locationName": "gateway",
+ "documentation": "The IP address of the Gateway for this route, if applicable."
}
},
- "required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateGroupRequest"
+ "documentation": "Used in DescribeNetworkResult, DescribeNetworkSummary, UpdateNetworkResult."
},
- "UpdateCloudWatchAlarmTemplateGroupRequestContent": {
+ "RouteCreateRequest": {
"type": "structure",
"members": {
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "Cidr": {
+ "shape": "__string",
+ "locationName": "cidr",
+ "documentation": "A CIDR block for one Route."
+ },
+ "Gateway": {
+ "shape": "__string",
+ "locationName": "gateway",
+ "documentation": "The IP address of the Gateway for this route, if applicable."
}
},
- "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateGroupRequestContent"
+ "documentation": "Used in CreateNetworkRequest."
},
- "UpdateCloudWatchAlarmTemplateGroupResponse": {
+ "RouteUpdateRequest": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
- "locationName": "arn",
- "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "Cidr": {
+ "shape": "__string",
+ "locationName": "cidr",
+ "documentation": "A CIDR block for one Route."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "Gateway": {
+ "shape": "__string",
+ "locationName": "gateway",
+ "documentation": "The IP address of the Gateway for this route, if applicable."
}
},
- "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateGroupResponse"
+ "documentation": "Used in UpdateNetworkRequest."
},
- "UpdateCloudWatchAlarmTemplateGroupResponseContent": {
+ "SrtEncryptionType": {
+ "type": "string",
+ "documentation": "Srt Encryption Type",
+ "enum": [
+ "AES128",
+ "AES192",
+ "AES256"
+ ]
+ },
+ "SrtGroupSettings": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup",
- "locationName": "arn",
- "documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "Id": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "id",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
- },
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "InputLossAction": {
+ "shape": "InputLossActionForUdpOut",
+ "locationName": "inputLossAction",
+ "documentation": "Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video."
}
},
- "required": [
- "CreatedAt",
- "Id",
- "Arn",
- "Name"
- ],
- "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateGroupResponseContent"
+ "documentation": "Srt Group Settings"
},
- "UpdateCloudWatchAlarmTemplateRequest": {
+ "SrtOutputDestinationSettings": {
"type": "structure",
"members": {
- "ComparisonOperator": {
- "shape": "CloudWatchAlarmTemplateComparisonOperator",
- "locationName": "comparisonOperator"
- },
- "DatapointsToAlarm": {
- "shape": "__integerMin1",
- "locationName": "datapointsToAlarm",
- "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "EvaluationPeriods": {
- "shape": "__integerMin1",
- "locationName": "evaluationPeriods",
- "documentation": "The number of periods over which data is compared to the specified threshold."
- },
- "GroupIdentifier": {
- "shape": "__stringPatternS",
- "locationName": "groupIdentifier",
- "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
- },
- "Identifier": {
+ "EncryptionPassphraseSecretArn": {
"shape": "__string",
- "location": "uri",
- "locationName": "identifier",
- "documentation": "A cloudwatch alarm template's identifier. Can be either be its id or current name."
- },
- "MetricName": {
- "shape": "__stringMax64",
- "locationName": "metricName",
- "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ "locationName": "encryptionPassphraseSecretArn",
+ "documentation": "Arn used to extract the password from Secrets Manager"
},
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "StreamId": {
+ "shape": "__string",
+ "locationName": "streamId",
+ "documentation": "Stream id for SRT destinations (URLs of type srt://)"
},
- "Period": {
- "shape": "__integerMin10Max86400",
- "locationName": "period",
- "documentation": "The period, in seconds, over which the specified statistic is applied."
+ "Url": {
+ "shape": "__string",
+ "locationName": "url",
+ "documentation": "A URL specifying a destination"
+ }
+ },
+ "documentation": "Placeholder documentation for SrtOutputDestinationSettings"
+ },
+ "SrtOutputSettings": {
+ "type": "structure",
+ "members": {
+ "BufferMsec": {
+ "shape": "__integerMin0Max10000",
+ "locationName": "bufferMsec",
+ "documentation": "SRT output buffering in milliseconds. A higher value increases latency through the encoder. But the benefits are that it helps to maintain a constant, low-jitter SRT output, and it accommodates clock recovery, input switching, input disruptions, picture reordering, and so on. Range: 0-10000 milliseconds."
},
- "Statistic": {
- "shape": "CloudWatchAlarmTemplateStatistic",
- "locationName": "statistic"
+ "ContainerSettings": {
+ "shape": "UdpContainerSettings",
+ "locationName": "containerSettings"
},
- "TargetResourceType": {
- "shape": "CloudWatchAlarmTemplateTargetResourceType",
- "locationName": "targetResourceType"
+ "Destination": {
+ "shape": "OutputLocationRef",
+ "locationName": "destination"
},
- "Threshold": {
- "shape": "__double",
- "locationName": "threshold",
- "documentation": "The threshold value to compare with the specified statistic."
+ "EncryptionType": {
+ "shape": "SrtEncryptionType",
+ "locationName": "encryptionType",
+ "documentation": "The encryption level for the content. Valid values are AES128, AES192, AES256. You and the downstream system should plan how to set this field because the values must not conflict with each other."
},
- "TreatMissingData": {
- "shape": "CloudWatchAlarmTemplateTreatMissingData",
- "locationName": "treatMissingData"
+ "Latency": {
+ "shape": "__integerMin40Max16000",
+ "locationName": "latency",
+ "documentation": "The latency value, in milliseconds, that is proposed during the SRT connection handshake. SRT will choose the maximum of the values proposed by the sender and receiver. On the sender side, latency is the amount of time a packet is held to give it a chance to be delivered successfully. On the receiver side, latency is the amount of time the packet is held before delivering to the application, aiding in packet recovery and matching as closely as possible the packet timing of the sender. Range: 40-16000 milliseconds."
}
},
+ "documentation": "Srt Output Settings",
"required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateRequest"
+ "Destination",
+ "ContainerSettings"
+ ]
},
- "UpdateCloudWatchAlarmTemplateRequestContent": {
+ "UpdateChannelPlacementGroupRequest": {
"type": "structure",
"members": {
- "ComparisonOperator": {
- "shape": "CloudWatchAlarmTemplateComparisonOperator",
- "locationName": "comparisonOperator"
- },
- "DatapointsToAlarm": {
- "shape": "__integerMin1",
- "locationName": "datapointsToAlarm",
- "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "EvaluationPeriods": {
- "shape": "__integerMin1",
- "locationName": "evaluationPeriods",
- "documentation": "The number of periods over which data is compared to the specified threshold."
- },
- "GroupIdentifier": {
- "shape": "__stringPatternS",
- "locationName": "groupIdentifier",
- "documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name."
- },
- "MetricName": {
- "shape": "__stringMax64",
- "locationName": "metricName",
- "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
+ "ChannelPlacementGroupId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "channelPlacementGroupId",
+ "documentation": "The ID of the channel placement group."
+ },
+ "ClusterId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Period": {
- "shape": "__integerMin10Max86400",
- "locationName": "period",
- "documentation": "The period, in seconds, over which the specified statistic is applied."
- },
- "Statistic": {
- "shape": "CloudWatchAlarmTemplateStatistic",
- "locationName": "statistic"
- },
- "TargetResourceType": {
- "shape": "CloudWatchAlarmTemplateTargetResourceType",
- "locationName": "targetResourceType"
- },
- "Threshold": {
- "shape": "__double",
- "locationName": "threshold",
- "documentation": "The threshold value to compare with the specified statistic."
+ "documentation": "Include this parameter only if you want to change the current name of the ChannelPlacementGroup. Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive."
},
- "TreatMissingData": {
- "shape": "CloudWatchAlarmTemplateTreatMissingData",
- "locationName": "treatMissingData"
+ "Nodes": {
+ "shape": "__listOf__string",
+ "locationName": "nodes",
+ "documentation": "Include this parameter only if you want to change the list of Nodes that are associated with the ChannelPlacementGroup."
}
},
- "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateRequestContent"
+ "documentation": "A request to update the channel placement group",
+ "required": [
+ "ClusterId",
+ "ChannelPlacementGroupId"
+ ]
},
- "UpdateCloudWatchAlarmTemplateResponse": {
+ "UpdateChannelPlacementGroupResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
- },
- "ComparisonOperator": {
- "shape": "CloudWatchAlarmTemplateComparisonOperator",
- "locationName": "comparisonOperator"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "DatapointsToAlarm": {
- "shape": "__integerMin1",
- "locationName": "datapointsToAlarm",
- "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ "documentation": "The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created."
},
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "EvaluationPeriods": {
- "shape": "__integerMin1",
- "locationName": "evaluationPeriods",
- "documentation": "The number of periods over which data is compared to the specified threshold."
+ "Channels": {
+ "shape": "__listOf__string",
+ "locationName": "channels",
+ "documentation": "Used in ListChannelPlacementGroupsResult"
},
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
- },
- "MetricName": {
- "shape": "__stringMax64",
- "locationName": "metricName",
- "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "documentation": "The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Period": {
- "shape": "__integerMin10Max86400",
- "locationName": "period",
- "documentation": "The period, in seconds, over which the specified statistic is applied."
- },
- "Statistic": {
- "shape": "CloudWatchAlarmTemplateStatistic",
- "locationName": "statistic"
+ "documentation": "The name that you specified for the ChannelPlacementGroup."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "Nodes": {
+ "shape": "__listOf__string",
+ "locationName": "nodes",
+ "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup."
},
- "TargetResourceType": {
- "shape": "CloudWatchAlarmTemplateTargetResourceType",
- "locationName": "targetResourceType"
+ "State": {
+ "shape": "ChannelPlacementGroupState",
+ "locationName": "state",
+ "documentation": "The current state of the ChannelPlacementGroup."
+ }
+ },
+ "documentation": "Placeholder documentation for UpdateChannelPlacementGroupResponse"
+ },
+ "UpdateClusterRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster"
},
- "Threshold": {
- "shape": "__double",
- "locationName": "threshold",
- "documentation": "The threshold value to compare with the specified statistic."
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "Include this parameter only if you want to change the current name of the Cluster. Specify a name that is unique in the AWS account. You can't change the name. Names are case-sensitive."
},
- "TreatMissingData": {
- "shape": "CloudWatchAlarmTemplateTreatMissingData",
- "locationName": "treatMissingData"
+ "NetworkSettings": {
+ "shape": "ClusterNetworkSettingsUpdateRequest",
+ "locationName": "networkSettings",
+ "documentation": "Include this property only if you want to change the current connections between the Nodes in the Cluster and the Networks the Cluster is associated with."
}
},
- "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateResponse"
+ "documentation": "A request to update the cluster.",
+ "required": [
+ "ClusterId"
+ ]
},
- "UpdateCloudWatchAlarmTemplateResponseContent": {
+ "UpdateClusterResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveCloudwatchAlarmTemplate",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)"
- },
- "ComparisonOperator": {
- "shape": "CloudWatchAlarmTemplateComparisonOperator",
- "locationName": "comparisonOperator"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "DatapointsToAlarm": {
- "shape": "__integerMin1",
- "locationName": "datapointsToAlarm",
- "documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm."
+ "documentation": "The ARN of the Cluster."
},
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "EvaluationPeriods": {
- "shape": "__integerMin1",
- "locationName": "evaluationPeriods",
- "documentation": "The number of periods over which data is compared to the specified threshold."
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds",
+ "documentation": "An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster."
},
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`"
+ "ClusterType": {
+ "shape": "ClusterType",
+ "locationName": "clusterType",
+ "documentation": "The hardware type for the Cluster"
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`"
- },
- "MetricName": {
- "shape": "__stringMax64",
- "locationName": "metricName",
- "documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType."
- },
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "documentation": "The unique ID of the Cluster."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- },
- "Period": {
- "shape": "__integerMin10Max86400",
- "locationName": "period",
- "documentation": "The period, in seconds, over which the specified statistic is applied."
- },
- "Statistic": {
- "shape": "CloudWatchAlarmTemplateStatistic",
- "locationName": "statistic"
+ "documentation": "The user-specified name of the Cluster."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
- },
- "TargetResourceType": {
- "shape": "CloudWatchAlarmTemplateTargetResourceType",
- "locationName": "targetResourceType"
- },
- "Threshold": {
- "shape": "__double",
- "locationName": "threshold",
- "documentation": "The threshold value to compare with the specified statistic."
+ "NetworkSettings": {
+ "shape": "ClusterNetworkSettings",
+ "locationName": "networkSettings",
+ "documentation": "Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with."
},
- "TreatMissingData": {
- "shape": "CloudWatchAlarmTemplateTreatMissingData",
- "locationName": "treatMissingData"
+ "State": {
+ "shape": "ClusterState",
+ "locationName": "state",
+ "documentation": "The current state of the Cluster."
}
},
- "required": [
- "TargetResourceType",
- "TreatMissingData",
- "ComparisonOperator",
- "CreatedAt",
- "Period",
- "EvaluationPeriods",
- "Name",
- "GroupId",
- "MetricName",
- "Statistic",
- "Id",
- "Arn",
- "Threshold"
- ],
- "documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateResponseContent"
+ "documentation": "Placeholder documentation for UpdateClusterResponse"
},
- "UpdateEventBridgeRuleTemplateGroupRequest": {
+ "UpdateClusterResult": {
"type": "structure",
"members": {
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The ARN of the Cluster."
},
- "Identifier": {
+ "ChannelIds": {
+ "shape": "__listOf__string",
+ "locationName": "channelIds",
+ "documentation": "An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster."
+ },
+ "ClusterType": {
+ "shape": "ClusterType",
+ "locationName": "clusterType",
+ "documentation": "The hardware type for the Cluster"
+ },
+ "Id": {
"shape": "__string",
- "location": "uri",
- "locationName": "identifier",
- "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ "locationName": "id",
+ "documentation": "The unique ID of the Cluster."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "The user-specified name of the Cluster."
+ },
+ "NetworkSettings": {
+ "shape": "ClusterNetworkSettings",
+ "locationName": "networkSettings",
+ "documentation": "Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with."
+ },
+ "State": {
+ "shape": "ClusterState",
+ "locationName": "state",
+ "documentation": "The current state of the Cluster."
}
},
- "required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateGroupRequest"
+ "documentation": "The name that you specified for the Cluster."
},
- "UpdateEventBridgeRuleTemplateGroupRequestContent": {
+ "UpdateNetworkRequest": {
"type": "structure",
"members": {
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "IpPools": {
+ "shape": "__listOfIpPoolUpdateRequest",
+ "locationName": "ipPools",
+ "documentation": "Include this parameter only if you want to change the pool of IP addresses in the network. An array of IpPoolCreateRequests that identify a collection of IP addresses in this network that you want to reserve for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPoolUpdateRequest specifies one CIDR block."
+ },
+ "Name": {
+ "shape": "__string",
+ "locationName": "name",
+ "documentation": "Include this parameter only if you want to change the name of the Network. Specify a name that is unique in the AWS account. Names are case-sensitive."
+ },
+ "NetworkId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "networkId",
+ "documentation": "The ID of the network"
+ },
+ "Routes": {
+ "shape": "__listOfRouteUpdateRequest",
+ "locationName": "routes",
+ "documentation": "Include this parameter only if you want to change or add routes in the Network. An array of Routes that MediaLive Anywhere needs to know about in order to route encoding traffic."
}
},
- "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateGroupRequestContent"
+ "documentation": "A request to update the network.",
+ "required": [
+ "NetworkId"
+ ]
},
- "UpdateEventBridgeRuleTemplateGroupResponse": {
+ "UpdateNetworkResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
+ "documentation": "The ARN of this Network. It is automatically assigned when the Network is created."
},
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "AssociatedClusterIds": {
+ "shape": "__listOf__string",
+ "locationName": "associatedClusterIds"
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ "documentation": "The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "IpPools": {
+ "shape": "__listOfIpPool",
+ "locationName": "ipPools",
+ "documentation": "An array of IpPools in your organization's network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The name that you specified for the Network."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "Routes": {
+ "shape": "__listOfRoute",
+ "locationName": "routes",
+ "documentation": "An array of Routes that MediaLive Anywhere needs to know about in order to route encoding traffic."
+ },
+ "State": {
+ "shape": "NetworkState",
+ "locationName": "state",
+ "documentation": "The current state of the Network. Only MediaLive Anywhere can change the state."
}
},
- "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateGroupResponse"
+ "documentation": "Placeholder documentation for UpdateNetworkResponse"
},
- "UpdateEventBridgeRuleTemplateGroupResponseContent": {
+ "UpdateNetworkResult": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)"
+ "documentation": "The ARN of this Network. It is automatically assigned when the Network is created."
},
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "AssociatedClusterIds": {
+ "shape": "__listOf__string",
+ "locationName": "associatedClusterIds"
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ "documentation": "The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN."
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "IpPools": {
+ "shape": "__listOfIpPool",
+ "locationName": "ipPools",
+ "documentation": "An array of IpPools in your organization's network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The name that you specified for the Network."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "Routes": {
+ "shape": "__listOfRoute",
+ "locationName": "routes",
+ "documentation": "An array of Routes that MediaLive Anywhere needs to know about in order to route encoding traffic."
+ },
+ "State": {
+ "shape": "NetworkState",
+ "locationName": "state",
+ "documentation": "The current state of the Network. Only MediaLive Anywhere can change the state."
}
},
- "required": [
- "CreatedAt",
- "Id",
- "Arn",
- "Name"
- ],
- "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateGroupResponseContent"
+ "documentation": "Contains the response for the UpdateNetwork"
},
- "UpdateEventBridgeRuleTemplateRequest": {
+ "UpdateNodeRequest": {
"type": "structure",
"members": {
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "EventTargets": {
- "shape": "__listOfEventBridgeRuleTemplateTarget",
- "locationName": "eventTargets"
- },
- "EventType": {
- "shape": "EventBridgeRuleTemplateEventType",
- "locationName": "eventType"
- },
- "GroupIdentifier": {
- "shape": "__stringPatternS",
- "locationName": "groupIdentifier",
- "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
- },
- "Identifier": {
+ "ClusterId": {
"shape": "__string",
"location": "uri",
- "locationName": "identifier",
- "documentation": "An eventbridge rule template's identifier. Can be either be its id or current name."
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster"
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
- }
- },
- "required": [
- "Identifier"
- ],
- "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateRequest"
- },
- "UpdateEventBridgeRuleTemplateRequestContent": {
- "type": "structure",
- "members": {
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
- },
- "EventTargets": {
- "shape": "__listOfEventBridgeRuleTemplateTarget",
- "locationName": "eventTargets"
- },
- "EventType": {
- "shape": "EventBridgeRuleTemplateEventType",
- "locationName": "eventType"
+ "documentation": "Include this parameter only if you want to change the current name of the Node. Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive."
},
- "GroupIdentifier": {
- "shape": "__stringPatternS",
- "locationName": "groupIdentifier",
- "documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name."
+ "NodeId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "nodeId",
+ "documentation": "The ID of the node."
},
- "Name": {
- "shape": "__stringMin1Max255PatternS",
- "locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "Role": {
+ "shape": "NodeRole",
+ "locationName": "role",
+ "documentation": "The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails."
}
},
- "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateRequestContent"
+ "documentation": "A request to update the node.",
+ "required": [
+ "NodeId",
+ "ClusterId"
+ ]
},
- "UpdateEventBridgeRuleTemplateResponse": {
+ "UpdateNodeResponse": {
"type": "structure",
"members": {
"Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
+ "shape": "__string",
"locationName": "arn",
- "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
- },
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
- },
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "documentation": "The ARN of the Node. It is automatically assigned when the Node is created."
},
- "EventTargets": {
- "shape": "__listOfEventBridgeRuleTemplateTarget",
- "locationName": "eventTargets"
+ "ChannelPlacementGroups": {
+ "shape": "__listOf__string",
+ "locationName": "channelPlacementGroups",
+ "documentation": "An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups."
},
- "EventType": {
- "shape": "EventBridgeRuleTemplateEventType",
- "locationName": "eventType"
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
},
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ "ConnectionState": {
+ "shape": "NodeConnectionState",
+ "locationName": "connectionState",
+ "documentation": "The current connection state of the Node."
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
+ "documentation": "The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN."
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "InstanceArn": {
+ "shape": "__string",
+ "locationName": "instanceArn",
+ "documentation": "The ARN of the EC2 instance hosting the Node."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The name that you specified for the Node."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "NodeInterfaceMappings": {
+ "shape": "__listOfNodeInterfaceMapping",
+ "locationName": "nodeInterfaceMappings",
+ "documentation": "Documentation update needed"
+ },
+ "Role": {
+ "shape": "NodeRole",
+ "locationName": "role",
+ "documentation": "The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails."
+ },
+ "State": {
+ "shape": "NodeState",
+ "locationName": "state",
+ "documentation": "The current state of the Node."
}
},
- "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateResponse"
+ "documentation": "Placeholder documentation for UpdateNodeResponse"
},
- "UpdateEventBridgeRuleTemplateResponseContent": {
+ "UpdateNodeState": {
+ "type": "string",
+ "documentation": "Used in UpdateNodeStateRequest.",
+ "enum": [
+ "ACTIVE",
+ "DRAINING"
+ ]
+ },
+ "UpdateNodeStateRequest": {
"type": "structure",
"members": {
- "Arn": {
- "shape": "__stringPatternArnMedialiveEventbridgeRuleTemplate",
- "locationName": "arn",
- "documentation": "An eventbridge rule template's ARN (Amazon Resource Name)"
+ "ClusterId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "clusterId",
+ "documentation": "The ID of the cluster"
},
- "CreatedAt": {
- "shape": "__timestampIso8601",
- "locationName": "createdAt"
+ "NodeId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "nodeId",
+ "documentation": "The ID of the node."
},
- "Description": {
- "shape": "__stringMin0Max1024",
- "locationName": "description",
- "documentation": "A resource's optional description."
+ "State": {
+ "shape": "UpdateNodeState",
+ "locationName": "state",
+ "documentation": "The state to apply to the Node. Set to ACTIVE (COMMISSIONED) to indicate that the Node is deployable. MediaLive Anywhere will consider this node it needs a Node to run a Channel on, or when it needs a Node to promote from a backup node to an active node. Set to DRAINING to isolate the Node so that MediaLive Anywhere won't use it."
+ }
+ },
+ "documentation": "A request to update the state of a node.",
+ "required": [
+ "NodeId",
+ "ClusterId"
+ ]
+ },
+ "UpdateNodeStateResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn",
+ "documentation": "The ARN of the Node. It is automatically assigned when the Node is created."
},
- "EventTargets": {
- "shape": "__listOfEventBridgeRuleTemplateTarget",
- "locationName": "eventTargets"
+ "ChannelPlacementGroups": {
+ "shape": "__listOf__string",
+ "locationName": "channelPlacementGroups",
+ "documentation": "An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups."
},
- "EventType": {
- "shape": "EventBridgeRuleTemplateEventType",
- "locationName": "eventType"
+ "ClusterId": {
+ "shape": "__string",
+ "locationName": "clusterId",
+ "documentation": "The ID of the Cluster that the Node belongs to."
},
- "GroupId": {
- "shape": "__stringMin7Max11PatternAws097",
- "locationName": "groupId",
- "documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`"
+ "ConnectionState": {
+ "shape": "NodeConnectionState",
+ "locationName": "connectionState",
+ "documentation": "The current connection state of the Node."
},
"Id": {
- "shape": "__stringMin7Max11PatternAws097",
+ "shape": "__string",
"locationName": "id",
- "documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`"
+ "documentation": "The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN."
},
- "ModifiedAt": {
- "shape": "__timestampIso8601",
- "locationName": "modifiedAt"
+ "InstanceArn": {
+ "shape": "__string",
+ "locationName": "instanceArn",
+ "documentation": "The ARN of the EC2 instance hosting the Node."
},
"Name": {
- "shape": "__stringMin1Max255PatternS",
+ "shape": "__string",
"locationName": "name",
- "documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region."
+ "documentation": "The name that you specified for the Node."
},
- "Tags": {
- "shape": "TagMap",
- "locationName": "tags"
+ "NodeInterfaceMappings": {
+ "shape": "__listOfNodeInterfaceMapping",
+ "locationName": "nodeInterfaceMappings",
+ "documentation": "Documentation update needed"
+ },
+ "Role": {
+ "shape": "NodeRole",
+ "locationName": "role",
+ "documentation": "The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails."
+ },
+ "State": {
+ "shape": "NodeState",
+ "locationName": "state",
+ "documentation": "The current state of the Node."
}
},
- "required": [
- "EventType",
- "CreatedAt",
- "Id",
- "Arn",
- "Name",
- "GroupId"
- ],
- "documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateResponseContent"
+ "documentation": "Placeholder documentation for UpdateNodeStateResponse"
},
- "__integerMax5": {
+ "__integerMin40Max16000": {
"type": "integer",
- "max": 5,
- "documentation": "Placeholder documentation for __integerMax5"
+ "min": 40,
+ "max": 16000,
+ "documentation": "Placeholder documentation for __integerMin40Max16000"
+ },
+ "__integerMin50000Max16000000": {
+ "type": "integer",
+ "min": 50000,
+ "max": 16000000,
+ "documentation": "Placeholder documentation for __integerMin50000Max16000000"
},
- "__integerMin10Max86400": {
+ "__integerMin50000Max8000000": {
"type": "integer",
- "min": 10,
- "max": 86400,
- "documentation": "Placeholder documentation for __integerMin10Max86400"
+ "min": 50000,
+ "max": 8000000,
+ "documentation": "Placeholder documentation for __integerMin50000Max8000000"
},
- "__listOfCloudWatchAlarmTemplateGroupSummary": {
+ "__listOfDescribeChannelPlacementGroupSummary": {
"type": "list",
"member": {
- "shape": "CloudWatchAlarmTemplateGroupSummary"
+ "shape": "DescribeChannelPlacementGroupSummary"
},
- "documentation": "Placeholder documentation for __listOfCloudWatchAlarmTemplateGroupSummary"
+ "documentation": "Placeholder documentation for __listOfDescribeChannelPlacementGroupSummary"
},
- "__listOfCloudWatchAlarmTemplateSummary": {
+ "__listOfDescribeClusterSummary": {
"type": "list",
"member": {
- "shape": "CloudWatchAlarmTemplateSummary"
+ "shape": "DescribeClusterSummary"
},
- "documentation": "Placeholder documentation for __listOfCloudWatchAlarmTemplateSummary"
+ "documentation": "Placeholder documentation for __listOfDescribeClusterSummary"
},
- "__listOfEventBridgeRuleTemplateGroupSummary": {
+ "__listOfDescribeNetworkSummary": {
"type": "list",
"member": {
- "shape": "EventBridgeRuleTemplateGroupSummary"
+ "shape": "DescribeNetworkSummary"
},
- "documentation": "Placeholder documentation for __listOfEventBridgeRuleTemplateGroupSummary"
+ "documentation": "Placeholder documentation for __listOfDescribeNetworkSummary"
},
- "__listOfEventBridgeRuleTemplateSummary": {
+ "__listOfDescribeNodeSummary": {
"type": "list",
"member": {
- "shape": "EventBridgeRuleTemplateSummary"
+ "shape": "DescribeNodeSummary"
},
- "documentation": "Placeholder documentation for __listOfEventBridgeRuleTemplateSummary"
+ "documentation": "Placeholder documentation for __listOfDescribeNodeSummary"
},
- "__listOfEventBridgeRuleTemplateTarget": {
+ "__listOfInputDestinationRoute": {
"type": "list",
"member": {
- "shape": "EventBridgeRuleTemplateTarget"
+ "shape": "InputDestinationRoute"
},
- "documentation": "Placeholder documentation for __listOfEventBridgeRuleTemplateTarget"
+ "documentation": "Placeholder documentation for __listOfInputDestinationRoute"
},
- "__listOfMediaResourceNeighbor": {
+ "__listOfInputRequestDestinationRoute": {
"type": "list",
"member": {
- "shape": "MediaResourceNeighbor"
+ "shape": "InputRequestDestinationRoute"
},
- "documentation": "Placeholder documentation for __listOfMediaResourceNeighbor"
+ "documentation": "Placeholder documentation for __listOfInputRequestDestinationRoute"
},
- "__listOfSignalMapSummary": {
+ "__listOfInterfaceMapping": {
"type": "list",
"member": {
- "shape": "SignalMapSummary"
+ "shape": "InterfaceMapping"
},
- "documentation": "Placeholder documentation for __listOfSignalMapSummary"
+ "documentation": "Placeholder documentation for __listOfInterfaceMapping"
},
- "__listOf__stringMin7Max11PatternAws097": {
+ "__listOfInterfaceMappingCreateRequest": {
"type": "list",
"member": {
- "shape": "__stringMin7Max11PatternAws097"
+ "shape": "InterfaceMappingCreateRequest"
},
- "documentation": "Placeholder documentation for __listOf__stringMin7Max11PatternAws097"
+ "documentation": "Placeholder documentation for __listOfInterfaceMappingCreateRequest"
},
- "__listOf__stringPatternS": {
+ "__listOfInterfaceMappingUpdateRequest": {
"type": "list",
"member": {
- "shape": "__stringPatternS"
+ "shape": "InterfaceMappingUpdateRequest"
},
- "documentation": "Placeholder documentation for __listOf__stringPatternS"
- },
- "__stringMax64": {
- "type": "string",
- "max": 64,
- "documentation": "Placeholder documentation for __stringMax64"
- },
- "__stringMin0Max1024": {
- "type": "string",
- "min": 0,
- "max": 1024,
- "documentation": "Placeholder documentation for __stringMin0Max1024"
- },
- "__stringMin1Max2048": {
- "type": "string",
- "min": 1,
- "max": 2048,
- "documentation": "Placeholder documentation for __stringMin1Max2048"
- },
- "__stringMin1Max2048PatternArn": {
- "type": "string",
- "min": 1,
- "max": 2048,
- "pattern": "^arn.+$",
- "documentation": "Placeholder documentation for __stringMin1Max2048PatternArn"
- },
- "__stringMin1Max255PatternS": {
- "type": "string",
- "min": 1,
- "max": 255,
- "pattern": "^[^\\s]+$",
- "documentation": "Placeholder documentation for __stringMin1Max255PatternS"
- },
- "__stringMin7Max11PatternAws097": {
- "type": "string",
- "min": 7,
- "max": 11,
- "pattern": "^(aws-)?[0-9]{7}$",
- "documentation": "Placeholder documentation for __stringMin7Max11PatternAws097"
- },
- "__stringPatternArnMedialiveCloudwatchAlarmTemplate": {
- "type": "string",
- "pattern": "^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$",
- "documentation": "Placeholder documentation for __stringPatternArnMedialiveCloudwatchAlarmTemplate"
- },
- "__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup": {
- "type": "string",
- "pattern": "^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$",
- "documentation": "Placeholder documentation for __stringPatternArnMedialiveCloudwatchAlarmTemplateGroup"
- },
- "__stringPatternArnMedialiveEventbridgeRuleTemplate": {
- "type": "string",
- "pattern": "^arn:.+:medialive:.+:eventbridge-rule-template:.+$",
- "documentation": "Placeholder documentation for __stringPatternArnMedialiveEventbridgeRuleTemplate"
- },
- "__stringPatternArnMedialiveEventbridgeRuleTemplateGroup": {
- "type": "string",
- "pattern": "^arn:.+:medialive:.+:eventbridge-rule-template-group:.+$",
- "documentation": "Placeholder documentation for __stringPatternArnMedialiveEventbridgeRuleTemplateGroup"
- },
- "__stringPatternArnMedialiveSignalMap": {
- "type": "string",
- "pattern": "^arn:.+:medialive:.+:signal-map:.+$",
- "documentation": "Placeholder documentation for __stringPatternArnMedialiveSignalMap"
- },
- "__stringPatternS": {
- "type": "string",
- "pattern": "^[^\\s]+$",
- "documentation": "Placeholder documentation for __stringPatternS"
- },
- "Scte35SegmentationScope": {
- "type": "string",
- "documentation": "Scte35 Segmentation Scope",
- "enum": [
- "ALL_OUTPUT_GROUPS",
- "SCTE35_ENABLED_OUTPUT_GROUPS"
- ]
+ "documentation": "Placeholder documentation for __listOfInterfaceMappingUpdateRequest"
},
- "Algorithm": {
- "type": "string",
- "enum": [
- "AES128",
- "AES192",
- "AES256"
- ],
- "documentation": "Placeholder documentation for Algorithm"
+ "__listOfIpPool": {
+ "type": "list",
+ "member": {
+ "shape": "IpPool"
+ },
+ "documentation": "Placeholder documentation for __listOfIpPool"
},
- "SrtCallerDecryption": {
- "type": "structure",
- "members": {
- "Algorithm": {
- "shape": "Algorithm",
- "locationName": "algorithm",
- "documentation": "The algorithm used to encrypt content."
- },
- "PassphraseSecretArn": {
- "shape": "__string",
- "locationName": "passphraseSecretArn",
- "documentation": "The ARN for the secret in Secrets Manager. Someone in your organization must create a secret and provide you with its ARN. The secret holds the passphrase that MediaLive uses to decrypt the source content."
- }
+ "__listOfIpPoolCreateRequest": {
+ "type": "list",
+ "member": {
+ "shape": "IpPoolCreateRequest"
},
- "documentation": "The decryption settings for the SRT caller source. Present only if the source has decryption enabled."
+ "documentation": "Placeholder documentation for __listOfIpPoolCreateRequest"
},
- "SrtCallerDecryptionRequest": {
- "type": "structure",
- "members": {
- "Algorithm": {
- "shape": "Algorithm",
- "locationName": "algorithm",
- "documentation": "The algorithm used to encrypt content."
- },
- "PassphraseSecretArn": {
- "shape": "__string",
- "locationName": "passphraseSecretArn",
- "documentation": "The ARN for the secret in Secrets Manager. Someone in your organization must create a secret and provide you with its ARN. This secret holds the passphrase that MediaLive will use to decrypt the source content."
- }
+ "__listOfIpPoolUpdateRequest": {
+ "type": "list",
+ "member": {
+ "shape": "IpPoolUpdateRequest"
},
- "documentation": "Complete these parameters only if the content is encrypted."
+ "documentation": "Placeholder documentation for __listOfIpPoolUpdateRequest"
},
- "SrtCallerSource": {
- "type": "structure",
- "members": {
- "Decryption": {
- "shape": "SrtCallerDecryption",
- "locationName": "decryption"
- },
- "MinimumLatency": {
- "shape": "__integer",
- "locationName": "minimumLatency",
- "documentation": "The preferred latency (in milliseconds) for implementing packet loss and recovery. Packet recovery is a key feature of SRT."
- },
- "SrtListenerAddress": {
- "shape": "__string",
- "locationName": "srtListenerAddress",
- "documentation": "The IP address at the upstream system (the listener) that MediaLive (the caller) connects to."
- },
- "SrtListenerPort": {
- "shape": "__string",
- "locationName": "srtListenerPort",
- "documentation": "The port at the upstream system (the listener) that MediaLive (the caller) connects to."
- },
- "StreamId": {
- "shape": "__string",
- "locationName": "streamId",
- "documentation": "The stream ID, if the upstream system uses this identifier."
- }
+ "__listOfMulticastSource": {
+ "type": "list",
+ "member": {
+ "shape": "MulticastSource"
},
- "documentation": "The configuration for a source that uses SRT as the connection protocol. In terms of establishing the connection, MediaLive is always caller and the upstream system is always the listener. In terms of transmission of the source content, MediaLive is always the receiver and the upstream system is always the sender."
+ "documentation": "Placeholder documentation for __listOfMulticastSource"
},
- "SrtCallerSourceRequest": {
- "type": "structure",
- "members": {
- "Decryption": {
- "shape": "SrtCallerDecryptionRequest",
- "locationName": "decryption"
- },
- "MinimumLatency": {
- "shape": "__integer",
- "locationName": "minimumLatency",
- "documentation": "The preferred latency (in milliseconds) for implementing packet loss and recovery. Packet recovery is a key feature of SRT. Obtain this value from the operator at the upstream system."
- },
- "SrtListenerAddress": {
- "shape": "__string",
- "locationName": "srtListenerAddress",
- "documentation": "The IP address at the upstream system (the listener) that MediaLive (the caller) will connect to."
- },
- "SrtListenerPort": {
- "shape": "__string",
- "locationName": "srtListenerPort",
- "documentation": "The port at the upstream system (the listener) that MediaLive (the caller) will connect to."
- },
- "StreamId": {
- "shape": "__string",
- "locationName": "streamId",
- "documentation": "This value is required if the upstream system uses this identifier because without it, the SRT handshake between MediaLive (the caller) and the upstream system (the listener) might fail."
- }
+ "__listOfMulticastSourceCreateRequest": {
+ "type": "list",
+ "member": {
+ "shape": "MulticastSourceCreateRequest"
},
- "documentation": "Configures the connection for a source that uses SRT as the connection protocol. In terms of establishing the connection, MediaLive is always the caller and the upstream system is always the listener. In terms of transmission of the source content, MediaLive is always the receiver and the upstream system is always the sender."
+ "documentation": "Placeholder documentation for __listOfMulticastSourceCreateRequest"
},
- "SrtSettings": {
- "type": "structure",
- "members": {
- "SrtCallerSources": {
- "shape": "__listOfSrtCallerSource",
- "locationName": "srtCallerSources"
- }
+ "__listOfMulticastSourceUpdateRequest": {
+ "type": "list",
+ "member": {
+ "shape": "MulticastSourceUpdateRequest"
},
- "documentation": "The configured sources for this SRT input."
+ "documentation": "Placeholder documentation for __listOfMulticastSourceUpdateRequest"
},
- "SrtSettingsRequest": {
- "type": "structure",
- "members": {
- "SrtCallerSources": {
- "shape": "__listOfSrtCallerSourceRequest",
- "locationName": "srtCallerSources"
- }
+ "__listOfNodeInterfaceMapping": {
+ "type": "list",
+ "member": {
+ "shape": "NodeInterfaceMapping"
},
- "documentation": "Configures the sources for this SRT input. For a single-pipeline input, include one srtCallerSource in the array. For a standard-pipeline input, include two srtCallerSource."
+ "documentation": "Placeholder documentation for __listOfNodeInterfaceMapping"
},
- "__listOfSrtCallerSource": {
+ "__listOfNodeInterfaceMappingCreateRequest": {
"type": "list",
"member": {
- "shape": "SrtCallerSource"
+ "shape": "NodeInterfaceMappingCreateRequest"
},
- "documentation": "Placeholder documentation for __listOfSrtCallerSource"
+ "documentation": "Placeholder documentation for __listOfNodeInterfaceMappingCreateRequest"
},
- "__listOfSrtCallerSourceRequest": {
+ "__listOfRoute": {
"type": "list",
"member": {
- "shape": "SrtCallerSourceRequest"
+ "shape": "Route"
},
- "documentation": "Placeholder documentation for __listOfSrtCallerSourceRequest"
+ "documentation": "Placeholder documentation for __listOfRoute"
},
- "MultiplexPacketIdentifiersMapping": {
- "type": "map",
- "key": {
- "shape": "__string"
+ "__listOfRouteCreateRequest": {
+ "type": "list",
+ "member": {
+ "shape": "RouteCreateRequest"
},
- "value": {
- "shape": "MultiplexProgramPacketIdentifiersMap"
+ "documentation": "Placeholder documentation for __listOfRouteCreateRequest"
+ },
+ "__listOfRouteUpdateRequest": {
+ "type": "list",
+ "member": {
+ "shape": "RouteUpdateRequest"
},
- "documentation": "Placeholder documentation for MultiplexPacketIdentifiersMapping"
+ "documentation": "Placeholder documentation for __listOfRouteUpdateRequest"
},
- "__integerMin1Max51": {
- "type": "integer",
- "min": 1,
- "max": 51,
- "documentation": "Placeholder documentation for __integerMin1Max51"
+ "__listOfSrtOutputDestinationSettings": {
+ "type": "list",
+ "member": {
+ "shape": "SrtOutputDestinationSettings"
+ },
+ "documentation": "Placeholder documentation for __listOfSrtOutputDestinationSettings"
}
},
"documentation": "API for AWS Elemental MediaLive"
diff --git a/services/medialive/src/main/resources/codegen-resources/waiters-2.json b/services/medialive/src/main/resources/codegen-resources/waiters-2.json
index dcff01bb8d9a..d95e09abe9f2 100644
--- a/services/medialive/src/main/resources/codegen-resources/waiters-2.json
+++ b/services/medialive/src/main/resources/codegen-resources/waiters-2.json
@@ -421,6 +421,204 @@
"expected": "UPDATE_REVERTED"
}
]
+ },
+ "ClusterCreated": {
+ "description": "Wait until a cluster has been created",
+ "operation": "DescribeCluster",
+ "delay": 3,
+ "maxAttempts": 5,
+ "acceptors": [
+ {
+ "state": "success",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "ACTIVE"
+ },
+ {
+ "state": "retry",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "CREATING"
+ },
+ {
+ "state": "retry",
+ "matcher": "status",
+ "expected": 500
+ },
+ {
+ "state": "failure",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "CREATE_FAILED"
+ }
+ ]
+ },
+ "ClusterDeleted": {
+ "description": "Wait until a cluster has been deleted",
+ "operation": "DescribeCluster",
+ "delay": 5,
+ "maxAttempts": 20,
+ "acceptors": [
+ {
+ "state": "success",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "DELETED"
+ },
+ {
+ "state": "retry",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "DELETING"
+ },
+ {
+ "state": "retry",
+ "matcher": "status",
+ "expected": 500
+ }
+ ]
+ },
+ "NodeRegistered": {
+ "description": "Wait until a node has been registered",
+ "operation": "DescribeNode",
+ "delay": 3,
+ "maxAttempts": 5,
+ "acceptors": [
+ {
+ "state": "success",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "ACTIVE"
+ },
+ {
+ "state": "retry",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "REGISTERING"
+ },
+ {
+ "state": "retry",
+ "matcher": "status",
+ "expected": 404
+ },
+ {
+ "state": "failure",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "REGISTRATION_FAILED"
+ },
+ {
+ "state": "retry",
+ "matcher": "status",
+ "expected": 500
+ }
+ ]
+ },
+ "NodeDeregistered": {
+ "description": "Wait until a node has been deregistered",
+ "operation": "DescribeNode",
+ "delay": 5,
+ "maxAttempts": 20,
+ "acceptors": [
+ {
+ "state": "success",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "DEREGISTERED"
+ },
+ {
+ "state": "retry",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "DEREGISTERING"
+ },
+ {
+ "state": "retry",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "DRAINING"
+ },
+ {
+ "state": "retry",
+ "matcher": "status",
+ "expected": 500
+ }
+ ]
+ },
+ "ChannelPlacementGroupAssigned": {
+ "description": "Wait until the channel placement group has been assigned",
+ "operation": "DescribeChannelPlacementGroup",
+ "delay": 3,
+ "maxAttempts": 5,
+ "acceptors": [
+ {
+ "state": "success",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "ASSIGNED"
+ },
+ {
+ "state": "retry",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "ASSIGNING"
+ },
+ {
+ "state": "retry",
+ "matcher": "status",
+ "expected": 500
+ }
+ ]
+ },
+ "ChannelPlacementGroupUnassigned": {
+ "description": "Wait until the channel placement group has been unassigned",
+ "operation": "DescribeChannelPlacementGroup",
+ "delay": 5,
+ "maxAttempts": 20,
+ "acceptors": [
+ {
+ "state": "success",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "UNASSIGNED"
+ },
+ {
+ "state": "retry",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "UNASSIGNING"
+ },
+ {
+ "state": "retry",
+ "matcher": "status",
+ "expected": 500
+ }
+ ]
+ },
+ "ChannelPlacementGroupDeleted": {
+ "description": "Wait until the channel placement group has been deleted",
+ "operation": "DescribeChannelPlacementGroup",
+ "delay": 5,
+ "maxAttempts": 20,
+ "acceptors": [
+ {
+ "state": "success",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "DELETED"
+ },
+ {
+ "state": "retry",
+ "matcher": "path",
+ "argument": "State",
+ "expected": "DELETING"
+ },
+ {
+ "state": "retry",
+ "matcher": "status",
+ "expected": 500
+ }
+ ]
}
}
}
diff --git a/services/mediapackage/pom.xml b/services/mediapackage/pom.xml
index 78d05028eb9a..c39825d5b276 100644
--- a/services/mediapackage/pom.xml
+++ b/services/mediapackage/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
mediapackage
diff --git a/services/mediapackagev2/pom.xml b/services/mediapackagev2/pom.xml
index 11b262c8cc2f..1ce6c845ca54 100644
--- a/services/mediapackagev2/pom.xml
+++ b/services/mediapackagev2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
mediapackagev2
AWS Java SDK :: Services :: Media Package V2
diff --git a/services/mediapackagevod/pom.xml b/services/mediapackagevod/pom.xml
index f5171be81b72..81fcdb73cfb2 100644
--- a/services/mediapackagevod/pom.xml
+++ b/services/mediapackagevod/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
mediapackagevod
AWS Java SDK :: Services :: MediaPackage Vod
diff --git a/services/mediastore/pom.xml b/services/mediastore/pom.xml
index bc9f10830a26..34ccdcce0447 100644
--- a/services/mediastore/pom.xml
+++ b/services/mediastore/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
mediastore
diff --git a/services/mediastoredata/pom.xml b/services/mediastoredata/pom.xml
index a0b3258144eb..30d11c9c6b26 100644
--- a/services/mediastoredata/pom.xml
+++ b/services/mediastoredata/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
mediastoredata
diff --git a/services/mediatailor/pom.xml b/services/mediatailor/pom.xml
index 700f9a3b1322..7539517b9fbc 100644
--- a/services/mediatailor/pom.xml
+++ b/services/mediatailor/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
mediatailor
AWS Java SDK :: Services :: MediaTailor
diff --git a/services/medicalimaging/pom.xml b/services/medicalimaging/pom.xml
index 8041bf0d9e9d..1164b4741a18 100644
--- a/services/medicalimaging/pom.xml
+++ b/services/medicalimaging/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
medicalimaging
AWS Java SDK :: Services :: Medical Imaging
diff --git a/services/memorydb/pom.xml b/services/memorydb/pom.xml
index 7ee5d43d100a..2400c161696e 100644
--- a/services/memorydb/pom.xml
+++ b/services/memorydb/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
memorydb
AWS Java SDK :: Services :: Memory DB
diff --git a/services/mgn/pom.xml b/services/mgn/pom.xml
index fcd4a48b6517..93dff7bb97b3 100644
--- a/services/mgn/pom.xml
+++ b/services/mgn/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
mgn
AWS Java SDK :: Services :: Mgn
diff --git a/services/migrationhub/pom.xml b/services/migrationhub/pom.xml
index 423354a1c9aa..164cdf00db6a 100644
--- a/services/migrationhub/pom.xml
+++ b/services/migrationhub/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
migrationhub
diff --git a/services/migrationhubconfig/pom.xml b/services/migrationhubconfig/pom.xml
index 2836644fb4f8..7445fea9df56 100644
--- a/services/migrationhubconfig/pom.xml
+++ b/services/migrationhubconfig/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
migrationhubconfig
AWS Java SDK :: Services :: MigrationHub Config
diff --git a/services/migrationhuborchestrator/pom.xml b/services/migrationhuborchestrator/pom.xml
index c30adecc17ba..b655d573829b 100644
--- a/services/migrationhuborchestrator/pom.xml
+++ b/services/migrationhuborchestrator/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
migrationhuborchestrator
AWS Java SDK :: Services :: Migration Hub Orchestrator
diff --git a/services/migrationhubrefactorspaces/pom.xml b/services/migrationhubrefactorspaces/pom.xml
index 99bb432bfa3c..6878dd103a64 100644
--- a/services/migrationhubrefactorspaces/pom.xml
+++ b/services/migrationhubrefactorspaces/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
migrationhubrefactorspaces
AWS Java SDK :: Services :: Migration Hub Refactor Spaces
diff --git a/services/migrationhubstrategy/pom.xml b/services/migrationhubstrategy/pom.xml
index 4db9f4ed007d..f93ed35b3b73 100644
--- a/services/migrationhubstrategy/pom.xml
+++ b/services/migrationhubstrategy/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
migrationhubstrategy
AWS Java SDK :: Services :: Migration Hub Strategy
diff --git a/services/mq/pom.xml b/services/mq/pom.xml
index 101235070a2d..6be89ec45c93 100644
--- a/services/mq/pom.xml
+++ b/services/mq/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
mq
diff --git a/services/mturk/pom.xml b/services/mturk/pom.xml
index 77ea2333e2f1..d50b0ef1422b 100644
--- a/services/mturk/pom.xml
+++ b/services/mturk/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
mturk
AWS Java SDK :: Services :: Amazon Mechanical Turk Requester
diff --git a/services/mwaa/pom.xml b/services/mwaa/pom.xml
index 97a246bbbd46..40546ceb574a 100644
--- a/services/mwaa/pom.xml
+++ b/services/mwaa/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
mwaa
AWS Java SDK :: Services :: MWAA
diff --git a/services/neptune/pom.xml b/services/neptune/pom.xml
index 3f933f772e8a..bd081c21ebed 100644
--- a/services/neptune/pom.xml
+++ b/services/neptune/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
neptune
AWS Java SDK :: Services :: Neptune
diff --git a/services/neptunedata/pom.xml b/services/neptunedata/pom.xml
index 7e89eeb9d205..4927afc2244e 100644
--- a/services/neptunedata/pom.xml
+++ b/services/neptunedata/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
neptunedata
AWS Java SDK :: Services :: Neptunedata
diff --git a/services/neptunegraph/pom.xml b/services/neptunegraph/pom.xml
index 93fe13222d25..0048d0e6daf4 100644
--- a/services/neptunegraph/pom.xml
+++ b/services/neptunegraph/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
neptunegraph
AWS Java SDK :: Services :: Neptune Graph
diff --git a/services/networkfirewall/pom.xml b/services/networkfirewall/pom.xml
index 198baacd09c8..c0d59ba41103 100644
--- a/services/networkfirewall/pom.xml
+++ b/services/networkfirewall/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
networkfirewall
AWS Java SDK :: Services :: Network Firewall
diff --git a/services/networkmanager/pom.xml b/services/networkmanager/pom.xml
index d4b11a39049e..0723dec72ecf 100644
--- a/services/networkmanager/pom.xml
+++ b/services/networkmanager/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
networkmanager
AWS Java SDK :: Services :: NetworkManager
diff --git a/services/networkmonitor/pom.xml b/services/networkmonitor/pom.xml
index cd00e32bd3fb..066740eb1ca0 100644
--- a/services/networkmonitor/pom.xml
+++ b/services/networkmonitor/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
networkmonitor
AWS Java SDK :: Services :: Network Monitor
diff --git a/services/nimble/pom.xml b/services/nimble/pom.xml
index b036c1757ef2..f5acfefff470 100644
--- a/services/nimble/pom.xml
+++ b/services/nimble/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
nimble
AWS Java SDK :: Services :: Nimble
diff --git a/services/oam/pom.xml b/services/oam/pom.xml
index e88ad49e1ce0..85506a82d277 100644
--- a/services/oam/pom.xml
+++ b/services/oam/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
oam
AWS Java SDK :: Services :: OAM
diff --git a/services/omics/pom.xml b/services/omics/pom.xml
index ee6cdd365eb1..277d57381ff0 100644
--- a/services/omics/pom.xml
+++ b/services/omics/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
omics
AWS Java SDK :: Services :: Omics
diff --git a/services/opensearch/pom.xml b/services/opensearch/pom.xml
index ee564ea98b7c..f61a468c65b3 100644
--- a/services/opensearch/pom.xml
+++ b/services/opensearch/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
opensearch
AWS Java SDK :: Services :: Open Search
diff --git a/services/opensearchserverless/pom.xml b/services/opensearchserverless/pom.xml
index f5e744e9783e..b5e870401f11 100644
--- a/services/opensearchserverless/pom.xml
+++ b/services/opensearchserverless/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
opensearchserverless
AWS Java SDK :: Services :: Open Search Serverless
diff --git a/services/opsworks/pom.xml b/services/opsworks/pom.xml
index d69844d3a50e..282809dc7816 100644
--- a/services/opsworks/pom.xml
+++ b/services/opsworks/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
opsworks
AWS Java SDK :: Services :: AWS OpsWorks
diff --git a/services/opsworkscm/pom.xml b/services/opsworkscm/pom.xml
index dca1ed119ea1..fd5f3cc0cc2e 100644
--- a/services/opsworkscm/pom.xml
+++ b/services/opsworkscm/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
opsworkscm
AWS Java SDK :: Services :: AWS OpsWorks for Chef Automate
diff --git a/services/organizations/pom.xml b/services/organizations/pom.xml
index 2585332792d6..00addfc5fa27 100644
--- a/services/organizations/pom.xml
+++ b/services/organizations/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
organizations
AWS Java SDK :: Services :: AWS Organizations
diff --git a/services/osis/pom.xml b/services/osis/pom.xml
index e21309d38c8e..836e2dfe02ab 100644
--- a/services/osis/pom.xml
+++ b/services/osis/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
osis
AWS Java SDK :: Services :: OSIS
diff --git a/services/outposts/pom.xml b/services/outposts/pom.xml
index 088f6d0cd563..968b8ae23a79 100644
--- a/services/outposts/pom.xml
+++ b/services/outposts/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
outposts
AWS Java SDK :: Services :: Outposts
diff --git a/services/panorama/pom.xml b/services/panorama/pom.xml
index 9f0343f03095..ee74e83e0b21 100644
--- a/services/panorama/pom.xml
+++ b/services/panorama/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
panorama
AWS Java SDK :: Services :: Panorama
diff --git a/services/paymentcryptography/pom.xml b/services/paymentcryptography/pom.xml
index 0e1c51fbb1e4..32574d13c37c 100644
--- a/services/paymentcryptography/pom.xml
+++ b/services/paymentcryptography/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
paymentcryptography
AWS Java SDK :: Services :: Payment Cryptography
diff --git a/services/paymentcryptographydata/pom.xml b/services/paymentcryptographydata/pom.xml
index c0091b8b3b02..ef1167cd34f6 100644
--- a/services/paymentcryptographydata/pom.xml
+++ b/services/paymentcryptographydata/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
paymentcryptographydata
AWS Java SDK :: Services :: Payment Cryptography Data
diff --git a/services/pcaconnectorad/pom.xml b/services/pcaconnectorad/pom.xml
index c761f8c9ba5a..a6505d5db470 100644
--- a/services/pcaconnectorad/pom.xml
+++ b/services/pcaconnectorad/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
pcaconnectorad
AWS Java SDK :: Services :: Pca Connector Ad
diff --git a/services/pcaconnectorscep/pom.xml b/services/pcaconnectorscep/pom.xml
index e29a1518b57d..c14f589eb1b5 100644
--- a/services/pcaconnectorscep/pom.xml
+++ b/services/pcaconnectorscep/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
pcaconnectorscep
AWS Java SDK :: Services :: Pca Connector Scep
diff --git a/services/pcs/pom.xml b/services/pcs/pom.xml
index 6ac1e293a0d9..77c1e5dccf72 100644
--- a/services/pcs/pom.xml
+++ b/services/pcs/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
pcs
AWS Java SDK :: Services :: PCS
diff --git a/services/personalize/pom.xml b/services/personalize/pom.xml
index 9659be29de0f..98dd7abd009a 100644
--- a/services/personalize/pom.xml
+++ b/services/personalize/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
personalize
AWS Java SDK :: Services :: Personalize
diff --git a/services/personalizeevents/pom.xml b/services/personalizeevents/pom.xml
index 9ec232484811..fae79bc936ec 100644
--- a/services/personalizeevents/pom.xml
+++ b/services/personalizeevents/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
personalizeevents
AWS Java SDK :: Services :: Personalize Events
diff --git a/services/personalizeruntime/pom.xml b/services/personalizeruntime/pom.xml
index 8b0bf3237916..b05f60b3dade 100644
--- a/services/personalizeruntime/pom.xml
+++ b/services/personalizeruntime/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
personalizeruntime
AWS Java SDK :: Services :: Personalize Runtime
diff --git a/services/pi/pom.xml b/services/pi/pom.xml
index 3a28c6b2412e..c044851c8c54 100644
--- a/services/pi/pom.xml
+++ b/services/pi/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
pi
AWS Java SDK :: Services :: PI
diff --git a/services/pinpoint/pom.xml b/services/pinpoint/pom.xml
index d7db3efb9cdb..15aefcaf4b5d 100644
--- a/services/pinpoint/pom.xml
+++ b/services/pinpoint/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
pinpoint
AWS Java SDK :: Services :: Amazon Pinpoint
diff --git a/services/pinpointemail/pom.xml b/services/pinpointemail/pom.xml
index a5fababf0bac..7f7c54ba3c71 100644
--- a/services/pinpointemail/pom.xml
+++ b/services/pinpointemail/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
pinpointemail
AWS Java SDK :: Services :: Pinpoint Email
diff --git a/services/pinpointsmsvoice/pom.xml b/services/pinpointsmsvoice/pom.xml
index 0cefcb74dbac..62f35b758f76 100644
--- a/services/pinpointsmsvoice/pom.xml
+++ b/services/pinpointsmsvoice/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
pinpointsmsvoice
AWS Java SDK :: Services :: Pinpoint SMS Voice
diff --git a/services/pinpointsmsvoicev2/pom.xml b/services/pinpointsmsvoicev2/pom.xml
index 083497bf43eb..774032304d74 100644
--- a/services/pinpointsmsvoicev2/pom.xml
+++ b/services/pinpointsmsvoicev2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
pinpointsmsvoicev2
AWS Java SDK :: Services :: Pinpoint SMS Voice V2
diff --git a/services/pipes/pom.xml b/services/pipes/pom.xml
index 557f74919c50..650587348171 100644
--- a/services/pipes/pom.xml
+++ b/services/pipes/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
pipes
AWS Java SDK :: Services :: Pipes
diff --git a/services/pipes/src/main/resources/codegen-resources/service-2.json b/services/pipes/src/main/resources/codegen-resources/service-2.json
index a8b133762058..9aa12e8b64c1 100644
--- a/services/pipes/src/main/resources/codegen-resources/service-2.json
+++ b/services/pipes/src/main/resources/codegen-resources/service-2.json
@@ -2,6 +2,7 @@
"version":"2.0",
"metadata":{
"apiVersion":"2015-10-07",
+ "auth":["aws.auth#sigv4"],
"endpointPrefix":"pipes",
"protocol":"rest-json",
"protocols":["rest-json"],
@@ -521,6 +522,10 @@
"LogConfiguration":{
"shape":"PipeLogConfigurationParameters",
"documentation":"The logging configuration settings for the pipe.
"
+ },
+ "KmsKeyIdentifier":{
+ "shape":"KmsKeyIdentifier",
+ "documentation":"The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt pipe data.
For more information, see Managing keys in the Key Management Service Developer Guide.
"
}
}
},
@@ -700,6 +705,10 @@
"LogConfiguration":{
"shape":"PipeLogConfiguration",
"documentation":"The logging configuration settings for the pipe.
"
+ },
+ "KmsKeyIdentifier":{
+ "shape":"KmsKeyIdentifier",
+ "documentation":"The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.
For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
"
}
}
},
@@ -1125,6 +1134,12 @@
"AT_TIMESTAMP"
]
},
+ "KmsKeyIdentifier":{
+ "type":"string",
+ "max":2048,
+ "min":0,
+ "pattern":"[a-zA-Z0-9_\\-/:]*"
+ },
"LaunchType":{
"type":"string",
"enum":[
@@ -2393,7 +2408,7 @@
},
"OutputFormat":{
"shape":"S3OutputFormat",
- "documentation":"The format EventBridge uses for the log records.
"
+ "documentation":"The format EventBridge uses for the log records.
EventBridge currently only supports json formatting.
"
}
},
"documentation":"The Amazon S3 logging configuration settings for the pipe.
"
@@ -2415,7 +2430,7 @@
},
"OutputFormat":{
"shape":"S3OutputFormat",
- "documentation":"How EventBridge should format the log records.
"
+ "documentation":"How EventBridge should format the log records.
EventBridge currently only supports json formatting.
"
},
"Prefix":{
"shape":"S3LogDestinationParametersPrefixString",
@@ -2556,7 +2571,7 @@
},
"SecurityGroup":{
"shape":"SecurityGroupIds",
- "documentation":"Specifies the security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
"
+ "documentation":"Specifies the security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many as five security groups.
"
}
},
"documentation":"This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
"
@@ -2963,6 +2978,10 @@
"LogConfiguration":{
"shape":"PipeLogConfigurationParameters",
"documentation":"The logging configuration settings for the pipe.
"
+ },
+ "KmsKeyIdentifier":{
+ "shape":"KmsKeyIdentifier",
+ "documentation":"The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.
To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.
For more information, see Managing keys in the Key Management Service Developer Guide.
"
}
}
},
diff --git a/services/polly/pom.xml b/services/polly/pom.xml
index faf637e243a8..fef4040cb964 100644
--- a/services/polly/pom.xml
+++ b/services/polly/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
polly
AWS Java SDK :: Services :: Amazon Polly
diff --git a/services/pom.xml b/services/pom.xml
index d2ed0fe3b677..3994f74d9e88 100644
--- a/services/pom.xml
+++ b/services/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
aws-sdk-java-pom
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
services
AWS Java SDK :: Services
diff --git a/services/pricing/pom.xml b/services/pricing/pom.xml
index 1cf89af92edc..0f3dddafb53d 100644
--- a/services/pricing/pom.xml
+++ b/services/pricing/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
pricing
diff --git a/services/privatenetworks/pom.xml b/services/privatenetworks/pom.xml
index ad3afefda563..77ba3931f4b2 100644
--- a/services/privatenetworks/pom.xml
+++ b/services/privatenetworks/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
privatenetworks
AWS Java SDK :: Services :: Private Networks
diff --git a/services/proton/pom.xml b/services/proton/pom.xml
index ad7d6b2c0f7f..ea13238d3991 100644
--- a/services/proton/pom.xml
+++ b/services/proton/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
proton
AWS Java SDK :: Services :: Proton
diff --git a/services/qapps/pom.xml b/services/qapps/pom.xml
index 82b680d3e393..9d72ff92b45c 100644
--- a/services/qapps/pom.xml
+++ b/services/qapps/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
qapps
AWS Java SDK :: Services :: Q Apps
diff --git a/services/qapps/src/main/resources/codegen-resources/service-2.json b/services/qapps/src/main/resources/codegen-resources/service-2.json
index bdda103f4c8c..cce8be26c806 100644
--- a/services/qapps/src/main/resources/codegen-resources/service-2.json
+++ b/services/qapps/src/main/resources/codegen-resources/service-2.json
@@ -24,6 +24,7 @@
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"InternalServerException"},
{"shape":"UnauthorizedException"},
@@ -142,6 +143,7 @@
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"InternalServerException"},
{"shape":"UnauthorizedException"},
@@ -410,12 +412,33 @@
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"InternalServerException"},
{"shape":"UnauthorizedException"},
{"shape":"ThrottlingException"}
],
- "documentation":"Updates the metadata and status of a library item for an Amazon Q App.
"
+ "documentation":"Updates the library item for an Amazon Q App.
"
+ },
+ "UpdateLibraryItemMetadata":{
+ "name":"UpdateLibraryItemMetadata",
+ "http":{
+ "method":"POST",
+ "requestUri":"/catalog.updateItemMetadata",
+ "responseCode":200
+ },
+ "input":{"shape":"UpdateLibraryItemMetadataInput"},
+ "errors":[
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ConflictException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"UnauthorizedException"},
+ {"shape":"ThrottlingException"}
+ ],
+ "documentation":"Updates the verification status of a library item for an Amazon Q App.
",
+ "idempotent":true
},
"UpdateQApp":{
"name":"UpdateQApp",
@@ -929,6 +952,10 @@
"ratingCount":{
"shape":"Integer",
"documentation":"The number of ratings the library item has received from users.
"
+ },
+ "isVerified":{
+ "shape":"Boolean",
+ "documentation":"Indicates whether the library item has been verified.
"
}
}
},
@@ -1356,6 +1383,10 @@
"userCount":{
"shape":"Integer",
"documentation":"The number of users who have associated the Q App with their account.
"
+ },
+ "isVerified":{
+ "shape":"Boolean",
+ "documentation":"Indicates whether the library item has been verified.
"
}
}
},
@@ -1641,6 +1672,10 @@
"userCount":{
"shape":"Integer",
"documentation":"The number of users who have the associated Q App.
"
+ },
+ "isVerified":{
+ "shape":"Boolean",
+ "documentation":"Indicates whether the library item has been verified.
"
}
},
"documentation":"A library item is a snapshot of an Amazon Q App that can be published so the users in their Amazon Q Apps library can discover it, clone it, and run it.
"
@@ -2327,7 +2362,8 @@
"Title":{
"type":"string",
"max":100,
- "min":0
+ "min":0,
+ "pattern":"[^{}\\\\\"<>]+"
},
"UUID":{
"type":"string",
@@ -2399,6 +2435,29 @@
}
}
},
+ "UpdateLibraryItemMetadataInput":{
+ "type":"structure",
+ "required":[
+ "instanceId",
+ "libraryItemId"
+ ],
+ "members":{
+ "instanceId":{
+ "shape":"InstanceId",
+ "documentation":"The unique identifier of the Amazon Q Business application environment instance.
",
+ "location":"header",
+ "locationName":"instance-id"
+ },
+ "libraryItemId":{
+ "shape":"UUID",
+ "documentation":"The unique identifier of the updated library item.
"
+ },
+ "isVerified":{
+ "shape":"Boolean",
+ "documentation":"The verification status of the library item
"
+ }
+ }
+ },
"UpdateLibraryItemOutput":{
"type":"structure",
"required":[
@@ -2459,6 +2518,10 @@
"userCount":{
"shape":"Integer",
"documentation":"The number of users who have the associated Q App.
"
+ },
+ "isVerified":{
+ "shape":"Boolean",
+ "documentation":"Indicates whether the library item has been verified.
"
}
}
},
@@ -2633,6 +2696,10 @@
"status":{
"shape":"String",
"documentation":"The status of the user's association with the Q App.
"
+ },
+ "isVerified":{
+ "shape":"Boolean",
+ "documentation":"Indicates whether the Q App has been verified.
"
}
},
"documentation":"An Amazon Q App associated with a user, either owned by the user or favorited.
"
@@ -2655,5 +2722,5 @@
"exception":true
}
},
- "documentation":"The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create an Q Appthat exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for marketing content-generation like writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information, see Amazon Q App in the Amazon Q Business User Guide.
"
+ "documentation":"The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create a Q App that exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information on the capabilities, see Amazon Q Apps capabilities in the Amazon Q Business User Guide.
For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API operations.
For information about the IAM access control permissions you need to use the Amazon Q Apps API, see IAM role for the Amazon Q Business web experience including Amazon Q Apps in the Amazon Q Business User Guide.
"
}
diff --git a/services/qbusiness/pom.xml b/services/qbusiness/pom.xml
index de0cdcc5e3b8..6ba50f0a8423 100644
--- a/services/qbusiness/pom.xml
+++ b/services/qbusiness/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
qbusiness
AWS Java SDK :: Services :: Q Business
diff --git a/services/qconnect/pom.xml b/services/qconnect/pom.xml
index d3986ac924e3..88b8a8d2b5f7 100644
--- a/services/qconnect/pom.xml
+++ b/services/qconnect/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
qconnect
AWS Java SDK :: Services :: Q Connect
diff --git a/services/qldb/pom.xml b/services/qldb/pom.xml
index ea3c1e4e42a7..3747585bec86 100644
--- a/services/qldb/pom.xml
+++ b/services/qldb/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
qldb
AWS Java SDK :: Services :: QLDB
diff --git a/services/qldbsession/pom.xml b/services/qldbsession/pom.xml
index 2c3701b53abc..1256d261777b 100644
--- a/services/qldbsession/pom.xml
+++ b/services/qldbsession/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
qldbsession
AWS Java SDK :: Services :: QLDB Session
diff --git a/services/quicksight/pom.xml b/services/quicksight/pom.xml
index b0eb4c6e34f3..9aac239df101 100644
--- a/services/quicksight/pom.xml
+++ b/services/quicksight/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
quicksight
AWS Java SDK :: Services :: QuickSight
diff --git a/services/ram/pom.xml b/services/ram/pom.xml
index 4ef924abad78..8022133693f4 100644
--- a/services/ram/pom.xml
+++ b/services/ram/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ram
AWS Java SDK :: Services :: RAM
diff --git a/services/rbin/pom.xml b/services/rbin/pom.xml
index 06249fd0e598..05ec9954f942 100644
--- a/services/rbin/pom.xml
+++ b/services/rbin/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
rbin
AWS Java SDK :: Services :: Rbin
diff --git a/services/rds/pom.xml b/services/rds/pom.xml
index 16458e4ddb65..f396d59a8e60 100644
--- a/services/rds/pom.xml
+++ b/services/rds/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
rds
AWS Java SDK :: Services :: Amazon RDS
diff --git a/services/rdsdata/pom.xml b/services/rdsdata/pom.xml
index bba77a8934d6..9ffdad73f089 100644
--- a/services/rdsdata/pom.xml
+++ b/services/rdsdata/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
rdsdata
AWS Java SDK :: Services :: RDS Data
diff --git a/services/redshift/pom.xml b/services/redshift/pom.xml
index 266eb56a6856..e2c2f9cfd328 100644
--- a/services/redshift/pom.xml
+++ b/services/redshift/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
redshift
AWS Java SDK :: Services :: Amazon Redshift
diff --git a/services/redshiftdata/pom.xml b/services/redshiftdata/pom.xml
index ff332bbb8b88..cd1d4815bcf0 100644
--- a/services/redshiftdata/pom.xml
+++ b/services/redshiftdata/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
redshiftdata
AWS Java SDK :: Services :: Redshift Data
diff --git a/services/redshiftserverless/pom.xml b/services/redshiftserverless/pom.xml
index e2016c775318..b4b36e111ba9 100644
--- a/services/redshiftserverless/pom.xml
+++ b/services/redshiftserverless/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
redshiftserverless
AWS Java SDK :: Services :: Redshift Serverless
diff --git a/services/rekognition/pom.xml b/services/rekognition/pom.xml
index 3e9118e4bf3e..7f91e976a71c 100644
--- a/services/rekognition/pom.xml
+++ b/services/rekognition/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
rekognition
AWS Java SDK :: Services :: Amazon Rekognition
diff --git a/services/repostspace/pom.xml b/services/repostspace/pom.xml
index 30bb586c9a79..1e1ae7e663de 100644
--- a/services/repostspace/pom.xml
+++ b/services/repostspace/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
repostspace
AWS Java SDK :: Services :: Repostspace
diff --git a/services/resiliencehub/pom.xml b/services/resiliencehub/pom.xml
index 459d1a3344ef..9d7b3bba276a 100644
--- a/services/resiliencehub/pom.xml
+++ b/services/resiliencehub/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
resiliencehub
AWS Java SDK :: Services :: Resiliencehub
diff --git a/services/resourceexplorer2/pom.xml b/services/resourceexplorer2/pom.xml
index 321e790b72c8..e3785a6abaee 100644
--- a/services/resourceexplorer2/pom.xml
+++ b/services/resourceexplorer2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
resourceexplorer2
AWS Java SDK :: Services :: Resource Explorer 2
diff --git a/services/resourcegroups/pom.xml b/services/resourcegroups/pom.xml
index 8c6d0ab715b3..ea1b16ceb2a5 100644
--- a/services/resourcegroups/pom.xml
+++ b/services/resourcegroups/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
resourcegroups
diff --git a/services/resourcegroupstaggingapi/pom.xml b/services/resourcegroupstaggingapi/pom.xml
index 2d11beb3f3ad..4826ee8e23c8 100644
--- a/services/resourcegroupstaggingapi/pom.xml
+++ b/services/resourcegroupstaggingapi/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
resourcegroupstaggingapi
AWS Java SDK :: Services :: AWS Resource Groups Tagging API
diff --git a/services/robomaker/pom.xml b/services/robomaker/pom.xml
index 0a7c3911a73d..6b926736f2d6 100644
--- a/services/robomaker/pom.xml
+++ b/services/robomaker/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
robomaker
AWS Java SDK :: Services :: RoboMaker
diff --git a/services/rolesanywhere/pom.xml b/services/rolesanywhere/pom.xml
index e7a09caf432c..887767bde9f6 100644
--- a/services/rolesanywhere/pom.xml
+++ b/services/rolesanywhere/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
rolesanywhere
AWS Java SDK :: Services :: Roles Anywhere
diff --git a/services/route53/pom.xml b/services/route53/pom.xml
index ca0b1d7a5812..e86af980aaae 100644
--- a/services/route53/pom.xml
+++ b/services/route53/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
route53
AWS Java SDK :: Services :: Amazon Route53
diff --git a/services/route53domains/pom.xml b/services/route53domains/pom.xml
index bf911243e094..cbb48ac26b91 100644
--- a/services/route53domains/pom.xml
+++ b/services/route53domains/pom.xml
@@ -22,7 +22,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
route53domains
AWS Java SDK :: Services :: Amazon Route53 Domains
diff --git a/services/route53profiles/pom.xml b/services/route53profiles/pom.xml
index 6aa1e5a9b11a..0ef2549382a1 100644
--- a/services/route53profiles/pom.xml
+++ b/services/route53profiles/pom.xml
@@ -17,7 +17,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
route53profiles
AWS Java SDK :: Services :: Route53 Profiles
diff --git a/services/route53recoverycluster/pom.xml b/services/route53recoverycluster/pom.xml
index f6287f05fccc..19524b96da49 100644
--- a/services/route53recoverycluster/pom.xml
+++ b/services/route53recoverycluster/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
route53recoverycluster
AWS Java SDK :: Services :: Route53 Recovery Cluster
diff --git a/services/route53recoverycontrolconfig/pom.xml b/services/route53recoverycontrolconfig/pom.xml
index 4929cdba7acd..2527e19632cb 100644
--- a/services/route53recoverycontrolconfig/pom.xml
+++ b/services/route53recoverycontrolconfig/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
route53recoverycontrolconfig
AWS Java SDK :: Services :: Route53 Recovery Control Config
diff --git a/services/route53recoveryreadiness/pom.xml b/services/route53recoveryreadiness/pom.xml
index 64fc6e59213a..3bc1d6d618ce 100644
--- a/services/route53recoveryreadiness/pom.xml
+++ b/services/route53recoveryreadiness/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
route53recoveryreadiness
AWS Java SDK :: Services :: Route53 Recovery Readiness
diff --git a/services/route53resolver/pom.xml b/services/route53resolver/pom.xml
index d0a64a3ff39d..0d2a9d756fa4 100644
--- a/services/route53resolver/pom.xml
+++ b/services/route53resolver/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
route53resolver
AWS Java SDK :: Services :: Route53Resolver
diff --git a/services/rum/pom.xml b/services/rum/pom.xml
index 297f965b0988..6caf36b3b779 100644
--- a/services/rum/pom.xml
+++ b/services/rum/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
rum
AWS Java SDK :: Services :: RUM
diff --git a/services/s3/pom.xml b/services/s3/pom.xml
index afbeaca16362..fb27d235325b 100644
--- a/services/s3/pom.xml
+++ b/services/s3/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
s3
AWS Java SDK :: Services :: Amazon S3
diff --git a/services/s3control/pom.xml b/services/s3control/pom.xml
index 578e44cdf4fc..0849b437ecc0 100644
--- a/services/s3control/pom.xml
+++ b/services/s3control/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
s3control
AWS Java SDK :: Services :: Amazon S3 Control
diff --git a/services/s3outposts/pom.xml b/services/s3outposts/pom.xml
index b3357853a654..186308ccb181 100644
--- a/services/s3outposts/pom.xml
+++ b/services/s3outposts/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
s3outposts
AWS Java SDK :: Services :: S3 Outposts
diff --git a/services/sagemaker/pom.xml b/services/sagemaker/pom.xml
index 17658a8a1946..5f78dedce020 100644
--- a/services/sagemaker/pom.xml
+++ b/services/sagemaker/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
sagemaker
diff --git a/services/sagemaker/src/main/resources/codegen-resources/service-2.json b/services/sagemaker/src/main/resources/codegen-resources/service-2.json
index 25495dadcca7..e6271915fa20 100644
--- a/services/sagemaker/src/main/resources/codegen-resources/service-2.json
+++ b/services/sagemaker/src/main/resources/codegen-resources/service-2.json
@@ -7256,7 +7256,7 @@
"documentation":"Details of LifeCycle configuration for the instance group.
"
},
"ExecutionRole":{
- "shape":"IAMRoleArn",
+ "shape":"RoleArn",
"documentation":"The execution role for the instance group to assume.
"
},
"ThreadsPerCore":{
@@ -7266,6 +7266,10 @@
"InstanceStorageConfigs":{
"shape":"ClusterInstanceStorageConfigs",
"documentation":"The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
"
+ },
+ "OnStartDeepHealthChecks":{
+ "shape":"OnStartDeepHealthChecks",
+ "documentation":"A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
"
}
},
"documentation":"Details of an instance group in a SageMaker HyperPod cluster.
"
@@ -7307,7 +7311,7 @@
"documentation":"Specifies the LifeCycle configuration for the instance group.
"
},
"ExecutionRole":{
- "shape":"IAMRoleArn",
+ "shape":"RoleArn",
"documentation":"Specifies an IAM execution role to be assumed by the instance group.
"
},
"ThreadsPerCore":{
@@ -7317,6 +7321,10 @@
"InstanceStorageConfigs":{
"shape":"ClusterInstanceStorageConfigs",
"documentation":"Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
"
+ },
+ "OnStartDeepHealthChecks":{
+ "shape":"OnStartDeepHealthChecks",
+ "documentation":"A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
"
}
},
"documentation":"The specifications of an instance group that you need to define.
"
@@ -7348,7 +7356,8 @@
"Failure",
"Pending",
"ShuttingDown",
- "SystemUpdating"
+ "SystemUpdating",
+ "DeepHealthCheckInProgress"
]
},
"ClusterInstanceStatusDetails":{
@@ -7516,6 +7525,13 @@
"min":1,
"pattern":"^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$"
},
+ "ClusterNodeRecovery":{
+ "type":"string",
+ "enum":[
+ "Automatic",
+ "None"
+ ]
+ },
"ClusterNodeSummaries":{
"type":"list",
"member":{"shape":"ClusterNodeSummary"}
@@ -7557,6 +7573,28 @@
"type":"integer",
"min":0
},
+ "ClusterOrchestrator":{
+ "type":"structure",
+ "required":["Eks"],
+ "members":{
+ "Eks":{
+ "shape":"ClusterOrchestratorEksConfig",
+ "documentation":"The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
"
+ }
+ },
+ "documentation":"The type of orchestrator used for the SageMaker HyperPod cluster.
"
+ },
+ "ClusterOrchestratorEksConfig":{
+ "type":"structure",
+ "required":["ClusterArn"],
+ "members":{
+ "ClusterArn":{
+ "shape":"EksClusterArn",
+ "documentation":"The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.
"
+ }
+ },
+ "documentation":"The configuration settings for the Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
"
+ },
"ClusterPrivateDnsHostname":{
"type":"string",
"pattern":"^ip-((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)-?\\b){4}\\..*$"
@@ -7643,7 +7681,7 @@
},
"AppLifecycleManagement":{
"shape":"AppLifecycleManagement",
- "documentation":"Settings that are used to configure and manage the lifecycle of CodeEditor applications.
"
+ "documentation":"Settings that are used to configure and manage the lifecycle of CodeEditor applications.
"
}
},
"documentation":"The Code Editor application settings.
For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.
"
@@ -8620,6 +8658,14 @@
"Tags":{
"shape":"TagList",
"documentation":"Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.
"
+ },
+ "Orchestrator":{
+ "shape":"ClusterOrchestrator",
+ "documentation":"The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is \"eks\", which is to use an Amazon Elastic Kubernetes Service (EKS) cluster as the orchestrator.
"
+ },
+ "NodeRecovery":{
+ "shape":"ClusterNodeRecovery",
+ "documentation":"The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.
"
}
}
},
@@ -11626,6 +11672,13 @@
"max":20,
"min":0
},
+ "DeepHealthCheckType":{
+ "type":"string",
+ "enum":[
+ "InstanceStress",
+ "InstanceConnectivity"
+ ]
+ },
"DefaultEbsStorageSettings":{
"type":"structure",
"required":[
@@ -13208,7 +13261,15 @@
"shape":"ClusterInstanceGroupDetailsList",
"documentation":"The instance groups of the SageMaker HyperPod cluster.
"
},
- "VpcConfig":{"shape":"VpcConfig"}
+ "VpcConfig":{"shape":"VpcConfig"},
+ "Orchestrator":{
+ "shape":"ClusterOrchestrator",
+ "documentation":"The type of orchestrator used for the SageMaker HyperPod cluster.
"
+ },
+ "NodeRecovery":{
+ "shape":"ClusterNodeRecovery",
+ "documentation":"The node recovery mode configured for the SageMaker HyperPod cluster.
"
+ }
}
},
"DescribeCodeRepositoryInput":{
@@ -18055,6 +18116,12 @@
"max":10,
"pattern":"\\d+"
},
+ "EksClusterArn":{
+ "type":"string",
+ "max":2048,
+ "min":20,
+ "pattern":"^arn:aws[a-z\\-]*:eks:[a-z0-9\\-]*:[0-9]{12}:cluster\\/[0-9A-Za-z][A-Za-z0-9\\-_]{0,99}$"
+ },
"EmrServerlessComputeConfig":{
"type":"structure",
"required":["ExecutionRoleARN"],
@@ -20832,12 +20899,6 @@
"type":"integer",
"min":1
},
- "IAMRoleArn":{
- "type":"string",
- "max":2048,
- "min":20,
- "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:role/[\\w+=,.@-]{1,64}$"
- },
"IamIdentity":{
"type":"structure",
"members":{
@@ -30091,6 +30152,12 @@
},
"documentation":"A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.
"
},
+ "OnStartDeepHealthChecks":{
+ "type":"list",
+ "member":{"shape":"DeepHealthCheckType"},
+ "max":2,
+ "min":1
+ },
"OnlineStoreConfig":{
"type":"structure",
"members":{
@@ -37844,6 +37911,10 @@
"InstanceGroups":{
"shape":"ClusterInstanceGroupSpecifications",
"documentation":"Specify the instance groups to update.
"
+ },
+ "NodeRecovery":{
+ "shape":"ClusterNodeRecovery",
+ "documentation":"The node recovery mode to be applied to the SageMaker HyperPod cluster.
"
}
}
},
diff --git a/services/sagemakera2iruntime/pom.xml b/services/sagemakera2iruntime/pom.xml
index bc931cbec02e..9f072ac12763 100644
--- a/services/sagemakera2iruntime/pom.xml
+++ b/services/sagemakera2iruntime/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
sagemakera2iruntime
AWS Java SDK :: Services :: SageMaker A2I Runtime
diff --git a/services/sagemakeredge/pom.xml b/services/sagemakeredge/pom.xml
index 70d9b4c87b29..0cae6c22e16f 100644
--- a/services/sagemakeredge/pom.xml
+++ b/services/sagemakeredge/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
sagemakeredge
AWS Java SDK :: Services :: Sagemaker Edge
diff --git a/services/sagemakerfeaturestoreruntime/pom.xml b/services/sagemakerfeaturestoreruntime/pom.xml
index 7459b77c55c9..bbdaadd29ca4 100644
--- a/services/sagemakerfeaturestoreruntime/pom.xml
+++ b/services/sagemakerfeaturestoreruntime/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
sagemakerfeaturestoreruntime
AWS Java SDK :: Services :: Sage Maker Feature Store Runtime
diff --git a/services/sagemakergeospatial/pom.xml b/services/sagemakergeospatial/pom.xml
index aae19a552ee6..7714e7f800be 100644
--- a/services/sagemakergeospatial/pom.xml
+++ b/services/sagemakergeospatial/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
sagemakergeospatial
AWS Java SDK :: Services :: Sage Maker Geospatial
diff --git a/services/sagemakermetrics/pom.xml b/services/sagemakermetrics/pom.xml
index 5a423adaced3..48a2128d8423 100644
--- a/services/sagemakermetrics/pom.xml
+++ b/services/sagemakermetrics/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
sagemakermetrics
AWS Java SDK :: Services :: Sage Maker Metrics
diff --git a/services/sagemakerruntime/pom.xml b/services/sagemakerruntime/pom.xml
index 728f17874178..e01d89897fd8 100644
--- a/services/sagemakerruntime/pom.xml
+++ b/services/sagemakerruntime/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
sagemakerruntime
AWS Java SDK :: Services :: SageMaker Runtime
diff --git a/services/sagemakerruntime/src/main/resources/codegen-resources/service-2.json b/services/sagemakerruntime/src/main/resources/codegen-resources/service-2.json
index 55bdb9d6f106..dcb227bae296 100644
--- a/services/sagemakerruntime/src/main/resources/codegen-resources/service-2.json
+++ b/services/sagemakerruntime/src/main/resources/codegen-resources/service-2.json
@@ -5,11 +5,13 @@
"endpointPrefix":"runtime.sagemaker",
"jsonVersion":"1.1",
"protocol":"rest-json",
+ "protocols":["rest-json"],
"serviceFullName":"Amazon SageMaker Runtime",
"serviceId":"SageMaker Runtime",
"signatureVersion":"v4",
"signingName":"sagemaker",
- "uid":"runtime.sagemaker-2017-05-13"
+ "uid":"runtime.sagemaker-2017-05-13",
+ "auth":["aws.auth#sigv4"]
},
"operations":{
"InvokeEndpoint":{
@@ -296,6 +298,12 @@
"documentation":"If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke.
",
"location":"header",
"locationName":"X-Amzn-SageMaker-Inference-Component"
+ },
+ "SessionId":{
+ "shape":"SessionIdOrNewSessionConstantHeader",
+ "documentation":"Creates a stateful session or identifies an existing one. You can do one of the following:
With a stateful session, you can send multiple requests to a stateful model. When you create a session with a stateful model, the model must create the session ID and set the expiration time. The model must also provide that information in the response to your request. You can get the ID and timestamp from the NewSessionId response parameter. For any subsequent request where you specify that session ID, SageMaker routes the request to the same instance that supports the session.
",
+ "location":"header",
+ "locationName":"X-Amzn-SageMaker-Session-Id"
}
},
"payload":"Body"
@@ -325,6 +333,18 @@
"documentation":"Provides additional information in the response about the inference returned by a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to return an ID received in the CustomAttributes header of a request or other metadata that a service endpoint was programmed to produce. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the custom attribute returned, the model must set the custom attribute to be included on the way back.
The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with Trace ID: in your post-processing function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.
",
"location":"header",
"locationName":"X-Amzn-SageMaker-Custom-Attributes"
+ },
+ "NewSessionId":{
+ "shape":"NewSessionResponseHeader",
+ "documentation":"If you created a stateful session with your request, the ID and expiration time that the model assigns to that session.
",
+ "location":"header",
+ "locationName":"X-Amzn-SageMaker-New-Session-Id"
+ },
+ "ClosedSessionId":{
+ "shape":"SessionIdHeader",
+ "documentation":"If you closed a stateful session with your request, the ID of that session.
",
+ "location":"header",
+ "locationName":"X-Amzn-SageMaker-Closed-Session-Id"
}
},
"payload":"Body"
@@ -387,6 +407,12 @@
"documentation":"If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke for a streaming response.
",
"location":"header",
"locationName":"X-Amzn-SageMaker-Inference-Component"
+ },
+ "SessionId":{
+ "shape":"SessionIdHeader",
+ "documentation":"The ID of a stateful session to handle your request.
You can't create a stateful session by using the InvokeEndpointWithResponseStream action. Instead, you can create one by using the InvokeEndpoint action. In your request, you specify NEW_SESSION for the SessionId request parameter. The response to that request provides the session ID for the NewSessionId response parameter.
",
+ "location":"header",
+ "locationName":"X-Amzn-SageMaker-Session-Id"
}
},
"payload":"Body"
@@ -466,6 +492,11 @@
"exception":true,
"synthetic":true
},
+ "NewSessionResponseHeader":{
+ "type":"string",
+ "max":256,
+ "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*;\\sExpires=[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
+ },
"PartBlob":{
"type":"blob",
"sensitive":true
@@ -517,6 +548,16 @@
"fault":true,
"synthetic":true
},
+ "SessionIdHeader":{
+ "type":"string",
+ "max":256,
+ "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$"
+ },
+ "SessionIdOrNewSessionConstantHeader":{
+ "type":"string",
+ "max":256,
+ "pattern":"^(NEW_SESSION)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*$"
+ },
"StatusCode":{"type":"integer"},
"TargetContainerHostnameHeader":{
"type":"string",
diff --git a/services/savingsplans/pom.xml b/services/savingsplans/pom.xml
index 3838a3e83b7d..b64857bd8118 100644
--- a/services/savingsplans/pom.xml
+++ b/services/savingsplans/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
savingsplans
AWS Java SDK :: Services :: Savingsplans
diff --git a/services/scheduler/pom.xml b/services/scheduler/pom.xml
index ba03ed8f7bbe..a946bf983138 100644
--- a/services/scheduler/pom.xml
+++ b/services/scheduler/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
scheduler
AWS Java SDK :: Services :: Scheduler
diff --git a/services/schemas/pom.xml b/services/schemas/pom.xml
index ae5192657a47..d4e6ac26fecc 100644
--- a/services/schemas/pom.xml
+++ b/services/schemas/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
schemas
AWS Java SDK :: Services :: Schemas
diff --git a/services/secretsmanager/pom.xml b/services/secretsmanager/pom.xml
index 0c0809436e44..ddfe64bd4a3f 100644
--- a/services/secretsmanager/pom.xml
+++ b/services/secretsmanager/pom.xml
@@ -22,7 +22,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
secretsmanager
AWS Java SDK :: Services :: AWS Secrets Manager
diff --git a/services/securityhub/pom.xml b/services/securityhub/pom.xml
index 303cc27869ae..0133a69a6181 100644
--- a/services/securityhub/pom.xml
+++ b/services/securityhub/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
securityhub
AWS Java SDK :: Services :: SecurityHub
diff --git a/services/securityhub/src/main/resources/codegen-resources/service-2.json b/services/securityhub/src/main/resources/codegen-resources/service-2.json
index d90539e107ad..c24a2fb45072 100644
--- a/services/securityhub/src/main/resources/codegen-resources/service-2.json
+++ b/services/securityhub/src/main/resources/codegen-resources/service-2.json
@@ -2284,7 +2284,7 @@
},
"RemoteIpDetails":{
"shape":"ActionRemoteIpDetails",
- "documentation":"Provided if CallerType is remoteIp. Provides information about the remote IP address that the API call originated from.
"
+ "documentation":"Provided if CallerType is remoteip. Provides information about the remote IP address that the API call originated from.
"
},
"DomainDetails":{
"shape":"AwsApiCallActionDomainDetails",
@@ -15845,30 +15845,30 @@
"members":{
"Status":{
"shape":"ComplianceStatus",
- "documentation":"The result of a standards check.
The valid values for Status are as follows.
-
-
PASSED - Standards check passed for all evaluated resources.
-
WARNING - Some information is missing or this check is not supported for your configuration.
-
FAILED - Standards check failed for at least one evaluated resource.
-
NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE for a Security Hub control, Security Hub automatically archives the finding after 3 days.
"
+ "documentation":"Typically summarizes the result of a control check.
For Security Hub controls, valid values for Status are as follows.
-
-
PASSED - Standards check passed for all evaluated resources.
-
WARNING - Some information is missing or this check is not supported for your configuration.
-
FAILED - Standards check failed for at least one evaluated resource.
-
NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE for a Security Hub control, Security Hub automatically archives the finding after 3 days.
"
},
"RelatedRequirements":{
"shape":"RelatedRequirementsList",
- "documentation":"For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.
Array Members: Maximum number of 32 items.
"
+ "documentation":"Typically provides the industry or regulatory framework requirements that are related to a control. The check for that control is aligned with these requirements.
Array Members: Maximum number of 32 items.
"
},
"StatusReasons":{
"shape":"StatusReasonsList",
- "documentation":"For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.
"
+ "documentation":"Typically used to provide a list of reasons for the value of Status.
"
},
"SecurityControlId":{
"shape":"NonEmptyString",
- "documentation":" The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Servicesservice and a number, such as APIGateway.5.
"
+ "documentation":" Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an Amazon Web Servicesservice and a unique number, such as APIGateway.5.
"
},
"AssociatedStandards":{
"shape":"AssociatedStandardsList",
- "documentation":"The enabled security standards in which a security control is currently enabled.
"
+ "documentation":"Typically provides an array of enabled security standards in which a security control is currently enabled.
"
},
"SecurityControlParameters":{
"shape":"SecurityControlParametersList",
- "documentation":" An object that includes security control parameter names and values.
"
+ "documentation":" Typically an object that includes security control parameter names and values.
"
}
},
- "documentation":"Contains finding details that are specific to control-based findings. Only returned for findings generated from controls.
"
+ "documentation":"This object typically provides details about a control finding, such as applicable standards and the status of control checks. While finding providers can add custom content in Compliance object fields, they are typically used to review details of Security Hub control findings.
"
},
"ComplianceStatus":{
"type":"string",
diff --git a/services/securitylake/pom.xml b/services/securitylake/pom.xml
index 2a73334435b9..62d83e446f8d 100644
--- a/services/securitylake/pom.xml
+++ b/services/securitylake/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
securitylake
AWS Java SDK :: Services :: Security Lake
diff --git a/services/serverlessapplicationrepository/pom.xml b/services/serverlessapplicationrepository/pom.xml
index 5ef13360365d..1b6d3a9bef8d 100644
--- a/services/serverlessapplicationrepository/pom.xml
+++ b/services/serverlessapplicationrepository/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
serverlessapplicationrepository
diff --git a/services/servicecatalog/pom.xml b/services/servicecatalog/pom.xml
index a6abf1987b2e..94f95e79ebb7 100644
--- a/services/servicecatalog/pom.xml
+++ b/services/servicecatalog/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
servicecatalog
AWS Java SDK :: Services :: AWS Service Catalog
diff --git a/services/servicecatalogappregistry/pom.xml b/services/servicecatalogappregistry/pom.xml
index 03703ebd2c45..89195ebd9649 100644
--- a/services/servicecatalogappregistry/pom.xml
+++ b/services/servicecatalogappregistry/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
servicecatalogappregistry
AWS Java SDK :: Services :: Service Catalog App Registry
diff --git a/services/servicediscovery/pom.xml b/services/servicediscovery/pom.xml
index ca22c7cfceee..5a3af42fa91a 100644
--- a/services/servicediscovery/pom.xml
+++ b/services/servicediscovery/pom.xml
@@ -20,7 +20,7 @@
services
software.amazon.awssdk
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
4.0.0
servicediscovery
diff --git a/services/servicequotas/pom.xml b/services/servicequotas/pom.xml
index bd64b52c8403..d30f7d1b603f 100644
--- a/services/servicequotas/pom.xml
+++ b/services/servicequotas/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
servicequotas
AWS Java SDK :: Services :: Service Quotas
diff --git a/services/ses/pom.xml b/services/ses/pom.xml
index f286935639f8..6d87c0bac491 100644
--- a/services/ses/pom.xml
+++ b/services/ses/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
ses
AWS Java SDK :: Services :: Amazon SES
diff --git a/services/sesv2/pom.xml b/services/sesv2/pom.xml
index 4ed66e3dc2f7..b9bf9cfe18c0 100644
--- a/services/sesv2/pom.xml
+++ b/services/sesv2/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
sesv2
AWS Java SDK :: Services :: SESv2
diff --git a/services/sfn/pom.xml b/services/sfn/pom.xml
index 55ea2139336b..54a4fc522b29 100644
--- a/services/sfn/pom.xml
+++ b/services/sfn/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
sfn
AWS Java SDK :: Services :: AWS Step Functions
diff --git a/services/shield/pom.xml b/services/shield/pom.xml
index 9eee51a43010..0a2719b0d549 100644
--- a/services/shield/pom.xml
+++ b/services/shield/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
shield
AWS Java SDK :: Services :: AWS Shield
diff --git a/services/signer/pom.xml b/services/signer/pom.xml
index 05a0dc0a93c9..6d1183aeb36d 100644
--- a/services/signer/pom.xml
+++ b/services/signer/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
signer
AWS Java SDK :: Services :: Signer
diff --git a/services/simspaceweaver/pom.xml b/services/simspaceweaver/pom.xml
index 9a6690d80f64..743200e5c6d9 100644
--- a/services/simspaceweaver/pom.xml
+++ b/services/simspaceweaver/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
simspaceweaver
AWS Java SDK :: Services :: Sim Space Weaver
diff --git a/services/sms/pom.xml b/services/sms/pom.xml
index a93efc423ea0..883368f4e8b1 100644
--- a/services/sms/pom.xml
+++ b/services/sms/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
sms
AWS Java SDK :: Services :: AWS Server Migration
diff --git a/services/snowball/pom.xml b/services/snowball/pom.xml
index 0bc373161871..5674c0429f67 100644
--- a/services/snowball/pom.xml
+++ b/services/snowball/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
snowball
AWS Java SDK :: Services :: Amazon Snowball
diff --git a/services/snowdevicemanagement/pom.xml b/services/snowdevicemanagement/pom.xml
index c1b8d23bb38a..465054404a8c 100644
--- a/services/snowdevicemanagement/pom.xml
+++ b/services/snowdevicemanagement/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
snowdevicemanagement
AWS Java SDK :: Services :: Snow Device Management
diff --git a/services/sns/pom.xml b/services/sns/pom.xml
index 07b07025c9f6..5e7bc43953b1 100644
--- a/services/sns/pom.xml
+++ b/services/sns/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
sns
AWS Java SDK :: Services :: Amazon SNS
diff --git a/services/sqs/pom.xml b/services/sqs/pom.xml
index 0d3a6d46e220..00f55724d9bf 100644
--- a/services/sqs/pom.xml
+++ b/services/sqs/pom.xml
@@ -21,7 +21,7 @@
software.amazon.awssdk
services
- 2.27.21-SNAPSHOT
+ 2.28.0-SNAPSHOT
sqs
AWS Java SDK :: Services :: Amazon SQS
@@ -91,5 +91,26 @@
${awsjavasdk.version}
test
+
+ org.junit.jupiter
+ junit-jupiter
+ test
+
+
+ nl.jqno.equalsverifier
+ equalsverifier
+ test
+
+
+ org.assertj
+ assertj-core
+ test
+
+
+ org.mockito
+ mockito-junit-jupiter
+ test
+
+
diff --git a/services/sqs/src/it/java/software/amazon/awssdk/services/sqs/RequestBatchManagerSqsIntegrationTest.java b/services/sqs/src/it/java/software/amazon/awssdk/services/sqs/RequestBatchManagerSqsIntegrationTest.java
new file mode 100644
index 000000000000..5faf289cda17
--- /dev/null
+++ b/services/sqs/src/it/java/software/amazon/awssdk/services/sqs/RequestBatchManagerSqsIntegrationTest.java
@@ -0,0 +1,460 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.nio.charset.StandardCharsets;
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import java.util.stream.Stream;
+
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.TestInstance;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import software.amazon.awssdk.services.sqs.batchmanager.SqsAsyncBatchManager;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityRequest;
+import software.amazon.awssdk.services.sqs.model.CreateQueueRequest;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageRequest;
+import software.amazon.awssdk.services.sqs.model.GetQueueUrlRequest;
+import software.amazon.awssdk.services.sqs.model.Message;
+import software.amazon.awssdk.services.sqs.model.PurgeQueueRequest;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
+import software.amazon.awssdk.services.sqs.model.SendMessageResponse;
+import software.amazon.awssdk.utils.BinaryUtils;
+import software.amazon.awssdk.utils.Logger;
+import software.amazon.awssdk.utils.Md5Utils;
+
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+public class RequestBatchManagerSqsIntegrationTest extends IntegrationTestBase {
+
+ private static final int DEFAULT_MAX_BATCH_OPEN = 200;
+ private static final String TEST_QUEUE_PREFIX = "myTestQueue";
+ private static final Logger log = Logger.loggerFor(RequestBatchManagerSqsIntegrationTest.class);
+ private static SqsAsyncClient client;
+ private static String defaultQueueUrl;
+ private SqsAsyncBatchManager batchManager;
+
+ @BeforeAll
+ public static void setUpBeforeClass() throws Exception {
+ client = createSqsAyncClient();
+
+
+ defaultQueueUrl = client.createQueue(CreateQueueRequest.builder()
+ .queueName(TEST_QUEUE_PREFIX + "0")
+ .build())
+ .get(3, TimeUnit.SECONDS)
+ .queueUrl();
+ }
+
+ @AfterAll
+ public static void tearDownAfterClass() {
+ purgeQueue(defaultQueueUrl);
+ client.close();
+ }
+
+ @BeforeEach
+ public void setUp() {
+ batchManager = client.batchManager();
+ }
+
+ @AfterEach
+ public void tearDown() {
+ batchManager.close();
+ }
+
+ @ParameterizedTest
+ @MethodSource("provideQueueUrls")
+ public void sendTenMessages(String queueUrl) {
+ executeSendMessagesTest(10, queueUrl);
+ }
+
+ @ParameterizedTest
+ @MethodSource("provideQueueUrls")
+ public void sendTwentyMessages(String queueUrl) {
+ executeSendMessagesTest(20, queueUrl);
+ }
+
+ @ParameterizedTest
+ @MethodSource("provideQueueUrls")
+ public void scheduleSendFiveMessages(String queueUrl) {
+ long startTime = System.nanoTime();
+ Map requests = createSendMessageRequests(5, queueUrl);
+ Map> responses = sendMessages(requests);
+ waitForAllResponses(responses);
+ long endTime = System.nanoTime();
+
+ assertThat(Duration.ofNanos(endTime - startTime).toMillis()).isGreaterThan(DEFAULT_MAX_BATCH_OPEN);
+ verifyResponses(requests, responses);
+ }
+
+ @ParameterizedTest
+ @MethodSource("provideQueueUrls")
+ public void scheduleTwoSendMessageBatches(String queueUrl) {
+ long startTime = System.nanoTime();
+ Map requests = createSendMessageRequests(10, queueUrl);
+ Map> responses = sendMessages(0, 5, requests);
+ waitFor(DEFAULT_MAX_BATCH_OPEN + 10);
+ responses.putAll(sendMessages(5, 5, requests));
+ waitForAllResponses(responses);
+ long endTime = System.nanoTime();
+
+ assertThat(responses).hasSize(10);
+ assertThat(Duration.ofNanos(endTime - startTime).toMillis()).isGreaterThan(DEFAULT_MAX_BATCH_OPEN + 100);
+ verifyResponses(requests, responses);
+ }
+
+ @ParameterizedTest
+ @MethodSource("provideMessageAndThreadCounts")
+ public void sendMultipleMessagesWithMultiThread(int numMessages, int numThreads, String queueUrl) {
+ executeConcurrentSendMessagesTest(numThreads, numMessages, queueUrl);
+ }
+
+ @ParameterizedTest
+ @MethodSource("provideQueueUrls")
+ public void scheduleFiveMessagesWithEachThreadToDifferentLocations(String queueUrl) throws Exception {
+ int numThreads = 10;
+ int numMessages = 5;
+
+ Map requests = createSendMessageRequestsForDifferentDestinations(numThreads, numMessages);
+ ConcurrentHashMap> responses = new ConcurrentHashMap<>();
+ ExecutorService executorService = Executors.newFixedThreadPool(numThreads);
+
+ List>>> sendRequestFutures =
+ createThreadsAndSendMessages(numThreads, numMessages, requests, responses, executorService);
+
+ checkThreadedResponses(requests, responses, sendRequestFutures);
+
+ cleanupQueues(numThreads);
+ }
+
+ @ParameterizedTest
+ @MethodSource("messageAndQueueProvider")
+ public void deleteMessages(int numMessages, String queueUrl) throws Exception {
+ executeDeleteMessagesTest(numMessages, queueUrl);
+ }
+
+ @ParameterizedTest
+ @MethodSource("messageAndQueueProvider")
+ public void changeVisibilityMessages(int numMessages, String queueUrl) throws Exception {
+ executeChangeVisibilityTest(numMessages, queueUrl);
+ }
+
+
+ @ParameterizedTest
+ @MethodSource("provideQueueUrls")
+ void sendMessagesWhichCanExceed256KiBCollectively(String queueUrl) {
+
+ String largeMessageBody = createLargeString('a', 256_000);
+
+ List> futures = new ArrayList<>();
+
+ // Send the large message 10 times and collect the futures
+ for (int i = 0; i < 10; i++) {
+ CompletableFuture future =
+ batchManager.sendMessage(r -> r.queueUrl(queueUrl).messageBody(largeMessageBody));
+ futures.add(future);
+ }
+
+ // Wait for all sendMessage futures to complete
+ CompletableFuture allFutures = CompletableFuture.allOf(futures.toArray(new CompletableFuture[0]));
+ allFutures.join();
+
+ // Validate that all responses have a non-null messageId
+ futures.forEach(future -> {
+ SendMessageResponse response = future.join();
+ assertThat(response.messageId()).isNotNull();
+ assertThat(response.md5OfMessageBody()).isNotNull();
+ });
+ }
+
+
+ private String createLargeString(char ch, int length) {
+ StringBuilder sb = new StringBuilder(length);
+ for (int i = 0; i < length; i++) {
+ sb.append(ch);
+ }
+ return sb.toString();
+ }
+
+
+ private static Stream provideQueueUrls() {
+ return Stream.of(
+ Arguments.of(defaultQueueUrl)
+ );
+ }
+
+ private static Stream messageAndQueueProvider() {
+ return Stream.of(
+ Arguments.of(1, defaultQueueUrl),
+ Arguments.of(5, defaultQueueUrl),
+ Arguments.of(10, defaultQueueUrl)
+ );
+ }
+
+ private static Stream provideMessageAndThreadCounts() {
+ return Stream.of(
+ Arguments.of(1, 1, defaultQueueUrl),
+ Arguments.of(10, 1, defaultQueueUrl),
+ Arguments.of(1, 10, defaultQueueUrl),
+ Arguments.of(10, 10, defaultQueueUrl)
+ );
+ }
+
+ private void executeSendMessagesTest(int numMessages, String queueUrl) {
+ Map requests = createSendMessageRequests(numMessages, queueUrl);
+ Map> responses = sendMessages(requests);
+ verifyResponses(requests, responses);
+ }
+
+ private void executeConcurrentSendMessagesTest(int numThreads, int numMessages, String queueUrl) {
+ Map requests = createSendMessageRequests(numThreads * numMessages, queueUrl);
+ ConcurrentHashMap> responses = new ConcurrentHashMap<>();
+ ExecutorService executorService = Executors.newFixedThreadPool(numThreads);
+
+ List>>> sendRequestFutures =
+ createThreadsAndSendMessages(numThreads, numMessages, requests, responses, executorService);
+
+ checkThreadedResponses(requests, responses, sendRequestFutures);
+ }
+
+ private void executeDeleteMessagesTest(int numMessages, String queueUrl) throws Exception {
+ Map requests = createSendMessageRequestsForDestination(numMessages, queueUrl);
+ Map> responses = sendMessages(requests);
+ waitForAllResponses(responses);
+
+ List messages = receiveMessages(queueUrl, numMessages);
+ deleteMessagesInBatches(messages, queueUrl);
+ purgeQueue(queueUrl);
+
+ assertThat(responses).hasSize(numMessages);
+ }
+
+ private void executeChangeVisibilityTest(int numMessages, String queueUrl) throws Exception {
+ Map requests = createSendMessageRequestsForDestination(numMessages, queueUrl);
+ Map> responses = sendMessages(requests);
+ waitForAllResponses(responses);
+
+ List messages = receiveMessages(queueUrl, numMessages);
+ changeVisibilityForMessages(messages, queueUrl);
+ assertThat(responses).hasSize(numMessages);
+ }
+
+ private Map createSendMessageRequests(int size, String queueUrl) {
+ return createSendMessageRequestsForDestination(size, queueUrl);
+ }
+
+ private Map createSendMessageRequestsForDestination(int size, String queueUrl) {
+ Map requests = new HashMap<>();
+ for (int i = 0; i < size; i++) {
+ String key = Integer.toString(i);
+ requests.put(key, createSendMessageRequestToDestination(key, queueUrl));
+ }
+ return requests;
+ }
+
+ private SendMessageRequest createSendMessageRequestToDestination(String messageBody, String queueUrl) {
+ SendMessageRequest.Builder requestBuilder = SendMessageRequest.builder()
+ .messageBody(messageBody)
+ .queueUrl(queueUrl);
+ // Check if the queue URL corresponds to a FIFO queue
+ if (queueUrl.endsWith(".fifo")) {
+ // Include a MessageGroupId for FIFO queues
+ requestBuilder.messageGroupId("default-group"); // Use a consistent or meaningful group ID
+ }
+ return requestBuilder.build();
+ }
+
+ private Map> sendMessages(Map requests) {
+ return sendMessages(0, requests.size(), requests);
+ }
+
+ private Map> sendMessages(int start, int size, Map requests) {
+ Map> responses = new HashMap<>();
+ for (int i = start; i < start + size; i++) {
+ String key = Integer.toString(i);
+ SendMessageRequest request = requests.get(key);
+ responses.put(key, batchManager.sendMessage(request));
+ }
+ return responses;
+ }
+
+ private List>>> createThreadsAndSendMessages(
+ int numThreads, int numMessages, Map requests,
+ ConcurrentHashMap> responses, ExecutorService executorService) {
+ List>>> executions = new ArrayList<>();
+ for (int i = 0; i < numThreads; i++) {
+ executions.add(sendMessagesToDestination(i * numMessages, numMessages, requests, responses, executorService));
+ }
+ return executions;
+ }
+
+ private CompletableFuture>> sendMessagesToDestination(
+ int start, int size, Map requests,
+ ConcurrentHashMap> responses, ExecutorService executorService) {
+ return CompletableFuture.supplyAsync(() -> {
+ Map> newResponses = sendMessages(start, size, requests);
+ responses.putAll(newResponses);
+ return newResponses;
+ }, executorService);
+ }
+
+ private void checkThreadedResponses(Map requests,
+ ConcurrentHashMap> responses,
+ List>>> sendRequestFutures) {
+ for (CompletableFuture>> sendRequestFuture : sendRequestFutures) {
+ try {
+ waitForAllResponses(sendRequestFuture.get(300, TimeUnit.MILLISECONDS));
+ } catch (InterruptedException | ExecutionException | TimeoutException e) {
+ log.error(() -> String.valueOf(e));
+ }
+ }
+ verifyResponses(requests, responses);
+ }
+
+ private void verifyResponses(Map requests, Map> responses) {
+ assertThat(responses).hasSameSizeAs(requests);
+ responses.forEach((key, future) -> {
+ String expectedMd5 = BinaryUtils.toHex(Md5Utils.computeMD5Hash(requests.get(key).messageBody().getBytes(StandardCharsets.UTF_8)));
+ assertThat(future.join().md5OfMessageBody()).isEqualTo(expectedMd5);
+ });
+ }
+
+ private void waitForAllResponses(Map> responses) {
+ CompletableFuture.allOf(responses.values().toArray(new CompletableFuture[0])).join();
+ }
+
+ private List receiveMessages(String queueUrl, int numMessages) throws Exception {
+ return client.receiveMessage(ReceiveMessageRequest.builder()
+ .queueUrl(queueUrl)
+ .maxNumberOfMessages(numMessages)
+ .build())
+ .get(3, TimeUnit.SECONDS)
+ .messages();
+ }
+
+ private void deleteMessagesInBatches(List messages, String queueUrl) throws Exception {
+ while (!messages.isEmpty()) {
+ Map deleteRequests = createDeleteRequests(messages, queueUrl);
+ sendDeleteMessages(deleteRequests);
+ messages = receiveMessages(queueUrl, messages.size());
+ }
+ }
+
+ private void changeVisibilityForMessages(List messages, String queueUrl) throws Exception {
+ while (!messages.isEmpty()) {
+ Map visibilityRequests = createChangeVisibilityRequests(messages, queueUrl);
+ sendChangeVisibilityRequests(visibilityRequests);
+ messages = receiveMessages(queueUrl, messages.size());
+ }
+ }
+
+ private Map createDeleteRequests(List messages, String queueUrl) {
+ Map requests = new HashMap<>();
+ for (int i = 0; i < messages.size(); i++) {
+ requests.put(Integer.toString(i), DeleteMessageRequest.builder()
+ .receiptHandle(messages.get(i).receiptHandle())
+ .queueUrl(queueUrl)
+ .build());
+ }
+ return requests;
+ }
+
+ private void sendDeleteMessages(Map deleteRequests) {
+ deleteRequests.forEach((key, request) -> batchManager.deleteMessage(request));
+ }
+
+ private Map createChangeVisibilityRequests(List messages, String queueUrl) {
+ Map requests = new HashMap<>();
+ for (int i = 0; i < messages.size(); i++) {
+ requests.put(Integer.toString(i), ChangeMessageVisibilityRequest.builder()
+ .receiptHandle(messages.get(i).receiptHandle())
+ .queueUrl(queueUrl)
+ .build());
+ }
+ return requests;
+ }
+
+ private void sendChangeVisibilityRequests(Map visibilityRequests) {
+ visibilityRequests.forEach((key, request) -> batchManager.changeMessageVisibility(request));
+ }
+
+ private String createQueue(String queueName) throws Exception {
+ return client.createQueue(CreateQueueRequest.builder()
+ .queueName(queueName)
+ .build())
+ .get(3, TimeUnit.SECONDS)
+ .queueUrl();
+ }
+
+ private void cleanupQueues(int numThreads) throws Exception {
+ for (int i = 1; i < numThreads; i++) {
+ String queueUrl = client.getQueueUrl(GetQueueUrlRequest.builder().queueName(TEST_QUEUE_PREFIX + i).build())
+ .get(3, TimeUnit.SECONDS)
+ .queueUrl();
+ purgeQueue(queueUrl);
+ }
+ }
+
+ private static void purgeQueue(String queueUrl) {
+ client.purgeQueue(PurgeQueueRequest.builder()
+ .queueUrl(queueUrl)
+ .build());
+ }
+
+ private void waitFor(int milliseconds) {
+ CountDownLatch latch = new CountDownLatch(1);
+ try {
+ latch.await(milliseconds, TimeUnit.MILLISECONDS);
+ } catch (InterruptedException e) {
+ Thread.currentThread().interrupt();
+ }
+ }
+
+ private Map createSendMessageRequestsForDifferentDestinations(int numDestinations, int destinationSize) throws Exception {
+ Map requests = new HashMap<>();
+ for (int i = 0; i < numDestinations; i++) {
+ // Create a new queue for each destination
+ String queueUrl = createQueue(TEST_QUEUE_PREFIX + i);
+
+ for (int j = 0; j < destinationSize; j++) {
+ // Generate a unique key for each message
+ String key = Integer.toString(i * destinationSize + j);
+ // Create a SendMessageRequest for the specific destination (queue)
+ requests.put(key, createSendMessageRequestToDestination(key, queueUrl));
+ }
+ }
+ return requests;
+ }
+}
\ No newline at end of file
diff --git a/services/sqs/src/it/java/software/amazon/awssdk/services/sqs/ResponseBatchManagerSqsIntegrationTest.java b/services/sqs/src/it/java/software/amazon/awssdk/services/sqs/ResponseBatchManagerSqsIntegrationTest.java
new file mode 100644
index 000000000000..3b8762cbc357
--- /dev/null
+++ b/services/sqs/src/it/java/software/amazon/awssdk/services/sqs/ResponseBatchManagerSqsIntegrationTest.java
@@ -0,0 +1,213 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.Executors;
+import java.util.concurrent.TimeUnit;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.TestInstance;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.Timeout;
+import software.amazon.awssdk.services.sqs.batchmanager.SqsAsyncBatchManager;
+import software.amazon.awssdk.services.sqs.model.CreateQueueRequest;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageResponse;
+import software.amazon.awssdk.services.sqs.model.Message;
+import software.amazon.awssdk.services.sqs.model.MessageAttributeValue;
+import software.amazon.awssdk.services.sqs.model.MessageSystemAttributeName;
+import software.amazon.awssdk.services.sqs.model.PurgeQueueRequest;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageResponse;
+
+
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+public class ResponseBatchManagerSqsIntegrationTest extends IntegrationTestBase {
+ private static final String TEST_QUEUE_PREFIX = "ResponseBatchManagerSqsIntegrationTest-";
+ private static SqsAsyncClient client;
+ private static String defaultQueueUrl;
+ private static SqsAsyncBatchManager batchManager;
+
+ @BeforeAll
+ public static void setUpBeforeClass() throws Exception {
+ client = SqsAsyncClient.builder()
+ .credentialsProvider(getCredentialsProvider())
+ .build();
+ defaultQueueUrl = client.createQueue(CreateQueueRequest.builder()
+ .queueName(TEST_QUEUE_PREFIX + UUID.randomUUID().toString())
+ .build())
+ .get(3, TimeUnit.SECONDS)
+ .queueUrl();
+ }
+
+ @AfterAll
+ public static void tearDownAfterClass() {
+ purgeQueue(defaultQueueUrl);
+ client.deleteQueue(d -> d.queueUrl(defaultQueueUrl)).join();
+ if(batchManager != null){
+ batchManager.close();
+ }
+ client.close();
+ }
+
+ private static void purgeQueue(String queueUrl) {
+ client.purgeQueue(PurgeQueueRequest.builder()
+ .queueUrl(queueUrl)
+ .build())
+ .join();
+ }
+
+ private static void deleteMessages(ReceiveMessageResponse receiveMessageResponse, SqsAsyncBatchManager batchManager) {
+ List> deleteFutures =
+ receiveMessageResponse.messages().stream()
+ .map(message -> batchManager.deleteMessage(r -> r.queueUrl(defaultQueueUrl)
+ .receiptHandle(message.receiptHandle())))
+ .collect(Collectors.toList());
+ CompletableFuture.allOf(deleteFutures.toArray(new CompletableFuture[0])).join();
+ }
+
+ private static void sendMessages(SqsAsyncBatchManager batchManager, String queueUrl, int numOfMessages) throws Exception {
+ List> futures = IntStream.rangeClosed(1, numOfMessages)
+ .mapToObj(i -> batchManager.sendMessage(s -> s.queueUrl(queueUrl)
+ .messageBody("Message " + i)
+ .messageAttributes(messageAttributeValueMap()))
+ .thenAccept(response -> {
+ })) // Removed logging
+ .collect(Collectors.toList());
+ CompletableFuture.allOf(futures.toArray(new CompletableFuture[0])).get();
+ }
+
+ private static Map messageAttributeValueMap() {
+ Map attributes = new HashMap<>();
+ attributes.put("keyOne", MessageAttributeValue.builder().stringValue("4").dataType("String").build());
+ attributes.put("keyTwo", MessageAttributeValue.builder().stringValue("2").dataType("String").build());
+ attributes.put("keyThree", MessageAttributeValue.builder().stringValue("3").dataType("String").build());
+ attributes.put("keyFour", MessageAttributeValue.builder().stringValue("5").dataType("String").build());
+ return attributes;
+ }
+
+ private void assertMessagesReceived(SqsAsyncBatchManager batchManager, int expectedMessageCount) throws Exception {
+ List allMessages = new ArrayList<>();
+ while (allMessages.size() < expectedMessageCount) {
+ CompletableFuture receiveMessageFuture =
+ batchManager.receiveMessage(r -> r.queueUrl(defaultQueueUrl));
+ ReceiveMessageResponse receiveMessageResponse = receiveMessageFuture.get(5, TimeUnit.SECONDS);
+ if (!receiveMessageResponse.messages().isEmpty()) {
+ allMessages.addAll(receiveMessageResponse.messages());
+ deleteMessages(receiveMessageResponse, batchManager);
+ }
+ }
+ assertThat(allMessages.size()).isEqualTo(expectedMessageCount);
+ }
+
+ @Timeout(value = 10, unit = TimeUnit.SECONDS)
+ @Test
+ void simpleReceiveMessagesWithDefaultConfiguration() throws Exception {
+ batchManager = client.batchManager();
+ sendMessages(batchManager, defaultQueueUrl, 10);
+ assertMessagesReceived(batchManager, 10);
+
+ List allMessages = batchManager.receiveMessage(r -> r.queueUrl(defaultQueueUrl))
+ .get(5, TimeUnit.SECONDS)
+ .messages();
+ assertTrue(allMessages.stream().allMatch(m -> m.messageAttributes().isEmpty()), "Expected no message attributes.");
+ assertTrue(allMessages.stream().allMatch(m -> m.attributes().isEmpty()), "Expected no system attributes.");
+ }
+
+ @Timeout(value = 10, unit = TimeUnit.SECONDS)
+ @Test
+ void simpleReceiveMessagesWithCustomConfigurations() throws Exception {
+ batchManager = SqsAsyncBatchManager.builder()
+ .client(client)
+ .scheduledExecutor(Executors.newScheduledThreadPool(5))
+ .overrideConfiguration(b -> b
+ .receiveMessageMinWaitDuration(Duration.ofSeconds(10))
+ .receiveMessageVisibilityTimeout(Duration.ofSeconds(1))
+ .receiveMessageAttributeNames(Collections.singletonList("*"))
+ .receiveMessageSystemAttributeNames(Collections.singletonList(MessageSystemAttributeName.ALL)))
+ .build();
+
+ sendMessages(batchManager, defaultQueueUrl, 10);
+ assertMessagesReceived(batchManager, 10);
+
+ List allMessages = batchManager.receiveMessage(r -> r.queueUrl(defaultQueueUrl))
+ .get(5, TimeUnit.SECONDS)
+ .messages();
+
+ Map expectedMessageAttributes = messageAttributeValueMap();
+ allMessages.forEach(m -> {
+ assertFalse(m.messageAttributes().isEmpty(), "Expected message attributes, but found none.");
+ assertThat(m.messageAttributes()).isEqualTo(expectedMessageAttributes);
+ assertFalse(m.attributes().isEmpty(), "Expected system attributes, but found none.");
+ assertTrue(m.attributes().containsKey(MessageSystemAttributeName.SENDER_ID), "Expected SenderId, but missing.");
+ assertTrue(m.attributes().containsKey(MessageSystemAttributeName.APPROXIMATE_FIRST_RECEIVE_TIMESTAMP), "Expected "
+ +
+ "ApproximateFirstReceiveTimestamp, but missing.");
+ });
+ }
+
+ @Timeout(value = 10, unit = TimeUnit.SECONDS)
+ @Test
+ void requestLevelMaxMessageAndWaitTimeIsHonoured() throws Exception {
+ batchManager = client.batchManager();
+
+ sendMessages(batchManager, defaultQueueUrl, 10);
+
+ List allMessages = new ArrayList<>();
+ List> deleteFutures = new ArrayList<>();
+ int expectedMessageCount = 10;
+
+ while (allMessages.size() < expectedMessageCount) {
+ CompletableFuture future =
+ batchManager.receiveMessage(r -> r.queueUrl(defaultQueueUrl)
+ .maxNumberOfMessages(1)
+ .waitTimeSeconds(2));
+
+ // Process the received message and delete if non-empty
+ future.whenComplete((response, throwable) -> {
+ if (response != null && !response.messages().isEmpty()) {
+ allMessages.addAll(response.messages());
+ assertThat(response.messages().size()).isEqualTo(1);
+
+ // Collect deleteMessage futures for each message
+ response.messages().forEach(message -> {
+ CompletableFuture deleteFuture = batchManager.deleteMessage(d -> d.queueUrl(defaultQueueUrl)
+ .receiptHandle(message.receiptHandle()));
+ deleteFutures.add(deleteFuture);
+ });
+ }
+ }).join(); // Wait for each receiveMessage future to complete before continuing
+ }
+
+ // Wait for all deleteMessage futures to complete
+ CompletableFuture allDeleteFutures = CompletableFuture.allOf(deleteFutures.toArray(new CompletableFuture[0]));
+ allDeleteFutures.join();
+
+ assertThat(allMessages.size()).isEqualTo(expectedMessageCount);
+ }
+}
\ No newline at end of file
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/batchmanager/BatchOverrideConfiguration.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/batchmanager/BatchOverrideConfiguration.java
new file mode 100644
index 000000000000..a701f099962a
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/batchmanager/BatchOverrideConfiguration.java
@@ -0,0 +1,316 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.batchmanager;
+
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchRequest;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageBatchRequest;
+import software.amazon.awssdk.services.sqs.model.MessageSystemAttributeName;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest;
+import software.amazon.awssdk.services.sqs.model.SendMessageBatchRequest;
+import software.amazon.awssdk.utils.ToString;
+import software.amazon.awssdk.utils.Validate;
+import software.amazon.awssdk.utils.builder.CopyableBuilder;
+import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
+
+/**
+ * Configuration values for the BatchManager implementation used for controlling batch operations.
+ * All values are optional, and default values will be used if they are not specified.
+ */
+@SdkPublicApi
+public final class BatchOverrideConfiguration implements ToCopyableBuilder {
+
+ private final Integer maxBatchSize;
+ private final Duration sendRequestFrequency;
+ private final Duration receiveMessageVisibilityTimeout;
+ private final Duration receiveMessageMinWaitDuration;
+ private final List receiveMessageSystemAttributeNames;
+ private final List receiveMessageAttributeNames;
+
+
+ private BatchOverrideConfiguration(Builder builder) {
+ this.maxBatchSize = Validate.isPositiveOrNull(builder.maxBatchSize,
+ "maxBatchSize");
+ Validate.isTrue(this.maxBatchSize == null || this.maxBatchSize <= 10,
+ "The maxBatchSize must be less than or equal to 10. A batch can contain up to 10 messages.");
+
+ this.sendRequestFrequency = Validate.isPositiveOrNull(builder.sendRequestFrequency,
+ "sendRequestFrequency");
+ this.receiveMessageVisibilityTimeout = Validate.isPositiveOrNull(builder.receiveMessageVisibilityTimeout,
+ "receiveMessageVisibilityTimeout");
+ this.receiveMessageMinWaitDuration = Validate.isPositiveOrNull(builder.receiveMessageMinWaitDuration,
+ "receiveMessageMinWaitDuration");
+ this.receiveMessageSystemAttributeNames =
+ builder.receiveMessageSystemAttributeNames == null ? Collections.emptyList() :
+ Collections.unmodifiableList(builder.receiveMessageSystemAttributeNames);
+
+ this.receiveMessageAttributeNames =
+ builder.receiveMessageAttributeNames == null ? Collections.emptyList() :
+ Collections.unmodifiableList(builder.receiveMessageAttributeNames);
+ }
+
+ public static Builder builder() {
+ return new Builder();
+ }
+
+ /**
+ * @return the maximum number of items that can be batched together in a single outbound SQS request
+ * (e.g., for {@link SendMessageBatchRequest}, {@link ChangeMessageVisibilityBatchRequest}, or
+ * {@link DeleteMessageBatchRequest}). A batch can contain up to a maximum of 10 messages.
+ * The default value is 10.
+ */
+ public Integer maxBatchSize() {
+ return maxBatchSize;
+ }
+
+ /**
+ * @return the maximum duration an outgoing call waits for additional messages of the same type before being sent.
+ * If the {@link #maxBatchSize()} is reached before this duration, the batch will be sent immediately.
+ * The default value is 200 milliseconds.
+ */
+ public Duration sendRequestFrequency() {
+ return sendRequestFrequency;
+ }
+
+ /**
+ * @return the custom visibility timeout to use when retrieving messages from SQS. If not set,
+ * the default visibility timeout configured on the SQS queue will be used.
+ */
+ public Duration receiveMessageVisibilityTimeout() {
+ return receiveMessageVisibilityTimeout;
+ }
+
+ /**
+ * @return the minimum wait time for incoming receive message requests. Without a non-zero minimum wait time,
+ * threads can waste CPU resources busy-waiting for messages. The default value is 50 milliseconds.
+ */
+ public Duration receiveMessageMinWaitDuration() {
+ return receiveMessageMinWaitDuration;
+ }
+
+ /**
+ * @return the system attribute names to request for {@link ReceiveMessageRequest}. Requests with differing
+ * system attribute names will bypass the batch manager and make a direct call to SQS.
+ */
+ public List receiveMessageSystemAttributeNames() {
+ return receiveMessageSystemAttributeNames;
+ }
+
+ /**
+ * @return the message attribute names to request for {@link ReceiveMessageRequest}. Requests with different
+ * message attribute names will bypass the batch manager and make a direct call to SQS.
+ */
+ public List receiveMessageAttributeNames() {
+ return receiveMessageAttributeNames;
+ }
+
+
+ @Override
+ public Builder toBuilder() {
+ return new Builder()
+ .maxBatchSize(maxBatchSize)
+ .sendRequestFrequency(sendRequestFrequency)
+ .receiveMessageVisibilityTimeout(receiveMessageVisibilityTimeout)
+ .receiveMessageMinWaitDuration(receiveMessageMinWaitDuration)
+ .receiveMessageSystemAttributeNames(receiveMessageSystemAttributeNames)
+ .receiveMessageAttributeNames(receiveMessageAttributeNames);
+ }
+
+ @Override
+ public String toString() {
+ return ToString.builder("BatchOverrideConfiguration")
+ .add("maxBatchSize", maxBatchSize)
+ .add("sendRequestFrequency", sendRequestFrequency)
+ .add("receiveMessageVisibilityTimeout", receiveMessageVisibilityTimeout)
+ .add("receiveMessageMinWaitDuration", receiveMessageMinWaitDuration)
+ .add("receiveMessageSystemAttributeNames", receiveMessageSystemAttributeNames)
+ .add("receiveMessageAttributeNames", receiveMessageAttributeNames)
+ .build();
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+
+ BatchOverrideConfiguration that = (BatchOverrideConfiguration) o;
+
+ if (maxBatchSize != null ? !maxBatchSize.equals(that.maxBatchSize) : that.maxBatchSize != null) {
+ return false;
+ }
+ if (sendRequestFrequency != null ? !sendRequestFrequency.equals(that.sendRequestFrequency) :
+ that.sendRequestFrequency != null) {
+ return false;
+ }
+ if (receiveMessageVisibilityTimeout != null
+ ? !receiveMessageVisibilityTimeout.equals(that.receiveMessageVisibilityTimeout) :
+ that.receiveMessageVisibilityTimeout != null) {
+ return false;
+ }
+ if (receiveMessageMinWaitDuration != null ? !receiveMessageMinWaitDuration.equals(that.receiveMessageMinWaitDuration) :
+ that.receiveMessageMinWaitDuration != null) {
+ return false;
+ }
+ if (receiveMessageSystemAttributeNames != null ?
+ !receiveMessageSystemAttributeNames.equals(that.receiveMessageSystemAttributeNames)
+ : that.receiveMessageSystemAttributeNames != null) {
+ return false;
+ }
+ return receiveMessageAttributeNames != null ? receiveMessageAttributeNames.equals(that.receiveMessageAttributeNames) :
+ that.receiveMessageAttributeNames == null;
+ }
+
+ @Override
+ public int hashCode() {
+ int result = maxBatchSize != null ? maxBatchSize.hashCode() : 0;
+ result = 31 * result + (sendRequestFrequency != null ? sendRequestFrequency.hashCode() : 0);
+ result = 31 * result + (receiveMessageVisibilityTimeout != null ? receiveMessageVisibilityTimeout.hashCode() : 0);
+ result = 31 * result + (receiveMessageMinWaitDuration != null ? receiveMessageMinWaitDuration.hashCode() : 0);
+ result = 31 * result + (receiveMessageSystemAttributeNames != null ? receiveMessageSystemAttributeNames.hashCode() : 0);
+ result = 31 * result + (receiveMessageAttributeNames != null ? receiveMessageAttributeNames.hashCode() : 0);
+ return result;
+ }
+
+ public static final class Builder implements CopyableBuilder {
+
+ private Integer maxBatchSize = 10;
+ private Duration sendRequestFrequency ;
+ private Duration receiveMessageVisibilityTimeout;
+ private Duration receiveMessageMinWaitDuration ;
+ private List receiveMessageSystemAttributeNames = Collections.emptyList();
+ private List receiveMessageAttributeNames = Collections.emptyList();
+
+
+ private Builder() {
+ }
+
+ /**
+ * Specifies the maximum number of items that the buffered client will include in a single outbound batch request.
+ * Outbound requests include {@link SendMessageBatchRequest}, {@link ChangeMessageVisibilityBatchRequest},
+ * and {@link DeleteMessageBatchRequest}.
+ * A batch can contain up to a maximum of 10 messages. The default value is 10.
+ *
+ * @param maxBatchSize The maximum number of items to be batched together in a single request.
+ * @return This Builder object for method chaining.
+ */
+ public Builder maxBatchSize(Integer maxBatchSize) {
+ this.maxBatchSize = maxBatchSize;
+ return this;
+ }
+
+ /**
+ * Specifies the frequency at which outbound batches are sent.
+ * This defines the maximum duration that an outbound batch is held open for additional outbound
+ * requests before being sent. Outbound requests include SendMessageBatchRequest,
+ * ChangeMessageVisibilityBatchRequest, and DeleteMessageBatchRequest. If the maxBatchSize is reached
+ * before this duration, the batch will be sent immediately.
+ * Increasing the {@code sendRequestFrequency} gives more time for additional messages to be added to
+ * the batch, which can reduce the number of requests and increase throughput. However, a higher
+ * frequency may also result in increased average message latency. The default value is 200 milliseconds.
+ *
+ * @param sendRequestFrequency The new value for the frequency at which outbound requests are sent.
+ * @return This Builder object for method chaining.
+ */
+ public Builder sendRequestFrequency(Duration sendRequestFrequency) {
+ this.sendRequestFrequency = sendRequestFrequency;
+ return this;
+ }
+
+ /**
+ * Defines the custom visibility timeout to use when retrieving messages from SQS. If set to a positive value,
+ * this timeout will override the default visibility timeout set on the SQS queue. If no value is set,
+ * then by default, the visibility timeout of the queue will be used. Only positive values are supported.
+ *
+ * @param receiveMessageVisibilityTimeout The new visibilityTimeout value.
+ * @return This Builder object for method chaining.
+ */
+ public Builder receiveMessageVisibilityTimeout(Duration receiveMessageVisibilityTimeout) {
+ this.receiveMessageVisibilityTimeout = receiveMessageVisibilityTimeout;
+ return this;
+ }
+
+ /**
+ * Configures the minimum wait time for incoming receive message requests. The default value is 50 milliseconds.
+ * Without a non-zero minimum wait time, threads can easily waste CPU time by busy-waiting against empty local buffers.
+ * Avoid setting this to 0 unless you are confident that threads will perform useful work between each call
+ * to receive messages.
+ * The call may return sooner than the configured `WaitTimeSeconds` if there are messages in the buffer.
+ * If no messages are available and the wait time expires, the call will return an empty message list.
+ *
+ * @param receiveMessageMinWaitDuration The new minimum wait time value.
+ * @return This Builder object for method chaining.
+ */
+ public Builder receiveMessageMinWaitDuration(Duration receiveMessageMinWaitDuration) {
+ this.receiveMessageMinWaitDuration = receiveMessageMinWaitDuration;
+ return this;
+ }
+
+ /**
+ * Defines the list of message system attribute names to request in receive message calls.
+ * If no `messageSystemAttributeNames` are set in the individual request, the ones configured here will be used.
+ *
+ * Requests with different `messageSystemAttributeNames` than those configured here will bypass the
+ * BatchManager and make a direct call to SQS. Only requests with matching attribute names will be
+ * batched and fulfilled from the receive buffers.
+ *
+ * @param receiveMessageSystemAttributeNames The list of message system attribute names to request.
+ * If null, an empty list will be used.
+ * @return This builder object for method chaining.
+ */
+ public Builder receiveMessageSystemAttributeNames(List receiveMessageSystemAttributeNames) {
+ this.receiveMessageSystemAttributeNames = receiveMessageSystemAttributeNames != null ?
+ new ArrayList<>(receiveMessageSystemAttributeNames) :
+ Collections.emptyList();
+ return this;
+ }
+
+ /**
+ * Defines the list of message attribute names to request in receive message calls.
+ * If no `receiveMessageAttributeNames` are set in the individual requests, the ones configured here will be used.
+ *
+ * Requests with different `receiveMessageAttributeNames` than those configured here will bypass the batched and
+ * fulfilled from the receive buffers.
+ *
+ * @param receiveMessageAttributeNames The list of message attribute names to request.
+ * If null, an empty list will be used.
+ * @return This builder object for method chaining.
+ */
+ public Builder receiveMessageAttributeNames(List receiveMessageAttributeNames) {
+ this.receiveMessageAttributeNames = receiveMessageAttributeNames != null ?
+ new ArrayList<>(receiveMessageAttributeNames) :
+ Collections.emptyList();
+ return this;
+ }
+
+ /**
+ * Builds a new {@link BatchOverrideConfiguration} object based on the values set in this builder.
+ *
+ * @return A new {@link BatchOverrideConfiguration} object.
+ */
+ public BatchOverrideConfiguration build() {
+ return new BatchOverrideConfiguration(this);
+ }
+ }
+}
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/batchmanager/SqsAsyncBatchManager.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/batchmanager/SqsAsyncBatchManager.java
new file mode 100644
index 000000000000..d8d54f718a59
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/batchmanager/SqsAsyncBatchManager.java
@@ -0,0 +1,198 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.batchmanager;
+
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.function.Consumer;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.services.sqs.SqsAsyncClient;
+import software.amazon.awssdk.services.sqs.internal.batchmanager.DefaultSqsAsyncBatchManager;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityRequest;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityResponse;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageRequest;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageResponse;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageResponse;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
+import software.amazon.awssdk.services.sqs.model.SendMessageResponse;
+import software.amazon.awssdk.utils.SdkAutoCloseable;
+
+/**
+ * Batch manager for implementing automatic batching with an SQS async client. Create an instance using {@link #builder()}.
+ *
+ * This manager buffers client requests and sends them in batches to the service, enhancing efficiency by reducing the number of
+ * API requests. Requests are buffered until they reach a specified limit or a timeout occurs.
+ */
+@SdkPublicApi
+public interface SqsAsyncBatchManager extends SdkAutoCloseable {
+
+ /**
+ * Creates a builder for configuring and creating an {@link SqsAsyncBatchManager}.
+ *
+ * @return A new builder.
+ */
+ static Builder builder() {
+ return DefaultSqsAsyncBatchManager.builder();
+ }
+
+ /**
+ * Buffers and batches {@link SendMessageRequest}s, sending them as a
+ * {@link software.amazon.awssdk.services.sqs.model.SendMessageBatchRequest}. Requests are grouped by queue URL and override
+ * configuration, and sent when the batch size or timeout is reached.
+ *
+ * @param request The SendMessageRequest to be buffered.
+ * @return CompletableFuture of the corresponding {@link SendMessageResponse}.
+ */
+ default CompletableFuture sendMessage(SendMessageRequest request) {
+ throw new UnsupportedOperationException();
+ }
+
+
+ /**
+ * Buffers and batches {@link SendMessageRequest}s using a {@link Consumer} to configure the request,
+ * sending them as a {@link software.amazon.awssdk.services.sqs.model.SendMessageBatchRequest}.
+ * Requests are grouped by queue URL and override configuration, and sent when the batch size or timeout is reached.
+ *
+ * @param sendMessageRequest A {@link Consumer} to configure the SendMessageRequest to be buffered.
+ * @return CompletableFuture of the corresponding {@link SendMessageResponse}.
+ */
+ default CompletableFuture sendMessage(Consumer sendMessageRequest) {
+ return sendMessage(SendMessageRequest.builder().applyMutation(sendMessageRequest).build());
+ }
+
+ /**
+ * Buffers and batches {@link DeleteMessageRequest}s, sending them as a
+ * {@link software.amazon.awssdk.services.sqs.model.DeleteMessageBatchRequest}. Requests are grouped by queue URL and override
+ * configuration, and sent when the batch size or timeout is reached.
+ *
+ * @param request The DeleteMessageRequest to be buffered.
+ * @return CompletableFuture of the corresponding {@link DeleteMessageResponse}.
+ */
+ default CompletableFuture deleteMessage(DeleteMessageRequest request) {
+ throw new UnsupportedOperationException();
+ }
+
+
+ /**
+ * Buffers and batches {@link DeleteMessageRequest}s using a {@link Consumer} to configure the request,
+ * sending them as a {@link software.amazon.awssdk.services.sqs.model.DeleteMessageBatchRequest}.
+ * Requests are grouped by queue URL and override configuration, and sent when the batch size or timeout is reached.
+ *
+ * @param request A {@link Consumer} to configure the DeleteMessageRequest to be buffered.
+ * @return CompletableFuture of the corresponding {@link DeleteMessageResponse}.
+ */
+ default CompletableFuture deleteMessage(Consumer request) {
+ return deleteMessage(DeleteMessageRequest.builder().applyMutation(request).build());
+ }
+
+ /**
+ * Buffers and batches {@link ChangeMessageVisibilityRequest}s, sending them as a
+ * {@link software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchRequest}. Requests are grouped by queue URL
+ * and override configuration, and sent when the batch size or timeout is reached.
+ *
+ * @param request The ChangeMessageVisibilityRequest to be buffered.
+ * @return CompletableFuture of the corresponding {@link ChangeMessageVisibilityResponse}.
+ */
+ default CompletableFuture changeMessageVisibility(ChangeMessageVisibilityRequest request) {
+ throw new UnsupportedOperationException();
+ }
+
+ /**
+ * Buffers and batches {@link ChangeMessageVisibilityRequest}s using a {@link Consumer} to configure the request,
+ * sending them as a {@link software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchRequest}.
+ * Requests are grouped by queue URL and override configuration, and sent when the batch size or timeout is reached.
+ *
+ * @param request A {@link Consumer} to configure the ChangeMessageVisibilityRequest to be buffered.
+ * @return CompletableFuture of the corresponding {@link ChangeMessageVisibilityResponse}.
+ */
+ default CompletableFuture changeMessageVisibility(
+ Consumer request) {
+ return changeMessageVisibility(ChangeMessageVisibilityRequest.builder().applyMutation(request).build());
+ }
+
+
+ /**
+ * Buffers and retrieves messages with {@link ReceiveMessageRequest}, with a maximum of 10 messages per request. Returns an
+ * empty message if no messages are available in SQS.
+ *
+ * @param request The ReceiveMessageRequest.
+ * @return CompletableFuture of the corresponding {@link ReceiveMessageResponse}.
+ */
+ default CompletableFuture receiveMessage(ReceiveMessageRequest request) {
+ throw new UnsupportedOperationException();
+ }
+
+ /**
+ * Buffers and retrieves messages with {@link ReceiveMessageRequest} using a {@link Consumer} to configure the request,
+ * with a maximum of 10 messages per request. Returns an empty message if no messages are available in SQS.
+ *
+ * @param request A {@link Consumer} to configure the ReceiveMessageRequest.
+ * @return CompletableFuture of the corresponding {@link ReceiveMessageResponse}.
+ */
+ default CompletableFuture receiveMessage(
+ Consumer request) {
+ return receiveMessage(ReceiveMessageRequest.builder().applyMutation(request).build());
+ }
+
+
+ interface Builder {
+
+ /**
+ * Sets custom overrides for the BatchManager configuration.
+ *
+ * @param overrideConfiguration The configuration overrides.
+ * @return This builder for method chaining.
+ */
+ Builder overrideConfiguration(BatchOverrideConfiguration overrideConfiguration);
+
+ /**
+ * Sets custom overrides for the BatchManager configuration using a {@link Consumer} to configure the overrides.
+ *
+ * @param overrideConfiguration A {@link Consumer} to configure the {@link BatchOverrideConfiguration}.
+ * @return This builder for method chaining.
+ */
+ default Builder overrideConfiguration(Consumer overrideConfiguration) {
+ return overrideConfiguration(BatchOverrideConfiguration.builder().applyMutation(overrideConfiguration).build());
+ }
+
+ /**
+ * Sets a custom {@link software.amazon.awssdk.services.sqs.SqsClient} for polling resources. This client must be closed
+ * by the caller.
+ *
+ * @param client The SqsAsyncClient to use.
+ * @return This builder for method chaining.
+ * @throws NullPointerException If client is null.
+ */
+ Builder client(SqsAsyncClient client);
+
+ /**
+ * Sets a custom {@link ScheduledExecutorService} for periodic buffer flushes. This executor must be closed by the
+ * caller.
+ *
+ * @param scheduledExecutor The executor to use.
+ * @return This builder for method chaining.
+ */
+ Builder scheduledExecutor(ScheduledExecutorService scheduledExecutor);
+
+ /**
+ * Builds an instance of {@link SqsAsyncBatchManager} based on the supplied configurations.
+ *
+ * @return An initialized SqsAsyncBatchManager.
+ */
+ SqsAsyncBatchManager build();
+ }
+}
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/BatchingExecutionContext.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/BatchingExecutionContext.java
new file mode 100644
index 000000000000..d3cd056f7b11
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/BatchingExecutionContext.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+
+@SdkInternalApi
+public final class BatchingExecutionContext {
+
+ private final RequestT request;
+ private final CompletableFuture response;
+
+ private final Optional responsePayloadByteSize;
+
+ public BatchingExecutionContext(RequestT request, CompletableFuture response) {
+ this.request = request;
+ this.response = response;
+ responsePayloadByteSize = RequestPayloadCalculator.calculateMessageSize(request);
+ }
+
+ public RequestT request() {
+ return request;
+ }
+
+ public CompletableFuture response() {
+ return response;
+ }
+
+ /**
+ * Optional because responsePayloadByteSize is required only for SendMessageRequests and not for other requests.
+ */
+ public Optional responsePayloadByteSize() {
+ return responsePayloadByteSize;
+ }
+}
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/BatchingMap.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/BatchingMap.java
new file mode 100644
index 000000000000..171b76aa4bff
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/BatchingMap.java
@@ -0,0 +1,96 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ScheduledFuture;
+import java.util.function.BiConsumer;
+import java.util.function.Supplier;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+
+/**
+ * Outer map maps a batchKey (ex. queueUrl, overrideConfig etc.) to a {@link RequestBatchBuffer}
+ *
+ * @param the type of an outgoing response
+ */
+@SdkInternalApi
+public final class BatchingMap {
+
+ private final int maxBatchKeys;
+ private final int maxBatchBytesSize;
+ private final int maxBatchSize;
+ private final int maxBufferSize;
+ private final Map> batchContextMap;
+
+ public BatchingMap(RequestBatchConfiguration overrideConfiguration) {
+ this.batchContextMap = new ConcurrentHashMap<>();
+ this.maxBatchKeys = overrideConfiguration.maxBatchKeys();
+ this.maxBatchBytesSize = overrideConfiguration.maxBatchBytesSize();
+ this.maxBatchSize = overrideConfiguration.maxBatchItems();
+ this.maxBufferSize = overrideConfiguration.maxBufferSize();
+ }
+
+ public void put(String batchKey, Supplier> scheduleFlush, RequestT request,
+ CompletableFuture response) throws IllegalStateException {
+ batchContextMap.computeIfAbsent(batchKey, k -> {
+ if (batchContextMap.size() == maxBatchKeys) {
+ throw new IllegalStateException("Reached MaxBatchKeys of: " + maxBatchKeys);
+ }
+ return new RequestBatchBuffer<>(scheduleFlush.get(), maxBatchSize, maxBatchBytesSize, maxBufferSize);
+ }).put(request, response);
+ }
+
+ public boolean contains(String batchKey) {
+ return batchContextMap.containsKey(batchKey);
+ }
+
+ public void putScheduledFlush(String batchKey, ScheduledFuture scheduledFlush) {
+ batchContextMap.get(batchKey).putScheduledFlush(scheduledFlush);
+ }
+
+ public void forEach(BiConsumer> action) {
+ batchContextMap.forEach(action);
+ }
+
+ public Map> flushableRequests(String batchKey) {
+ return batchContextMap.get(batchKey).flushableRequests();
+ }
+
+ public Map> flushableRequestsOnByteLimitBeforeAdd(String batchKey,
+ RequestT request) {
+ return batchContextMap.get(batchKey).flushableRequestsOnByteLimitBeforeAdd(request);
+ }
+
+ public Map> flushableScheduledRequests(String batchKey,
+ int maxBatchItems) {
+ return batchContextMap.get(batchKey).flushableScheduledRequests(maxBatchItems);
+ }
+
+ public void cancelScheduledFlush(String batchKey) {
+ batchContextMap.get(batchKey).cancelScheduledFlush();
+ }
+
+ public void clear() {
+ for (Map.Entry> entry : batchContextMap.entrySet()) {
+ String key = entry.getKey();
+ entry.getValue().clear();
+ batchContextMap.remove(key);
+ }
+ batchContextMap.clear();
+ }
+}
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ChangeMessageVisibilityBatchManager.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ChangeMessageVisibilityBatchManager.java
new file mode 100644
index 000000000000..910866e3088b
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ChangeMessageVisibilityBatchManager.java
@@ -0,0 +1,146 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.stream.Collectors;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
+import software.amazon.awssdk.awscore.exception.AwsErrorDetails;
+import software.amazon.awssdk.services.sqs.SqsAsyncClient;
+import software.amazon.awssdk.services.sqs.model.BatchResultErrorEntry;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchRequest;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchRequestEntry;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchResponse;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchResultEntry;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityRequest;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityResponse;
+import software.amazon.awssdk.services.sqs.model.SqsException;
+import software.amazon.awssdk.utils.Either;
+
+@SdkInternalApi
+public class ChangeMessageVisibilityBatchManager extends RequestBatchManager {
+
+ private final SqsAsyncClient sqsAsyncClient;
+
+ protected ChangeMessageVisibilityBatchManager(RequestBatchConfiguration overrideConfiguration,
+ ScheduledExecutorService scheduledExecutor,
+ SqsAsyncClient sqsAsyncClient) {
+ super(overrideConfiguration, scheduledExecutor);
+ this.sqsAsyncClient = sqsAsyncClient;
+ }
+
+ private static ChangeMessageVisibilityBatchRequest createChangeMessageVisibilityBatchRequest(
+ List> identifiedRequests, String batchKey) {
+
+ List entries =
+ identifiedRequests.stream()
+ .map(identifiedRequest -> createChangeMessageVisibilityBatchRequestEntry(
+ identifiedRequest.id(),
+ identifiedRequest.message()))
+ .collect(Collectors.toList());
+
+ // All requests have the same overrideConfiguration, so it's sufficient to retrieve it from the first request.
+ Optional overrideConfiguration = identifiedRequests.get(0)
+ .message()
+ .overrideConfiguration();
+
+ return overrideConfiguration
+ .map(config -> ChangeMessageVisibilityBatchRequest.builder()
+ .queueUrl(batchKey)
+ .overrideConfiguration(config.toBuilder()
+ .applyMutation(USER_AGENT_APPLIER)
+ .build())
+ .entries(entries)
+ .build())
+ .orElseGet(() -> ChangeMessageVisibilityBatchRequest.builder()
+ .queueUrl(batchKey)
+ .overrideConfiguration(o -> o
+ .applyMutation(USER_AGENT_APPLIER)
+ .build())
+ .entries(entries)
+ .build());
+ }
+
+ private static ChangeMessageVisibilityBatchRequestEntry createChangeMessageVisibilityBatchRequestEntry(
+ String id,
+ ChangeMessageVisibilityRequest request) {
+ return ChangeMessageVisibilityBatchRequestEntry.builder().id(id).receiptHandle(request.receiptHandle())
+ .visibilityTimeout(request.visibilityTimeout()).build();
+ }
+
+ private static IdentifiableMessage createChangeMessageVisibilityResponse(
+ ChangeMessageVisibilityBatchResultEntry successfulEntry, ChangeMessageVisibilityBatchResponse batchResponse) {
+ String key = successfulEntry.id();
+ ChangeMessageVisibilityResponse.Builder builder = ChangeMessageVisibilityResponse.builder();
+ if (batchResponse.responseMetadata() != null) {
+ builder.responseMetadata(batchResponse.responseMetadata());
+ }
+ if (batchResponse.sdkHttpResponse() != null) {
+ builder.sdkHttpResponse(batchResponse.sdkHttpResponse());
+ }
+ ChangeMessageVisibilityResponse response = builder.build();
+ return new IdentifiableMessage<>(key, response);
+ }
+
+ private static IdentifiableMessage changeMessageVisibilityCreateThrowable(BatchResultErrorEntry failedEntry) {
+ String key = failedEntry.id();
+ AwsErrorDetails errorDetailsBuilder = AwsErrorDetails.builder().errorCode(failedEntry.code())
+ .errorMessage(failedEntry.message()).build();
+ Throwable response = SqsException.builder().awsErrorDetails(errorDetailsBuilder).build();
+ return new IdentifiableMessage<>(key, response);
+ }
+
+ @Override
+ protected CompletableFuture batchAndSend(
+ List> identifiedRequests, String batchKey) {
+ ChangeMessageVisibilityBatchRequest batchRequest = createChangeMessageVisibilityBatchRequest(identifiedRequests,
+ batchKey);
+ return sqsAsyncClient.changeMessageVisibilityBatch(batchRequest);
+ }
+
+ @Override
+ protected String getBatchKey(ChangeMessageVisibilityRequest request) {
+ return request.overrideConfiguration().map(overrideConfig -> request.queueUrl() + overrideConfig.hashCode())
+ .orElseGet(request::queueUrl);
+ }
+
+ @Override
+ protected List,
+ IdentifiableMessage>> mapBatchResponse(ChangeMessageVisibilityBatchResponse batchResponse) {
+
+ List, IdentifiableMessage>> mappedResponses =
+ new ArrayList<>();
+ batchResponse.successful().forEach(
+ batchResponseEntry -> {
+ IdentifiableMessage response = createChangeMessageVisibilityResponse(
+ batchResponseEntry, batchResponse);
+ mappedResponses.add(Either.left(response));
+ });
+ batchResponse.failed().forEach(batchResponseEntry -> {
+ IdentifiableMessage response = changeMessageVisibilityCreateThrowable(batchResponseEntry);
+ mappedResponses.add(Either.right(response));
+ });
+ return mappedResponses;
+
+ }
+}
\ No newline at end of file
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/DefaultSqsAsyncBatchManager.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/DefaultSqsAsyncBatchManager.java
new file mode 100644
index 000000000000..08300d485249
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/DefaultSqsAsyncBatchManager.java
@@ -0,0 +1,145 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+
+import static software.amazon.awssdk.services.sqs.internal.batchmanager.ResponseBatchConfiguration.MAX_SEND_MESSAGE_PAYLOAD_SIZE_BYTES;
+
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ScheduledExecutorService;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.services.sqs.SqsAsyncClient;
+import software.amazon.awssdk.services.sqs.batchmanager.BatchOverrideConfiguration;
+import software.amazon.awssdk.services.sqs.batchmanager.SqsAsyncBatchManager;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityRequest;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityResponse;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageRequest;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageResponse;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageResponse;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
+import software.amazon.awssdk.services.sqs.model.SendMessageResponse;
+import software.amazon.awssdk.utils.Validate;
+
+@SdkInternalApi
+public final class DefaultSqsAsyncBatchManager implements SqsAsyncBatchManager {
+ private final SqsAsyncClient client;
+
+ private final SendMessageBatchManager sendMessageBatchManager;
+
+ private final DeleteMessageBatchManager deleteMessageBatchManager;
+
+ private final ChangeMessageVisibilityBatchManager changeMessageVisibilityBatchManager;
+
+ private final ReceiveMessageBatchManager receiveMessageBatchManager;
+
+ private DefaultSqsAsyncBatchManager(DefaultBuilder builder) {
+ this.client = Validate.notNull(builder.client, "client cannot be null");
+ ScheduledExecutorService scheduledExecutor = Validate.notNull(builder.scheduledExecutor,
+ "scheduledExecutor cannot be null");
+ this.sendMessageBatchManager =
+ new SendMessageBatchManager(
+ RequestBatchConfiguration.builder(builder.overrideConfiguration)
+ .maxBatchBytesSize(MAX_SEND_MESSAGE_PAYLOAD_SIZE_BYTES)
+ .build(),
+ scheduledExecutor,
+ client
+ );
+
+ this.deleteMessageBatchManager =
+ new DeleteMessageBatchManager(
+ RequestBatchConfiguration.builder(builder.overrideConfiguration).build(),
+ scheduledExecutor,
+ client
+ );
+
+ this.changeMessageVisibilityBatchManager =
+ new ChangeMessageVisibilityBatchManager(
+ RequestBatchConfiguration.builder(builder.overrideConfiguration).build(),
+ scheduledExecutor,
+ client
+ );
+
+ this.receiveMessageBatchManager =
+ new ReceiveMessageBatchManager(client,
+ scheduledExecutor,
+ ResponseBatchConfiguration.builder(builder.overrideConfiguration).build());
+ }
+
+ @Override
+ public CompletableFuture sendMessage(SendMessageRequest request) {
+ return sendMessageBatchManager.batchRequest(request);
+ }
+
+ @Override
+ public CompletableFuture deleteMessage(DeleteMessageRequest request) {
+ return deleteMessageBatchManager.batchRequest(request);
+ }
+
+ @Override
+ public CompletableFuture changeMessageVisibility(ChangeMessageVisibilityRequest request) {
+ return changeMessageVisibilityBatchManager.batchRequest(request);
+ }
+
+ @Override
+ public CompletableFuture receiveMessage(ReceiveMessageRequest request) {
+ return this.receiveMessageBatchManager.batchRequest(request);
+ }
+
+ public static SqsAsyncBatchManager.Builder builder() {
+ return new DefaultBuilder();
+ }
+
+ @Override
+ public void close() {
+ sendMessageBatchManager.close();
+ deleteMessageBatchManager.close();
+ changeMessageVisibilityBatchManager.close();
+ receiveMessageBatchManager.close();
+ }
+
+ public static final class DefaultBuilder implements SqsAsyncBatchManager.Builder {
+ private SqsAsyncClient client;
+ private BatchOverrideConfiguration overrideConfiguration;
+ private ScheduledExecutorService scheduledExecutor;
+
+ private DefaultBuilder() {
+ }
+
+ @Override
+ public SqsAsyncBatchManager.Builder overrideConfiguration(BatchOverrideConfiguration overrideConfiguration) {
+ this.overrideConfiguration = overrideConfiguration;
+ return this;
+ }
+
+ @Override
+ public SqsAsyncBatchManager.Builder client(SqsAsyncClient client) {
+ this.client = client;
+ return this;
+ }
+
+ @Override
+ public SqsAsyncBatchManager.Builder scheduledExecutor(ScheduledExecutorService scheduledExecutor) {
+ this.scheduledExecutor = scheduledExecutor;
+ return this;
+ }
+
+ @Override
+ public SqsAsyncBatchManager build() {
+ return new DefaultSqsAsyncBatchManager(this);
+ }
+ }
+}
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/DeleteMessageBatchManager.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/DeleteMessageBatchManager.java
new file mode 100644
index 000000000000..683d1f8a97ab
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/DeleteMessageBatchManager.java
@@ -0,0 +1,146 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.stream.Collectors;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
+import software.amazon.awssdk.awscore.exception.AwsErrorDetails;
+import software.amazon.awssdk.services.sqs.SqsAsyncClient;
+import software.amazon.awssdk.services.sqs.model.BatchResultErrorEntry;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageBatchRequest;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageBatchRequestEntry;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResponse;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResultEntry;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageRequest;
+import software.amazon.awssdk.services.sqs.model.DeleteMessageResponse;
+import software.amazon.awssdk.services.sqs.model.SqsException;
+import software.amazon.awssdk.utils.Either;
+
+@SdkInternalApi
+public class DeleteMessageBatchManager extends RequestBatchManager {
+
+ private final SqsAsyncClient sqsAsyncClient;
+
+ protected DeleteMessageBatchManager(RequestBatchConfiguration overrideConfiguration,
+ ScheduledExecutorService scheduledExecutor,
+ SqsAsyncClient sqsAsyncClient) {
+ super(overrideConfiguration, scheduledExecutor);
+ this.sqsAsyncClient = sqsAsyncClient;
+ }
+
+ private static DeleteMessageBatchRequest createDeleteMessageBatchRequest(
+ List> identifiedRequests, String batchKey) {
+
+ List entries = identifiedRequests
+ .stream()
+ .map(identifiedRequest -> createDeleteMessageBatchRequestEntry(
+ identifiedRequest.id(), identifiedRequest.message()
+ ))
+ .collect(Collectors.toList());
+
+ // Since requests are batched together according to a combination of their queueUrl and overrideConfiguration,
+ // all requests must have the same overrideConfiguration, so it is sufficient to retrieve it from the first request.
+ Optional overrideConfiguration = identifiedRequests.get(0).message()
+ .overrideConfiguration();
+
+ return overrideConfiguration.map(
+ overrideConfig -> DeleteMessageBatchRequest.builder()
+ .queueUrl(batchKey)
+ .overrideConfiguration(
+ overrideConfig.toBuilder()
+ .applyMutation(USER_AGENT_APPLIER)
+ .build()
+ )
+ .entries(entries)
+ .build()
+ ).orElseGet(
+ () -> DeleteMessageBatchRequest.builder()
+ .queueUrl(batchKey)
+ .overrideConfiguration(o ->
+ o.applyMutation(USER_AGENT_APPLIER).build()
+ )
+ .entries(entries)
+ .build()
+ );
+ }
+
+ private static DeleteMessageBatchRequestEntry createDeleteMessageBatchRequestEntry(String id, DeleteMessageRequest request) {
+ return DeleteMessageBatchRequestEntry.builder().id(id).receiptHandle(request.receiptHandle()).build();
+ }
+
+
+ private static IdentifiableMessage createDeleteMessageResponse(
+ DeleteMessageBatchResultEntry successfulEntry, DeleteMessageBatchResponse batchResponse) {
+ String key = successfulEntry.id();
+ DeleteMessageResponse.Builder builder = DeleteMessageResponse.builder();
+ if (batchResponse.responseMetadata() != null) {
+ builder.responseMetadata(batchResponse.responseMetadata());
+ }
+ if (batchResponse.sdkHttpResponse() != null) {
+ builder.sdkHttpResponse(batchResponse.sdkHttpResponse());
+ }
+ DeleteMessageResponse response = builder.build();
+ return new IdentifiableMessage<>(key, response);
+ }
+
+ private static IdentifiableMessage deleteMessageCreateThrowable(BatchResultErrorEntry failedEntry) {
+ String key = failedEntry.id();
+ AwsErrorDetails errorDetailsBuilder = AwsErrorDetails.builder().errorCode(failedEntry.code())
+ .errorMessage(failedEntry.message()).build();
+ Throwable response = SqsException.builder().awsErrorDetails(errorDetailsBuilder).build();
+ return new IdentifiableMessage<>(key, response);
+ }
+
+ @Override
+ protected CompletableFuture batchAndSend(
+ List> identifiedRequests, String batchKey) {
+ DeleteMessageBatchRequest batchRequest = createDeleteMessageBatchRequest(identifiedRequests, batchKey);
+ return sqsAsyncClient.deleteMessageBatch(batchRequest);
+ }
+
+ @Override
+ protected String getBatchKey(DeleteMessageRequest request) {
+ return request.overrideConfiguration().map(overrideConfig -> request.queueUrl() + overrideConfig.hashCode())
+ .orElse(request.queueUrl());
+ }
+
+ @Override
+ protected List,
+ IdentifiableMessage>> mapBatchResponse(DeleteMessageBatchResponse batchResponse) {
+
+ List, IdentifiableMessage>> mappedResponses =
+ new ArrayList<>();
+ batchResponse.successful().forEach(
+ batchResponseEntry -> {
+ IdentifiableMessage response = createDeleteMessageResponse(batchResponseEntry,
+ batchResponse);
+ mappedResponses.add(Either.left(response));
+ });
+ batchResponse.failed().forEach(batchResponseEntry -> {
+ IdentifiableMessage response = deleteMessageCreateThrowable(batchResponseEntry);
+ mappedResponses.add(Either.right(response));
+ });
+ return mappedResponses;
+ }
+
+}
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/IdentifiableMessage.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/IdentifiableMessage.java
new file mode 100644
index 000000000000..63cc78f42b9f
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/IdentifiableMessage.java
@@ -0,0 +1,68 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.utils.Validate;
+
+/**
+ * Wrapper class for a message (either request/response) and its associated batch id.
+ *
+ * @param The message
+ */
+@SdkInternalApi
+public final class IdentifiableMessage {
+
+ private final String id;
+ private final MessageT message;
+
+ public IdentifiableMessage(String id, MessageT message) {
+ this.id = Validate.notNull(id, "ID cannot be null");
+ this.message = Validate.notNull(message, "Message cannot be null");
+ }
+
+ public String id() {
+ return id;
+ }
+
+ public MessageT message() {
+ return message;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+
+ IdentifiableMessage that = (IdentifiableMessage) o;
+
+ if (!id.equals(that.id)) {
+ return false;
+ }
+ return message.equals(that.message);
+ }
+
+ @Override
+ public int hashCode() {
+ int result = id.hashCode();
+ result = 31 * result + message.hashCode();
+ return result;
+ }
+}
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/QueueAttributesManager.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/QueueAttributesManager.java
new file mode 100644
index 000000000000..268b563ac694
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/QueueAttributesManager.java
@@ -0,0 +1,161 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+
+import static software.amazon.awssdk.services.sqs.internal.batchmanager.RequestBatchManager.USER_AGENT_APPLIER;
+
+import java.time.Duration;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicReference;
+import java.util.stream.Collectors;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.services.sqs.SqsAsyncClient;
+import software.amazon.awssdk.services.sqs.model.GetQueueAttributesRequest;
+import software.amazon.awssdk.services.sqs.model.QueueAttributeName;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest;
+import software.amazon.awssdk.utils.CompletableFutureUtils;
+import software.amazon.awssdk.utils.Validate;
+
+
+/**
+ * The {@code QueueAttributesManager} class is responsible for managing and retrieving specific attributes
+ * of an AWS SQS queue, such as message wait time and visibility timeout. It efficiently caches these attributes
+ * to minimize redundant API calls to SQS, ensuring that the attributes are fetched only once and reused in subsequent requests.
+ *
+ * This class uses an {@link AtomicReference} to maintain the state of the attribute map, allowing concurrent access
+ * and handling cases where the fetching of attributes may fail. If an error occurs during the retrieval of attributes,
+ * the state is reset to allow for a fresh attempt in subsequent calls.
+ *
+ * The class provides methods to get the visibility timeout and calculate the message receive timeout, which
+ * are asynchronously retrieved and processed using {@link CompletableFuture}. These methods handle cancellation
+ * scenarios by cancelling the SQS request if the calling future is cancelled.
+ *
+ * This class is intended for internal use and is marked with the {@link SdkInternalApi} annotation.
+ */
+@SdkInternalApi
+public final class QueueAttributesManager {
+
+ private static final List QUEUE_ATTRIBUTE_NAMES =
+ Arrays.asList(QueueAttributeName.RECEIVE_MESSAGE_WAIT_TIME_SECONDS,
+ QueueAttributeName.VISIBILITY_TIMEOUT);
+ private final SqsAsyncClient sqsClient;
+ private final String queueUrl;
+ private final AtomicReference>> queueAttributeMap = new AtomicReference<>();
+
+ public QueueAttributesManager(SqsAsyncClient sqsClient, String queueUrl) {
+ this.sqsClient = sqsClient;
+ this.queueUrl = queueUrl;
+ }
+
+ /**
+ * Retrieves the received message timeout based on the provided request and queue attributes.
+ *
+ * @param rq The receive message request
+ * @param configuredWaitTime The configured minimum wait time
+ * @return CompletableFuture with the calculated receive message timeout in milliseconds
+ */
+ public CompletableFuture getReceiveMessageTimeout(ReceiveMessageRequest rq, Duration configuredWaitTime) {
+ Integer waitTimeSeconds = rq.waitTimeSeconds();
+ if (waitTimeSeconds != null) {
+ long waitTimeMillis = TimeUnit.SECONDS.toMillis(waitTimeSeconds);
+ return CompletableFuture.completedFuture(Duration.ofMillis(Math.max(configuredWaitTime.toMillis(), waitTimeMillis)));
+ }
+
+ CompletableFuture> attributeFuture = getAttributeMap();
+ CompletableFuture resultFuture = attributeFuture.thenApply(attributes -> {
+ String waitTimeSecondsStr = attributes.get(QueueAttributeName.RECEIVE_MESSAGE_WAIT_TIME_SECONDS);
+ long waitTimeFromSqsMillis = TimeUnit.SECONDS.toMillis(Long.parseLong(waitTimeSecondsStr));
+ return Duration.ofMillis(Math.max(configuredWaitTime.toMillis(), waitTimeFromSqsMillis));
+ });
+
+ return CompletableFutureUtils.forwardExceptionTo(resultFuture, attributeFuture);
+ }
+
+ /**
+ * Retrieves the visibility timeout for the queue.
+ *
+ * @return CompletableFuture with the visibility timeout in nanoseconds
+ */
+ public CompletableFuture getVisibilityTimeout() {
+ CompletableFuture> attributeFuture = getAttributeMap();
+ CompletableFuture resultFuture = attributeFuture.thenApply(attributes -> {
+ String visibilityTimeoutStr = attributes.get(QueueAttributeName.VISIBILITY_TIMEOUT);
+ return Duration.ofSeconds(Integer.parseInt(visibilityTimeoutStr));
+ });
+
+ return CompletableFutureUtils.forwardExceptionTo(resultFuture, attributeFuture);
+ }
+
+ /**
+ * Retrieves the queue attributes based on the predefined attribute names.
+ *
+ * @return CompletableFuture with the map of attribute names and their values.
+ */
+ private CompletableFuture> getAttributeMap() {
+ CompletableFuture> future = queueAttributeMap.get();
+
+ if (future == null || future.isCompletedExceptionally()) {
+ CompletableFuture> newFuture = new CompletableFuture<>();
+
+ if (queueAttributeMap.compareAndSet(future, newFuture)) {
+ fetchQueueAttributes().whenComplete((r, t) -> {
+ if (t != null) {
+ newFuture.completeExceptionally(t);
+ } else {
+ newFuture.complete(r);
+ }
+ });
+ return newFuture;
+ } else {
+ newFuture.cancel(true);
+ return queueAttributeMap.get();
+ }
+ }
+ return future;
+ }
+
+ /**
+ * Fetches the queue attributes from SQS and completes the provided future with the result.
+ *
+ * @return CompletableFuture with the map of attribute names and values.
+ */
+ private CompletableFuture> fetchQueueAttributes() {
+ GetQueueAttributesRequest request = GetQueueAttributesRequest.builder()
+ .queueUrl(queueUrl)
+ .attributeNames(QUEUE_ATTRIBUTE_NAMES)
+ .overrideConfiguration(o -> o
+ .applyMutation(USER_AGENT_APPLIER))
+ .build();
+
+ return sqsClient.getQueueAttributes(request)
+ .thenApply(response -> {
+ Map attributes = response.attributes();
+ Validate.notNull(attributes.get(QueueAttributeName.RECEIVE_MESSAGE_WAIT_TIME_SECONDS),
+ QueueAttributeName.RECEIVE_MESSAGE_WAIT_TIME_SECONDS
+ + " attribute is null in SQS.");
+ Validate.notNull(attributes.get(QueueAttributeName.VISIBILITY_TIMEOUT),
+ QueueAttributeName.VISIBILITY_TIMEOUT + " attribute is null in SQS.");
+ return attributes.entrySet().stream()
+ .filter(entry -> QUEUE_ATTRIBUTE_NAMES.contains(entry.getKey()))
+ .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+ });
+ }
+}
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveBatchManager.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveBatchManager.java
new file mode 100644
index 000000000000..1225c2fcea54
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveBatchManager.java
@@ -0,0 +1,75 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+import static software.amazon.awssdk.services.sqs.internal.batchmanager.ResponseBatchConfiguration.MAX_SUPPORTED_SQS_RECEIVE_MSG;
+
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.services.sqs.SqsAsyncClient;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageResponse;
+import software.amazon.awssdk.utils.SdkAutoCloseable;
+
+@SdkInternalApi
+public class ReceiveBatchManager implements SdkAutoCloseable {
+
+ private final SqsAsyncClient sqsClient;
+ private final ScheduledExecutorService executor;
+ private final ResponseBatchConfiguration config;
+ private final String queueUrl;
+ private final ReceiveQueueBuffer receiveQueueBuffer;
+ private final QueueAttributesManager queueAttributesManager;
+
+ public ReceiveBatchManager(SqsAsyncClient sqsClient, ScheduledExecutorService executor, ResponseBatchConfiguration config,
+ String queueUrl) {
+ this.sqsClient = sqsClient;
+ this.executor = executor;
+ this.config = config;
+ this.queueUrl = queueUrl;
+ this.queueAttributesManager = new QueueAttributesManager(sqsClient, queueUrl);
+ this.receiveQueueBuffer = ReceiveQueueBuffer.builder()
+ .executor(executor)
+ .sqsClient(sqsClient)
+ .config(config)
+ .queueUrl(queueUrl)
+ .queueAttributesManager(queueAttributesManager).build();
+ }
+
+ public CompletableFuture processRequest(ReceiveMessageRequest rq) {
+ if (receiveQueueBuffer.isShutDown()) {
+ throw new IllegalStateException("The client has been shut down.");
+ }
+ int numMessages = rq.maxNumberOfMessages() != null ? rq.maxNumberOfMessages() : MAX_SUPPORTED_SQS_RECEIVE_MSG;
+
+ return queueAttributesManager.getReceiveMessageTimeout(rq, config.messageMinWaitDuration()).thenCompose(waitTimeMs -> {
+ CompletableFuture receiveMessageFuture = new CompletableFuture<>();
+ receiveQueueBuffer.receiveMessage(receiveMessageFuture, numMessages);
+ executor.schedule(() -> receiveMessageFuture.complete(ReceiveMessageResponse.builder().build()),
+ waitTimeMs.toMillis(),
+ TimeUnit.MILLISECONDS);
+ return receiveMessageFuture;
+
+ });
+ }
+
+ @Override
+ public void close() {
+ receiveQueueBuffer.close();
+ }
+}
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveMessageBatchManager.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveMessageBatchManager.java
new file mode 100644
index 000000000000..909108aadfa0
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveMessageBatchManager.java
@@ -0,0 +1,117 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ScheduledExecutorService;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.services.sqs.SqsAsyncClient;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageResponse;
+import software.amazon.awssdk.utils.Logger;
+import software.amazon.awssdk.utils.SdkAutoCloseable;
+
+@SdkInternalApi
+public class ReceiveMessageBatchManager implements SdkAutoCloseable {
+
+ private static final Logger log = Logger.loggerFor(ReceiveMessageBatchManager.class);
+
+ private final SqsAsyncClient sqsClient;
+ private final ScheduledExecutorService executor;
+ private final ResponseBatchConfiguration config;
+ private final Map receiveBatchManagerMap = new ConcurrentHashMap<>();
+
+ public ReceiveMessageBatchManager(SqsAsyncClient sqsClient,
+ ScheduledExecutorService executor,
+ ResponseBatchConfiguration config) {
+ this.sqsClient = sqsClient;
+ this.executor = executor;
+ this.config = config;
+
+
+ }
+
+ public CompletableFuture batchRequest(ReceiveMessageRequest request) {
+ String ineligibleReason = checkBatchingEligibility(request);
+ if (ineligibleReason == null) {
+ return receiveBatchManagerMap.computeIfAbsent(generateBatchKey(request), key -> createReceiveBatchManager(request))
+ .processRequest(request);
+ } else {
+ log.debug(() -> String.format("Batching skipped. Reason: %s", ineligibleReason));
+ return sqsClient.receiveMessage(request);
+ }
+ }
+
+ /**
+ * Generates a unique key for batch processing based on the queue URL and any override configuration.
+ *
+ * @param request The receive message request.
+ * @return The generated batch key.
+ */
+ private String generateBatchKey(ReceiveMessageRequest request) {
+ return request.overrideConfiguration()
+ .map(config -> request.queueUrl() + config.hashCode())
+ .orElse(request.queueUrl());
+ }
+
+ private ReceiveBatchManager createReceiveBatchManager(ReceiveMessageRequest request) {
+ return new ReceiveBatchManager(sqsClient, executor, config, request.queueUrl());
+ }
+
+ @Override
+ public void close() {
+ receiveBatchManagerMap.values().forEach(ReceiveBatchManager::close);
+ }
+
+ private String checkBatchingEligibility(ReceiveMessageRequest rq) {
+ if (!hasCompatibleAttributes(rq)) {
+ return "Incompatible attributes.";
+ }
+ if (rq.visibilityTimeout() != null) {
+ return "Visibility timeout is set.";
+ }
+ if (!isBufferingEnabled()) {
+ return "Buffering is disabled.";
+ }
+ if (rq.overrideConfiguration().isPresent()) {
+ return "Request has override configurations.";
+ }
+ return null;
+ }
+
+ private boolean hasCompatibleAttributes(ReceiveMessageRequest rq) {
+ return !rq.hasAttributeNames()
+ && hasCompatibleSystemAttributes(rq)
+ && hasCompatibleMessageAttributes(rq);
+ }
+
+ private boolean hasCompatibleSystemAttributes(ReceiveMessageRequest rq) {
+ return !rq.hasMessageSystemAttributeNames()
+ || config.messageSystemAttributeNames().equals(rq.messageSystemAttributeNames());
+ }
+
+ private boolean hasCompatibleMessageAttributes(ReceiveMessageRequest rq) {
+ return !rq.hasMessageAttributeNames()
+ || config.receiveMessageAttributeNames().equals(rq.messageAttributeNames());
+ }
+
+ private boolean isBufferingEnabled() {
+ return config.maxInflightReceiveBatches() > 0 && config.maxDoneReceiveBatches() > 0;
+ }
+
+}
\ No newline at end of file
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveQueueBuffer.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveQueueBuffer.java
new file mode 100644
index 000000000000..895fa3d8a57a
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveQueueBuffer.java
@@ -0,0 +1,246 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+import static software.amazon.awssdk.services.sqs.internal.batchmanager.ResponseBatchConfiguration.MAX_SUPPORTED_SQS_RECEIVE_MSG;
+
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Queue;
+import java.util.concurrent.CancellationException;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ConcurrentLinkedQueue;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.concurrent.atomic.AtomicInteger;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.services.sqs.SqsAsyncClient;
+import software.amazon.awssdk.services.sqs.model.Message;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageResponse;
+import software.amazon.awssdk.utils.SdkAutoCloseable;
+
+@SdkInternalApi
+public class ReceiveQueueBuffer implements SdkAutoCloseable {
+
+ private final ScheduledExecutorService executor;
+ private final SqsAsyncClient sqsClient;
+ private final ResponseBatchConfiguration config;
+ private final String queueUrl;
+ private final QueueAttributesManager queueAttributesManager;
+
+ private final Queue finishedTasks = new ConcurrentLinkedQueue<>();
+ private final Queue futures = new ConcurrentLinkedQueue<>();
+
+ private final AtomicInteger inflightReceiveMessageBatches = new AtomicInteger(0);
+ private final AtomicBoolean shutDown = new AtomicBoolean(false);
+
+ private final AtomicBoolean processingFutures = new AtomicBoolean(false);
+
+ private ReceiveQueueBuffer(Builder builder) {
+ this.executor = builder.executor;
+ this.sqsClient = builder.sqsClient;
+ this.config = builder.config;
+ this.queueUrl = builder.queueUrl;
+ this.queueAttributesManager = builder.queueAttributesManager;
+ }
+
+ public static Builder builder() {
+ return new Builder();
+ }
+
+ public void receiveMessage(CompletableFuture receiveMessageFuture, int numMessages) {
+ futures.add(new FutureRequestWrapper(receiveMessageFuture, numMessages));
+ satisfyFuturesFromBuffer();
+ spawnMoreReceiveTasks();
+ }
+
+ public boolean isShutDown() {
+ return shutDown.get();
+ }
+
+ @Override
+ public void close() {
+ if (this.shutDown.compareAndSet(false, true)) {
+ while (!finishedTasks.isEmpty()) {
+ ReceiveSqsMessageHelper batch = finishedTasks.poll();
+ if (inflightReceiveMessageBatches.get() > 0) {
+ inflightReceiveMessageBatches.decrementAndGet();
+ }
+ if (batch != null) {
+ batch.clear();
+ }
+ }
+ futures.forEach(futureWrapper -> {
+ if (!futureWrapper.getFuture().isDone()) {
+ futureWrapper.getFuture().completeExceptionally(new CancellationException("Shutdown in progress"));
+ }
+ });
+ futures.clear();
+ }
+ }
+
+ private void spawnMoreReceiveTasks() {
+ if (shutDown.get()) {
+ return;
+ }
+
+ int desiredBatches = determineDesiredBatches();
+ if (finishedTasks.size() >= desiredBatches) {
+ return;
+ }
+
+ if (!finishedTasks.isEmpty() && (finishedTasks.size() + inflightReceiveMessageBatches.get()) >= desiredBatches) {
+ return;
+ }
+
+ queueAttributesManager.getVisibilityTimeout().thenAccept(visibilityTimeout -> {
+ int max = Math.max(config.maxInflightReceiveBatches(), 1);
+ int toSpawn = max - inflightReceiveMessageBatches.get();
+ if (toSpawn > 0) {
+ ReceiveSqsMessageHelper receiveSqsMessageHelper = new ReceiveSqsMessageHelper(
+ queueUrl, sqsClient, visibilityTimeout, config);
+ inflightReceiveMessageBatches.incrementAndGet();
+ receiveSqsMessageHelper.asyncReceiveMessage()
+ .whenComplete((response, exception) -> reportBatchFinished(response));
+ }
+ });
+ }
+
+ private int determineDesiredBatches() {
+ int desiredBatches = Math.max(config.maxDoneReceiveBatches(), 1);
+ int totalRequested = futures.stream()
+ .mapToInt(FutureRequestWrapper::getRequestedSize)
+ .sum();
+ int batchesNeededToFulfillFutures = (int) Math.ceil((float) totalRequested / MAX_SUPPORTED_SQS_RECEIVE_MSG);
+ desiredBatches = Math.min(batchesNeededToFulfillFutures, desiredBatches);
+
+ return desiredBatches;
+ }
+
+ private void fulfillFuture(FutureRequestWrapper futureWrapper) {
+ ReceiveSqsMessageHelper peekedMessage = finishedTasks.peek();
+ List messages = new LinkedList<>();
+ Throwable exception = peekedMessage.getException();
+ int numRetrieved = 0;
+ boolean batchDone = false;
+
+ if (exception != null) {
+ futureWrapper.getFuture().completeExceptionally(exception);
+ finishedTasks.poll();
+ return;
+ }
+
+ while (numRetrieved < futureWrapper.getRequestedSize()) {
+ Message msg = peekedMessage.removeMessage();
+ if (msg != null) {
+ messages.add(msg);
+ ++numRetrieved;
+ } else {
+ batchDone = true;
+ break;
+ }
+ }
+ batchDone = batchDone || peekedMessage.isEmpty();
+ if (batchDone) {
+ finishedTasks.poll();
+ }
+ futureWrapper.getFuture().complete(ReceiveMessageResponse.builder().messages(messages).build());
+ }
+
+ private void satisfyFuturesFromBuffer() {
+ if (!processingFutures.compareAndSet(false, true)) {
+ return;
+ }
+ try {
+ do {
+ futures.removeIf(future -> {
+ if (future.getFuture().isDone()) {
+ return true;
+ }
+ if (!finishedTasks.isEmpty()) {
+ fulfillFuture(future);
+ return true;
+ }
+ return false;
+ });
+ } while (!futures.isEmpty() && !finishedTasks.isEmpty());
+ } finally {
+ processingFutures.set(false);
+ }
+ }
+
+ private void reportBatchFinished(ReceiveSqsMessageHelper batch) {
+ finishedTasks.offer(batch);
+ inflightReceiveMessageBatches.decrementAndGet();
+ satisfyFuturesFromBuffer();
+ spawnMoreReceiveTasks();
+ }
+
+ private static class FutureRequestWrapper {
+ private final CompletableFuture future;
+ private final int requestedSize;
+
+ FutureRequestWrapper(CompletableFuture future, int requestedSize) {
+ this.future = future;
+ this.requestedSize = requestedSize;
+ }
+
+ public CompletableFuture getFuture() {
+ return future;
+ }
+
+ public int getRequestedSize() {
+ return requestedSize;
+ }
+ }
+
+ public static class Builder {
+ private ScheduledExecutorService executor;
+ private SqsAsyncClient sqsClient;
+ private ResponseBatchConfiguration config;
+ private String queueUrl;
+ private QueueAttributesManager queueAttributesManager;
+
+ public Builder executor(ScheduledExecutorService executor) {
+ this.executor = executor;
+ return this;
+ }
+
+ public Builder sqsClient(SqsAsyncClient sqsClient) {
+ this.sqsClient = sqsClient;
+ return this;
+ }
+
+ public Builder config(ResponseBatchConfiguration config) {
+ this.config = config;
+ return this;
+ }
+
+ public Builder queueUrl(String queueUrl) {
+ this.queueUrl = queueUrl;
+ return this;
+ }
+
+ public Builder queueAttributesManager(QueueAttributesManager queueAttributesManager) {
+ this.queueAttributesManager = queueAttributesManager;
+ return this;
+ }
+
+ public ReceiveQueueBuffer build() {
+ return new ReceiveQueueBuffer(this);
+ }
+ }
+}
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveSqsMessageHelper.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveSqsMessageHelper.java
new file mode 100644
index 000000000000..07314d2e86e2
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/ReceiveSqsMessageHelper.java
@@ -0,0 +1,179 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+
+import static software.amazon.awssdk.services.sqs.internal.batchmanager.RequestBatchManager.USER_AGENT_APPLIER;
+
+import java.time.Duration;
+import java.util.List;
+import java.util.Objects;
+import java.util.Queue;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ConcurrentLinkedQueue;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.annotations.SdkTestInternalApi;
+import software.amazon.awssdk.services.sqs.SqsAsyncClient;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchRequest;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchRequestEntry;
+import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchResponse;
+import software.amazon.awssdk.services.sqs.model.Message;
+import software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest;
+import software.amazon.awssdk.utils.CollectionUtils;
+import software.amazon.awssdk.utils.Logger;
+import software.amazon.awssdk.utils.NumericUtils;
+
+/**
+ * The {@code ReceiveSqsMessageHelper} class forms a {@link ReceiveMessageRequest} request based on configuration settings,
+ * collects messages from an AWS SQS queue, and handles exceptions during the process.
+ *
+ * It manages message visibility timeout by tracking the visibility deadline and expiring messages if not processed in time,
+ * ensuring unhandled messages return to the queue for reprocessing.
+ *
+ * Additionally, the class supports clearing messages in the batch and changing their visibility as needed.
+ */
+
+@SdkInternalApi
+public class ReceiveSqsMessageHelper {
+
+ private static final Logger log = Logger.loggerFor(ReceiveSqsMessageHelper.class);
+ private final String queueUrl;
+ private final SqsAsyncClient asyncClient;
+ private final Duration visibilityTimeout;
+ private final ResponseBatchConfiguration config;
+ private volatile Throwable exception;
+ private Queue messages = new ConcurrentLinkedQueue<>();
+ private volatile long visibilityDeadlineNano;
+
+ public ReceiveSqsMessageHelper(String queueUrl,
+ SqsAsyncClient asyncClient,
+ Duration visibilityTimeout,
+ ResponseBatchConfiguration config) {
+ this.queueUrl = queueUrl;
+ this.asyncClient = asyncClient;
+ this.visibilityTimeout = visibilityTimeout;
+ this.config = config;
+ }
+
+ public CompletableFuture asyncReceiveMessage() {
+ ReceiveMessageRequest.Builder request =
+ ReceiveMessageRequest.builder()
+ .queueUrl(queueUrl)
+ .maxNumberOfMessages(config.maxBatchItems())
+ .overrideConfiguration(o -> o.applyMutation(USER_AGENT_APPLIER));
+
+ if (!CollectionUtils.isNullOrEmpty(config.messageSystemAttributeNames())) {
+ request.messageSystemAttributeNames(config.messageSystemAttributeNames());
+ }
+
+ if (!CollectionUtils.isNullOrEmpty(config.receiveMessageAttributeNames())) {
+ request.messageAttributeNames(config.receiveMessageAttributeNames());
+ }
+
+ request.visibilityTimeout(NumericUtils.saturatedCast(this.visibilityTimeout.getSeconds()));
+
+ try {
+ return asyncClient.receiveMessage(request.build())
+ .handle((response, throwable) -> {
+ if (throwable != null) {
+ this.exception = throwable;
+ } else {
+ messages.addAll(response.messages());
+ }
+ return this;
+ });
+ } finally {
+ visibilityDeadlineNano = System.nanoTime() + visibilityTimeout.toNanos();
+ }
+
+ }
+
+ public boolean isEmpty() {
+ return messages == null || messages.isEmpty();
+ }
+
+ public Throwable getException() {
+ return exception;
+ }
+
+ public Message removeMessage() {
+ if (isExpired()) {
+ clear();
+ return null;
+ }
+ return messages.poll();
+ }
+
+ private boolean isExpired() {
+ return System.nanoTime() > visibilityDeadlineNano;
+ }
+
+
+ public void clear() {
+ if (!isEmpty()) {
+ CompletableFuture nackedMessages = nackMessages();
+ if (nackedMessages != null) {
+ nackedMessages.exceptionally(throwable -> {
+ log.warn(() -> String.format(
+ "Failed to reset the visibility timeout of unprocessed messages for queueUrl: %s. "
+ + "As a result, these unprocessed messages will remain invisible in the queue for the "
+ + "duration of the visibility timeout (%s).",
+ queueUrl, visibilityTimeout
+ ), throwable);
+
+ return null;
+ });
+ }
+ }
+ }
+
+
+ private CompletableFuture nackMessages() {
+ if (messages == null || messages.isEmpty()) {
+ return null;
+ }
+
+ List entries =
+ IntStream.range(0, messages.size())
+ .mapToObj(i -> ChangeMessageVisibilityBatchRequestEntry.builder()
+ .id(String.valueOf(i))
+ .receiptHandle(Objects.requireNonNull(messages.poll())
+ .receiptHandle())
+ .visibilityTimeout(0)
+ .build())
+ .collect(Collectors.toList());
+
+ ChangeMessageVisibilityBatchRequest batchRequest =
+ ChangeMessageVisibilityBatchRequest.builder()
+ .queueUrl(queueUrl)
+ .entries(entries)
+ .overrideConfiguration(o -> o.applyMutation(USER_AGENT_APPLIER))
+ .build();
+
+ return asyncClient.changeMessageVisibilityBatch(batchRequest);
+ }
+
+ /**
+ * messages.size() is expensive since it is ConcurrentLinkedQueue.
+ * Thus, its used only for testing the results and not used in any internal classes.
+ */
+ @SdkTestInternalApi
+ public Integer messagesSize() {
+ return messages != null ? messages.size() : 0;
+ }
+}
\ No newline at end of file
diff --git a/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/RequestBatchBuffer.java b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/RequestBatchBuffer.java
new file mode 100644
index 000000000000..d13b32c29e1e
--- /dev/null
+++ b/services/sqs/src/main/java/software/amazon/awssdk/services/sqs/internal/batchmanager/RequestBatchBuffer.java
@@ -0,0 +1,165 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.sqs.internal.batchmanager;
+
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ScheduledFuture;
+import java.util.stream.Collectors;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+
+@SdkInternalApi
+public final class RequestBatchBuffer {
+ private final Object flushLock = new Object();
+
+ private final Map> idToBatchContext;
+ private final int maxBatchItems;
+ private final int maxBufferSize;
+ private final int maxBatchSizeInBytes;
+ /**
+ * Batch entries in a batch request require a unique ID so nextId keeps track of the ID to assign to the next
+ * BatchingExecutionContext. For simplicity, the ID is just an integer that is incremented everytime a new request and
+ * response pair is received.
+ */
+ private int nextId;
+ /**
+ * Keeps track of the ID of the next entry to be added in a batch request. This ID does not necessarily correlate to a request
+ * that already exists in the idToBatchContext map since it refers to the next entry (ex. if the last entry added to
+ * idToBatchContext had an id of 22, nextBatchEntry will have a value of 23).
+ */
+ private int nextBatchEntry;
+
+ /**
+ * The scheduled flush tasks associated with this batchBuffer.
+ */
+ private ScheduledFuture scheduledFlush;
+
+ public RequestBatchBuffer(ScheduledFuture scheduledFlush,
+ int maxBatchItems, int maxBatchSizeInBytes, int maxBufferSize) {
+ this.idToBatchContext = new ConcurrentHashMap<>();
+ this.nextId = 0;
+ this.nextBatchEntry = 0;
+ this.scheduledFlush = scheduledFlush;
+ this.maxBatchItems = maxBatchItems;
+ this.maxBufferSize = maxBufferSize;
+ this.maxBatchSizeInBytes = maxBatchSizeInBytes;
+ }
+
+ public Map> flushableRequests() {
+ synchronized (flushLock) {
+ return (isByteSizeThresholdCrossed(0) || isMaxBatchSizeLimitReached())
+ ? extractFlushedEntries(maxBatchItems)
+ : Collections.emptyMap();
+ }
+ }
+
+
+ private boolean isMaxBatchSizeLimitReached() {
+ return idToBatchContext.size() >= maxBatchItems;
+ }
+
+ public Map> flushableRequestsOnByteLimitBeforeAdd(RequestT request) {
+ synchronized (flushLock) {
+ if (maxBatchSizeInBytes > 0 && !idToBatchContext.isEmpty()) {
+ int incomingRequestBytes = RequestPayloadCalculator.calculateMessageSize(request).orElse(0);
+ if (isByteSizeThresholdCrossed(incomingRequestBytes)) {
+ return extractFlushedEntries(maxBatchItems);
+ }
+ }
+ return Collections.emptyMap();
+ }
+ }
+
+ private boolean isByteSizeThresholdCrossed(int incomingRequestBytes) {
+ if (maxBatchSizeInBytes < 0) {
+ return false;
+ }
+ int totalPayloadSize = idToBatchContext.values().stream()
+ .map(BatchingExecutionContext::responsePayloadByteSize)
+ .mapToInt(opt -> opt.orElse(0))
+ .sum() + incomingRequestBytes;
+ return totalPayloadSize > maxBatchSizeInBytes;
+ }
+
+ public Map> flushableScheduledRequests(int maxBatchItems) {
+ synchronized (flushLock) {
+ if (!idToBatchContext.isEmpty()) {
+ return extractFlushedEntries(maxBatchItems);
+ }
+ return Collections.emptyMap();
+ }
+ }
+
+ private Map> extractFlushedEntries(int maxBatchItems) {
+ LinkedHashMap> requestEntries = new LinkedHashMap<>();
+ String nextEntry;
+ while (requestEntries.size() < maxBatchItems && hasNextBatchEntry()) {
+ nextEntry = nextBatchEntry();
+ requestEntries.put(nextEntry, idToBatchContext.get(nextEntry));
+ idToBatchContext.remove(nextEntry);
+ }
+ return requestEntries;
+ }
+
+ public void put(RequestT request, CompletableFuture