Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for\n developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of\n the batch computing to remove the undifferentiated heavy lifting of configuring and managing required infrastructure.\n At the same time, it also adopts a familiar batch computing software approach. You can use Batch to efficiently\n provision resources d, and work toward eliminating capacity constraints, reducing your overall compute costs, and\n delivering results more quickly.
\nAs a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically\n provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific\n workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus\n on analyzing results and solving your specific problems instead.
", + "smithy.api#documentation": "Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for\n developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of\n the batch computing to remove the undifferentiated heavy lifting of configuring and managing required infrastructure.\n At the same time, it also adopts a familiar batch computing software approach. You can use Batch to efficiently\n provision resources, and work toward eliminating capacity constraints, reducing your overall compute costs, and\n delivering results more quickly.
\nAs a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically\n provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific\n workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus\n on analyzing results and solving your specific problems instead.
", "smithy.api#title": "AWS Batch", "smithy.api#xmlNamespace": { "uri": "http://batch.amazonaws.com/doc/2016-08-10/" @@ -1327,6 +1327,12 @@ "traits": { "smithy.api#documentation": "A short, human-readable string to provide additional details for the current status of the\n job attempt.
" } + }, + "taskProperties": { + "target": "com.amazonaws.batch#ListAttemptEcsTaskDetails", + "traits": { + "smithy.api#documentation": "The properties for a task definition that describes the container and volume definitions of\n an Amazon ECS task.
" + } } }, "traits": { @@ -1339,6 +1345,70 @@ "target": "com.amazonaws.batch#AttemptDetail" } }, + "com.amazonaws.batch#AttemptEcsTaskDetails": { + "type": "structure", + "members": { + "containerInstanceArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container instance that hosts the task.
" + } + }, + "taskArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon ECS task.
" + } + }, + "containers": { + "target": "com.amazonaws.batch#ListAttemptTaskContainerDetails", + "traits": { + "smithy.api#documentation": "A list of containers that are included in the taskProperties list.
An object that represents the details of a task.
" + } + }, + "com.amazonaws.batch#AttemptTaskContainerDetails": { + "type": "structure", + "members": { + "exitCode": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "The exit code for the container’s attempt. A non-zero exit code is considered failed.
" + } + }, + "name": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The name of a container.
" + } + }, + "reason": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "A short (255 max characters) string that's easy to understand and provides additional details for a\n running or stopped container.
" + } + }, + "logStreamName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log\n group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name\n when they reach the RUNNING status.
The network interfaces that are associated with the job attempt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that represents the details of a container that's part of a job attempt.
" + } + }, "com.amazonaws.batch#Boolean": { "type": "boolean" }, @@ -3747,7 +3817,7 @@ "containers": { "target": "com.amazonaws.batch#ListTaskContainerDetails", "traits": { - "smithy.api#documentation": "A list of containers that are included in the taskProperties\n list.
A list of containers that are included in the taskProperties list.
The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more\n information, see IAM roles for tasks in the\n Amazon Elastic Container Service Developer Guide.
\nThis is object is comparable to ContainerProperties:jobRoleArn.
\nThe Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more\n information, see IAM roles for tasks in the\n Amazon Elastic Container Service Developer Guide.
\nThis is object is comparable to ContainerProperties:jobRoleArn.
\nThe IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none.
If host is specified, all containers within the tasks that specified the\n host IPC mode on the same container instance share the same IPC resources with the\n host Amazon EC2 instance.
If task is specified, all containers within the specified task\n share the same IPC resources.
If none is specified, the IPC resources within the containers of a task are\n private, and are not shared with other containers in a task or on the container instance.
If no value is specified, then the IPC resource namespace sharing depends on the Docker\n daemon setting on the container instance. For more information, see IPC settings in\n the Docker run reference.
" + "smithy.api#documentation": "The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none.
If host is specified, all containers within the tasks that specified the\n host IPC mode on the same container instance share the same IPC resources with the\n host Amazon EC2 instance.
If task is specified, all containers within the specified task\n share the same IPC resources.
If none is specified, the IPC resources within the containers of a task are\n private, and are not shared with other containers in a task or on the container instance.
If no value is specified, then the IPC resource namespace sharing depends on the Docker\n daemon setting on the container instance. For more information, see IPC settings in\n the Docker run reference.
" } }, "taskRoleArn": { @@ -3865,7 +3935,7 @@ "pidMode": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The process namespace to use for the containers in the task. The valid values are\n host or task. For example, monitoring sidecars might need\n pidMode to access information about other containers running in the same\n task.
If host is specified, all containers within the tasks that specified the\n host PID mode on the same container instance share the process namespace with the\n host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same\n process namespace.
If no value is specified, the default is a private namespace for each container. For more\n information, see PID settings in the Docker run reference.
" + "smithy.api#documentation": "The process namespace to use for the containers in the task. The valid values are\n host or task. For example, monitoring sidecars might need\n pidMode to access information about other containers running in the same\n task.
If host is specified, all containers within the tasks that specified the\n host PID mode on the same container instance share the process namespace with the\n host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same\n process namespace.
If no value is specified, the default is a private namespace for each container. For more\n information, see PID settings in the Docker run reference.
" } }, "networkConfiguration": { @@ -3894,10 +3964,16 @@ "com.amazonaws.batch#EksAttemptContainerDetail": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The name of a container.
" + } + }, "exitCode": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The exit code returned for the job attempt. A non-zero exit code is considered failed.
" + "smithy.api#documentation": "The exit code returned for the job attempt. A non-zero exit code is considered\n failed.
" } }, "reason": { @@ -4109,7 +4185,7 @@ "exitCode": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The exit code returned for the job attempt. A non-zero exit code is considered failed.
" + "smithy.api#documentation": "The exit code returned for the job attempt. A non-zero exit code is considered\n failed.
" } }, "reason": { @@ -4175,7 +4251,7 @@ "name": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "A pointer to the container that you want to override. The name must match a unique container name that you wish to override.
" + "smithy.api#documentation": "A pointer to the container that you want to override. The name must match a unique container\n name that you wish to override.
" } }, "image": { @@ -4263,7 +4339,7 @@ "allowPrivilegeEscalation": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process. The default value is false.
Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent\n process. The default value is false.
References a Kubernetes secret resource. This object must start and end with an alphanumeric character, is required to be lowercase, can include periods (.) and hyphens (-), and can't contain more than 253 characters.
\n\n ImagePullSecret$name is required when this object is used.
References a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain\n access to pull an images from a private registry.
\n\n ImagePullSecret$name is required when this object is used.
These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init\n Containers in the Kubernetes documentation.
\nThis object is limited to 10 elements
\nThese containers run before application containers, always runs to completion, and must\n complete successfully before the next container starts. These containers are registered with the\n Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.\n For more information, see Init\n Containers in the Kubernetes documentation.
\nThis object is limited to 10 elements
\nDisplays the reference pointer to the Kubernetes secret resource.
" + "smithy.api#documentation": "Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain\n access to pull an images from a private registry.
" } }, "containers": { @@ -4535,7 +4611,7 @@ "initContainers": { "target": "com.amazonaws.batch#EksContainerOverrideList", "traits": { - "smithy.api#documentation": "The overrides for the conatainers defined in the Amazon EKS pod. These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init\n Containers in the Kubernetes documentation.
\nThis object is limited to 10 elements
\nThe overrides for the conatainers defined in the Amazon EKS pod. These containers run before\n application containers, always runs to completion, and must complete successfully before the next\n container starts. These containers are registered with the Amazon EKS Connector agent and persists the\n registration information in the Kubernetes backend data store. For more information, see Init\n Containers in the Kubernetes documentation.
\nThis object is limited to 10 elements
\nProvides a unique identifier for the ImagePullSecret. This object is required when EksPodProperties$imagePullSecrets is used.
Provides a unique identifier for the ImagePullSecret. This object is required\n when EksPodProperties$imagePullSecrets is used.
References a Kubernetes configuration resource that holds a list of secrets. These secrets help to gain access to pull an image from a private registry.
" + "smithy.api#documentation": "References a Kubernetes secret resource. This name of the secret must start and end with an\n alphanumeric character, is required to be lowercase, can include periods (.) and hyphens (-), and\n can't contain more than 253 characters.
" } }, "com.amazonaws.batch#ImagePullSecrets": { @@ -4944,7 +5020,7 @@ "containerProperties": { "target": "com.amazonaws.batch#ContainerProperties", "traits": { - "smithy.api#documentation": "An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties, ecsProperties, or\n nodeProperties.
An object with properties specific to Amazon ECS-based jobs. When\n containerProperties is used in the job definition, it can't be used in addition to\n eksProperties, ecsProperties, or nodeProperties.
An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or eksProperties.
If the job runs on Fargate resources, don't specify nodeProperties. Use\n containerProperties instead.
An object with properties that are specific to multi-node parallel jobs. When\n nodeProperties is used in the job definition, it can't be used in addition to\n containerProperties, ecsProperties, or\n eksProperties.
If the job runs on Fargate resources, don't specify nodeProperties. Use\n containerProperties instead.
An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties\n is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.
An object that contains the properties for the Amazon ECS resources of a job.When\n ecsProperties is used in the job definition, it can't be used in addition to\n containerProperties, eksProperties, or\n nodeProperties.
An object with properties that are specific to Amazon EKS-based jobs. When eksProperties\n is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or nodeProperties.
An object with properties that are specific to Amazon EKS-based jobs. When\n eksProperties is used in the job definition, it can't be used in addition to\n containerProperties, ecsProperties, or\n nodeProperties.
A short, human-readable string to provide more details for the current status of the job.
\n\n CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have insufficient capacity to\n service the job.
\n MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments have a\n maxVcpu setting that is smaller than the job requirements.
\n MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no connected instances\n that meet the job requirements.
\n MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have problems with the\n service role permissions.
A short, human-readable string to provide more details for the current status of the\n job.
\n\n CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have\n insufficient capacity to service the job.
\n MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments\n have a maxVcpu setting that is smaller than the job requirements.
\n MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no\n connected instances that meet the job requirements.
\n MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have\n problems with the service role permissions.
An object that represents the details for the container that's associated with the\n job. If the details are for a multiple-container job, this object will be empty.
" + "smithy.api#documentation": "An object that represents the details for the container that's associated with the job. If\n the details are for a multiple-container job, this object will be empty.
" } }, "nodeDetails": { @@ -5357,7 +5433,7 @@ "target": "com.amazonaws.batch#JobStateTimeLimitActionsState", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The state of the job needed to trigger the action. The only supported value is \"RUNNABLE\".
The state of the job needed to trigger the action. The only supported value is RUNNABLE.
The action to take when a job is at the head of the job queue in the specified state for the specified period of\n time. The only supported value is \"CANCEL\", which will cancel the job.
The action to take when a job is at the head of the job queue in the specified state for the specified period of\n time. The only supported value is CANCEL, which will cancel the job.
Linux-specific modifications that are applied to the container, such as details for device\n mappings.
" } }, + "com.amazonaws.batch#ListAttemptEcsTaskDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#AttemptEcsTaskDetails" + } + }, + "com.amazonaws.batch#ListAttemptTaskContainerDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#AttemptTaskContainerDetails" + } + }, "com.amazonaws.batch#ListEcsTaskDetails": { "type": "list", "member": { @@ -6332,7 +6420,7 @@ "instanceTypes": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "The instance types of the underlying host infrastructure of a multi-node parallel job.
\nThis parameter isn't applicable to jobs that are running on Fargate resources.
\nIn addition, this list object is currently limited to one element.
\nThe instance types of the underlying host infrastructure of a multi-node parallel\n job.
\nThis parameter isn't applicable to jobs that are running on Fargate resources.
\nIn addition, this list object is currently limited to one element.
\nThe dependency condition of the container. The following are the available conditions and\n their behavior:
\n\n START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
\n COMPLETE - This condition validates that a dependent container runs to\n completion (exits) before permitting other containers to start. This can be useful for\n nonessential containers that run a script and then exit. This condition can't be set on an\n essential container.
\n SUCCESS - This condition is the same as COMPLETE, but it also\n requires that the container exits with a zero status. This condition can't be set on an\n essential container.
The dependency condition of the container. The following are the available conditions and\n their behavior:
\n\n START - This condition emulates the behavior of links and volumes today. It\n validates that a dependent container is started before permitting other containers to start.\n
\n COMPLETE - This condition validates that a dependent container runs to\n completion (exits) before permitting other containers to start. This can be useful for\n nonessential containers that run a script and then exit. This condition can't be set on an\n essential container.
\n SUCCESS - This condition is the same as COMPLETE, but it also\n requires that the container exits with a zero status. This condition can't be set on an\n essential container.
The name of a container. The name can be used as a unique identifier to target your dependsOn and Overrides objects.
The name of a container. The name can be used as a unique identifier to target your\n dependsOn and Overrides objects.
The parameters in the request body for the Lambda input event.
" } + }, + "function": { + "target": "com.amazonaws.bedrockagentruntime#Function", + "traits": { + "smithy.api#documentation": "The function in the action group to call.
" + } } }, "traits": { - "smithy.api#documentation": "Contains information about the action group being invoked.
" + "smithy.api#documentation": "Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace in the Amazon Bedrock User Guide.
" } }, "com.amazonaws.bedrockagentruntime#ActionGroupInvocationOutput": { @@ -96,6 +102,16 @@ "smithy.api#pattern": "^[0-9a-zA-Z]+$" } }, + "com.amazonaws.bedrockagentruntime#AgentVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + } + }, "com.amazonaws.bedrockagentruntime#AmazonBedrockAgentRunTimeService": { "type": "service", "version": "2023-07-26", @@ -789,12 +805,151 @@ } } }, + "com.amazonaws.bedrockagentruntime#ApiContentMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#PropertyParameters" + } + }, + "com.amazonaws.bedrockagentruntime#ApiInvocationInput": { + "type": "structure", + "members": { + "actionGroup": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The action group that the API operation belongs to.
", + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The HTTP method of the API operation.
" + } + }, + "apiPath": { + "target": "com.amazonaws.bedrockagentruntime#ApiPath", + "traits": { + "smithy.api#documentation": "The path to the API operation.
" + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagentruntime#ApiParameters", + "traits": { + "smithy.api#documentation": "The parameters to provide for the API request, as the agent elicited from the user.
" + } + }, + "requestBody": { + "target": "com.amazonaws.bedrockagentruntime#ApiRequestBody", + "traits": { + "smithy.api#documentation": "The request body to provide for the API request, as the agent elicited from the user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the API operation that the agent predicts should be called.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the Retrieve response\n
The name of the parameter.
" + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data type for the parameter.
" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a parameter to provide to the API request.
\nThis data type is used in the following API operations:
\n\n Retrieve response\n
\nThe content of the request body. The key of the object in this field is a media type defining the format of the request body.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request body to provide for the API request, as the agent elicited from the user.
\nThis data type is used in the following API operations:
\n\n Retrieve response\n
\nThe action group that the API operation belongs to.
", + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The HTTP method for the API operation.
" + } + }, + "apiPath": { + "target": "com.amazonaws.bedrockagentruntime#ApiPath", + "traits": { + "smithy.api#documentation": "The path to the API operation.
" + } + }, + "responseBody": { + "target": "com.amazonaws.bedrockagentruntime#ResponseBody", + "traits": { + "smithy.api#documentation": "The response body from the API operation. The key of the object is the content type. The response may be returned directly or from the Lambda function.
" + } + }, + "httpStatusCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "http status code from API execution response (for example: 200, 400, 500).
" + } + }, + "responseState": { + "target": "com.amazonaws.bedrockagentruntime#ResponseState", + "traits": { + "smithy.api#documentation": "Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the API operation that was called from the action group and the response body that was returned.
\nThis data type is used in the following API operations:
\nIn the returnControlInvocationResults of the Retrieve request\n
The body of the API response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the body of the API response.
\nThis data type is used in the following API operations:
\nIn the returnControlInvocationResults field of the Retrieve request\n
The action group that the function belongs to.
", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagentruntime#FunctionParameters", + "traits": { + "smithy.api#documentation": "A list of parameters of the function.
" + } + }, + "function": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the function that the agent predicts should be called.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the Retrieve response\n
The name of the parameter.
" + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data type of the parameter.
" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a parameter of the function.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the Retrieve response\n
The action group that the function belongs to.
", + "smithy.api#required": {} + } + }, + "function": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the function that was called.
" + } + }, + "responseBody": { + "target": "com.amazonaws.bedrockagentruntime#ResponseBody", + "traits": { + "smithy.api#documentation": "The response from the function call using the parameters. The response may be returned directly or from the Lambda function.
" + } + }, + "responseState": { + "target": "com.amazonaws.bedrockagentruntime#ResponseState", + "traits": { + "smithy.api#documentation": "Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the function that was called from the action group and the response that was returned.
\nThis data type is used in the following API operations:
\nIn the returnControlInvocationResults of the Retrieve request\n
Contains information about the API operation that the agent predicts should be called.
" + } + }, + "functionInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#FunctionInvocationInput", + "traits": { + "smithy.api#documentation": "Contains information about the function that the agent predicts should be called.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the API operation or function that the agent predicts should be called.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the Retrieve response\n
The result from the API response from the action group invocation.
" + } + }, + "functionResult": { + "target": "com.amazonaws.bedrockagentruntime#FunctionResult", + "traits": { + "smithy.api#documentation": "The result from the function from the action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A result from the action group invocation.
\nThis data type is used in the following API operations:
\n\n Retrieve request\n
\nSends a prompt for the agent to process and respond to.
\nThe CLI doesn't support InvokeAgent.
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
Include attributes for the session or prompt in the sessionState object.
The response is returned in the bytes field of the chunk object.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
Errors are also surfaced in the response.
\nSends a prompt for the agent to process and respond to. Use return control event type for function calling.
\nThe CLI doesn't support InvokeAgent.
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or parameters returned from the action group.
Use return control event type for function calling.
\nThe response is returned in the bytes field of the chunk object.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
Errors are also surfaced in the response.
\nThe prompt text to send the agent.
", - "smithy.api#required": {} + "smithy.api#documentation": "The prompt text to send the agent.
" } } }, @@ -1680,7 +1998,13 @@ } }, "traits": { - "smithy.api#documentation": "A parameter in the Lambda input event.
" + "smithy.api#documentation": "A parameter for the API request or function.
" + } + }, + "com.amazonaws.bedrockagentruntime#ParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Parameter" } }, "com.amazonaws.bedrockagentruntime#Parameters": { @@ -1897,6 +2221,20 @@ } } }, + "com.amazonaws.bedrockagentruntime#PropertyParameters": { + "type": "structure", + "members": { + "properties": { + "target": "com.amazonaws.bedrockagentruntime#ParameterList", + "traits": { + "smithy.api#documentation": "A list of parameters in the request body.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the parameters in the request body.
" + } + }, "com.amazonaws.bedrockagentruntime#Rationale": { "type": "structure", "members": { @@ -1956,7 +2294,7 @@ } }, "traits": { - "smithy.api#documentation": "The parameters in the request body for the Lambda input event.
" + "smithy.api#documentation": "The parameters in the API request body.
" } }, "com.amazonaws.bedrockagentruntime#ResourceNotFoundException": { @@ -1967,11 +2305,37 @@ } }, "traits": { - "smithy.api#documentation": "The specified resource ARN was not found. Check the ARN and try your request again.
", + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, + "com.amazonaws.bedrockagentruntime#ResponseBody": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#ContentBody" + } + }, + "com.amazonaws.bedrockagentruntime#ResponseState": { + "type": "enum", + "members": { + "FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILURE" + } + }, + "REPROMPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPROMPT" + } + } + } + }, "com.amazonaws.bedrockagentruntime#ResponseStream": { "type": "union", "members": { @@ -1984,7 +2348,13 @@ "trace": { "target": "com.amazonaws.bedrockagentruntime#TracePart", "traits": { - "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" + "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" + } + }, + "returnControl": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlPayload", + "traits": { + "smithy.api#documentation": "Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" } }, "internalServerException": { @@ -2002,7 +2372,7 @@ "resourceNotFoundException": { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", "traits": { - "smithy.api#documentation": "The specified resource ARN was not found. Check the ARN and try your request again.
" + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" } }, "serviceQuotaExceededException": { @@ -2569,6 +2939,39 @@ "target": "com.amazonaws.bedrockagentruntime#RetrievedReference" } }, + "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#InvocationResultMember" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentruntime#ReturnControlPayload": { + "type": "structure", + "members": { + "invocationInputs": { + "target": "com.amazonaws.bedrockagentruntime#InvocationInputs", + "traits": { + "smithy.api#documentation": "A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
" + } + }, + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information to return from the action group that the agent has predicted to invoke.
\nThis data type is used in the following API operations:
\n\n Retrieve response\n
\nContains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see Prompt template placeholder variables.
" } + }, + "returnControlInvocationResults": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults", + "traits": { + "smithy.api#documentation": "Contains information about the results from the action group invocation.
" + } + }, + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the invocation.
" + } } }, "traits": { @@ -2842,6 +3257,12 @@ "smithy.api#documentation": "The unique identifier of the session with the agent.
" } }, + "agentVersion": { + "target": "com.amazonaws.bedrockagentruntime#AgentVersion", + "traits": { + "smithy.api#documentation": "The version of the agent.
" + } + }, "trace": { "target": "com.amazonaws.bedrockagentruntime#Trace", "traits": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent.2023-06-05.json b/codegen/sdk-codegen/aws-models/bedrock-agent.2023-06-05.json index 50429f5f99f..8acc8289a0c 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent.2023-06-05.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent.2023-06-05.json @@ -40,7 +40,13 @@ "lambda": { "target": "com.amazonaws.bedrockagent#LambdaArn", "traits": { - "smithy.api#documentation": "The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + }, + "customControl": { + "target": "com.amazonaws.bedrockagent#CustomControlMethod", + "traits": { + "smithy.api#documentation": "To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.
The ARN of the agent.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent.
", "smithy.api#required": {} } }, @@ -221,14 +227,14 @@ "agentResourceRoleArn": { "target": "com.amazonaws.bedrockagent#AgentRoleArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role with permissions to call API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", "smithy.api#required": {} } }, "customerEncryptionKeyArn": { "target": "com.amazonaws.bedrockagent#KmsKeyArn", "traits": { - "smithy.api#documentation": "The ARN of the KMS key that encrypts the agent.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" } }, "createdAt": { @@ -340,7 +346,7 @@ "actionGroupExecutor": { "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", "traits": { - "smithy.api#documentation": "The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" } }, "apiSchema": { @@ -349,6 +355,12 @@ "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" } }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
" + } + }, "actionGroupState": { "target": "com.amazonaws.bedrockagent#ActionGroupState", "traits": { @@ -388,7 +400,7 @@ "agentAliasArn": { "target": "com.amazonaws.bedrockagent#AgentAliasArn", "traits": { - "smithy.api#documentation": "The ARN of the alias of the agent.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias of the agent.
", "smithy.api#required": {} } }, @@ -902,7 +914,7 @@ "agentArn": { "target": "com.amazonaws.bedrockagent#AgentArn", "traits": { - "smithy.api#documentation": "The ARN of the agent that the version belongs to.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent that the version belongs to.
", "smithy.api#required": {} } }, @@ -948,14 +960,14 @@ "agentResourceRoleArn": { "target": "com.amazonaws.bedrockagent#AgentRoleArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role with permissions to invoke API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", "smithy.api#required": {} } }, "customerEncryptionKeyArn": { "target": "com.amazonaws.bedrockagent#KmsKeyArn", "traits": { - "smithy.api#documentation": "The ARN of the KMS key that encrypts the agent.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" } }, "createdAt": { @@ -2020,7 +2032,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
\nSpecify the following fields for security purposes.
\n\n agentResourceRoleArn – The ARN of the role with permissions to create an agent.
(Optional) customerEncryptionKeyArn – The ARN of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
\nSpecify the following fields for security purposes.
\n\n agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" } }, "apiSchema": { @@ -2138,6 +2150,12 @@ "traits": { "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } } }, "traits": { @@ -2310,14 +2328,13 @@ "agentResourceRoleArn": { "target": "com.amazonaws.bedrockagent#AgentRoleArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role with permissions to create the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
" } }, "customerEncryptionKeyArn": { "target": "com.amazonaws.bedrockagent#KmsKeyArn", "traits": { - "smithy.api#documentation": "The ARN of the KMS key with which to encrypt the agent.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" } }, "tags": { @@ -2495,7 +2512,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
\nIf you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
\nProvide the name and an optional description.
Provide the ARN with permissions to create a knowledge base in the roleArn field.
Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.
Provide the configuration for your vector store in the storageConfiguration object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
\nIf you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
\nProvide the name and an optional description.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.
Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.
Provide the configuration for your vector store in the storageConfiguration object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
The ARN of the IAM role with permissions to create the knowledge base.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", "smithy.api#required": {} } }, @@ -2594,6 +2611,17 @@ } } }, + "com.amazonaws.bedrockagent#CustomControlMethod": { + "type": "enum", + "members": { + "RETURN_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETURN_CONTROL" + } + } + } + }, "com.amazonaws.bedrockagent#DataSource": { "type": "structure", "members": { @@ -3496,6 +3524,62 @@ "smithy.api#documentation": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
A name for the function.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FunctionDescription", + "traits": { + "smithy.api#documentation": "A description of the function and its purpose.
" + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagent#ParameterMap", + "traits": { + "smithy.api#documentation": "The parameters that the agent elicits from the user to fulfill the function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
\nThis data type is used in the following API operations:
\nA list of functions that each define an action in the action group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
\nThis data type is used in the following API operations:
\nContains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
\nThis data type is used in the following API operations:
\nContains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
\nThis data type is used in the following API operations:
\nThe ARN of the knowledge base.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", "smithy.api#required": {} } }, @@ -4590,7 +4674,7 @@ "roleArn": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_.
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", "smithy.api#required": {} } }, @@ -5662,7 +5746,7 @@ "resourceArn": { "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "The ARN of the resource for which to list tags.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to list tags.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5757,7 +5841,7 @@ "collectionArn": { "target": "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn", "traits": { - "smithy.api#documentation": "The ARN of the OpenSearch Service vector store.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
", "smithy.api#required": {} } }, @@ -5818,6 +5902,51 @@ "smithy.api#pattern": "^.*$" } }, + "com.amazonaws.bedrockagent#ParameterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagent#ParameterDetail": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.bedrockagent#ParameterDescription", + "traits": { + "smithy.api#documentation": "A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#Type", + "traits": { + "smithy.api#documentation": "The data type of the parameter.
", + "smithy.api#required": {} + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the parameter is required for the agent to complete the function for action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a parameter in a function for an action group.
\nThis data type is used in the following API operations:
\nThe ARN of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
", "smithy.api#required": {} } }, @@ -6129,14 +6258,14 @@ "resourceArn": { "target": "com.amazonaws.bedrockagent#RdsArn", "traits": { - "smithy.api#documentation": "The ARN of the vector store.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vector store.
", "smithy.api#required": {} } }, "credentialsSecretArn": { "target": "com.amazonaws.bedrockagent#SecretArn", "traits": { - "smithy.api#documentation": "The ARN of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
", "smithy.api#required": {} } }, @@ -6259,7 +6388,7 @@ "credentialsSecretArn": { "target": "com.amazonaws.bedrockagent#SecretArn", "traits": { - "smithy.api#documentation": "The ARN of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
", "smithy.api#required": {} } }, @@ -6330,7 +6459,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified resource ARN was not found. Check the ARN and try your request again.
", + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -6361,7 +6490,7 @@ "bucketArn": { "target": "com.amazonaws.bedrockagent#S3BucketArn", "traits": { - "smithy.api#documentation": "The ARN of the bucket that contains the data source.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket that contains the data source.
", "smithy.api#required": {} } }, @@ -6439,7 +6568,7 @@ "kmsKeyArn": { "target": "com.amazonaws.bedrockagent#KmsKeyArn", "traits": { - "smithy.api#documentation": "The ARN of the KMS key used to encrypt the resource.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
" } } }, @@ -6698,7 +6827,7 @@ "resourceArn": { "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "The ARN of the resource to tag.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6805,6 +6934,41 @@ } } }, + "com.amazonaws.bedrockagent#Type": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "string" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "number" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "integer" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "boolean" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "array" + } + } + } + }, "com.amazonaws.bedrockagent#UntagResource": { "type": "operation", "input": { @@ -6846,7 +7010,7 @@ "resourceArn": { "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "The ARN of the resource from which to remove tags.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to remove tags.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7008,7 +7172,7 @@ "actionGroupExecutor": { "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", "traits": { - "smithy.api#documentation": "The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" } }, "actionGroupState": { @@ -7022,6 +7186,12 @@ "traits": { "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } } }, "traits": { @@ -7292,14 +7462,14 @@ "agentResourceRoleArn": { "target": "com.amazonaws.bedrockagent#AgentRoleArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", "smithy.api#required": {} } }, "customerEncryptionKeyArn": { "target": "com.amazonaws.bedrockagent#KmsKeyArn", "traits": { - "smithy.api#documentation": "The ARN of the KMS key with which to encrypt the agent.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" } }, "promptOverrideConfiguration": { @@ -7508,7 +7678,7 @@ "roleArn": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", "traits": { - "smithy.api#documentation": "Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to modify the knowledge base.
", + "smithy.api#documentation": "Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", "smithy.api#required": {} } }, @@ -7613,7 +7783,7 @@ "embeddingModelArn": { "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn", "traits": { - "smithy.api#documentation": "The ARN of the model used to create vector embeddings for the knowledge base.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/cleanrooms.2022-02-17.json b/codegen/sdk-codegen/aws-models/cleanrooms.2022-02-17.json index 43e1297b155..db7e7cfa502 100644 --- a/codegen/sdk-codegen/aws-models/cleanrooms.2022-02-17.json +++ b/codegen/sdk-codegen/aws-models/cleanrooms.2022-02-17.json @@ -1374,6 +1374,12 @@ "traits": { "smithy.api#documentation": "The parameters of the analysis template.
" } + }, + "validations": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusDetailList", + "traits": { + "smithy.api#documentation": "Information about the validations performed on the analysis template.
" + } } }, "traits": { @@ -1548,6 +1554,95 @@ } } }, + "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatus": { + "type": "enum", + "members": { + "VALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALID" + } + }, + "INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID" + } + }, + "UNABLE_TO_VALIDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNABLE_TO_VALIDATE" + } + } + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusDetail": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateValidationType", + "traits": { + "smithy.api#documentation": "The type of validation that was performed.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatus", + "traits": { + "smithy.api#documentation": "The status of the validation.
", + "smithy.api#required": {} + } + }, + "reasons": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusReasonList", + "traits": { + "smithy.api#documentation": "The reasons for the validation results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The status details of the analysis template validation. Clean Rooms Differential Privacy uses a general-purpose query structure to support complex SQL queries and validates whether an analysis template fits that general-purpose query structure. Validation is performed when analysis templates are created and fetched. Because analysis templates are immutable by design, we recommend that you create analysis templates after you associate the configured tables with their analysis rule to your collaboration.
\nFor more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy.
" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusDetail" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusReason": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The validation message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The reasons for the validation results.
" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusReasonList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusReason" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateValidationType": { + "type": "enum", + "members": { + "DIFFERENTIAL_PRIVACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIFFERENTIAL_PRIVACY" + } + } + } + }, "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplate": { "type": "operation", "input": { @@ -2106,6 +2201,12 @@ "traits": { "smithy.api#documentation": "The analysis parameters that have been specified in the analysis template.
" } + }, + "validations": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusDetailList", + "traits": { + "smithy.api#documentation": "The validations that were performed.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json b/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json index 4452cd7c608..6ea959868ab 100644 --- a/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json +++ b/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json @@ -292,6 +292,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudformation#AfterContext": { + "type": "string" + }, + "com.amazonaws.cloudformation#AfterValue": { + "type": "string" + }, "com.amazonaws.cloudformation#AllowedValue": { "type": "string" }, @@ -321,6 +327,29 @@ "com.amazonaws.cloudformation#Arn": { "type": "string" }, + "com.amazonaws.cloudformation#AttributeChangeType": { + "type": "enum", + "members": { + "Add": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Add" + } + }, + "Remove": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Remove" + } + }, + "Modify": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Modify" + } + } + } + }, "com.amazonaws.cloudformation#AutoDeployment": { "type": "structure", "members": { @@ -441,6 +470,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudformation#BeforeContext": { + "type": "string" + }, + "com.amazonaws.cloudformation#BeforeValue": { + "type": "string" + }, "com.amazonaws.cloudformation#BoxedInteger": { "type": "integer" }, @@ -600,7 +635,7 @@ "Type": { "target": "com.amazonaws.cloudformation#ChangeType", "traits": { - "smithy.api#documentation": "The type of entity that CloudFormation changes. Currently, the only entity type is Resource.
The type of entity that CloudFormation changes.
\n\n Resource This change is for a resource.
A string (provided by the DescribeChangeSet response output) that identifies the next page of\n information that you want to retrieve.
" } + }, + "IncludePropertyValues": { + "target": "com.amazonaws.cloudformation#IncludePropertyValues", + "traits": { + "smithy.api#documentation": "If true, the returned changes include detailed changes in the property values.
Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" } + }, + "BeforeContext": { + "target": "com.amazonaws.cloudformation#BeforeContext", + "traits": { + "smithy.api#documentation": "An encoded JSON string containing the context of the resource before the change is executed.
" + } + }, + "AfterContext": { + "target": "com.amazonaws.cloudformation#AfterContext", + "traits": { + "smithy.api#documentation": "An encoded JSON string containing the context of the resource after the change is executed.
" + } } }, "traits": { @@ -10359,6 +10415,9 @@ "com.amazonaws.cloudformation#ResourceProperties": { "type": "string" }, + "com.amazonaws.cloudformation#ResourcePropertyPath": { + "type": "string" + }, "com.amazonaws.cloudformation#ResourceScanId": { "type": "string" }, @@ -10684,6 +10743,30 @@ "traits": { "smithy.api#documentation": "If the Attribute value is Properties, indicates whether a change to this property\n causes the resource to be recreated. The value can be Never, Always, or\n Conditionally. To determine the conditions for a Conditionally recreation, see the update\n behavior for that property in the\n CloudFormation User Guide.
The property path of the property.
" + } + }, + "BeforeValue": { + "target": "com.amazonaws.cloudformation#BeforeValue", + "traits": { + "smithy.api#documentation": "The value of the property before the change is executed. Large values can be truncated.
" + } + }, + "AfterValue": { + "target": "com.amazonaws.cloudformation#AfterValue", + "traits": { + "smithy.api#documentation": "The value of the property after the change is executed. Large values can be truncated.
" + } + }, + "AttributeChangeType": { + "target": "com.amazonaws.cloudformation#AttributeChangeType", + "traits": { + "smithy.api#documentation": "The type of change to be made to the property if the change is executed.
\n\n Add The item will be added.
\n Remove The item will be removed.
\n Modify The item will be modified.
The protocol that viewers can use to access the files in the origin specified by\n\t\t\t\tTargetOriginId when a request matches the path pattern in\n\t\t\t\tPathPattern. You can specify the following options:
\n allow-all: Viewers can use HTTP or HTTPS.
\n redirect-to-https: If a viewer submits an HTTP request, CloudFront\n\t\t\t\t\treturns an HTTP status code of 301 (Moved Permanently) to the viewer along with\n\t\t\t\t\tthe HTTPS URL. The viewer then resubmits the request using the new URL.
\n https-only: If a viewer sends an HTTP request, CloudFront returns an\n\t\t\t\t\tHTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nThe only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects' cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\t\tManaging Cache\n\t\t\t\t\tExpiration in the Amazon CloudFront Developer Guide.
\nThe protocol that viewers can use to access the files in the origin specified by\n\t\t\t\tTargetOriginId when a request matches the path pattern in\n\t\t\t\tPathPattern. You can specify the following options:
\n allow-all: Viewers can use HTTP or HTTPS.
\n redirect-to-https: If a viewer submits an HTTP request, CloudFront\n\t\t\t\t\treturns an HTTP status code of 301 (Moved Permanently) to the viewer along with\n\t\t\t\t\tthe HTTPS URL. The viewer then resubmits the request using the new URL.
\n https-only: If a viewer sends an HTTP request, CloudFront returns an\n\t\t\t\t\tHTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nThe only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects' cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\t\tManaging Cache\n\t\t\t\t\tExpiration in the Amazon CloudFront Developer Guide.
\nA complex type that describes how CloudFront processes requests.
\nYou must create at least as many cache behaviors (including the default cache\n\t\t\tbehavior) as you have origins if you want CloudFront to serve objects from all of the origins.\n\t\t\tEach cache behavior specifies the one origin from which you want CloudFront to get objects. If\n\t\t\tyou have two origins and only the default cache behavior, the default cache behavior\n\t\t\twill cause CloudFront to get objects from one of the origins, but the other origin is never\n\t\t\tused.
\nFor the current quota (formerly known as limit) on the number of cache behaviors that\n\t\t\tyou can add to a distribution, see Quotas in the\n\t\t\tAmazon CloudFront Developer Guide.
\nIf you don't want to specify any cache behaviors, include only an empty\n\t\t\t\tCacheBehaviors element. Don't include an empty\n\t\t\t\tCacheBehavior element because this is invalid.
To delete all cache behaviors in an existing distribution, update the distribution\n\t\t\tconfiguration and include only an empty CacheBehaviors element.
To add, change, or remove one or more cache behaviors, update the distribution\n\t\t\tconfiguration and specify all of the cache behaviors that you want to include in the\n\t\t\tupdated distribution.
\nFor more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A complex type that describes how CloudFront processes requests.
\nYou must create at least as many cache behaviors (including the default cache\n\t\t\tbehavior) as you have origins if you want CloudFront to serve objects from all of the origins.\n\t\t\tEach cache behavior specifies the one origin from which you want CloudFront to get objects. If\n\t\t\tyou have two origins and only the default cache behavior, the default cache behavior\n\t\t\twill cause CloudFront to get objects from one of the origins, but the other origin is never\n\t\t\tused.
\nFor the current quota (formerly known as limit) on the number of cache behaviors that\n\t\t\tyou can add to a distribution, see Quotas in the\n\t\t\tAmazon CloudFront Developer Guide.
\nIf you don't want to specify any cache behaviors, include only an empty\n\t\t\tCacheBehaviors element. For more information, see CacheBehaviors. Don't include an empty\n\t\t\t\tCacheBehavior element because this is invalid.
To delete all cache behaviors in an existing distribution, update the distribution\n\t\t\tconfiguration and include only an empty CacheBehaviors element.
To add, change, or remove one or more cache behaviors, update the distribution\n\t\t\tconfiguration and specify all of the cache behaviors that you want to include in the\n\t\t\tupdated distribution.
\nFor more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#CacheBehaviorList": { @@ -825,7 +825,7 @@ } }, "traits": { - "smithy.api#documentation": "The Key Value Store entity cannot be deleted while it is in use.
", + "smithy.api#documentation": "The key value store entity cannot be deleted while it is in use.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1365,7 +1365,7 @@ "name": "cloudfront" }, "aws.protocols#restXml": {}, - "smithy.api#documentation": "This is the Amazon CloudFront API Reference. This guide is for developers\n\t\t\twho need detailed information about CloudFront API actions, data types, and errors. For\n\t\t\tdetailed information about CloudFront features, see the\n\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "This is the Amazon CloudFront API Reference. This guide is for developers\n\t\t\twho need detailed information about CloudFront API actions, data types, and errors. For\n\t\t\tdetailed information about CloudFront features, see the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#title": "Amazon CloudFront", "smithy.api#xmlNamespace": { "uri": "http://cloudfront.amazonaws.com/doc/2020-05-31/" @@ -2583,7 +2583,7 @@ "Weight": { "target": "com.amazonaws.cloudfront#float", "traits": { - "smithy.api#documentation": "The percentage of traffic to send to a staging distribution, expressed as a decimal\n\t\t\tnumber between 0 and .15.
", + "smithy.api#documentation": "The percentage of traffic to send to a staging distribution, expressed as a decimal\n\t\t\tnumber between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
", "smithy.api#required": {} } }, @@ -4011,7 +4011,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new invalidation.
", + "smithy.api#documentation": "Create a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distribution/{DistributionId}/invalidation", @@ -4168,10 +4168,13 @@ }, { "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#UnsupportedOperation" } ], "traits": { - "smithy.api#documentation": "Specifies the Key Value Store resource to add to your account. In your account, the Key Value Store names must be unique. You can also import Key Value Store data in JSON format from an S3 bucket by providing a valid ImportSource that you own.
Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid ImportSource that you own.
The name of the Key Value Store. The maximum length of the name is 32 characters.
", + "smithy.api#documentation": "The name of the key value store. The minimum length is 1 character and the maximum length is\n\t\t\t64 characters.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#KeyValueStoreComment", "traits": { - "smithy.api#documentation": "The comment of the Key Value Store.
" + "smithy.api#documentation": "The comment of the key value store.
" } }, "ImportSource": { @@ -4212,21 +4215,21 @@ "KeyValueStore": { "target": "com.amazonaws.cloudfront#KeyValueStore", "traits": { - "smithy.api#documentation": "The resulting Key Value Store.
", + "smithy.api#documentation": "The resulting key value store.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The ETag in the resulting Key Value Store.
", + "smithy.api#documentation": "The ETag in the resulting key value store.
The location of the resulting Key Value Store.
", + "smithy.api#documentation": "The location of the resulting key value store.
", "smithy.api#httpHeader": "Location" } } @@ -4601,7 +4604,7 @@ "SamplingRate": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "The sampling rate for this real-time log configuration. The sampling rate determines\n\t\t\tthe percentage of viewer requests that are represented in the real-time log data. You\n\t\t\tmust provide an integer between 1 and 100, inclusive.
", + "smithy.api#documentation": "The sampling rate for this real-time log configuration. You can specify a whole number between 1 and 100 (inclusive) to determine the percentage of viewer requests that are represented in the real-time log data.
", "smithy.api#required": {} } } @@ -5084,7 +5087,7 @@ "ViewerProtocolPolicy": { "target": "com.amazonaws.cloudfront#ViewerProtocolPolicy", "traits": { - "smithy.api#documentation": "The protocol that viewers can use to access the files in the origin specified by\n\t\t\t\tTargetOriginId when a request matches the path pattern in\n\t\t\t\tPathPattern. You can specify the following options:
\n allow-all: Viewers can use HTTP or HTTPS.
\n redirect-to-https: If a viewer submits an HTTP request, CloudFront\n\t\t\t\t\treturns an HTTP status code of 301 (Moved Permanently) to the viewer along with\n\t\t\t\t\tthe HTTPS URL. The viewer then resubmits the request using the new URL.
\n https-only: If a viewer sends an HTTP request, CloudFront returns an\n\t\t\t\t\tHTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nThe only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects' cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\t\tManaging Cache\n\t\t\t\t\tExpiration in the Amazon CloudFront Developer Guide.
\nThe protocol that viewers can use to access the files in the origin specified by\n\t\t\t\tTargetOriginId when a request matches the path pattern in\n\t\t\t\tPathPattern. You can specify the following options:
\n allow-all: Viewers can use HTTP or HTTPS.
\n redirect-to-https: If a viewer submits an HTTP request, CloudFront\n\t\t\t\t\treturns an HTTP status code of 301 (Moved Permanently) to the viewer along with\n\t\t\t\t\tthe HTTPS URL. The viewer then resubmits the request using the new URL.
\n https-only: If a viewer sends an HTTP request, CloudFront returns an\n\t\t\t\t\tHTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nThe only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects' cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\t\tManaging Cache\n\t\t\t\t\tExpiration in the Amazon CloudFront Developer Guide.
\nA list of CloudFront functions that are associated with this cache behavior. CloudFront functions\n\t\t\tmust be published to the LIVE stage to associate them with a cache\n\t\t\tbehavior.
A list of CloudFront functions that are associated with this cache behavior. Your functions\n\t\t\tmust be published to the LIVE stage to associate them with a cache\n\t\t\tbehavior.
Specifies the Key Value Store to delete.
", + "smithy.api#documentation": "Specifies the key value store to delete.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/key-value-store/{Name}", @@ -5681,7 +5687,7 @@ "Name": { "target": "com.amazonaws.cloudfront#KeyValueStoreName", "traits": { - "smithy.api#documentation": "The name of the Key Value Store.
", + "smithy.api#documentation": "The name of the key value store.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5689,7 +5695,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The Key Value Store to delete, if a match occurs.
", + "smithy.api#documentation": "The key value store to delete, if a match occurs.
", "smithy.api#httpHeader": "If-Match", "smithy.api#required": {} } @@ -5722,7 +5728,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables additional CloudWatch metrics for the specified CloudFront\n\t\t\tdistribution.
", + "smithy.api#documentation": "Disables additional CloudWatch metrics for the specified CloudFront distribution.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", @@ -6183,10 +6189,13 @@ }, { "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#UnsupportedOperation" } ], "traits": { - "smithy.api#documentation": "Specifies the Key Value Store and its configuration.
", + "smithy.api#documentation": "Specifies the key value store and its configuration.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/key-value-store/{Name}", @@ -6200,7 +6209,7 @@ "Name": { "target": "com.amazonaws.cloudfront#KeyValueStoreName", "traits": { - "smithy.api#documentation": "The name of the Key Value Store.
", + "smithy.api#documentation": "The name of the key value store.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6216,14 +6225,14 @@ "KeyValueStore": { "target": "com.amazonaws.cloudfront#KeyValueStore", "traits": { - "smithy.api#documentation": "The resulting Key Value Store.
", + "smithy.api#documentation": "The resulting key value store.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The ETag of the resulting Key Value Store.
", + "smithy.api#documentation": "The ETag of the resulting key value store.
A unique identifier that specifies the WAF web ACL, if any, to associate with this\n\t\t\tdistribution. To specify a web ACL created using the latest version of WAF, use the\n\t\t\tACL ARN, for example\n\t\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a.\n\t\t\tTo specify a web ACL created using WAF Classic, use the ACL ID, for example\n\t\t\t\t473e64fd-f30b-4765-81a0-62ad96dd167a.
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests\n\t\t\tthat are forwarded to CloudFront, and lets you control access to your content. Based on\n\t\t\tconditions that you specify, such as the IP addresses that requests originate from or\n\t\t\tthe values of query strings, CloudFront responds to requests either with the requested content\n\t\t\tor with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a\n\t\t\tcustom error page when a request is blocked. For more information about WAF, see the\n\t\t\t\tWAF Developer Guide.
" + "smithy.api#documentation": "A unique identifier that specifies the WAF web ACL, if any, to associate with this\n\t\t\tdistribution. To specify a web ACL created using the latest version of WAF, use the\n\t\t\tACL ARN, for example\n\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.\n\t\t\tTo specify a web ACL created using WAF Classic, use the ACL ID, for example\n\t\t\ta1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests\n\t\t\tthat are forwarded to CloudFront, and lets you control access to your content. Based on\n\t\t\tconditions that you specify, such as the IP addresses that requests originate from or\n\t\t\tthe values of query strings, CloudFront responds to requests either with the requested content\n\t\t\tor with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a\n\t\t\tcustom error page when a request is blocked. For more information about WAF, see the\n\t\t\t\tWAF Developer Guide.
" } }, "HttpVersion": { "target": "com.amazonaws.cloudfront#HttpVersion", "traits": { - "smithy.api#documentation": "(Optional) Specify the maximum HTTP version(s) that you want viewers to use to\n\t\t\tcommunicate with CloudFront. The default value for new web distributions is\n\t\t\thttp2. Viewers that don't support HTTP/2 automatically use an earlier HTTP\n\t\t\tversion.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must\n\t\t\tsupport Server Name Indication (SNI).
\nFor viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name\n\t\t\tIndication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to\n\t\t\tswitch networks without losing connection. For more information about connection\n\t\t\tmigration, see Connection Migration at RFC 9000. For more information about supported\n\t\t\tTLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.
" + "smithy.api#documentation": "(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with\n\t\t\tCloudFront. The default value for new web distributions is http2. Viewers that\n\t\t\tdon't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must\n\t\t\tsupport Server Name Indication (SNI).
\nFor viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name\n\t\t\tIndication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to\n\t\t\tswitch networks without losing connection. For more information about connection\n\t\t\tmigration, see Connection Migration at RFC 9000. For more information about supported\n\t\t\tTLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.
" } }, "IsIPV6Enabled": { @@ -6731,7 +6740,7 @@ "Staging": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "Whether the primary distribution has a staging distribution enabled.
", + "smithy.api#documentation": "A Boolean that indicates whether this is a staging distribution. When this value is\n\t\t\t\ttrue, this is a staging distribution. When this value is\n\t\t\t\tfalse, this is not a staging distribution.
The Key Value Store entity already exists. You must provide a unique Key Value Store\n\t\t\tentity.
", + "smithy.api#documentation": "The key value store entity already exists. You must provide a unique key value store\n\t\t\tentity.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -6856,7 +6865,7 @@ } }, "traits": { - "smithy.api#documentation": "The Key Value Store entity limit has been exceeded.
", + "smithy.api#documentation": "The key value store entity limit has been exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6869,7 +6878,7 @@ } }, "traits": { - "smithy.api#documentation": "The Key Value Store entity was not found.
", + "smithy.api#documentation": "The key value store entity was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -6882,7 +6891,7 @@ } }, "traits": { - "smithy.api#documentation": "The Key Value Store entity size limit was exceeded.
", + "smithy.api#documentation": "The key value store entity size limit was exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 413 } @@ -7443,12 +7452,12 @@ "Items": { "target": "com.amazonaws.cloudfront#FunctionAssociationList", "traits": { - "smithy.api#documentation": "The CloudFront functions that are associated with a cache behavior in a CloudFront distribution.\n\t\t\tCloudFront functions must be published to the LIVE stage to associate them with a\n\t\t\tcache behavior.
The CloudFront functions that are associated with a cache behavior in a CloudFront distribution.\n\t\t\tYour functions must be published to the LIVE stage to associate them with a\n\t\t\tcache behavior.
A list of CloudFront functions that are associated with a cache behavior in a CloudFront\n\t\t\tdistribution. CloudFront functions must be published to the LIVE stage to\n\t\t\tassociate them with a cache behavior.
A list of CloudFront functions that are associated with a cache behavior in a CloudFront\n\t\t\tdistribution. Your functions must be published to the LIVE stage to\n\t\t\tassociate them with a cache behavior.
The configuration for the Key Value Store associations.
" + "smithy.api#documentation": "The configuration for the key value store associations.
" } } }, @@ -9722,20 +9731,20 @@ "SourceType": { "target": "com.amazonaws.cloudfront#ImportSourceType", "traits": { - "smithy.api#documentation": "The source type of the import source for the Key Value Store.
", + "smithy.api#documentation": "The source type of the import source for the key value store.
", "smithy.api#required": {} } }, "SourceARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the import source for the Key Value Store.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the import source for the key value store.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The import source for the Key Value Store.
" + "smithy.api#documentation": "The import source for the key value store.
" } }, "com.amazonaws.cloudfront#ImportSourceType": { @@ -10457,47 +10466,47 @@ "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The name of the Key Value Store.
", + "smithy.api#documentation": "The name of the key value store.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The unique Id for the Key Value Store.
", + "smithy.api#documentation": "The unique Id for the key value store.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A comment for the Key Value Store.
", + "smithy.api#documentation": "A comment for the key value store.
", "smithy.api#required": {} } }, "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Key Value Store.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the key value store.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The status of the Key Value Store.
" + "smithy.api#documentation": "The status of the key value store.
" } }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { - "smithy.api#documentation": "The last-modified time of the Key Value Store.
", + "smithy.api#documentation": "The last-modified time of the key value store.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The Key Value Store. Use this to separate data from function code, allowing you to update\n\t\t\tdata without having to publish a new version of a function. The Key Value Store holds\n\t\t\tkeys and their corresponding values.
" + "smithy.api#documentation": "The key value store. Use this to separate data from function code, allowing you to update\n\t\t\tdata without having to publish a new version of a function. The key value store holds\n\t\t\tkeys and their corresponding values.
" } }, "com.amazonaws.cloudfront#KeyValueStoreARN": { @@ -10516,13 +10525,13 @@ "KeyValueStoreARN": { "target": "com.amazonaws.cloudfront#KeyValueStoreARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Key Value Store association.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the key value store association.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The Key Value Store association.
" + "smithy.api#documentation": "The key value store association.
" } }, "com.amazonaws.cloudfront#KeyValueStoreAssociationList": { @@ -10540,19 +10549,19 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The quantity of Key Value Store associations.
", + "smithy.api#documentation": "The quantity of key value store associations.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#KeyValueStoreAssociationList", "traits": { - "smithy.api#documentation": "The items of the Key Value Store association.
" + "smithy.api#documentation": "The items of the key value store association.
" } } }, "traits": { - "smithy.api#documentation": "The Key Value Store associations.
" + "smithy.api#documentation": "The key value store associations.
" } }, "com.amazonaws.cloudfront#KeyValueStoreComment": { @@ -10570,32 +10579,32 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The next marker associated with the Key Value Store list.
" + "smithy.api#documentation": "The next marker associated with the key value store list.
" } }, "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The maximum number of items in the Key Value Store list.
", + "smithy.api#documentation": "The maximum number of items in the key value store list.
", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The quantity of the Key Value Store list.
", + "smithy.api#documentation": "The quantity of the key value store list.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#KeyValueStoreSummaryList", "traits": { - "smithy.api#documentation": "The items of the Key Value Store list.
" + "smithy.api#documentation": "The items of the key value store list.
" } } }, "traits": { - "smithy.api#documentation": "The Key Value Store list.
" + "smithy.api#documentation": "The key value store list.
" } }, "com.amazonaws.cloudfront#KeyValueStoreName": { @@ -11410,7 +11419,7 @@ "WebACLId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The ID of the WAF web ACL that you want to list the associated distributions. If you\n\t\t\tspecify \"null\" for the ID, the request returns a list of the distributions that aren't\n\t\t\tassociated with a web ACL.
", + "smithy.api#documentation": "The ID of the WAF web ACL that you want to list the associated distributions. If you\n\t\t\tspecify \"null\" for the ID, the request returns a list of the distributions that aren't\n\t\t\tassociated with a web ACL.
\nFor WAFV2, this is the ARN of the web ACL, such as\n\t\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
For WAF Classic, this is the ID of the web ACL, such as a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
Specifies the Key Value Stores to list.
", + "smithy.api#documentation": "Specifies the key value stores to list.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/key-value-store", @@ -11840,21 +11852,21 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The marker associated with the Key Value Stores list.
", + "smithy.api#documentation": "The marker associated with the key value stores list.
", "smithy.api#httpQuery": "Marker" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The maximum number of items in the Key Value Stores list.
", + "smithy.api#documentation": "The maximum number of items in the key value stores list.
", "smithy.api#httpQuery": "MaxItems" } }, "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The status of the request for the Key Value Stores list.
", + "smithy.api#documentation": "The status of the request for the key value stores list.
", "smithy.api#httpQuery": "Status" } } @@ -11869,7 +11881,7 @@ "KeyValueStoreList": { "target": "com.amazonaws.cloudfront#KeyValueStoreList", "traits": { - "smithy.api#documentation": "The resulting Key Value Stores list.
", + "smithy.api#documentation": "The resulting key value stores list.
", "smithy.api#httpPayload": {} } } @@ -12856,7 +12868,7 @@ "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A name to identify the origin access control.
", + "smithy.api#documentation": "A name to identify the origin access control. You can specify up to 64 characters.
", "smithy.api#required": {} } }, @@ -12967,6 +12979,18 @@ "traits": { "smithy.api#enumValue": "mediastore" } + }, + "mediapackagev2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mediapackagev2" + } + }, + "lambda": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lambda" + } } } }, @@ -13120,7 +13144,7 @@ } }, "traits": { - "smithy.api#documentation": "An origin group includes two origins (a primary origin and a second origin to failover to)\n\t\t\tand a failover criteria that you specify. You create an origin group to support origin\n\t\t\tfailover in CloudFront. When you create or update a distribution, you can specify the\n\t\t\torigin group instead of a single origin, and CloudFront will failover from the primary\n\t\t\torigin to the second origin under the failover conditions that you've chosen.
" + "smithy.api#documentation": "An origin group includes two origins (a primary origin and a second origin to failover to)\n\t\t\tand a failover criteria that you specify. You create an origin group to support origin\n\t\t\tfailover in CloudFront. When you create or update a distribution, you can specify the\n\t\t\torigin group instead of a single origin, and CloudFront will failover from the primary\n\t\t\torigin to the second origin under the failover conditions that you've chosen.
" } }, "com.amazonaws.cloudfront#OriginGroupFailoverCriteria": { @@ -13129,7 +13153,7 @@ "StatusCodes": { "target": "com.amazonaws.cloudfront#StatusCodes", "traits": { - "smithy.api#documentation": "The status codes that, when returned from the primary origin, will trigger CloudFront\n\t\t\tto failover to the second origin.
", + "smithy.api#documentation": "The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
", "smithy.api#required": {} } } @@ -14965,7 +14989,7 @@ "StrictTransportSecurity": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyStrictTransportSecurity", "traits": { - "smithy.api#documentation": "Determines whether CloudFront includes the Strict-Transport-Security HTTP\n\t\t\tresponse header and the header's value.
For more information about the Strict-Transport-Security HTTP response\n\t\t\theader, see Strict-Transport-Security in the MDN Web Docs.
Determines whether CloudFront includes the Strict-Transport-Security HTTP\n\t\t\tresponse header and the header's value.
For more information about the Strict-Transport-Security HTTP response\n\t\t\theader, see Security headers in the Amazon CloudFront Developer Guide and Strict-Transport-Security in the MDN Web Docs.
The CloudFront origin access identity to associate with the origin. Use an origin access\n\t\t\tidentity to configure the origin so that viewers can only access\n\t\t\tobjects in an Amazon S3 bucket through CloudFront. The format of the value is:
\norigin-access-identity/cloudfront/ID-of-origin-access-identity\n
\nwhere \n ID-of-origin-access-identity\n is the value that\n\t\t\tCloudFront returned in the ID element when you created the origin access\n\t\t\tidentity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3\n\t\t\tURL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the\n\t\t\tdistribution configuration and include an empty OriginAccessIdentity\n\t\t\telement.
To replace the origin access identity, update the distribution configuration and\n\t\t\tspecify the new origin access identity.
\nFor more information about the origin access identity, see Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "If you're using origin access control (OAC) instead of origin access identity,\n\t\t\t\tspecify an empty OriginAccessIdentity element. For more information,\n\t\t\t\tsee Restricting access to an Amazon Web Services in the\n\t\t\t\t\tAmazon CloudFront Developer Guide.
The CloudFront origin access identity to associate with the origin. Use an origin access\n\t\t\tidentity to configure the origin so that viewers can only access\n\t\t\tobjects in an Amazon S3 bucket through CloudFront. The format of the value is:
\n\n origin-access-identity/cloudfront/ID-of-origin-access-identity\n
The \n ID-of-origin-access-identity\n is the value that CloudFront\n\t\t\treturned in the ID element when you created the origin access\n\t\t\tidentity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3\n\t\t\tURL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the\n\t\t\tdistribution configuration and include an empty OriginAccessIdentity\n\t\t\telement.
To replace the origin access identity, update the distribution configuration and\n\t\t\tspecify the new origin access identity.
\nFor more information about the origin access identity, see Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } } @@ -15207,7 +15231,7 @@ "MaximumTTL": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The maximum amount of time to consider requests from the viewer as being part of the\n\t\t\tsame session. Allowed values are 300–3600 seconds (5–60 minutes).
\nThe value must be less than or equal to IdleTTL.
The maximum amount of time to consider requests from the viewer as being part of the\n\t\t\tsame session. Allowed values are 300–3600 seconds (5–60 minutes).
\nThe value must be greater than or equal to IdleTTL.
Specifies the Key Value Store to update.
", + "smithy.api#documentation": "Specifies the key value store to update.
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/key-value-store/{Name}", @@ -18114,7 +18141,7 @@ "Name": { "target": "com.amazonaws.cloudfront#KeyValueStoreName", "traits": { - "smithy.api#documentation": "The name of the Key Value Store to update.
", + "smithy.api#documentation": "The name of the key value store to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18122,14 +18149,14 @@ "Comment": { "target": "com.amazonaws.cloudfront#KeyValueStoreComment", "traits": { - "smithy.api#documentation": "The comment of the Key Value Store to update.
", + "smithy.api#documentation": "The comment of the key value store to update.
", "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The Key Value Store to update, if a match occurs.
", + "smithy.api#documentation": "The key value store to update, if a match occurs.
", "smithy.api#httpHeader": "If-Match", "smithy.api#required": {} } @@ -18145,14 +18172,14 @@ "KeyValueStore": { "target": "com.amazonaws.cloudfront#KeyValueStore", "traits": { - "smithy.api#documentation": "The resulting Key Value Store to update.
", + "smithy.api#documentation": "The resulting key value store to update.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The ETag of the resulting Key Value Store.
", + "smithy.api#documentation": "The ETag of the resulting key value store.
The current status of the anomaly detector's training. The possible values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA\n
The current status of the anomaly detector's training.
" + } + }, + "MetricCharacteristics": { + "target": "com.amazonaws.cloudwatch#MetricCharacteristics", + "traits": { + "smithy.api#documentation": "This object includes parameters that you can use to provide information about your metric to \n\t\t\tCloudWatch to help it build more accurate anomaly detection models. Currently, it includes\n\t\t\tthe PeriodicSpikes parameter.
Set this parameter to true if values for this metric consistently include spikes\n\t\t\tthat should not be considered to be anomalies. With this set to true, CloudWatch will expect \n\t\t\tto see spikes that occurred consistently during the model training period, and won't flag future similar spikes\n\t\t\tas anomalies.
This object includes parameters that you can use to provide information to \n\t\t\tCloudWatch to help it build more accurate anomaly detection models.
" + } + }, "com.amazonaws.cloudwatch#MetricData": { "type": "list", "member": { @@ -5402,6 +5422,9 @@ } } }, + "com.amazonaws.cloudwatch#PeriodicSpikes": { + "type": "boolean" + }, "com.amazonaws.cloudwatch#PutAnomalyDetector": { "type": "operation", "input": { @@ -5476,6 +5499,12 @@ "smithy.api#documentation": "The configuration specifies details about how the \n\t\t\tanomaly detection model is to be trained, including \n\t\t\ttime ranges to exclude when training and updating the model.\n\t\t\tYou can specify as many as 10 time ranges.
\nThe configuration can also include the time zone to use for \n\t\t\tthe metric.
" } }, + "MetricCharacteristics": { + "target": "com.amazonaws.cloudwatch#MetricCharacteristics", + "traits": { + "smithy.api#documentation": "Use this object to include parameters to provide information about your metric to \n\t\t\tCloudWatch to help it build more accurate anomaly detection models. Currently, it includes\n\t\t\tthe PeriodicSpikes parameter.
For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket,\n this is the app password.
", + "smithy.api#documentation": "For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket,\n this is either the access token or the app password.
", "smithy.api#required": {} } }, @@ -6355,7 +6355,7 @@ "location": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "Information about the location of the source code to be built. Valid values\n include:
\nFor source code settings that are specified in the source action of a pipeline\n in CodePipeline, location should not be specified. If it is specified,\n CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source\n action instead of this value.
For source code in an CodeCommit repository, the HTTPS clone URL to the repository\n that contains the source code and the buildspec file (for example,\n https://git-codecommit.).
For source code in an Amazon S3 input bucket, one of the following.
\nThe path to the ZIP file that contains the source code (for example,\n
The path to the folder that contains the source code (for example,\n
For source code in a GitHub repository, the HTTPS clone URL to the repository\n that contains the source and the buildspec file. You must connect your Amazon Web Services account \n to your GitHub account. Use the CodeBuild console to start creating a build\n project. When you use the console to connect (or reconnect) with GitHub, on the\n GitHub Authorize application page, for\n Organization access, choose Request access next to each repository you want to\n allow CodeBuild to have access to, and then choose Authorize\n application. (After you have connected to your GitHub account,\n you do not need to finish creating the build project. You can leave the CodeBuild\n console.) To instruct CodeBuild to use this connection, in the source\n object, set the auth object's type value to\n OAUTH.
For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository\n that contains the source and the buildspec file. You must connect your Amazon Web Services account \n to your GitLab account. Use the CodeBuild console to start creating a build\n project. When you use the console to connect (or reconnect) with GitLab, on the\n Connections Authorize application page, choose Authorize. Then on the CodeStar Connections Create GitLab connection page, \n choose Connect to GitLab. (After you have connected to your GitLab account,\n you do not need to finish creating the build project. You can leave the CodeBuild\n console.) To instruct CodeBuild to override the default connection and use this connection instead,\n set the auth object's type value to\n CODECONNECTIONS in the source object.
For source code in a Bitbucket repository, the HTTPS clone URL to the\n repository that contains the source and the buildspec file. You must connect\n your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start\n creating a build project. When you use the console to connect (or reconnect)\n with Bitbucket, on the Bitbucket Confirm access to your\n account page, choose Grant\n access. (After you have connected to your Bitbucket account, you\n do not need to finish creating the build project. You can leave the CodeBuild\n console.) To instruct CodeBuild to use this connection, in the source\n object, set the auth object's type value to\n OAUTH.
\n If you specify CODEPIPELINE for the Type property, don't specify this \n property. For all of the other types, you must specify Location.\n
Information about the location of the source code to be built. Valid values\n include:
\nFor source code settings that are specified in the source action of a pipeline\n in CodePipeline, location should not be specified. If it is specified,\n CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source\n action instead of this value.
For source code in an CodeCommit repository, the HTTPS clone URL to the repository\n that contains the source code and the buildspec file (for example,\n https://git-codecommit.).
For source code in an Amazon S3 input bucket, one of the following.
\nThe path to the ZIP file that contains the source code (for example,\n
The path to the folder that contains the source code (for example,\n
For source code in a GitHub repository, the HTTPS clone URL to the repository\n that contains the source and the buildspec file. You must connect your Amazon Web Services account \n to your GitHub account. Use the CodeBuild console to start creating a build\n project. When you use the console to connect (or reconnect) with GitHub, on the\n GitHub Authorize application page, for\n Organization access, choose Request access next to each repository you want to\n allow CodeBuild to have access to, and then choose Authorize\n application. (After you have connected to your GitHub account,\n you do not need to finish creating the build project. You can leave the CodeBuild\n console.) To instruct CodeBuild to use this connection, in the source\n object, set the auth object's type value to\n OAUTH.
For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository\n that contains the source and the buildspec file. You must connect your Amazon Web Services account \n to your GitLab account. Use the CodeBuild console to start creating a build\n project. When you use the console to connect (or reconnect) with GitLab, on the\n Connections Authorize application page, choose Authorize. Then on the CodeConnections Create GitLab connection page, \n choose Connect to GitLab. (After you have connected to your GitLab account,\n you do not need to finish creating the build project. You can leave the CodeBuild\n console.) To instruct CodeBuild to override the default connection and use this connection instead,\n set the auth object's type value to\n CODECONNECTIONS in the source object.
For source code in a Bitbucket repository, the HTTPS clone URL to the\n repository that contains the source and the buildspec file. You must connect\n your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start\n creating a build project. When you use the console to connect (or reconnect)\n with Bitbucket, on the Bitbucket Confirm access to your\n account page, choose Grant\n access. (After you have connected to your Bitbucket account, you\n do not need to finish creating the build project. You can leave the CodeBuild\n console.) To instruct CodeBuild to use this connection, in the source\n object, set the auth object's type value to\n OAUTH.
\n If you specify CODEPIPELINE for the Type property, don't specify this \n property. For all of the other types, you must specify Location.\n
The type of webhook filter. There are eight webhook filter types: EVENT,\n ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF,\n FILE_PATH, COMMIT_MESSAGE, TAG_NAME, and RELEASE_NAME.
\n EVENT\n
\n A webhook event triggers a build when the provided pattern\n matches one of eight event types: PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, \n PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, \n PULL_REQUEST_MERGED, RELEASED, and PRERELEASED. The EVENT patterns are\n specified as a comma-separated string. For example, PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull\n request created, and pull request updated events.
The PULL_REQUEST_REOPENED works with GitHub and GitHub\n Enterprise only. The RELEASED and PRERELEASED work \n with GitHub only.
ACTOR_ACCOUNT_ID
\n A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n Bitbucket account ID matches the regular expression pattern.\n
HEAD_REF
\n A webhook event triggers a build when the head reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name and refs/tags/tag-name.
Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
\nBASE_REF
\n A webhook event triggers a build when the base reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name.
Works with pull request events only.
\nFILE_PATH
\n A webhook triggers a build when the path of a changed file matches the\n regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.
\nCOMMIT_MESSAGE
\nA webhook triggers a build when the head commit message matches the\n regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.
\nTAG_NAME
\nA webhook triggers a build when the tag name of the release matches the \n regular expression pattern.
Works with RELEASED and PRERELEASED events only.
RELEASE_NAME
\nA webhook triggers a build when the release name matches the \n regular expression pattern.
Works with RELEASED and PRERELEASED events only.
The type of webhook filter. There are nine webhook filter types: EVENT,\n ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF,\n FILE_PATH, COMMIT_MESSAGE, TAG_NAME, RELEASE_NAME, \n and WORKFLOW_NAME.
\n EVENT\n
\n A webhook event triggers a build when the provided pattern\n matches one of nine event types: PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, \n PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, \n PULL_REQUEST_MERGED, RELEASED, PRERELEASED, \n and WORKFLOW_JOB_QUEUED. The EVENT patterns are\n specified as a comma-separated string. For example, PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull\n request created, and pull request updated events.
The PULL_REQUEST_REOPENED works with GitHub and GitHub\n Enterprise only. The RELEASED, PRERELEASED, \n and WORKFLOW_JOB_QUEUED work with GitHub only.
ACTOR_ACCOUNT_ID
\n A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n Bitbucket account ID matches the regular expression pattern.\n
HEAD_REF
\n A webhook event triggers a build when the head reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name and refs/tags/tag-name.
Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
\nBASE_REF
\n A webhook event triggers a build when the base reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name.
Works with pull request events only.
\nFILE_PATH
\n A webhook triggers a build when the path of a changed file matches the\n regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.
\nCOMMIT_MESSAGE
\nA webhook triggers a build when the head commit message matches the\n regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.
\nTAG_NAME
\nA webhook triggers a build when the tag name of the release matches the \n regular expression pattern.
Works with RELEASED and PRERELEASED events only.
RELEASE_NAME
\nA webhook triggers a build when the release name matches the \n regular expression pattern.
Works with RELEASED and PRERELEASED events only.
WORKFLOW_NAME
\nA webhook triggers a build when the workflow name matches the \n regular expression pattern.
Works with WORKFLOW_JOB_QUEUED events only.
The time when configuration changes for the resource were delivered.
" + "smithy.api#documentation": "The time when configuration changes for the resource were delivered.
\nThis field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording,\n\t\t\tthis field will be populated. However, if you are using continuous recording,\n\t\t\tthis field will be omitted since the delivery time is instantaneous as the CI is available right away. For more information on daily recording and continuous recording, see Recording Frequency in the Config\n\t\t\t\t\tDeveloper Guide.
\nThe time when configuration changes for the resource were delivered.
" + "smithy.api#documentation": "The time when configuration changes for the resource were delivered.
\nThis field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording,\n\t\t\tthis field will be populated. However, if you are using continuous recording,\n\t\t\tthis field will be omitted since the delivery time is instantaneous as the CI is available right away. For more information on daily recording and continuous recording, see Recording Frequency in the Config\n\t\t\t\t\tDeveloper Guide.
\nThe number of rule evaluation results that you want\n\t\t\treturned.
\nThis parameter is required if the rule limit for your account\n\t\t\tis more than the default of 150 rules.
\nFor information about requesting a rule limit increase, see\n\t\t\t\tConfig Limits in the Amazon Web Services General\n\t\t\t\tReference Guide.
" + "smithy.api#documentation": "The number of rule evaluation results that you want\n\t\t\treturned.
\nThis parameter is required if the rule limit for your account\n\t\t\tis more than the default of 1000 rules.
\nFor information about requesting a rule limit increase, see\n\t\t\t\tConfig Limits in the Amazon Web Services General\n\t\t\t\tReference Guide.
" } } }, @@ -8040,7 +8040,7 @@ } }, "traits": { - "smithy.api#documentation": "Failed to add the Config rule because the account already\n\t\t\tcontains the maximum number of 150 rules. Consider deleting any\n\t\t\tdeactivated rules before you add new rules.
", + "smithy.api#documentation": "Failed to add the Config rule because the account already\n\t\t\tcontains the maximum number of 1000 rules. Consider deleting any\n\t\t\tdeactivated rules before you add new rules.
", "smithy.api#error": "client" } }, @@ -11440,7 +11440,7 @@ "EvaluationMode": { "target": "com.amazonaws.configservice#EvaluationMode", "traits": { - "smithy.api#documentation": "Filters all resource evaluations results based on an evaluation mode. the valid value for this API is Proactive.
Filters all resource evaluations results based on an evaluation mode.
\nCurrently, DECTECTIVE is not supported as a valid value. Ignore other documentation stating otherwise.
This API is in preview release for Amazon Connect and is subject to change.
\nA list of third-party applications that the security profile will give access to.
" + "smithy.api#documentation": "A list of third-party applications that the security profile will give access to.
" } }, "HierarchyRestrictedResources": { @@ -13264,6 +13270,15 @@ } } }, + "com.amazonaws.connect#EvaluationFormId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.connect#EvaluationFormItem": { "type": "union", "members": { @@ -20854,7 +20869,7 @@ "Applications": { "target": "com.amazonaws.connect#Applications", "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nA list of the third-party application's metadata.
" + "smithy.api#documentation": "A list of the third-party application's metadata.
" } }, "NextToken": { @@ -27901,6 +27916,12 @@ "traits": { "smithy.api#documentation": "Information about the end associated tasks action.
\nSupported only for TriggerEventSource values: OnCaseUpdate.
Information about the submit automated evaluation action.
" + } } }, "traits": { @@ -31469,6 +31490,21 @@ } } }, + "com.amazonaws.connect#SubmitAutoEvaluationActionDefinition": { + "type": "structure", + "members": { + "EvaluationFormId": { + "target": "com.amazonaws.connect#EvaluationFormId", + "traits": { + "smithy.api#documentation": "The identifier of the auto-evaluation enabled form.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the submit automated evaluation action.
" + } + }, "com.amazonaws.connect#SubmitContactEvaluation": { "type": "operation", "input": { @@ -35758,7 +35794,7 @@ "Applications": { "target": "com.amazonaws.connect#Applications", "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nA list of the third-party application's metadata.
" + "smithy.api#documentation": "A list of the third-party application's metadata.
" } }, "HierarchyRestrictedResources": { diff --git a/codegen/sdk-codegen/aws-models/drs.2020-02-26.json b/codegen/sdk-codegen/aws-models/drs.2020-02-26.json index e1344ff4141..f0b1e2d8b4a 100644 --- a/codegen/sdk-codegen/aws-models/drs.2020-02-26.json +++ b/codegen/sdk-codegen/aws-models/drs.2020-02-26.json @@ -875,6 +875,12 @@ "traits": { "smithy.api#documentation": "AWS Availability zone into which data is being replicated.
" } + }, + "stagingOutpostArn": { + "target": "com.amazonaws.drs#OutpostARN", + "traits": { + "smithy.api#documentation": "The ARN of the staging Outpost
" + } } }, "traits": { @@ -5572,6 +5578,16 @@ ] } }, + "com.amazonaws.drs#OutpostARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 255 + }, + "smithy.api#pattern": "^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$" + } + }, "com.amazonaws.drs#PITPolicy": { "type": "list", "member": { @@ -6051,6 +6067,12 @@ "traits": { "smithy.api#documentation": "The version of the DRS agent installed on the recovery instance
" } + }, + "sourceOutpostArn": { + "target": "com.amazonaws.drs#OutpostARN", + "traits": { + "smithy.api#documentation": "The ARN of the source Outpost
" + } } }, "traits": { @@ -6121,6 +6143,12 @@ "traits": { "smithy.api#documentation": "AWS Availability zone into which data is being replicated.
" } + }, + "stagingOutpostArn": { + "target": "com.amazonaws.drs#OutpostARN", + "traits": { + "smithy.api#documentation": "The ARN of the staging Outpost
" + } } }, "traits": { @@ -7477,6 +7505,12 @@ "traits": { "smithy.api#documentation": "AWS Availability Zone for an EC2-originated Source Server.
" } + }, + "sourceOutpostArn": { + "target": "com.amazonaws.drs#OutpostARN", + "traits": { + "smithy.api#documentation": "The ARN of the source Outpost
" + } } }, "traits": { @@ -9569,6 +9603,10 @@ { "value": "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE", "name": "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE" + }, + { + "value": "PENDING", + "name": "PENDING" } ] } diff --git a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json index 2433891020c..b91544f82a8 100644 --- a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json +++ b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json @@ -10100,7 +10100,7 @@ "target": "com.amazonaws.ec2#CancelSpotFleetRequestsResponse" }, "traits": { - "smithy.api#documentation": "Cancels the specified Spot Fleet requests.
\nAfter you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
\nYou must also specify whether a canceled Spot Fleet request should terminate its instances. If you\n choose to terminate the instances, the Spot Fleet request enters the\n cancelled_terminating state. Otherwise, the Spot Fleet request enters\n the cancelled_running state and the instances continue to run until they\n are interrupted or you terminate them manually.
Cancels the specified Spot Fleet requests.
\nAfter you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
\nYou must also specify whether a canceled Spot Fleet request should terminate its instances. If you\n choose to terminate the instances, the Spot Fleet request enters the\n cancelled_terminating state. Otherwise, the Spot Fleet request enters\n the cancelled_running state and the instances continue to run until they\n are interrupted or you terminate them manually.
\n Restrictions\n
\nYou can delete up to 100 fleets in a single request. If you exceed the specified\n number, no fleets are deleted.
\nThe IDs of the Spot Fleet requests.
", + "smithy.api#documentation": "The IDs of the Spot Fleet requests.
\nConstraint: You can specify up to 100 IDs in a single request.
", "smithy.api#required": {}, "smithy.api#xmlName": "spotFleetRequestId" } @@ -15031,7 +15031,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ErrorCode", - "smithy.api#documentation": "The error code that indicates why the instance could not be launched. For more\n information about error codes, see Error codes.
", + "smithy.api#documentation": "The error code that indicates why the instance could not be launched. For more\n information about error codes, see Error codes.
", "smithy.api#xmlName": "errorCode" } }, @@ -15039,7 +15039,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ErrorMessage", - "smithy.api#documentation": "The error message that describes why the instance could not be launched. For more\n information about error messages, see Error codes.
", + "smithy.api#documentation": "The error message that describes why the instance could not be launched. For more\n information about error messages, see Error codes.
", "smithy.api#xmlName": "errorMessage" } } @@ -22715,7 +22715,7 @@ "target": "com.amazonaws.ec2#DeleteFleetsResult" }, "traits": { - "smithy.api#documentation": "Deletes the specified EC2 Fleets.
\nAfter you delete an EC2 Fleet, it launches no new instances.
\nYou must also specify whether a deleted EC2 Fleet should terminate its instances. If you\n choose to terminate the instances, the EC2 Fleet enters the deleted_terminating\n state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances\n continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is\n deleted. A deleted instant fleet with running instances is not\n supported.
\n Restrictions\n
\nYou can delete up to 25 instant fleets in a single request. If you exceed this\n number, no instant fleets are deleted and an error is returned. There is no\n restriction on the number of fleets of type maintain or request that can be deleted\n in a single request.
Up to 1000 instances can be terminated in a single request to delete\n instant fleets.
For more information, see Delete an EC2\n Fleet in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Deletes the specified EC2 Fleets.
\nAfter you delete an EC2 Fleet, it launches no new instances.
\nYou must also specify whether a deleted EC2 Fleet should terminate its instances. If you\n choose to terminate the instances, the EC2 Fleet enters the deleted_terminating\n state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances\n continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is\n deleted. Up to 1000 instances can be terminated in a single request to delete\n instant fleets. A deleted instant fleet with running instances\n is not supported.
\n Restrictions\n
\nYou can delete up to 25 fleets of type instant in a single\n request.
You can delete up to 100 fleets of type maintain or\n request in a single request.
You can delete up to 125 fleets in a single request, provided you do not exceed\n the quota for each fleet type, as specified above.
\nIf you exceed the specified number of fleets to delete, no fleets are\n deleted.
\nFor more information, see Delete an EC2\n Fleet in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#DeleteFleetsRequest": { @@ -22731,7 +22731,7 @@ "target": "com.amazonaws.ec2#FleetIdSet", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IDs of the EC2 Fleets.
", + "smithy.api#documentation": "The IDs of the EC2 Fleets.
\nConstraints: In a single request, you can specify up to 25 instant fleet\n IDs and up to 100 maintain or request fleet IDs.
Returns a list of all instance types offered. The results can be filtered by location (Region or Availability\n Zone). If no location is specified, the instance types offered in the current Region are returned.
", + "smithy.api#documentation": "Lists the instance types that are offered for the specified location. If no location is specified, the default\n is to list the instance types that are offered in the current Region.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -31954,13 +31954,13 @@ "LocationType": { "target": "com.amazonaws.ec2#LocationType", "traits": { - "smithy.api#documentation": "The location type.
" + "smithy.api#documentation": "The location type.
\n\n availability-zone - The Availability Zone. When you specify a location filter, it must be\n an Availability Zone for the current Region.
\n availability-zone-id - The AZ ID. When you specify a location filter, it must be\n an AZ ID for the current Region.
\n outpost - The Outpost ARN. When you specify a location filter, it must be an Outpost ARN\n for the current Region.
\n region - The current Region. If you specify a location filter, it must match the current Region.
One or more filters. Filter names and values are case-sensitive.
\n\n location - This depends on the location type. For example, if the location type is\n region (default), the location is the Region code (for example, us-east-2.)
\n instance-type - The instance type. For example,\n c5.2xlarge.
One or more filters. Filter names and values are case-sensitive.
\n\n instance-type - The instance type. For a list of possible values, see \n Instance.
\n location - The location. For a list of possible identifiers, see Regions and Zones.
The instance types offered.
", + "smithy.api#documentation": "The instance types offered in the location.
", "smithy.api#xmlName": "instanceTypeOfferingSet" } }, @@ -32014,7 +32014,7 @@ "target": "com.amazonaws.ec2#DescribeInstanceTypesResult" }, "traits": { - "smithy.api#documentation": "Describes the details of the instance types that are offered in a location. The results can be filtered by the\n attributes of the instance types.
", + "smithy.api#documentation": "Describes the specified instance types. By default, all instance types for the current Region are described.\n Alternatively, you can filter the results.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -32035,7 +32035,7 @@ "InstanceTypes": { "target": "com.amazonaws.ec2#RequestInstanceTypeList", "traits": { - "smithy.api#documentation": "The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The instance types.
", "smithy.api#xmlName": "InstanceType" } }, @@ -32070,7 +32070,7 @@ "target": "com.amazonaws.ec2#InstanceTypeInfoList", "traits": { "aws.protocols#ec2QueryName": "InstanceTypeSet", - "smithy.api#documentation": "The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The instance type.
", "smithy.api#xmlName": "instanceTypeSet" } }, @@ -32148,6 +32148,23 @@ "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], + "smithy.test#smokeTests": [ + { + "id": "DescribeInstancesFailure", + "params": { + "InstanceIds": [ + "i-12345678" + ] + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ], "smithy.waiters#waitable": { "InstanceExists": { "acceptors": [ @@ -35852,6 +35869,19 @@ ] } } + ], + "smithy.test#smokeTests": [ + { + "id": "DescribeRegionsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } ] } }, @@ -51167,7 +51197,7 @@ "target": "com.amazonaws.ec2#GetConsoleScreenshotResult" }, "traits": { - "smithy.api#documentation": "Retrieve a JPG-format screenshot of a running instance to help with\n troubleshooting.
\nThe returned content is Base64-encoded.
" + "smithy.api#documentation": "Retrieve a JPG-format screenshot of a running instance to help with\n troubleshooting.
\nThe returned content is Base64-encoded.
\nFor more information, see Instance console output in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#GetConsoleScreenshotRequest": { @@ -75208,7 +75238,7 @@ "target": "com.amazonaws.ec2#ModifyInstanceMetadataDefaultsResult" }, "traits": { - "smithy.api#documentation": "Modifies the default instance metadata service (IMDS) settings at the account level in\n the specified Amazon Web Services\u2028 Region.
\nTo remove a parameter's account-level default setting, specify\n no-preference. At instance launch, the value will come from the\n AMI, or from the launch parameter if specified. For more information, see Order of precedence for instance metadata options in the\n Amazon EC2 User Guide.
Modifies the default instance metadata service (IMDS) settings at the account level in\n the specified Amazon Web Services\u2028 Region.
\nTo remove a parameter's account-level default setting, specify\n no-preference. If an account-level setting is cleared with\n no-preference, then the instance launch considers the other\n instance metadata settings. For more information, see Order of precedence for instance metadata options in the\n Amazon EC2 User Guide.
The maximum number of hops that the metadata token can travel.
\nMinimum: 1\n
Maximum: 64\n
The maximum number of hops that the metadata token can travel. To indicate no\n preference, specify -1.
Possible values: Integers from 1 to 64, and -1\n to indicate no preference
One or more network interfaces. If you specify a network interface, you must specify\n any security groups and subnets as part of the network interface.
", + "smithy.api#documentation": "The network interfaces for the instance.
", "smithy.api#xmlName": "NetworkInterface" } }, @@ -87575,14 +87605,14 @@ "SecurityGroupIds": { "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { - "smithy.api#documentation": "One or more security group IDs. You can create a security group using CreateSecurityGroup.
", + "smithy.api#documentation": "The IDs of the security groups.
\nIf you specify a network interface, you must specify any security groups as part of \n the network interface instead of using this parameter.
", "smithy.api#xmlName": "SecurityGroupId" } }, "SecurityGroups": { "target": "com.amazonaws.ec2#SecurityGroupStringList", "traits": { - "smithy.api#documentation": "One or more security group names. For a nondefault VPC, you must use security group\n IDs instead.
", + "smithy.api#documentation": "The names of the security groups. For a nondefault VPC, you must use security group\n IDs instead.
\nIf you specify a network interface, you must specify any security groups as part of \n the network interface instead of using this parameter.
", "smithy.api#xmlName": "SecurityGroup" } }, @@ -91811,21 +91841,21 @@ "SecurityGroupIds": { "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { - "smithy.api#documentation": "The IDs of the security groups. You can create a security group using CreateSecurityGroup.
\nIf you specify a network interface, you must specify any security groups as part of\n the network interface.
", + "smithy.api#documentation": "The IDs of the security groups. You can create a security group using CreateSecurityGroup.
\nIf you specify a network interface, you must specify any security groups as part of\n the network interface instead of using this parameter.
", "smithy.api#xmlName": "SecurityGroupId" } }, "SecurityGroups": { "target": "com.amazonaws.ec2#SecurityGroupStringList", "traits": { - "smithy.api#documentation": "[Default VPC] The names of the security groups.
\nIf you specify a network interface, you must specify any security groups as part of\n the network interface.
\nDefault: Amazon EC2 uses the default security group.
", + "smithy.api#documentation": "[Default VPC] The names of the security groups.
\nIf you specify a network interface, you must specify any security groups as part of\n the network interface instead of using this parameter.
\nDefault: Amazon EC2 uses the default security group.
", "smithy.api#xmlName": "SecurityGroup" } }, "SubnetId": { "target": "com.amazonaws.ec2#SubnetId", "traits": { - "smithy.api#documentation": "The ID of the subnet to launch the instance into.
\nIf you specify a network interface, you must specify any subnets as part of the\n network interface.
" + "smithy.api#documentation": "The ID of the subnet to launch the instance into.
\nIf you specify a network interface, you must specify any subnets as part of the\n network interface instead of using this parameter.
" } }, "UserData": { @@ -91895,7 +91925,7 @@ "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", "traits": { "aws.protocols#ec2QueryName": "NetworkInterface", - "smithy.api#documentation": "The network interfaces to associate with the instance. If you specify a network\n interface, you must specify any security groups and subnets as part of the network\n interface.
", + "smithy.api#documentation": "The network interfaces to associate with the instance.
", "smithy.api#xmlName": "networkInterface" } }, @@ -91910,13 +91940,13 @@ "ElasticGpuSpecification": { "target": "com.amazonaws.ec2#ElasticGpuSpecifications", "traits": { - "smithy.api#documentation": "Deprecated.
\nAmazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.
\nAn elastic GPU to associate with the instance.
\nAmazon Elastic Graphics reached end of life on January 8, 2024.
\nAn elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.
\nYou cannot specify accelerators from different generations in the same request.
\nStarting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon\n Elastic Inference (EI), and will help current customers migrate their workloads to\n options that offer better price and performance. After April 15, 2023, new customers\n will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,\n Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during\n the past 30-day period are considered current customers and will be able to continue\n using the service.
\nAn elastic inference accelerator to associate with the instance.
\nAmazon Elastic Inference (EI) is no longer available to new customers. For more\n information, see Amazon Elastic Inference FAQs.
\nThe maximum number of routes to return.
" + "smithy.api#documentation": "The maximum number of routes to return. If a value is not provided, the default is\n 1000.
" } }, "DryRun": { @@ -95072,7 +95102,7 @@ "target": "com.amazonaws.ec2#GroupIdentifierList", "traits": { "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "The security groups.
", + "smithy.api#documentation": "The security groups.
\nIf you specify a network interface, you must specify any security groups as part of\n the network interface instead of using this parameter.
", "smithy.api#xmlName": "groupSet" } }, @@ -95152,7 +95182,7 @@ "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", "traits": { "aws.protocols#ec2QueryName": "NetworkInterfaceSet", - "smithy.api#documentation": "One or more network interfaces. If you specify a network interface, you must specify \n subnet IDs and security group IDs using the network interface.
\n\n SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
The network interfaces.
\n\n SpotFleetLaunchSpecification does not support Elastic Fabric Adapter (EFA). \n You must use LaunchTemplateConfig instead.
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate\n them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".
", + "smithy.api#documentation": "The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate\n them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".
\nIf you specify a network interface, you must specify any subnets as part of the\n network interface instead of using this parameter.
", "smithy.api#xmlName": "subnetId" } }, diff --git a/codegen/sdk-codegen/aws-models/emr-serverless.2021-07-13.json b/codegen/sdk-codegen/aws-models/emr-serverless.2021-07-13.json index 3cbe28dd825..1b1c7af60f8 100644 --- a/codegen/sdk-codegen/aws-models/emr-serverless.2021-07-13.json +++ b/codegen/sdk-codegen/aws-models/emr-serverless.2021-07-13.json @@ -1301,6 +1301,26 @@ "smithy.api#documentation": "A configuration specification to be used to override existing configurations.
" } }, + "com.amazonaws.emrserverless#ConfigurationPropertyKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.emrserverless#ConfigurationPropertyValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, "com.amazonaws.emrserverless#ConflictException": { "type": "structure", "members": { @@ -1542,6 +1562,12 @@ "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$" } }, + "com.amazonaws.emrserverless#DiskType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(SHUFFLE_OPTIMIZED|[Ss]huffle_[Oo]ptimized|STANDARD|[Ss]tandard)$" + } + }, "com.amazonaws.emrserverless#Duration": { "type": "long", "traits": { @@ -2670,6 +2696,12 @@ "traits": { "smithy.api#documentation": "The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs\n to send log information to CloudWatch.
" } + }, + "prometheusMonitoringConfiguration": { + "target": "com.amazonaws.emrserverless#PrometheusMonitoringConfiguration", + "traits": { + "smithy.api#documentation": "The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.
" + } } }, "traits": { @@ -2706,6 +2738,30 @@ "smithy.api#pattern": "^[A-Za-z0-9_=-]+$" } }, + "com.amazonaws.emrserverless#PrometheusMonitoringConfiguration": { + "type": "structure", + "members": { + "remoteWriteUrl": { + "target": "com.amazonaws.emrserverless#PrometheusUrlString", + "traits": { + "smithy.api#documentation": "The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.
" + } + }, + "com.amazonaws.emrserverless#PrometheusUrlString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": "^https://aps-workspaces.([a-z]{2}-[a-z-]{1,20}-[1-9]).amazonaws(.[0-9A-Za-z]{2,4})+/workspaces/[-_.0-9A-Za-z]{1,100}/api/v1/remote_write$" + } + }, "com.amazonaws.emrserverless#Query": { "type": "string", "traits": { @@ -2834,10 +2890,10 @@ "com.amazonaws.emrserverless#SensitivePropertiesMap": { "type": "map", "key": { - "target": "com.amazonaws.emrserverless#String1024" + "target": "com.amazonaws.emrserverless#ConfigurationPropertyKey" }, "value": { - "target": "com.amazonaws.emrserverless#String1024" + "target": "com.amazonaws.emrserverless#ConfigurationPropertyValue" }, "traits": { "smithy.api#length": { @@ -3525,6 +3581,12 @@ "traits": { "smithy.api#documentation": "The disk requirements for every worker instance of the worker type.
" } + }, + "diskType": { + "target": "com.amazonaws.emrserverless#DiskType", + "traits": { + "smithy.api#documentation": "The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance \n characteristics and are better for shuffle heavy workloads. Default is STANDARD.
Adds a policy statement object. To retrieve a list of existing policy statements, use\n the GetPolicy API.
The Amazon Resource Name (ARN) of the resource that will be accessed by the\n principal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statementId": { + "target": "com.amazonaws.entityresolution#StatementId", + "traits": { + "smithy.api#documentation": "A statement identifier that differentiates the statement from others in the same\n policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "effect": { + "target": "com.amazonaws.entityresolution#StatementEffect", + "traits": { + "smithy.api#documentation": "Determines whether the permissions specified in the policy are to be allowed\n (Allow) or denied (Deny).
The action that the principal can use on the resource.
\nFor example, entityresolution:GetIdMappingJob,\n entityresolution:GetMatchingJob.
The Amazon Web Services service or Amazon Web Services account that can access the\n resource defined as ARN.
", + "smithy.api#required": {} + } + }, + "condition": { + "target": "com.amazonaws.entityresolution#StatementCondition", + "traits": { + "smithy.api#documentation": "A set of condition keys that you can use in key policies.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#AddPolicyStatementOutput": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.entityresolution#VeniceGlobalArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that will be accessed by the\n principal.
", + "smithy.api#required": {} + } + }, + "token": { + "target": "com.amazonaws.entityresolution#PolicyToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the current revision of the policy.
", + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.entityresolution#PolicyDocument", + "traits": { + "smithy.api#documentation": "The resource-based policy.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.entityresolution#AttributeMatchingModel": { "type": "enum", "members": { @@ -823,7 +967,7 @@ "com.amazonaws.entityresolution#AwsAccountId": { "type": "string", "traits": { - "smithy.api#pattern": "\\d{12}" + "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.entityresolution#AwsAccountIdList": { @@ -908,8 +1052,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#IdMappingWorkflowOutputSourceConfig", "traits": { - "smithy.api#documentation": "A list of IdMappingWorkflowOutputSource objects, each of which contains\n fields OutputS3Path and Output.
A list of IdMappingWorkflowOutputSource objects, each of which contains\n fields OutputS3Path and Output.
A list of IdMappingWorkflowOutputSource objects, each of which contains\n fields OutputS3Path and Output.
A list of IdMappingWorkflowOutputSource objects, each of which contains\n fields OutputS3Path and Output.
Creates an ID namespace object which will help customers provide metadata explaining\n their dataset and how to use it. Each ID namespace must have a unique name. To modify an\n existing ID namespace, use the UpdateIdNamespace API.
The name of the ID namespace.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "The description of the ID namespace.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#IdNamespaceInputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields\n InputSourceARN and SchemaName.
Determines the properties of IdMappingWorflow where this\n IdNamespace can be used as a Source or a\n Target.
The type of ID namespace. There are two types: SOURCE and\n TARGET.
The SOURCE contains configurations for sourceId data that will\n be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId to which all\n sourceIds will resolve to.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access the resources defined in this IdNamespace on your behalf\n as part of the workflow run.
The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#CreateIdNamespaceOutput": { + "type": "structure", + "members": { + "idNamespaceName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the ID namespace.
", + "smithy.api#required": {} + } + }, + "idNamespaceArn": { + "target": "com.amazonaws.entityresolution#IdNamespaceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ID namespace.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "The description of the ID namespace.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#IdNamespaceInputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields\n InputSourceARN and SchemaName.
Determines the properties of IdMappingWorkflow where this\n IdNamespace can be used as a Source or a\n Target.
The type of ID namespace. There are two types: SOURCE and\n TARGET.
The SOURCE contains configurations for sourceId data that will\n be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId to which all\n sourceIds will resolve to.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access the resources defined in inputSourceConfig on your behalf\n as part of the workflow run.
The timestamp of when the ID namespace was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the ID namespace was last updated.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.entityresolution#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.entityresolution#CreateMatchingWorkflow": { "type": "operation", "input": { @@ -1272,6 +1576,9 @@ { "target": "com.amazonaws.entityresolution#AccessDeniedException" }, + { + "target": "com.amazonaws.entityresolution#ConflictException" + }, { "target": "com.amazonaws.entityresolution#InternalServerException" }, @@ -1323,13 +1630,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.entityresolution#DeleteMatchingWorkflow": { + "com.amazonaws.entityresolution#DeleteIdNamespace": { "type": "operation", "input": { - "target": "com.amazonaws.entityresolution#DeleteMatchingWorkflowInput" + "target": "com.amazonaws.entityresolution#DeleteIdNamespaceInput" }, "output": { - "target": "com.amazonaws.entityresolution#DeleteMatchingWorkflowOutput" + "target": "com.amazonaws.entityresolution#DeleteIdNamespaceOutput" }, "errors": [ { @@ -1346,22 +1653,22 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the MatchingWorkflow with a given name. This operation will succeed\n even if a workflow with the given name does not exist.
Deletes the IdNamespace with a given name.
The name of the workflow to be retrieved.
", + "smithy.api#documentation": "The name of the ID namespace.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1371,7 +1678,7 @@ "smithy.api#input": {} } }, - "com.amazonaws.entityresolution#DeleteMatchingWorkflowOutput": { + "com.amazonaws.entityresolution#DeleteIdNamespaceOutput": { "type": "structure", "members": { "message": { @@ -1386,13 +1693,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.entityresolution#DeleteSchemaMapping": { + "com.amazonaws.entityresolution#DeleteMatchingWorkflow": { "type": "operation", "input": { - "target": "com.amazonaws.entityresolution#DeleteSchemaMappingInput" + "target": "com.amazonaws.entityresolution#DeleteMatchingWorkflowInput" }, "output": { - "target": "com.amazonaws.entityresolution#DeleteSchemaMappingOutput" + "target": "com.amazonaws.entityresolution#DeleteMatchingWorkflowOutput" }, "errors": [ { @@ -1412,16 +1719,172 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the SchemaMapping with a given name. This operation will succeed\n even if a schema with the given name does not exist. This operation will fail if there is a\n MatchingWorkflow object that references the SchemaMapping in\n the workflow's InputSourceConfig.
Deletes the MatchingWorkflow with a given name. This operation will succeed\n even if a workflow with the given name does not exist.
The name of the workflow to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#DeleteMatchingWorkflowOutput": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A successful operation message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#DeletePolicyStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#DeletePolicyStatementInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#DeletePolicyStatementOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#ConflictException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the policy statement.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/policies/{arn}/{statementId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.entityresolution#DeletePolicyStatementInput": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.entityresolution#VeniceGlobalArn", + "traits": { + "smithy.api#documentation": "The ARN of the resource for which the policy need to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statementId": { + "target": "com.amazonaws.entityresolution#StatementId", + "traits": { + "smithy.api#documentation": "A statement identifier that differentiates the statement from others in the same\n policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#DeletePolicyStatementOutput": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.entityresolution#VeniceGlobalArn", + "traits": { + "smithy.api#documentation": "The ARN of the resource for which the policy need to be deleted.
", + "smithy.api#required": {} + } + }, + "token": { + "target": "com.amazonaws.entityresolution#PolicyToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the deleted policy.
", + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.entityresolution#PolicyDocument", + "traits": { + "smithy.api#documentation": "The resource-based policy.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#DeleteSchemaMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#DeleteSchemaMappingInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#DeleteSchemaMappingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#ConflictException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the SchemaMapping with a given name. This operation will succeed\n even if a schema with the given name does not exist. This operation will fail if there is a\n MatchingWorkflow object that references the SchemaMapping in\n the workflow's InputSourceConfig.
The name of the workflow.
", "smithy.api#httpLabel": {}, @@ -1615,6 +2090,12 @@ }, "errorDetails": { "target": "com.amazonaws.entityresolution#ErrorDetails" + }, + "outputSourceConfig": { + "target": "com.amazonaws.entityresolution#IdMappingJobOutputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of OutputSource objects.
A list of OutputSource objects, each of which contains fields\n OutputS3Path and KMSArn.
A list of OutputSource objects, each of which contains fields\n OutputS3Path and KMSArn.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access resources on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access Amazon Web Services resources on your behalf.
", "smithy.api#required": {} } }, @@ -1748,13 +2228,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.entityresolution#GetMatchId": { + "com.amazonaws.entityresolution#GetIdNamespace": { "type": "operation", "input": { - "target": "com.amazonaws.entityresolution#GetMatchIdInput" + "target": "com.amazonaws.entityresolution#GetIdNamespaceInput" }, "output": { - "target": "com.amazonaws.entityresolution#GetMatchIdOutput" + "target": "com.amazonaws.entityresolution#GetIdNamespaceOutput" }, "errors": [ { @@ -1774,45 +2254,97 @@ } ], "traits": { - "smithy.api#documentation": "Returns the corresponding Match ID of a customer record if the record has been\n processed.
", + "smithy.api#documentation": "Returns the IdNamespace with a given name, if it exists.
The name of the workflow.
", + "smithy.api#documentation": "The name of the ID namespace.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "record": { - "target": "com.amazonaws.entityresolution#RecordAttributeMap", - "traits": { - "smithy.api#documentation": "The record to fetch the Match ID for.
", - "smithy.api#required": {} - } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.entityresolution#GetMatchIdOutput": { + "com.amazonaws.entityresolution#GetIdNamespaceOutput": { "type": "structure", "members": { - "matchId": { - "target": "smithy.api#String", + "idNamespaceName": { + "target": "com.amazonaws.entityresolution#EntityName", "traits": { - "smithy.api#documentation": "The unique identifiers for this group of match records.
" + "smithy.api#documentation": "The name of the ID namespace.
", + "smithy.api#required": {} + } + }, + "idNamespaceArn": { + "target": "com.amazonaws.entityresolution#IdNamespaceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ID namespace.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "The description of the ID namespace.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#IdNamespaceInputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields\n InputSourceARN and SchemaName.
Determines the properties of IdMappingWorkflow where this\n IdNamespace can be used as a Source or a\n Target.
The type of ID namespace. There are two types: SOURCE and\n TARGET.
The SOURCE contains configurations for sourceId data that will\n be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId to which all\n sourceIds will resolve to.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access the resources defined in this IdNamespace on your behalf\n as part of a workflow run.
The timestamp of when the ID namespace was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the ID namespace was last updated.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.entityresolution#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, @@ -1820,13 +2352,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.entityresolution#GetMatchingJob": { + "com.amazonaws.entityresolution#GetMatchId": { "type": "operation", "input": { - "target": "com.amazonaws.entityresolution#GetMatchingJobInput" + "target": "com.amazonaws.entityresolution#GetMatchIdInput" }, "output": { - "target": "com.amazonaws.entityresolution#GetMatchingJobOutput" + "target": "com.amazonaws.entityresolution#GetMatchIdOutput" }, "errors": [ { @@ -1846,16 +2378,16 @@ } ], "traits": { - "smithy.api#documentation": "Gets the status, metrics, and errors (if there are any) that are associated with a\n job.
", + "smithy.api#documentation": "Returns the corresponding Match ID of a customer record if the record has been\n processed.
", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/matchingworkflows/{workflowName}/jobs/{jobId}" + "method": "POST", + "uri": "/matchingworkflows/{workflowName}/matches" }, "smithy.api#readonly": {} } }, - "com.amazonaws.entityresolution#GetMatchingJobInput": { + "com.amazonaws.entityresolution#GetMatchIdInput": { "type": "structure", "members": { "workflowName": { @@ -1866,30 +2398,115 @@ "smithy.api#required": {} } }, - "jobId": { - "target": "com.amazonaws.entityresolution#JobId", + "record": { + "target": "com.amazonaws.entityresolution#RecordAttributeMap", "traits": { - "smithy.api#documentation": "The ID of the job.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The record to fetch the Match ID for.
", "smithy.api#required": {} } + }, + "applyNormalization": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "Normalizes the attributes defined in the schema in the input data. For example, if an\n attribute has an AttributeType of PHONE_NUMBER, and the data in\n the input table is in a format of 1234567890, Entity Resolution will normalize this field\n in the output to (123)-456-7890.
The ID of the job.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifiers for this group of match records.
" } }, - "status": { + "matchRule": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The rule the record matched on.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#GetMatchingJobInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#GetMatchingJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the status, metrics, and errors (if there are any) that are associated with a\n job.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/matchingworkflows/{workflowName}/jobs/{jobId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingJobInput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "jobId": { + "target": "com.amazonaws.entityresolution#JobId", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingJobOutput": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.entityresolution#JobId", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#required": {} + } + }, + "status": { "target": "com.amazonaws.entityresolution#JobStatus", "traits": { "smithy.api#documentation": "The current status of the job.
", @@ -1920,6 +2537,12 @@ "traits": { "smithy.api#documentation": "An object containing an error message, if there was an error.
" } + }, + "outputSourceConfig": { + "target": "com.amazonaws.entityresolution#JobOutputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of OutputSource objects.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access resources on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access Amazon Web Services resources on your behalf.
", "smithy.api#required": {} } }, @@ -2059,6 +2682,85 @@ "smithy.api#output": {} } }, + "com.amazonaws.entityresolution#GetPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#GetPolicyInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#GetPolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the resource-based policy.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/policies/{arn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.entityresolution#GetPolicyInput": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.entityresolution#VeniceGlobalArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the policy need to be\n returned.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#GetPolicyOutput": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.entityresolution#VeniceGlobalArn", + "traits": { + "smithy.api#documentation": "The Entity Resolution resource ARN.
", + "smithy.api#required": {} + } + }, + "token": { + "target": "com.amazonaws.entityresolution#PolicyToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the current revision of the policy.
", + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.entityresolution#PolicyDocument", + "traits": { + "smithy.api#documentation": "The resource-based policy.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.entityresolution#GetProviderService": { "type": "operation", "input": { @@ -2162,6 +2864,18 @@ "smithy.api#documentation": "The definition of the provider configuration.
" } }, + "providerIdNameSpaceConfiguration": { + "target": "com.amazonaws.entityresolution#ProviderIdNameSpaceConfiguration", + "traits": { + "smithy.api#documentation": "The provider configuration required for different ID namespace types.
" + } + }, + "providerJobConfiguration": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Provider service job configurations.
" + } + }, "providerEndpointConfiguration": { "target": "com.amazonaws.entityresolution#ProviderEndpointConfiguration", "traits": { @@ -2188,6 +2902,12 @@ "traits": { "smithy.api#documentation": "The Amazon Web Services accounts and the S3 permissions that are required by some\n providers to create an S3 bucket for intermediate data storage.
" } + }, + "providerComponentSchema": { + "target": "com.amazonaws.entityresolution#ProviderComponentSchema", + "traits": { + "smithy.api#documentation": "Input schema for the provider service.
" + } } }, "traits": { @@ -2333,6 +3053,46 @@ "smithy.api#documentation": "An object containing InputRecords, TotalRecordsProcessed,\n MatchIDs, and RecordsNotProcessed.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access Amazon Web Services resources on your behalf as part of workflow\n execution.
", + "smithy.api#required": {} + } + }, + "outputS3Path": { + "target": "com.amazonaws.entityresolution#S3Path", + "traits": { + "smithy.api#documentation": "The S3 path to which Entity Resolution will write the output table.
", + "smithy.api#required": {} + } + }, + "KMSArn": { + "target": "com.amazonaws.entityresolution#KMSArn", + "traits": { + "smithy.api#documentation": "Customer KMS ARN for encryption at rest. If not provided, system will use\n an Entity Resolution managed KMS key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing KMSArn, OutputS3Path, and\n RoleARN.
An object which defines any additional configurations required by the provider\n service.
", - "smithy.api#required": {} + "smithy.api#documentation": "An object which defines any additional configurations required by the provider\n service.
" } } }, @@ -2369,7 +3128,7 @@ "com.amazonaws.entityresolution#IdMappingWorkflowArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(idmappingworkflow/.*)$" + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idmappingworkflow/[a-zA-Z_0-9-]{1,255})$" } }, "com.amazonaws.entityresolution#IdMappingWorkflowInputSource": { @@ -2378,21 +3137,26 @@ "inputSourceARN": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An Gluetable ARN for the input source table.
", - "smithy.api#pattern": "^arn:aws:.*:.*:[0-9]+:.*$", + "smithy.api#documentation": "An Glue table ARN for the input source table.
", + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", "smithy.api#required": {} } }, "schemaName": { "target": "com.amazonaws.entityresolution#EntityName", "traits": { - "smithy.api#documentation": "The name of the schema to be retrieved.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the schema to be retrieved.
" + } + }, + "type": { + "target": "com.amazonaws.entityresolution#IdNamespaceType", + "traits": { + "smithy.api#documentation": "The type of ID namespace. There are two types: SOURCE and\n TARGET.
The SOURCE contains configurations for sourceId data that will\n be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId to which all\n sourceIds will resolve to.
An object containing InputSourceARN and SchemaName.
An object containing InputSourceARN, SchemaName, and\n Type.
A list of IdMappingWorkflowSummary objects, each of which contain the\n fields WorkflowName, WorkflowArn, CreatedAt, and\n UpdatedAt.
The type of ID mapping.
", + "smithy.api#required": {} + } + }, + "providerProperties": { + "target": "com.amazonaws.entityresolution#NamespaceProviderProperties", + "traits": { + "smithy.api#documentation": "An object which defines any additional configurations required by the provider\n service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing IdMappingType and\n ProviderProperties.
An Glue table ARN for the input source table.
", + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", + "smithy.api#required": {} + } + }, + "schemaName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the schema.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing InputSourceARN and SchemaName.
The name of the ID namespace.
", + "smithy.api#required": {} + } + }, + "idNamespaceArn": { + "target": "com.amazonaws.entityresolution#IdNamespaceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ID namespace.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "The description of the ID namespace.
" + } + }, + "type": { + "target": "com.amazonaws.entityresolution#IdNamespaceType", + "traits": { + "smithy.api#documentation": "The type of ID namespace. There are two types: SOURCE and\n TARGET.
The SOURCE contains configurations for sourceId data that will\n be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId to which all\n sourceIds will resolve to.
The timestamp of when the ID namespace was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the ID namespace was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of ID namespaces.
" + } + }, + "com.amazonaws.entityresolution#IdNamespaceType": { + "type": "enum", + "members": { + "SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE" + } + }, + "TARGET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TARGET" + } + } + } + }, "com.amazonaws.entityresolution#IncrementalRunConfig": { "type": "structure", "members": { @@ -2514,7 +3423,7 @@ "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An Glue table ARN for the input source table.
", - "smithy.api#pattern": "^arn:aws:.*:.*:[0-9]+:.*$", + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", "smithy.api#required": {} } }, @@ -2621,6 +3530,46 @@ "smithy.api#documentation": "An object containing InputRecords, TotalRecordsProcessed,\n MatchIDs, and RecordsNotProcessed.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access Amazon Web Services resources on your behalf as part of workflow\n execution.
", + "smithy.api#required": {} + } + }, + "outputS3Path": { + "target": "com.amazonaws.entityresolution#S3Path", + "traits": { + "smithy.api#documentation": "The S3 path to which Entity Resolution will write the output table.
", + "smithy.api#required": {} + } + }, + "KMSArn": { + "target": "com.amazonaws.entityresolution#KMSArn", + "traits": { + "smithy.api#documentation": "Customer KMS ARN for encryption at rest. If not provided, system will use\n an Entity Resolution managed KMS key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing KMSArn, OutputS3Path, and\n RoleArn.
Lists all ID mapping jobs for a given workflow.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/idmappingworkflows/{workflowName}/jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.entityresolution#ListIdMappingJobsInput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityNameOrIdMappingWorkflowArn", + "traits": { + "smithy.api#documentation": "The name of the workflow to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.entityresolution#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token from the previous API call.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of objects returned per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#ListIdMappingJobsOutput": { + "type": "structure", + "members": { + "jobs": { + "target": "com.amazonaws.entityresolution#JobList", + "traits": { + "smithy.api#documentation": "A list of JobSummary objects.
The pagination token from the previous API call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#ListIdMappingWorkflows": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#ListIdMappingWorkflowsInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#ListIdMappingWorkflowsOutput" }, "errors": [ { @@ -2706,9 +3750,6 @@ { "target": "com.amazonaws.entityresolution#InternalServerException" }, - { - "target": "com.amazonaws.entityresolution#ResourceNotFoundException" - }, { "target": "com.amazonaws.entityresolution#ThrottlingException" }, @@ -2717,32 +3758,24 @@ } ], "traits": { - "smithy.api#documentation": "Lists all ID mapping jobs for a given workflow.
", + "smithy.api#documentation": "Returns a list of all the IdMappingWorkflows that have been created for an\n Amazon Web Services account.
The name of the workflow to be retrieved.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "nextToken": { "target": "com.amazonaws.entityresolution#NextToken", "traits": { @@ -2756,7 +3789,6 @@ "smithy.api#documentation": "The maximum number of objects returned per page.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { - "min": 1, "max": 25 } } @@ -2766,13 +3798,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.entityresolution#ListIdMappingJobsOutput": { + "com.amazonaws.entityresolution#ListIdMappingWorkflowsOutput": { "type": "structure", "members": { - "jobs": { - "target": "com.amazonaws.entityresolution#JobList", + "workflowSummaries": { + "target": "com.amazonaws.entityresolution#IdMappingWorkflowList", "traits": { - "smithy.api#documentation": "A list of JobSummary objects.
A list of IdMappingWorkflowSummary objects.
Returns a list of all the IdMappingWorkflows that have been created for an\n Amazon Web Services account.
Returns a list of all ID namespaces.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/idmappingworkflows" + "uri": "/idnamespaces" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", - "items": "workflowSummaries" + "items": "idNamespaceSummaries" }, "smithy.api#readonly": {} } }, - "com.amazonaws.entityresolution#ListIdMappingWorkflowsInput": { + "com.amazonaws.entityresolution#ListIdNamespacesInput": { "type": "structure", "members": { "nextToken": { @@ -2837,7 +3869,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The maximum number of objects returned per page.
", + "smithy.api#documentation": "The maximum number of IdNamespace objects returned per page.
A list of IdMappingWorkflowSummary objects.
A list of IdNamespaceSummaries objects.
A list of MatchingWorkflowSummary objects, each of which contain the fields\n WorkflowName, WorkflowArn, CreatedAt,\n UpdatedAt.
The Amazon Resource Name (ARN) of the provider service.
", + "smithy.api#required": {} + } + }, + "providerConfiguration": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "An object which defines any additional configurations required by the provider\n service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing ProviderConfiguration and\n ProviderServiceArn.
Input schema for the provider service.
" + } + }, + "providerSchemaAttributes": { + "target": "com.amazonaws.entityresolution#ProviderSchemaAttributes", + "traits": { + "smithy.api#documentation": "The provider schema attributes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input schema supported by provider service.
" + } + }, "com.amazonaws.entityresolution#ProviderEndpointConfiguration": { "type": "union", "members": { @@ -3441,13 +4533,39 @@ "smithy.api#documentation": "The required configuration fields to use with the provider service.
" } }, + "com.amazonaws.entityresolution#ProviderIdNameSpaceConfiguration": { + "type": "structure", + "members": { + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the ID namespace.
" + } + }, + "providerTargetConfigurationDefinition": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Configurations required for the target ID namespace.
" + } + }, + "providerSourceConfigurationDefinition": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Configurations required for the source ID namespace.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The provider configuration required for different ID namespace types.
" + } + }, "com.amazonaws.entityresolution#ProviderIntermediateDataAccessConfiguration": { "type": "structure", "members": { "awsAccountIds": { "target": "com.amazonaws.entityresolution#AwsAccountIdList", "traits": { - "smithy.api#documentation": "The Amazon Web Services account\n that\n provider can use to read or write data into the customer's intermediate S3\n bucket.
" + "smithy.api#documentation": "The Amazon Web Services account that provider can use to read or write data into the\n customer's intermediate S3 bucket.
" } }, "requiredBucketActions": { @@ -3497,98 +4615,233 @@ "smithy.api#documentation": "The identifiers of the provider service, from Data Exchange.
" } }, - "com.amazonaws.entityresolution#ProviderProperties": { + "com.amazonaws.entityresolution#ProviderProperties": { + "type": "structure", + "members": { + "providerServiceArn": { + "target": "com.amazonaws.entityresolution#ProviderServiceArn", + "traits": { + "smithy.api#documentation": "The ARN of the provider service.
", + "smithy.api#required": {} + } + }, + "providerConfiguration": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The required configuration fields to use with the provider service.
" + } + }, + "intermediateSourceConfiguration": { + "target": "com.amazonaws.entityresolution#IntermediateSourceConfiguration", + "traits": { + "smithy.api#documentation": "The Amazon S3 location that temporarily stores your data while it processes.\n Your information won't be saved permanently.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing the providerServiceARN,\n intermediateSourceConfiguration, and\n providerConfiguration.
The field name.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.entityresolution#SchemaAttributeType", + "traits": { + "smithy.api#documentation": "The type of the provider schema attribute.
", + "smithy.api#required": {} + } + }, + "subType": { + "target": "com.amazonaws.entityresolution#AttributeName", + "traits": { + "smithy.api#documentation": "The sub type of the provider schema attribute.
" + } + }, + "hashing": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "The hashing attribute of the provider schema.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The provider schema attribute.
" + } + }, + "com.amazonaws.entityresolution#ProviderSchemaAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#ProviderSchemaAttribute" + } + }, + "com.amazonaws.entityresolution#ProviderServiceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 255 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})$" + } + }, + "com.amazonaws.entityresolution#ProviderServiceDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 255 + } + } + }, + "com.amazonaws.entityresolution#ProviderServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#ProviderServiceSummary" + } + }, + "com.amazonaws.entityresolution#ProviderServiceSummary": { + "type": "structure", + "members": { + "providerServiceArn": { + "target": "com.amazonaws.entityresolution#ProviderServiceArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the\n providerService.
The name of the provider. This name is typically the company name.
", + "smithy.api#required": {} + } + }, + "providerServiceDisplayName": { + "target": "com.amazonaws.entityresolution#ProviderServiceDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the provider service.
", + "smithy.api#required": {} + } + }, + "providerServiceName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the product that the provider service provides.
", + "smithy.api#required": {} + } + }, + "providerServiceType": { + "target": "com.amazonaws.entityresolution#ServiceType", + "traits": { + "smithy.api#documentation": "The type of provider service.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of ProviderService objects, each of which contain the fields\n providerName, providerServiceArn,\n providerServiceName, and providerServiceType.
Updates the resource-based policy.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/policies/{arn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.entityresolution#PutPolicyInput": { "type": "structure", "members": { - "providerServiceArn": { - "target": "com.amazonaws.entityresolution#ProviderServiceArn", + "arn": { + "target": "com.amazonaws.entityresolution#VeniceGlobalArn", "traits": { - "smithy.api#documentation": "The ARN of the provider service.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the policy needs to be\n updated.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "providerConfiguration": { - "target": "smithy.api#Document", + "token": { + "target": "com.amazonaws.entityresolution#PolicyToken", "traits": { - "smithy.api#documentation": "The required configuration fields to use with the provider service.
" + "smithy.api#documentation": "A unique identifier for the current revision of the policy.
" } }, - "intermediateSourceConfiguration": { - "target": "com.amazonaws.entityresolution#IntermediateSourceConfiguration", + "policy": { + "target": "com.amazonaws.entityresolution#PolicyDocument", "traits": { - "smithy.api#documentation": "The Amazon S3 location that temporarily stores your data while it processes.\n Your information won't be saved permanently.
" + "smithy.api#documentation": "The resource-based policy.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "An object containing the providerServiceARN,\n intermediateSourceConfiguration, and\n providerConfiguration.
The ARN (Amazon Resource Name) that Entity Resolution generated for the\n providerService.
The name of the provider. This name is typically the company name.
", - "smithy.api#required": {} - } - }, - "providerServiceDisplayName": { - "target": "com.amazonaws.entityresolution#ProviderServiceDisplayName", + "arn": { + "target": "com.amazonaws.entityresolution#VeniceGlobalArn", "traits": { - "smithy.api#documentation": "The display name of the provider service.
", + "smithy.api#documentation": "The Entity Resolution resource ARN.
", "smithy.api#required": {} } }, - "providerServiceName": { - "target": "com.amazonaws.entityresolution#EntityName", + "token": { + "target": "com.amazonaws.entityresolution#PolicyToken", "traits": { - "smithy.api#documentation": "The name of the product that the provider service provides.
", + "smithy.api#documentation": "A unique identifier for the current revision of the policy.
", "smithy.api#required": {} } }, - "providerServiceType": { - "target": "com.amazonaws.entityresolution#ServiceType", + "policy": { + "target": "com.amazonaws.entityresolution#PolicyDocument", "traits": { - "smithy.api#documentation": "The type of provider service.
", - "smithy.api#required": {} + "smithy.api#documentation": "The resource-based policy.
" } } }, "traits": { - "smithy.api#documentation": "A list of ProviderService objects, each of which contain the fields\n providerName, providerServiceArn,\n providerServiceName, and providerServiceType.
The type of matching. There are two types of matching: RULE_MATCHING and\n ML_MATCHING.
The type of matching. There are three types of matching: RULE_MATCHING,\n ML_MATCHING, and PROVIDER.
Instruct Entity Resolution to combine several columns into a unified column with the\n identical attribute type. For example, when working with columns such as first_name,\n middle_name, and last_name, assigning them a common GroupName will prompt\n Entity Resolution to concatenate them into a single value.
A string that instructs Entity Resolution to combine several columns into a unified\n column with the identical attribute type.
\nFor example, when working with columns such as first_name,\n middle_name, and last_name, assigning them a common\n groupName will prompt Entity Resolution to concatenate them into a single\n value.
A key that allows grouping of multiple input attributes into a unified matching group.\n For example, let's consider a scenario where the source table contains various addresses,\n such as business_address and shipping_address. By assigning the\n MatchKey\n Address to both attributes, Entity Resolution will match records\n across these fields to create a consolidated matching group. If no MatchKey is\n specified for a column, it won't be utilized for matching purposes but will still be\n included in the output table.
A key that allows grouping of multiple input attributes into a unified matching group.\n For example, consider a scenario where the source table contains various addresses, such as\n business_address and shipping_address. By assigning a\n matchKey called address to both attributes, Entity Resolution\n will match records across these fields to create a consolidated matching group. If no\n matchKey is specified for a column, it won't be utilized for matching\n purposes but will still be included in the output table.
An object containing FieldName, Type, GroupName,\n and MatchKey.
An object containing FieldName, Type, GroupName,\n MatchKey, and SubType.
An object containing SchemaName, SchemaArn,\n CreatedAt, andUpdatedAt.
The name of the ID mapping job to be retrieved.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "outputSourceConfig": { + "target": "com.amazonaws.entityresolution#IdMappingJobOutputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of OutputSource objects.
The ID of the job.
", "smithy.api#required": {} } + }, + "outputSourceConfig": { + "target": "com.amazonaws.entityresolution#IdMappingJobOutputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of OutputSource objects.
A list of OutputSource objects, each of which contains fields\n OutputS3Path and KMSArn.
A list of OutputSource objects, each of which contains fields\n OutputS3Path and KMSArn.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access resources on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access Amazon Web Services resources on your behalf.
", "smithy.api#required": {} } } @@ -4425,7 +5783,7 @@ "workflowArn": { "target": "com.amazonaws.entityresolution#IdMappingWorkflowArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the workflow role. Entity Resolution assumes this role\n to access resources on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the workflow role. Entity Resolution assumes this role\n to access Amazon Web Services resources on your behalf.
", "smithy.api#required": {} } }, @@ -4445,8 +5803,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#IdMappingWorkflowOutputSourceConfig", "traits": { - "smithy.api#documentation": "A list of OutputSource objects, each of which contains fields\n OutputS3Path and KMSArn.
A list of OutputSource objects, each of which contains fields\n OutputS3Path and KMSArn.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access resources on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access Amazon Web Services resources on your behalf.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#UpdateIdNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#UpdateIdNamespaceInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#UpdateIdNamespaceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing ID namespace.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/idnamespaces/{idNamespaceName}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.entityresolution#UpdateIdNamespaceInput": { + "type": "structure", + "members": { + "idNamespaceName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the ID namespace.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "The description of the ID namespace.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#IdNamespaceInputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields\n InputSourceARN and SchemaName.
Determines the properties of IdMappingWorkflow where this\n IdNamespace can be used as a Source or a\n Target.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access the resources defined in this IdNamespace on your behalf\n as part of a workflow run.
The name of the ID namespace.
", + "smithy.api#required": {} + } + }, + "idNamespaceArn": { + "target": "com.amazonaws.entityresolution#IdNamespaceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ID namespace.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "The description of the ID namespace.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#IdNamespaceInputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields\n InputSourceARN and SchemaName.
Determines the properties of IdMappingWorkflow where this\n IdNamespace can be used as a Source or a\n Target.
The type of ID namespace. There are two types: SOURCE and\n TARGET.
The SOURCE contains configurations for sourceId data that will\n be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId to which all\n sourceIds will resolve to.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes\n this role to access the resources defined in this IdNamespace on your behalf\n as part of a workflow run.
The timestamp of when the ID namespace was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the ID namespace was last updated.
", "smithy.api#required": {} } } @@ -4732,7 +6231,7 @@ "com.amazonaws.entityresolution#VeniceGlobalArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):(entityresolution):.*:[0-9]+:((schemamapping|matchingworkflow|idmappingworkflow)/[a-zA-Z0-9_-]+)$" + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:((schemamapping|matchingworkflow|idmappingworkflow|idnamespace)/[a-zA-Z_0-9-]{1,255})$" } } } diff --git a/codegen/sdk-codegen/aws-models/glue.2017-03-31.json b/codegen/sdk-codegen/aws-models/glue.2017-03-31.json index b1e3d8a9545..44f400bca34 100644 --- a/codegen/sdk-codegen/aws-models/glue.2017-03-31.json +++ b/codegen/sdk-codegen/aws-models/glue.2017-03-31.json @@ -20008,7 +20008,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves table metadata from the Data Catalog that contains unfiltered \n metadata.
\nFor IAM authorization, the public IAM action associated with this API is glue:GetTable.
Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog.
\nFor IAM authorization, the public IAM action associated with this API is glue:GetTable.
(Required) A list of supported permission types.
", + "smithy.api#documentation": "Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:
\n COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.
\n CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.
\n NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.
\n NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.
Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.
\nImportant: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.
The resource ARN of the view.
" + } + }, + "RootResourceArn": { + "target": "com.amazonaws.glue#ArnString", + "traits": { + "smithy.api#documentation": "The resource ARN of the root view in a chain of nested views.
" + } + }, "SupportedDialect": { "target": "com.amazonaws.glue#SupportedDialect", "traits": { @@ -20136,6 +20148,12 @@ "traits": { "smithy.api#documentation": "The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
" } + }, + "RowFilter": { + "target": "com.amazonaws.glue#PredicateString", + "traits": { + "smithy.api#documentation": "The filter that applies to the table. For example when applying the filter in SQL, it would go in the WHERE clause and can be evaluated by using an AND operator with any other predicates applied by the user querying the table.
The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple GetRecords API calls may be made within this time. The default value is 1000.
The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If MaxFetchRecordsPerShard needs to be strict then it needs to be a multiple of MaxRecordPerRead. The default value is 100000.
Represents the criteria to be used in the filter for querying findings.
\nYou can only use the following attributes to query findings:
\naccountId
\nid
\nregion
\nseverity
\nTo filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:
\n\n Low: [\"1\", \"2\", \"3\"]\n
\n Medium: [\"4\", \"5\", \"6\"]\n
\n High: [\"7\", \"8\", \"9\"]\n
For more information, see Severity\n levels for GuardDuty findings.
\ntype
\nupdatedAt
\nType: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.outpostArn
\nresource.resourceType
\nresource.s3BucketDetails.publicAccess.effectivePermissions
\nresource.s3BucketDetails.name
\nresource.s3BucketDetails.tags.key
\nresource.s3BucketDetails.tags.value
\nresource.s3BucketDetails.type
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.errorCode
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.dnsRequestAction.domainWithSuffix
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.remoteIpDetails.city.cityName
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.action.awsApiCallAction.remoteAccountDetails.affiliated
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.kubernetesApiCallAction.namespace
\nservice.action.kubernetesApiCallAction.remoteIpDetails.organization.asn
\nservice.action.kubernetesApiCallAction.requestUri
\nservice.action.kubernetesApiCallAction.statusCode
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.protocol
\nservice.action.awsApiCallAction.serviceName
\nservice.action.awsApiCallAction.remoteAccountDetails.accountId
\nservice.additionalInfo.threatListName
\nservice.resourceRole
\nresource.eksClusterDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.namespace
\nresource.kubernetesDetails.kubernetesUserDetails.username
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
\nservice.ebsVolumeScanDetails.scanId
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
\nresource.ecsClusterDetails.name
\nresource.ecsClusterDetails.taskDetails.containers.image
\nresource.ecsClusterDetails.taskDetails.definitionArn
\nresource.containerDetails.image
\nresource.rdsDbInstanceDetails.dbInstanceIdentifier
\nresource.rdsDbInstanceDetails.dbClusterIdentifier
\nresource.rdsDbInstanceDetails.engine
\nresource.rdsDbUserDetails.user
\nresource.rdsDbInstanceDetails.tags.key
\nresource.rdsDbInstanceDetails.tags.value
\nservice.runtimeDetails.process.executableSha256
\nservice.runtimeDetails.process.name
\nservice.runtimeDetails.process.name
\nresource.lambdaDetails.functionName
\nresource.lambdaDetails.functionArn
\nresource.lambdaDetails.tags.key
\nresource.lambdaDetails.tags.value
\nRepresents the criteria to be used in the filter for querying findings.
\nYou can only use the following attributes to query findings:
\naccountId
\nid
\nregion
\nseverity
\nTo filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:
\n\n Low: [\"1\", \"2\", \"3\"]\n
\n Medium: [\"4\", \"5\", \"6\"]\n
\n High: [\"7\", \"8\", \"9\"]\n
For more information, see Severity\n levels for GuardDuty findings.
\ntype
\nupdatedAt
\nType: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.outpostArn
\nresource.resourceType
\nresource.s3BucketDetails.publicAccess.effectivePermissions
\nresource.s3BucketDetails.name
\nresource.s3BucketDetails.tags.key
\nresource.s3BucketDetails.tags.value
\nresource.s3BucketDetails.type
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.errorCode
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV6
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.dnsRequestAction.domainWithSuffix
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.remoteIpDetails.city.cityName
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV6
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.action.awsApiCallAction.remoteAccountDetails.affiliated
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6
\nservice.action.kubernetesApiCallAction.namespace
\nservice.action.kubernetesApiCallAction.remoteIpDetails.organization.asn
\nservice.action.kubernetesApiCallAction.requestUri
\nservice.action.kubernetesApiCallAction.statusCode
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV6
\nservice.action.networkConnectionAction.protocol
\nservice.action.awsApiCallAction.serviceName
\nservice.action.awsApiCallAction.remoteAccountDetails.accountId
\nservice.additionalInfo.threatListName
\nservice.resourceRole
\nresource.eksClusterDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.namespace
\nresource.kubernetesDetails.kubernetesUserDetails.username
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
\nservice.ebsVolumeScanDetails.scanId
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
\nresource.ecsClusterDetails.name
\nresource.ecsClusterDetails.taskDetails.containers.image
\nresource.ecsClusterDetails.taskDetails.definitionArn
\nresource.containerDetails.image
\nresource.rdsDbInstanceDetails.dbInstanceIdentifier
\nresource.rdsDbInstanceDetails.dbClusterIdentifier
\nresource.rdsDbInstanceDetails.engine
\nresource.rdsDbUserDetails.user
\nresource.rdsDbInstanceDetails.tags.key
\nresource.rdsDbInstanceDetails.tags.value
\nservice.runtimeDetails.process.executableSha256
\nservice.runtimeDetails.process.name
\nservice.runtimeDetails.process.name
\nresource.lambdaDetails.functionName
\nresource.lambdaDetails.functionArn
\nresource.lambdaDetails.tags.key
\nresource.lambdaDetails.tags.value
\nThe IPv4 local address of the connection.
", "smithy.api#jsonName": "ipAddressV4" } + }, + "IpAddressV6": { + "target": "com.amazonaws.guardduty#SensitiveString", + "traits": { + "smithy.api#documentation": "The IPv6 local address of the connection.
", + "smithy.api#jsonName": "ipAddressV6" + } } }, "traits": { @@ -11559,6 +11566,13 @@ "smithy.api#jsonName": "ipAddressV4" } }, + "IpAddressV6": { + "target": "com.amazonaws.guardduty#SensitiveString", + "traits": { + "smithy.api#documentation": "The IPv6 remote address of the connection.
", + "smithy.api#jsonName": "ipAddressV6" + } + }, "Organization": { "target": "com.amazonaws.guardduty#Organization", "traits": { diff --git a/codegen/sdk-codegen/aws-models/healthlake.2017-07-01.json b/codegen/sdk-codegen/aws-models/healthlake.2017-07-01.json index 3d52f0ee345..33db822d026 100644 --- a/codegen/sdk-codegen/aws-models/healthlake.2017-07-01.json +++ b/codegen/sdk-codegen/aws-models/healthlake.2017-07-01.json @@ -367,6 +367,12 @@ "traits": { "smithy.api#documentation": "The identity provider that you selected when you created the data store.
" } + }, + "ErrorCause": { + "target": "com.amazonaws.healthlake#ErrorCause", + "traits": { + "smithy.api#documentation": "The error cause for the current data store operation.
" + } } }, "traits": { @@ -405,6 +411,12 @@ "traits": { "smithy.api#enumValue": "DELETED" } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } } } }, @@ -683,6 +695,52 @@ "smithy.api#pattern": "^(arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))$" } }, + "com.amazonaws.healthlake#ErrorCategory": { + "type": "enum", + "members": { + "RETRYABLE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRYABLE_ERROR" + } + }, + "NON_RETRYABLE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_RETRYABLE_ERROR" + } + } + } + }, + "com.amazonaws.healthlake#ErrorCause": { + "type": "structure", + "members": { + "ErrorMessage": { + "target": "com.amazonaws.healthlake#ErrorMessage", + "traits": { + "smithy.api#documentation": "The text of the error message.
" + } + }, + "ErrorCategory": { + "target": "com.amazonaws.healthlake#ErrorCategory", + "traits": { + "smithy.api#documentation": "The error category of the create/delete data store operation. Possible statuses are RETRYABLE_ERROR or NON_RETRYABLE_ERROR.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The error info of the create/delete data store operation.
" + } + }, + "com.amazonaws.healthlake#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, "com.amazonaws.healthlake#ExportJobProperties": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/iam.2010-05-08.json b/codegen/sdk-codegen/aws-models/iam.2010-05-08.json index e03cef8bacd..b03777a8607 100644 --- a/codegen/sdk-codegen/aws-models/iam.2010-05-08.json +++ b/codegen/sdk-codegen/aws-models/iam.2010-05-08.json @@ -2954,7 +2954,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new instance profile. For information about instance profiles, see Using\n roles for applications on Amazon EC2 in the\n IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.
\nFor information about the number of instance profiles you can create, see IAM object\n quotas in the IAM User Guide.
", + "smithy.api#documentation": "Creates a new instance profile. For information about instance profiles, see Using\n roles for applications on Amazon EC2 in the\n IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.
\nFor information about the number of instance profiles you can create, see IAM object\n quotas in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To create an instance profile", @@ -3132,12 +3132,15 @@ { "target": "com.amazonaws.iam#LimitExceededException" }, + { + "target": "com.amazonaws.iam#OpenIdIdpCommunicationErrorException" + }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { - "smithy.api#documentation": "Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
\nThe OIDC provider that you create with this operation can be used as a principal in a\n role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and\n the OIDC provider.
\nIf you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't\n need to create a separate IAM identity provider. These OIDC identity providers are\n already built-in to Amazon Web Services and are available for your use. Instead, you can move directly\n to creating new roles using your identity provider. To learn more, see Creating\n a role for web identity or OpenID connect federation in the IAM\n User Guide.
\nWhen you create the IAM OIDC provider, you specify the following:
\nThe URL of the OIDC identity provider (IdP) to trust
\nA list of client IDs (also known as audiences) that identify the application\n or applications allowed to authenticate using the OIDC provider
\nA list of tags that are attached to the specified IAM OIDC provider
\nA list of thumbprints of one or more server certificates that the IdP\n uses
\nYou get all of this information from the OIDC IdP you want to use to access\n Amazon Web Services.
\nAmazon Web Services secures communication with some OIDC identity providers (IdPs) through our library\n of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to\n verify your IdP server certificate. In these cases, your legacy thumbprint remains in your\n configuration, but is no longer used for validation. These OIDC IdPs include Auth0, GitHub,\n GitLab, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS)\n endpoint.
\nThe trust for the OIDC provider is derived from the IAM provider that this\n operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged\n users.
\nCreates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
\nThe OIDC provider that you create with this operation can be used as a principal in a\n role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and\n the OIDC provider.
\nIf you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't\n need to create a separate IAM identity provider. These OIDC identity providers are\n already built-in to Amazon Web Services and are available for your use. Instead, you can move directly\n to creating new roles using your identity provider. To learn more, see Creating\n a role for web identity or OpenID connect federation in the IAM\n User Guide.
\nWhen you create the IAM OIDC provider, you specify the following:
\nThe URL of the OIDC identity provider (IdP) to trust
\nA list of client IDs (also known as audiences) that identify the application\n or applications allowed to authenticate using the OIDC provider
\nA list of tags that are attached to the specified IAM OIDC provider
\nA list of thumbprints of one or more server certificates that the IdP\n uses
\nYou get all of this information from the OIDC IdP you want to use to access\n Amazon Web Services.
\nAmazon Web Services secures communication with some OIDC identity providers (IdPs) through our library\n of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to\n verify your IdP server certificate. In these cases, your legacy thumbprint remains in your\n configuration, but is no longer used for validation. These OIDC IdPs include Auth0, GitHub,\n GitLab, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS)\n endpoint.
\nThe trust for the OIDC provider is derived from the IAM provider that this\n operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged\n users.
\nA list of server certificate thumbprints for the OpenID Connect (OIDC) identity\n provider's server certificates. Typically this list includes only one entry. However,\n IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain\n multiple thumbprints if the identity provider is rotating certificates.
\nThe server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509\n certificate used by the domain where the OpenID Connect provider makes its keys\n available. It is always a 40-character string.
\nYou must provide at least one thumbprint when creating an IAM OIDC provider. For\n example, assume that the OIDC provider is server.example.com and the\n provider stores its keys at https://keys.server.example.com/openid-connect. In that\n case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate\n used by https://keys.server.example.com.\n
For more information about obtaining the OIDC provider thumbprint, see Obtaining the\n thumbprint for an OpenID Connect provider in the IAM user\n Guide.
", - "smithy.api#required": {} + "smithy.api#documentation": "A list of server certificate thumbprints for the OpenID Connect (OIDC) identity\n provider's server certificates. Typically this list includes only one entry. However,\n IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain\n multiple thumbprints if the identity provider is rotating certificates.
\nThis parameter is optional. If it is not included, IAM will retrieve and use the top\n intermediate certificate authority (CA) thumbprint of the OpenID Connect identity\n provider server certificate.
\nThe server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509\n certificate used by the domain where the OpenID Connect provider makes its keys\n available. It is always a 40-character string.
\nFor example, assume that the OIDC provider is server.example.com and the\n provider stores its keys at https://keys.server.example.com/openid-connect. In that\n case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate\n used by https://keys.server.example.com.\n
For more information about obtaining the OIDC provider thumbprint, see Obtaining the\n thumbprint for an OpenID Connect provider in the IAM user\n Guide.
" } }, "Tags": { @@ -4478,7 +4480,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role\n programmatically, you must delete the items attached to the role manually, or the\n deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the\n following attached items:
\nInline policies (DeleteRolePolicy)
\nAttached managed policies (DetachRolePolicy)
\nInstance profile (RemoveRoleFromInstanceProfile)
\nOptional – Delete instance profile after detaching from role for\n resource clean up (DeleteInstanceProfile)
\nMake sure that you do not have any Amazon EC2 instances running with the role you\n are about to delete. Deleting a role or instance profile that is associated with a\n running instance will break any applications running on the instance.
\nDeletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role\n programmatically, you must delete the items attached to the role manually, or the\n deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the\n following attached items:
\nInline policies (DeleteRolePolicy)
\nAttached managed policies (DetachRolePolicy)
\nInstance profile (RemoveRoleFromInstanceProfile)
\nOptional – Delete instance profile after detaching from role for\n resource clean up (DeleteInstanceProfile)
\nMake sure that you do not have any Amazon EC2 instances running with the role you are\n about to delete. Deleting a role or instance profile that is associated with a\n running instance will break any applications running on the instance.
\nThe request failed because IAM cannot connect to the OpenID Connect identity provider URL.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.iam#OrganizationsDecisionDetail": { "type": "structure", "members": { @@ -12199,7 +12218,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified IAM role from the specified EC2 instance profile.
\nMake sure that you do not have any Amazon EC2 instances running with the role you\n are about to remove from the instance profile. Removing a role from an instance\n profile that is associated with a running instance might break any applications\n running on the instance.
\nFor more information about roles, see IAM roles in the\n IAM User Guide. For more information about instance profiles,\n see Using\n instance profiles in the IAM User Guide.
", + "smithy.api#documentation": "Removes the specified IAM role from the specified Amazon EC2 instance profile.
\nMake sure that you do not have any Amazon EC2 instances running with the role you are\n about to remove from the instance profile. Removing a role from an instance profile\n that is associated with a running instance might break any applications running on\n the instance.
\nFor more information about roles, see IAM roles in the\n IAM User Guide. For more information about instance profiles,\n see Using\n instance profiles in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To remove a role from an instance profile", @@ -13383,7 +13402,7 @@ "ResourceHandlingOption": { "target": "com.amazonaws.iam#ResourceHandlingOptionType", "traits": { - "smithy.api#documentation": "Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.
\nEach of the EC2 scenarios requires that you specify instance, image, and security\n group resources. If your scenario includes an EBS volume, then you must specify that\n volume as a resource. If the EC2 scenario includes VPC, then you must supply the network\n interface resource. If it includes an IP subnet, then you must specify the subnet\n resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User\n Guide.
\n\n EC2-VPC-InstanceStore\n
\ninstance, image, security group, network interface
\n\n EC2-VPC-InstanceStore-Subnet\n
\ninstance, image, security group, network interface, subnet
\n\n EC2-VPC-EBS\n
\ninstance, image, security group, network interface, volume
\n\n EC2-VPC-EBS-Subnet\n
\ninstance, image, security group, network interface, subnet, volume
\nSpecifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.
\nEach of the Amazon EC2 scenarios requires that you specify instance, image, and security\n group resources. If your scenario includes an EBS volume, then you must specify that\n volume as a resource. If the Amazon EC2 scenario includes VPC, then you must supply the\n network interface resource. If it includes an IP subnet, then you must specify the\n subnet resource. For more information on the Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.
\n\n EC2-VPC-InstanceStore\n
\ninstance, image, security group, network interface
\n\n EC2-VPC-InstanceStore-Subnet\n
\ninstance, image, security group, network interface, subnet
\n\n EC2-VPC-EBS\n
\ninstance, image, security group, network interface, volume
\n\n EC2-VPC-EBS-Subnet\n
\ninstance, image, security group, network interface, subnet, volume
\nSpecifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.
\nEach of the EC2 scenarios requires that you specify instance, image, and security\n group resources. If your scenario includes an EBS volume, then you must specify that\n volume as a resource. If the EC2 scenario includes VPC, then you must supply the network\n interface resource. If it includes an IP subnet, then you must specify the subnet\n resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User\n Guide.
\n\n EC2-VPC-InstanceStore\n
\ninstance, image, security group, network interface
\n\n EC2-VPC-InstanceStore-Subnet\n
\ninstance, image, security group, network interface, subnet
\n\n EC2-VPC-EBS\n
\ninstance, image, security group, network interface, volume
\n\n EC2-VPC-EBS-Subnet\n
\ninstance, image, security group, network interface, subnet, volume
\nSpecifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.
\nEach of the Amazon EC2 scenarios requires that you specify instance, image, and security\n group resources. If your scenario includes an EBS volume, then you must specify that\n volume as a resource. If the Amazon EC2 scenario includes VPC, then you must supply the\n network interface resource. If it includes an IP subnet, then you must specify the\n subnet resource. For more information on the Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.
\n\n EC2-VPC-InstanceStore\n
\ninstance, image, security group, network interface
\n\n EC2-VPC-InstanceStore-Subnet\n
\ninstance, image, security group, network interface, subnet
\n\n EC2-VPC-EBS\n
\ninstance, image, security group, network interface, volume
\n\n EC2-VPC-EBS-Subnet\n
\ninstance, image, security group, network interface, subnet, volume
\nReplaces the existing list of server certificate thumbprints associated with an OpenID\n Connect (OIDC) provider resource object with a new list of thumbprints.
\nThe list that you pass with this operation completely replaces the existing list of\n thumbprints. (The lists are not merged.)
\nTypically, you need to update a thumbprint only when the identity provider certificate\n changes, which occurs rarely. However, if the provider's certificate\n does change, any attempt to assume an IAM role that specifies\n the OIDC provider as a principal fails until the certificate thumbprint is\n updated.
\nAmazon Web Services secures communication with some OIDC identity providers (IdPs) through our library\n of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to\n verify your IdP server certificate. In these cases, your legacy thumbprint remains in your\n configuration, but is no longer used for validation. These OIDC IdPs include Auth0, GitHub,\n GitLab, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS)\n endpoint.
\nTrust for the OIDC provider is derived from the provider certificate and is\n validated by the thumbprint. Therefore, it is best to limit access to the\n UpdateOpenIDConnectProviderThumbprint operation to highly\n privileged users.
Replaces the existing list of server certificate thumbprints associated with an OpenID\n Connect (OIDC) provider resource object with a new list of thumbprints.
\nThe list that you pass with this operation completely replaces the existing list of\n thumbprints. (The lists are not merged.)
\nTypically, you need to update a thumbprint only when the identity provider certificate\n changes, which occurs rarely. However, if the provider's certificate\n does change, any attempt to assume an IAM role that specifies\n the OIDC provider as a principal fails until the certificate thumbprint is\n updated.
\nAmazon Web Services secures communication with some OIDC identity providers (IdPs) through our library\n of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to\n verify your IdP server certificate. In these cases, your legacy thumbprint remains in your\n configuration, but is no longer used for validation. These OIDC IdPs include Auth0, GitHub,\n GitLab, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS)\n endpoint.
\nTrust for the OIDC provider is derived from the provider certificate and is\n validated by the thumbprint. Therefore, it is best to limit access to the\n UpdateOpenIDConnectProviderThumbprint operation to highly\n privileged users.
The maximum session duration (in seconds) that you want to set for the specified role.\n If you do not specify a value for this setting, the default value of one hour is\n applied. This setting can have a value from 1 hour to 12 hours.
\nAnyone who assumes the role from the CLI or API can use the\n DurationSeconds API parameter or the duration-seconds\n CLI parameter to request a longer session. The MaxSessionDuration setting\n determines the maximum duration that can be requested using the\n DurationSeconds parameter. If users don't specify a value for the\n DurationSeconds parameter, their security credentials are valid for one\n hour by default. This applies when you use the AssumeRole* API operations\n or the assume-role* CLI operations but does not apply when you use those\n operations to create a console URL. For more information, see Using IAM\n roles in the IAM User Guide.
The maximum session duration (in seconds) that you want to set for the specified role.\n If you do not specify a value for this setting, the default value of one hour is\n applied. This setting can have a value from 1 hour to 12 hours.
\nAnyone who assumes the role from the CLI or API can use the\n DurationSeconds API parameter or the duration-seconds\n CLI parameter to request a longer session. The MaxSessionDuration setting\n determines the maximum duration that can be requested using the\n DurationSeconds parameter. If users don't specify a value for the\n DurationSeconds parameter, their security credentials are valid for one\n hour by default. This applies when you use the AssumeRole* API operations\n or the assume-role* CLI operations but does not apply when you use those\n operations to create a console URL. For more information, see Using IAM\n roles in the IAM User Guide.
IAM role credentials provided by Amazon EC2 instances assigned to the role are not\n subject to the specified maximum session duration.
\nThe name of the internet service provider (ISP) or network (ASN).
", + "smithy.api#required": {} + } + }, + "ASNumber": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The Autonomous System Number (ASN) of the network at an impacted location.
", + "smithy.api#required": {} + } + }, + "Country": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the country where the internet event is located.
", + "smithy.api#required": {} + } + }, + "Subdivision": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The subdivision location where the health event is located. The subdivision usually maps to states in most countries \n\t\t\t(including the United States). For United Kingdom, it maps to a country (England, Scotland, Wales) or province (Northern Ireland).
" + } + }, + "Metro": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The metro area where the health event is located.
\nMetro indicates a metropolitan region in the United States, such as the region around New York City. In non-US countries, \n\t\t\tthis is a second-level subdivision. For example, in the United Kingdom, it could be a county, a London borough, a unitary \n\t\t\tauthority, council area, and so on.
" + } + }, + "City": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the city where the internet event is located.
", + "smithy.api#required": {} + } + }, + "Latitude": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The latitude where the internet event is located.
", + "smithy.api#required": {} + } + }, + "Longitude": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The longitude where the internet event is located.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The impacted location, such as a city, that Amazon Web Services clients access application resources from.
" + } + }, "com.amazonaws.internetmonitor#ConflictException": { "type": "structure", "members": { @@ -321,7 +383,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations,\n\t\t\tand all the information related to the event, by location.
\nThe information returned includes the impact on performance, availability, and round-trip time, information about the network providers (ASNs),\n\t\t\tthe event type, and so on.
\nInformation rolled up at the global traffic level is also returned, including the impact type and total traffic impact.
", + "smithy.api#documentation": "Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations,\n\t\t\tand all the information related to the event, by location.
\nThe information returned includes the impact on performance, availability, and round-trip time, information about the network providers (ASNs),\n\t\t\tthe event type, and so on.
\nInformation rolled up at the global traffic level is also returned, including the impact type and total traffic impact.
", "smithy.api#http": { "uri": "/v20210603/Monitors/{MonitorName}/HealthEvents/{EventId}", "method": "GET" @@ -351,7 +413,7 @@ "LinkedAccountId": { "target": "com.amazonaws.internetmonitor#AccountId", "traits": { - "smithy.api#documentation": "TBD
", + "smithy.api#documentation": "The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account\n\t\t\tsharing by using Amazon CloudWatch Observability Access Manager. For more information, see \n\t\t\tInternet Monitor cross-account\n\t\t\tobservability in the Amazon CloudWatch Internet Monitor User Guide.
", "smithy.api#httpQuery": "LinkedAccountId" } } @@ -440,6 +502,111 @@ } } }, + "com.amazonaws.internetmonitor#GetInternetEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#GetInternetEventInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#GetInternetEventOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event. Internet Monitor displays information about \n\t\t\trecent global health events, called internet events, on a global outages map that is available to all Amazon Web Services\n\t\t\tcustomers.
\nThe information returned here includes the impacted location,\n\t\t\twhen the event started and (if the event is over) ended, the type of event (PERFORMANCE or AVAILABILITY),\n\t\t\tand the status (ACTIVE or RESOLVED).
The EventId of the internet event to return information for.
The internally-generated identifier of an internet event.
", + "smithy.api#required": {} + } + }, + "EventArn": { + "target": "com.amazonaws.internetmonitor#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the internet event.
", + "smithy.api#required": {} + } + }, + "StartedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the internet event started.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "EndedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the internet event ended. If the event hasn't ended yet, this value is empty.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "ClientLocation": { + "target": "com.amazonaws.internetmonitor#ClientLocation", + "traits": { + "smithy.api#documentation": "The impacted location, such as a city, where clients access Amazon Web Services application resources.
", + "smithy.api#required": {} + } + }, + "EventType": { + "target": "com.amazonaws.internetmonitor#InternetEventType", + "traits": { + "smithy.api#documentation": "The type of network impairment.
", + "smithy.api#required": {} + } + }, + "EventStatus": { + "target": "com.amazonaws.internetmonitor#InternetEventStatus", + "traits": { + "smithy.api#documentation": "The status of the internet event.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.internetmonitor#GetMonitor": { "type": "operation", "input": { @@ -485,7 +652,7 @@ "LinkedAccountId": { "target": "com.amazonaws.internetmonitor#AccountId", "traits": { - "smithy.api#documentation": "TBD
", + "smithy.api#documentation": "The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account\n\t\t\tsharing by using Amazon CloudWatch Observability Access Manager. For more information, see \n\t\t\tInternet Monitor cross-account\n\t\t\t\tobservability in the Amazon CloudWatch Internet Monitor User Guide.
", "smithy.api#httpQuery": "LinkedAccountId" } } @@ -823,7 +990,7 @@ "Status": { "target": "com.amazonaws.internetmonitor#HealthEventStatus", "traits": { - "smithy.api#documentation": "Health event list member.
", + "smithy.api#documentation": "The status of a health event.
", "smithy.api#required": {} } }, @@ -969,7 +1136,7 @@ "ASName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the network at an impacted location.
", + "smithy.api#documentation": "The name of the internet service provider (ISP) or network (ASN).
", "smithy.api#required": {} } }, @@ -1099,6 +1266,142 @@ "smithy.api#retryable": {} } }, + "com.amazonaws.internetmonitor#InternetEventId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.internetmonitor#InternetEventMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.internetmonitor#InternetEventResource": { + "type": "resource", + "identifiers": { + "EventId": { + "target": "com.amazonaws.internetmonitor#InternetEventId" + } + }, + "read": { + "target": "com.amazonaws.internetmonitor#GetInternetEvent" + }, + "list": { + "target": "com.amazonaws.internetmonitor#ListInternetEvents" + }, + "traits": { + "aws.api#arn": { + "template": "internet-event/{EventId}", + "noRegion": true, + "noAccount": false + }, + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "Represents an internet event for a specific city+AS location" + } + }, + "com.amazonaws.internetmonitor#InternetEventStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACTIVE", + "value": "ACTIVE" + }, + { + "name": "RESOLVED", + "value": "RESOLVED" + } + ] + } + }, + "com.amazonaws.internetmonitor#InternetEventSummary": { + "type": "structure", + "members": { + "EventId": { + "target": "com.amazonaws.internetmonitor#InternetEventId", + "traits": { + "smithy.api#documentation": "The internally-generated identifier of an internet event.
", + "smithy.api#required": {} + } + }, + "EventArn": { + "target": "com.amazonaws.internetmonitor#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the internet event.
", + "smithy.api#required": {} + } + }, + "StartedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when an internet event started.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "EndedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when an internet event ended. If the event hasn't ended yet, this value\n\t\tis empty.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "ClientLocation": { + "target": "com.amazonaws.internetmonitor#ClientLocation", + "traits": { + "smithy.api#documentation": "The impacted location, such as a city, that Amazon Web Services clients access application resources from.
", + "smithy.api#required": {} + } + }, + "EventType": { + "target": "com.amazonaws.internetmonitor#InternetEventType", + "traits": { + "smithy.api#documentation": "The type of network impairment.
", + "smithy.api#required": {} + } + }, + "EventStatus": { + "target": "com.amazonaws.internetmonitor#InternetEventStatus", + "traits": { + "smithy.api#documentation": "The status of an internet event.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of information about an internet event in Amazon CloudWatch Internet Monitor. Internet events are issues that cause performance degradation\n\t\t\tor availability problems for impacted Amazon Web Services client locations. Internet Monitor displays information about \n\t\t\trecent global health events, called internet events, on a global outages map that is available to all Amazon Web Services\n\t\t\tcustomers.
" + } + }, + "com.amazonaws.internetmonitor#InternetEventType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AVAILABILITY", + "name": "AVAILABILITY" + }, + { + "value": "PERFORMANCE", + "name": "PERFORMANCE" + } + ] + } + }, + "com.amazonaws.internetmonitor#InternetEventsList": { + "type": "list", + "member": { + "target": "com.amazonaws.internetmonitor#InternetEventSummary" + } + }, "com.amazonaws.internetmonitor#InternetHealth": { "type": "structure", "members": { @@ -1148,6 +1451,9 @@ } ], "resources": [ + { + "target": "com.amazonaws.internetmonitor#InternetEventResource" + }, { "target": "com.amazonaws.internetmonitor#MonitorResource" } @@ -1866,7 +2172,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end time and \n\t\t\tthe status.
\nHealth events that have start times during the time frame that is requested are not included in the list of health events.
\nLists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end times, and \n\t\t\tthe status.
\nHealth events that have start times during the time frame that is requested are not included in the list of health events.
\nTBD
", + "smithy.api#documentation": "The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account\n\t\t\tsharing by using Amazon CloudWatch Observability Access Manager. For more information, see \n\t\t\tInternet Monitor cross-account\n\t\t\t\tobservability in the Amazon CloudWatch Internet Monitor User Guide.
", "smithy.api#httpQuery": "LinkedAccountId" } } @@ -1955,6 +2261,116 @@ } } }, + "com.amazonaws.internetmonitor#ListInternetEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#ListInternetEventsInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#ListInternetEventsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about \n\t\t\trecent global health events, called internet events, on a global outages map that is available to all Amazon Web Services\n\t\t\tcustomers.
\nYou can constrain the list of internet events returned by providing a start time and end time to define a total \n\t\t\ttime frame for events you want to list. Both start time and end time specify the time when an event started. End time\n\t\t\tis optional. If you don't include it, the default end time is the current time.
\nYou can also limit the events returned to a specific status\n\t\t\t(ACTIVE or RESOLVED) or type (PERFORMANCE or AVAILABILITY).
The token for the next set of results. You receive this token from a previous call.
", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.internetmonitor#InternetEventMaxResults", + "traits": { + "smithy.api#documentation": "The number of query results that you want to return with this call.
", + "smithy.api#httpQuery": "InternetEventMaxResults" + } + }, + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the time window that you want to get a list of internet events for.
", + "smithy.api#httpQuery": "StartTime", + "smithy.api#timestampFormat": "date-time" + } + }, + "EndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the time window that you want to get a list of internet events for.
", + "smithy.api#httpQuery": "EndTime", + "smithy.api#timestampFormat": "date-time" + } + }, + "EventStatus": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The status of an internet event.
", + "smithy.api#httpQuery": "EventStatus" + } + }, + "EventType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of network impairment.
", + "smithy.api#httpQuery": "EventType" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.internetmonitor#ListInternetEventsOutput": { + "type": "structure", + "members": { + "InternetEvents": { + "target": "com.amazonaws.internetmonitor#InternetEventsList", + "traits": { + "smithy.api#documentation": "A set of internet events returned for the list operation.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.internetmonitor#ListMonitors": { "type": "operation", "input": { @@ -2019,7 +2435,7 @@ "IncludeLinkedAccounts": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "TBD
", + "smithy.api#documentation": "A boolean option that you can set to TRUE to include monitors for linked accounts in a list of\n\t\t\tmonitors, when you've set up cross-account sharing in Amazon CloudWatch Internet Monitor. You configure cross-account\n\t\t\tsharing by using Amazon CloudWatch Observability Access Manager. For more information, see \n\t\t\tInternet Monitor cross-account\n\t\t\t\tobservability in the Amazon CloudWatch Internet Monitor User Guide.
The internet provider name or network name.
", + "smithy.api#documentation": "The name of the internet service provider (ISP) or network (ASN).
", "smithy.api#required": {} } }, @@ -2371,7 +2787,7 @@ } }, "traits": { - "smithy.api#documentation": "An internet service provider (ISP) or network in Amazon CloudWatch Internet Monitor.
" + "smithy.api#documentation": "An internet service provider (ISP) or network (ASN) in Amazon CloudWatch Internet Monitor.
" } }, "com.amazonaws.internetmonitor#NetworkImpairment": { @@ -2394,7 +2810,7 @@ "NetworkEventType": { "target": "com.amazonaws.internetmonitor#TriangulationEventType", "traits": { - "smithy.api#documentation": "Type of network impairment.
", + "smithy.api#documentation": "The type of network impairment.
", "smithy.api#required": {} } } @@ -2733,7 +3149,7 @@ "LinkedAccountId": { "target": "com.amazonaws.internetmonitor#AccountId", "traits": { - "smithy.api#documentation": "TBD
" + "smithy.api#documentation": "The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account\n\t\t\tsharing by using Amazon CloudWatch Observability Access Manager. For more information, see \n\t\t\tInternet Monitor cross-account\n\t\t\t\tobservability in the Amazon CloudWatch Internet Monitor User Guide.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/iot-wireless.2020-11-22.json b/codegen/sdk-codegen/aws-models/iot-wireless.2020-11-22.json index 3cdccfe1959..e703a56407c 100644 --- a/codegen/sdk-codegen/aws-models/iot-wireless.2020-11-22.json +++ b/codegen/sdk-codegen/aws-models/iot-wireless.2020-11-22.json @@ -328,7 +328,7 @@ "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", + "smithy.api#documentation": "Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
", "smithy.api#idempotencyToken": {} } }, @@ -1231,7 +1231,7 @@ "com.amazonaws.iotwireless#ClientRequestToken": { "type": "string", "traits": { - "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client\n request.
", + "smithy.api#documentation": "Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
", "smithy.api#length": { "min": 1, "max": 64 @@ -1410,7 +1410,7 @@ "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", + "smithy.api#documentation": "Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
", "smithy.api#idempotencyToken": {} } } @@ -1497,7 +1497,7 @@ "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", + "smithy.api#documentation": "Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
", "smithy.api#idempotencyToken": {} } }, @@ -1682,7 +1682,7 @@ "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", + "smithy.api#documentation": "Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
", "smithy.api#idempotencyToken": {} } }, @@ -1873,7 +1873,7 @@ "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", + "smithy.api#documentation": "Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
", "smithy.api#idempotencyToken": {} } } @@ -1971,7 +1971,7 @@ "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", + "smithy.api#documentation": "Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
", "smithy.api#idempotencyToken": {} } }, @@ -2050,7 +2050,7 @@ } ], "traits": { - "smithy.api#documentation": "Provisions a wireless gateway.
", + "smithy.api#documentation": "Provisions a wireless gateway.
\nWhen provisioning a wireless gateway, you might run into duplication errors\n for the following reasons.
\nIf you specify a GatewayEui value that already exists.
If you used a ClientRequestToken with the same parameters \n within the last 10 minutes.
To avoid this error, make sure that you use unique identifiers and parameters\n for each request within the specified time period.
\nEach resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", + "smithy.api#documentation": "Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
", "smithy.api#idempotencyToken": {} } } @@ -2218,7 +2218,7 @@ "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", + "smithy.api#documentation": "Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
", "smithy.api#idempotencyToken": {} } }, @@ -2934,7 +2934,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a wireless gateway.
", + "smithy.api#documentation": "Deletes a wireless gateway.
\nWhen deleting a wireless gateway, you might run into duplication errors\n for the following reasons.
\nIf you specify a GatewayEui value that already exists.
If you used a ClientRequestToken with the same parameters \n within the last 10 minutes.
To avoid this error, make sure that you use unique identifiers and parameters\n for each request within the specified time period.
\nGet the metric configuration status for this account.
", + "smithy.api#documentation": "Get the metric configuration status for this AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/metric-configuration", @@ -5096,7 +5099,7 @@ "SummaryMetric": { "target": "com.amazonaws.iotwireless#SummaryMetricConfiguration", "traits": { - "smithy.api#documentation": "The account's configuration status for summary metric aggregation.
" + "smithy.api#documentation": "The configuration status of the AWS account for summary metric aggregation.
" } } }, @@ -5133,7 +5136,7 @@ } ], "traits": { - "smithy.api#documentation": "Get metrics.
", + "smithy.api#documentation": "Get the summary metrics for this AWS account.
", "smithy.api#http": { "method": "POST", "uri": "/metrics", @@ -5147,7 +5150,7 @@ "SummaryMetricQueries": { "target": "com.amazonaws.iotwireless#SummaryMetricQueries", "traits": { - "smithy.api#documentation": "The list of queries to retrieve summary metrics.
" + "smithy.api#documentation": "The list of queries to retrieve the summary metrics.
" } } }, @@ -5161,7 +5164,7 @@ "SummaryMetricQueryResults": { "target": "com.amazonaws.iotwireless#SummaryMetricQueryResults", "traits": { - "smithy.api#documentation": "The list of retrieved metrics.
" + "smithy.api#documentation": "The list of summary metrics that were retrieved.
" } } }, @@ -7235,6 +7238,15 @@ "smithy.api#pattern": "^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$" } }, + "com.amazonaws.iotwireless#Id": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.iotwireless#Identifier": { "type": "string", "traits": { @@ -9058,6 +9070,12 @@ "traits": { "smithy.api#documentation": "Information about the gateways accessed by the device.
" } + }, + "PublicGateways": { + "target": "com.amazonaws.iotwireless#LoRaWANPublicGatewayMetadataList", + "traits": { + "smithy.api#documentation": "Information about the LoRaWAN public network accessed by the device.
" + } } }, "traits": { @@ -9572,6 +9590,53 @@ "smithy.api#documentation": "The LoRaWAN information used with the multicast session.
" } }, + "com.amazonaws.iotwireless#LoRaWANPublicGatewayMetadata": { + "type": "structure", + "members": { + "ProviderNetId": { + "target": "com.amazonaws.iotwireless#ProviderNetId", + "traits": { + "smithy.api#documentation": "The ID of the LoRaWAN public network provider.
" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#Id", + "traits": { + "smithy.api#documentation": "The ID of the gateways that are operated by the network provider.
" + } + }, + "Rssi": { + "target": "com.amazonaws.iotwireless#Double", + "traits": { + "smithy.api#documentation": "The RSSI (received signal strength indicator) value.
" + } + }, + "Snr": { + "target": "com.amazonaws.iotwireless#Double", + "traits": { + "smithy.api#documentation": "The SNR (signal to noise ratio) value.
" + } + }, + "RfRegion": { + "target": "com.amazonaws.iotwireless#RfRegion" + }, + "DlAllowed": { + "target": "com.amazonaws.iotwireless#DlAllowed", + "traits": { + "smithy.api#documentation": "Boolean that indicates whether downlink is allowed using the network.
" + } + } + }, + "traits": { + "smithy.api#documentation": "LoRaWAN public gateway metadata.
" + } + }, + "com.amazonaws.iotwireless#LoRaWANPublicGatewayMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#LoRaWANPublicGatewayMetadata" + } + }, "com.amazonaws.iotwireless#LoRaWANSendDataToDevice": { "type": "structure", "members": { @@ -10326,37 +10391,37 @@ "Min": { "target": "com.amazonaws.iotwireless#Min", "traits": { - "smithy.api#documentation": "The minimum of the values of the all data points collected during the period.
" + "smithy.api#documentation": "The minimum of the values of all data points collected during the aggregation\n period.
" } }, "Max": { "target": "com.amazonaws.iotwireless#Max", "traits": { - "smithy.api#documentation": "The maximum of the values of the all data points collected during the period.
" + "smithy.api#documentation": "The maximum of the values of all the data points collected during the aggregation\n period.
" } }, "Sum": { "target": "com.amazonaws.iotwireless#Sum", "traits": { - "smithy.api#documentation": "The sum of the values of the all data points collected during the period.
" + "smithy.api#documentation": "The sum of the values of all data points collected during the aggregation\n period.
" } }, "Avg": { "target": "com.amazonaws.iotwireless#Avg", "traits": { - "smithy.api#documentation": "The average of the values of the all data points collected during the period.
" + "smithy.api#documentation": "The average of the values of all data points collected during the aggregation\n period.
" } }, "Std": { "target": "com.amazonaws.iotwireless#Std", "traits": { - "smithy.api#documentation": "The standard deviation of the values of the all data points collected during the period.
" + "smithy.api#documentation": "The standard deviation of the values of all data points collected during the\n aggregation period.
" } }, "P90": { "target": "com.amazonaws.iotwireless#P90", "traits": { - "smithy.api#documentation": "The 90th percentile of the values of the all data points collected during the period.
" + "smithy.api#documentation": "The 90th percentile of the values of all data points collected during the aggregation\n period.
" } } }, @@ -10426,7 +10491,7 @@ } }, "traits": { - "smithy.api#documentation": "\n FrameInfo of your multicast group resources for the trace content. Use\n FrameInfo to debug the multicast communication between your multicast groups and the network server.
\n FrameInfo of your multicast group resources for the trace content. Use\n FrameInfo to debug the multicast communication between your multicast groups and the\n network server.
The AppEUI value. You specify this value when using LoRaWAN versions v1.0.2 or v1.0.3.
" + "smithy.api#documentation": "The AppEUI value. You specify this value when using LoRaWAN versions v1.0.2 or\n v1.0.3.
" } }, "JoinEui": { "target": "com.amazonaws.iotwireless#JoinEui", "traits": { - "smithy.api#documentation": "The JoinEUI value. You specify this value instead of the AppEUI when using LoRaWAN \n version v1.0.4.
" + "smithy.api#documentation": "The JoinEUI value. You specify this value instead of the AppEUI when using LoRaWAN\n version v1.0.4.
" } }, "GenAppKey": { @@ -11126,6 +11191,15 @@ "target": "com.amazonaws.iotwireless#CertificateList" } }, + "com.amazonaws.iotwireless#ProviderNetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.iotwireless#ProximityEventConfiguration": { "type": "structure", "members": { @@ -12879,12 +12953,12 @@ "Status": { "target": "com.amazonaws.iotwireless#SummaryMetricConfigurationStatus", "traits": { - "smithy.api#documentation": "The configuration of summary metric.
" + "smithy.api#documentation": "The status of the configuration of summary metrics.
" } } }, "traits": { - "smithy.api#documentation": "The configuration of summary metric.
" + "smithy.api#documentation": "The configuration of summary metrics.
" } }, "com.amazonaws.iotwireless#SummaryMetricConfigurationStatus": { @@ -12916,7 +12990,7 @@ "QueryId": { "target": "com.amazonaws.iotwireless#MetricQueryId", "traits": { - "smithy.api#documentation": "The id of the query.
" + "smithy.api#documentation": "The id of the summary metric query.
" } }, "MetricName": { @@ -12928,30 +13002,30 @@ "Dimensions": { "target": "com.amazonaws.iotwireless#Dimensions", "traits": { - "smithy.api#documentation": "The dimensions of the metric.
" + "smithy.api#documentation": "The dimensions of the summary metric.
" } }, "AggregationPeriod": { "target": "com.amazonaws.iotwireless#AggregationPeriod", "traits": { - "smithy.api#documentation": "The aggregation period of the metric.
" + "smithy.api#documentation": "The aggregation period of the summary metric.
" } }, "StartTimestamp": { "target": "com.amazonaws.iotwireless#MetricQueryStartTimestamp", "traits": { - "smithy.api#documentation": "The start timestamp for summary metric query.
" + "smithy.api#documentation": "The start timestamp for the summary metric query.
" } }, "EndTimestamp": { "target": "com.amazonaws.iotwireless#MetricQueryEndTimestamp", "traits": { - "smithy.api#documentation": "The end timestamp for summary metric query.
" + "smithy.api#documentation": "The end timestamp for the summary metric query.
" } } }, "traits": { - "smithy.api#documentation": "The metric query object.
" + "smithy.api#documentation": "The summary metric query object.
" } }, "com.amazonaws.iotwireless#SummaryMetricQueryResult": { @@ -12960,25 +13034,25 @@ "QueryId": { "target": "com.amazonaws.iotwireless#MetricQueryId", "traits": { - "smithy.api#documentation": "The id of the query.
" + "smithy.api#documentation": "The ID of the summary metric results query operation.
" } }, "QueryStatus": { "target": "com.amazonaws.iotwireless#MetricQueryStatus", "traits": { - "smithy.api#documentation": "The status of the metric query.
" + "smithy.api#documentation": "The status of the summary metric query result.
" } }, "Error": { "target": "com.amazonaws.iotwireless#MetricQueryError", "traits": { - "smithy.api#documentation": "The error message for the summary metric query.
" + "smithy.api#documentation": "The error message for the summary metric query result.
" } }, "MetricName": { "target": "com.amazonaws.iotwireless#MetricName", "traits": { - "smithy.api#documentation": "The name of the metric.
" + "smithy.api#documentation": "The name of the summary metric query result.
" } }, "Dimensions": { @@ -12996,13 +13070,13 @@ "StartTimestamp": { "target": "com.amazonaws.iotwireless#MetricQueryStartTimestamp", "traits": { - "smithy.api#documentation": "The start timestamp for summary metric query.
" + "smithy.api#documentation": "The start timestamp for the summary metric query.
" } }, "EndTimestamp": { "target": "com.amazonaws.iotwireless#MetricQueryEndTimestamp", "traits": { - "smithy.api#documentation": "The end timestamp for summary metric query.
" + "smithy.api#documentation": "The end timestamp for the summary metric query.
" } }, "Timestamps": { @@ -13014,7 +13088,7 @@ "Values": { "target": "com.amazonaws.iotwireless#MetricQueryValues", "traits": { - "smithy.api#documentation": "The list of aggregated metrics.
" + "smithy.api#documentation": "The list of aggregated summary metric query results.
" } }, "Unit": { @@ -13025,7 +13099,7 @@ } }, "traits": { - "smithy.api#documentation": "The result of metrics aggregation operation.
" + "smithy.api#documentation": "The result of the summary metrics aggregation operation.
" } }, "com.amazonaws.iotwireless#SummaryMetricQueryResults": { @@ -14092,7 +14166,7 @@ } ], "traits": { - "smithy.api#documentation": "Update the metric configuration.
", + "smithy.api#documentation": "Update the summary metric configuration.
", "smithy.api#http": { "method": "PUT", "uri": "/metric-configuration", @@ -14267,13 +14341,13 @@ "MulticastGroupsToAdd": { "target": "com.amazonaws.iotwireless#NetworkAnalyzerMulticastGroupList", "traits": { - "smithy.api#documentation": "Multicast group resources to add to the network analyzer configuration. Provide the\n MulticastGroupId of the resource to add in the input array.
Multicast group resources to add to the network analyzer configuration. Provide the\n MulticastGroupId of the resource to add in the input array.
Multicast group resources to remove from the network analyzer configuration. Provide the\n MulticastGroupId of the resources to remove in the input array.
Multicast group resources to remove from the network analyzer configuration. Provide\n the MulticastGroupId of the resources to remove in the input array.
With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.
\nFleet Hub for AWS IoT Device Management is in public preview and is subject to change.
\nWith Fleet Hub for IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.
", "smithy.api#title": "AWS IoT Fleet Hub", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -990,7 +990,7 @@ } }, "traits": { - "smithy.api#documentation": "A summary of information about a AWS IoT Device Management web application.
\nFleet Hub for AWS IoT Device Management is in public preview and is subject to change.
\nA summary of information about a Fleet Hub for IoT Device Management web application.
" } }, "com.amazonaws.iotfleethub#Arn": { @@ -1049,7 +1049,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Fleet Hub for AWS IoT Device Management web application.
\nFleet Hub for AWS IoT Device Management is in public preview and is subject to change.
\nCreates a Fleet Hub for IoT Device Management web application.
\nWhen creating a Fleet Hub application, you must create an organization instance of\n IAM Identity Center if you don't already have one. The Fleet Hub application you create must also be in\n the same Amazon Web Services Region of the organization instance of IAM Identity Center. For more information see Enabling\n IAM Identity Center and Organization instances of IAM Identity Center.
", "smithy.api#http": { "method": "POST", "uri": "/applications", @@ -1083,7 +1083,7 @@ "roleArn": { "target": "com.amazonaws.iotfleethub#Arn", "traits": { - "smithy.api#documentation": "The ARN of the role that the web application assumes when it interacts with AWS IoT Core.
\nThe name of the role must be in the form AWSIotFleetHub_random_string\n .
The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.
\nThe name of the role must be in the form AWSIotFleetHub_random_string\n .
Deletes a Fleet Hub for AWS IoT Device Management web application.
\nFleet Hub for AWS IoT Device Management is in public preview and is subject to change.
\nDeletes a Fleet Hub for IoT Device Management web application.
", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{applicationId}", @@ -1205,7 +1205,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a Fleet Hub for AWS IoT Device Management web application.
\nFleet Hub for AWS IoT Device Management is in public preview and is subject to change.
\nGets information about a Fleet Hub for IoT Device Management web application.
", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}", @@ -1292,7 +1292,7 @@ "roleArn": { "target": "com.amazonaws.iotfleethub#Arn", "traits": { - "smithy.api#documentation": "The ARN of the role that the web application assumes when it interacts with AWS IoT Core.
", + "smithy.api#documentation": "The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.
", "smithy.api#required": {} } }, @@ -1305,7 +1305,7 @@ "errorMessage": { "target": "com.amazonaws.iotfleethub#ErrorMessage", "traits": { - "smithy.api#documentation": "A message indicating why the DescribeApplication API failed.
A message that explains any failures included in the applicationState response field. This message \n explains failures in the CreateApplication and DeleteApplication actions.
Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.
\nFleet Hub for AWS IoT Device Management is in public preview and is subject to change.
\nGets a list of Fleet Hub for IoT Device Management web applications for the current account.
", "smithy.api#http": { "method": "GET", "uri": "/applications", @@ -1469,7 +1469,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the tags for the specified resource.
\nFleet Hub for AWS IoT Device Management is in public preview and is subject to change.
\nLists the tags for the specified resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", @@ -1597,7 +1597,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.
\nFleet Hub for AWS IoT Device Management is in public preview and is subject to change.
\nAdds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -1683,7 +1683,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified tags (metadata) from the resource.
\nFleet Hub for AWS IoT Device Management is in public preview and is subject to change.
\nRemoves the specified tags (metadata) from the resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", @@ -1748,7 +1748,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates information about a Fleet Hub for a AWS IoT Device Management web application.
\nFleet Hub for AWS IoT Device Management is in public preview and is subject to change.
\nUpdates information about a Fleet Hub for IoT Device Management web application.
", "smithy.api#http": { "method": "PATCH", "uri": "/applications/{applicationId}", diff --git a/codegen/sdk-codegen/aws-models/kms.2014-11-01.json b/codegen/sdk-codegen/aws-models/kms.2014-11-01.json index 0534f4c3ee3..e6e77c9ae7b 100644 --- a/codegen/sdk-codegen/aws-models/kms.2014-11-01.json +++ b/codegen/sdk-codegen/aws-models/kms.2014-11-01.json @@ -336,6 +336,23 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.kms#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.kms#ErrorMessageType" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConflictException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "The request was rejected because an automatic rotation of this key is currently in \n progress or scheduled to begin within the next 20 minutes.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.kms#ConnectCustomKeyStore": { "type": "operation", "input": { @@ -1819,7 +1836,7 @@ "target": "com.amazonaws.kms#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in thisresponse to the Marker parameter in a\n subsequent request.
A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in this response to the Marker parameter in a\n subsequent request.
Disables automatic\n rotation of the key material of the specified symmetric encryption KMS key.
\nAutomatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
\nYou can enable (EnableKeyRotation) and disable automatic rotation of the\n key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not\n configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS\n keys varies.
\nIn May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years to every year. For details, see EnableKeyRotation.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n Required permissions: kms:DisableKeyRotation (key policy)
\n\n Related operations:\n
\n\n EnableKeyRotation\n
\n\n GetKeyRotationStatus\n
\n\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.
", + "smithy.api#documentation": "Disables automatic\n rotation of the key material of the specified symmetric encryption KMS key.
\nAutomatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
\nYou can enable (EnableKeyRotation) and disable automatic rotation of the\n key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not\n configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS\n keys varies.
\nIn May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years to every year. For details, see EnableKeyRotation.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n Required permissions: kms:DisableKeyRotation (key policy)
\n\n Related operations:\n
\n\n EnableKeyRotation\n
\n\n GetKeyRotationStatus\n
\n\n ListKeyRotations\n
\n\n RotateKeyOnDemand\n
\n\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.
", "smithy.api#examples": [ { "title": "To disable automatic rotation of key material", @@ -2353,13 +2370,14 @@ } ], "traits": { - "smithy.api#documentation": "Enables automatic rotation\n of the key material of the specified symmetric encryption KMS key.
\nWhen you enable automatic rotation of a customer managed KMS key, KMS\n rotates the key material of the KMS key one year (approximately 365 days) from the enable date\n and every year thereafter. You can monitor rotation of the key material for your KMS keys in\n CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer\n managed KMS key, use the DisableKeyRotation operation.
\nAutomatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
\nYou cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS\n always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS\n keys varies.
\nIn May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years (approximately 1,095 days) to every year (approximately 365 days).
\nNew Amazon Web Services managed keys are automatically rotated one year after they are created, and\n approximately every year thereafter.
\nExisting Amazon Web Services managed keys are automatically rotated one year after their most recent\n rotation, and every year thereafter.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n Required permissions: kms:EnableKeyRotation (key policy)
\n\n Related operations:\n
\n\n DisableKeyRotation\n
\n\n GetKeyRotationStatus\n
\n\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.
", + "smithy.api#documentation": "Enables automatic rotation\n of the key material of the specified symmetric encryption KMS key.
\nBy default, when you enable automatic rotation of a customer managed KMS key, KMS\n rotates the key material of the KMS key one year (approximately 365 days) from the enable date\n and every year thereafter. You can use the optional RotationPeriodInDays\n parameter to specify a custom rotation period when you enable key rotation, or you can use \n RotationPeriodInDays to modify the rotation period of a key that you previously \n enabled automatic key rotation on.
You can monitor rotation of the key material\n for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key\n material in a customer managed KMS key, use the DisableKeyRotation\n operation. You can use the GetKeyRotationStatus operation to identify any in progress \n rotations. You can use the ListKeyRotations operation to view the details of\n completed rotations.
\nAutomatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
\nYou cannot enable or disable automatic rotation of Amazon Web Services managed KMS keys. KMS\n always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS\n keys is managed by the Amazon Web Services service that owns the key.
\nIn May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years (approximately 1,095 days) to every year (approximately 365 days).
\nNew Amazon Web Services managed keys are automatically rotated one year after they are created, and\n approximately every year thereafter.
\nExisting Amazon Web Services managed keys are automatically rotated one year after their most recent\n rotation, and every year thereafter.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n Required permissions: kms:EnableKeyRotation (key policy)
\n\n Related operations:\n
\n\n DisableKeyRotation\n
\n\n GetKeyRotationStatus\n
\n\n ListKeyRotations\n
\n\n RotateKeyOnDemand\n
\nYou can perform on-demand (RotateKeyOnDemand) rotation of the \n key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled.
\n\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.
", "smithy.api#examples": [ { "title": "To enable automatic rotation of key material", - "documentation": "The following example enables automatic annual rotation of the key material for the specified KMS key.", + "documentation": "The following example enables automatic rotation with a rotation period of 365 days for the specified KMS key.", "input": { - "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "RotationPeriodInDays": 365 } } ] @@ -2374,6 +2392,12 @@ "smithy.api#documentation": "Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
\nSpecify the key ID or key ARN of the KMS key.
\nFor example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
", "smithy.api#required": {} } + }, + "RotationPeriodInDays": { + "target": "com.amazonaws.kms#RotationPeriodInDaysType", + "traits": { + "smithy.api#documentation": "Use this parameter to specify a custom period of time between each rotation date. If no\n value is specified, the default value is 365 days.
\nThe rotation period defines the number of days after you enable automatic key rotation\n that KMS will rotate your key material, and the number of days between each automatic\n rotation thereafter.
\nYou can use the \n kms:RotationPeriodInDays\n condition key to further constrain the \n values that principals can specify in the RotationPeriodInDays parameter.
" + } } }, "traits": { @@ -3471,19 +3495,7 @@ } ], "traits": { - "smithy.api#documentation": "
Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified KMS key.
\nWhen you enable automatic rotation for customer managed KMS keys, KMS\n rotates the key material of the KMS key one year (approximately 365 days) from the enable date\n and every year thereafter. You can monitor rotation of the key material for your KMS keys in\n CloudTrail and Amazon CloudWatch.
\nAutomatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key..
\nYou can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key\n material rotation of Amazon Web Services managed KMS keys is not\n configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The\n key rotation status for Amazon Web Services managed KMS keys is always true.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years to every year. For details, see EnableKeyRotation.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\nDisabled: The key rotation status does not change when you disable a KMS key. However,\n while the KMS key is disabled, KMS does not rotate the key material. When you re-enable\n the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been\n rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been\n less than a year since the key material in the re-enabled KMS key was rotated, the KMS key\n resumes its prior rotation schedule.
\nPending deletion: While a KMS key is pending deletion, its key rotation status is\n false and KMS does not rotate the key material. If you cancel the\n deletion, the original key rotation status returns to true.
\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.
\n Required permissions: kms:GetKeyRotationStatus (key policy)
\n\n Related operations:\n
\n\n DisableKeyRotation\n
\n\n EnableKeyRotation\n
\n\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.
", - "smithy.api#examples": [ - { - "title": "To retrieve the rotation status for a KMS key", - "documentation": "The following example retrieves the status of automatic annual rotation of the key material for the specified KMS key.", - "input": { - "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" - }, - "output": { - "KeyRotationEnabled": true - } - } - ] + "smithy.api#documentation": "Provides detailed information about the rotation status for a KMS key, including \n whether automatic rotation of the key material is enabled for the specified KMS key, the\n rotation period, and the next scheduled\n rotation date.
\nAutomatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key..
\nYou can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key\n material rotation of Amazon Web Services managed KMS keys is not\n configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The\n key rotation status for Amazon Web Services managed KMS keys is always true.
You can perform on-demand (RotateKeyOnDemand) rotation of the \n key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. \n You can use GetKeyRotationStatus to identify the date and time that an in progress on-demand rotation\n was initiated. You can use ListKeyRotations to view the details of completed rotations.
\nIn May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years to every year. For details, see EnableKeyRotation.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\nDisabled: The key rotation status does not change when you disable a KMS key. However,\n while the KMS key is disabled, KMS does not rotate the key material. When you re-enable\n the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been\n rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been\n less than a year since the key material in the re-enabled KMS key was rotated, the KMS key\n resumes its prior rotation schedule.
\nPending deletion: While a KMS key is pending deletion, its key rotation status is\n false and KMS does not rotate the key material. If you cancel the\n deletion, the original key rotation status returns to true.
\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.
\n Required permissions: kms:GetKeyRotationStatus (key policy)
\n\n Related operations:\n
\n\n DisableKeyRotation\n
\n\n EnableKeyRotation\n
\n\n ListKeyRotations\n
\n\n RotateKeyOnDemand\n
\n\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.
" } }, "com.amazonaws.kms#GetKeyRotationStatusRequest": { @@ -3510,6 +3522,30 @@ "smithy.api#default": false, "smithy.api#documentation": "A Boolean value that specifies whether key rotation is enabled.
" } + }, + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "Identifies the specified symmetric encryption KMS key.
" + } + }, + "RotationPeriodInDays": { + "target": "com.amazonaws.kms#RotationPeriodInDaysType", + "traits": { + "smithy.api#documentation": "The number of days between each automatic rotation. The default value is 365 days.
" + } + }, + "NextRotationDate": { + "target": "com.amazonaws.kms#DateType", + "traits": { + "smithy.api#documentation": "The next date that KMS will automatically rotate the key material.
" + } + }, + "OnDemandRotationStartDate": { + "target": "com.amazonaws.kms#DateType", + "traits": { + "smithy.api#documentation": "Identifies the date and time that an in progress on-demand rotation was initiated.
\nThe KMS API follows an eventual consistency model\n due to the distributed nature of the system. As a result, there might be a slight delay\n between initiating on-demand key rotation and the rotation's completion. Once the on-demand\n rotation is complete, use ListKeyRotations to view the details of the\n on-demand rotation.
" + } } }, "traits": { @@ -4903,7 +4939,7 @@ "target": "com.amazonaws.kms#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in thisresponse to the Marker parameter in a\n subsequent request.
A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in this response to the Marker parameter in a\n subsequent request.
A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in thisresponse to the Marker parameter in a\n subsequent request.
A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in this response to the Marker parameter in a\n subsequent request.
A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in thisresponse to the Marker parameter in a\n subsequent request.
A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in this response to the Marker parameter in a\n subsequent request.
Returns information about all completed key material rotations for the specified KMS\n key.
\nYou must specify the KMS key in all requests. You can refine the key rotations list by\n limiting the number of rotations returned.
\nFor detailed information about automatic and on-demand key rotations, see Rotating KMS keys in the\n Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n Required permissions: kms:ListKeyRotations (key policy)
\n\n Related operations:\n
\n\n EnableKeyRotation\n
\n\n DisableKeyRotation\n
\n\n GetKeyRotationStatus\n
\n\n RotateKeyOnDemand\n
\n\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "Rotations", + "pageSize": "Limit" + } + } + }, + "com.amazonaws.kms#ListKeyRotationsRequest": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "Gets the key rotations for the specified KMS key.
\nSpecify the key ID or key ARN of the KMS key.
\nFor example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
", + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.kms#LimitType", + "traits": { + "smithy.api#documentation": "Use this parameter to specify the maximum number of items to return. When this\n value is present, KMS does not return more than the specified number of items, but it might\n return fewer.
\nThis value is optional. If you include a value, it must be between\n 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
" + } + }, + "Marker": { + "target": "com.amazonaws.kms#MarkerType", + "traits": { + "smithy.api#documentation": "Use this parameter in a subsequent request after you receive a response with\n truncated results. Set it to the value of NextMarker from the truncated response\n you just received.
A list of completed key material rotations.
" + } + }, + "NextMarker": { + "target": "com.amazonaws.kms#MarkerType", + "traits": { + "smithy.api#documentation": "When Truncated is true, this element is present and contains the\n value to use for the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in this response to the Marker parameter in a\n subsequent request.
A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in thisresponse to the Marker parameter in a\n subsequent request.
A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in this response to the Marker parameter in a\n subsequent request.
A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in thisresponse to the Marker parameter in a\n subsequent request.
A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in this response to the Marker parameter in a\n subsequent request.
Immediately initiates rotation of the key material of the specified symmetric encryption\n KMS key.
\nYou can perform on-demand rotation\n of the key material in customer managed KMS keys, \n regardless of whether or not automatic key rotation is enabled.\n On-demand rotations do not change existing automatic rotation schedules. For example, consider a KMS key that\n has automatic key rotation enabled with a rotation period of 730 days. If the key is scheduled to \n automatically rotate on April 14, 2024, and you perform an on-demand rotation on April 10, 2024, the key will automatically rotate,\n as scheduled, on April 14, 2024 and every 730 days thereafter.
\nYou can perform on-demand key rotation a maximum of 10 times\n per KMS key. You can use the KMS console \n to view the number of remaining on-demand rotations available for a KMS key.
\nYou can use GetKeyRotationStatus to identify any in progress \n on-demand rotations. You can use ListKeyRotations to identify the date that\n completed on-demand rotations were performed. You can monitor rotation of the key material \n for your KMS keys in CloudTrail and Amazon CloudWatch.
\nOn-demand key rotation is supported only on symmetric encryption KMS keys.\n You cannot perform on-demand rotation of asymmetric KMS keys,\n HMAC KMS keys, \n KMS keys with imported key material, or KMS keys in a custom key store. To perform\n on-demand rotation of a set of related multi-Region keys,\n invoke the on-demand rotation on the primary key.
\nYou cannot initiate on-demand rotation of Amazon Web Services managed KMS keys. KMS\n always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS\n keys is managed by the Amazon Web Services service that owns the key.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n Required permissions: kms:RotateKeyOnDemand (key policy)
\n\n Related operations:\n
\n\n EnableKeyRotation\n
\n\n DisableKeyRotation\n
\n\n GetKeyRotationStatus\n
\n\n ListKeyRotations\n
\n\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.
", + "smithy.api#examples": [ + { + "title": "To perform on-demand rotation of key material", + "documentation": "The following example immediately initiates rotation of the key material for the specified KMS key.", + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + } + } + ] + } + }, + "com.amazonaws.kms#RotateKeyOnDemandRequest": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "Identifies a symmetric encryption KMS key. You cannot perform on-demand rotation of asymmetric KMS keys,\n HMAC KMS keys, \n KMS keys with imported key material, or KMS keys in a custom key store. To perform\n on-demand rotation of a set of related multi-Region keys,\n invoke the on-demand rotation on the primary key.
\nSpecify the key ID or key ARN of the KMS key.
\nFor example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.kms#RotateKeyOnDemandResponse": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "Identifies the symmetric encryption KMS key that you initiated on-demand rotation\n on.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.kms#RotationPeriodInDaysType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 90, + "max": 2560 + } + } + }, + "com.amazonaws.kms#RotationType": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + } + } + }, + "com.amazonaws.kms#RotationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.kms#RotationsListEntry" + } + }, + "com.amazonaws.kms#RotationsListEntry": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "Unique identifier of the key.
" + } + }, + "RotationDate": { + "target": "com.amazonaws.kms#DateType", + "traits": { + "smithy.api#documentation": "Date and time that the key material rotation completed. Formatted as Unix time.
" + } + }, + "RotationType": { + "target": "com.amazonaws.kms#RotationType", + "traits": { + "smithy.api#documentation": "Identifies whether the key material rotation was a scheduled automatic rotation or an on-demand rotation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about completed key material rotations.
" + } + }, "com.amazonaws.kms#ScheduleKeyDeletion": { "type": "operation", "input": { @@ -6807,6 +7075,9 @@ { "target": "com.amazonaws.kms#ListKeyPolicies" }, + { + "target": "com.amazonaws.kms#ListKeyRotations" + }, { "target": "com.amazonaws.kms#ListKeys" }, @@ -6831,6 +7102,9 @@ { "target": "com.amazonaws.kms#RevokeGrant" }, + { + "target": "com.amazonaws.kms#RotateKeyOnDemand" + }, { "target": "com.amazonaws.kms#ScheduleKeyDeletion" }, @@ -9132,7 +9406,7 @@ "code": "XksProxyUriEndpointInUseException", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request was rejected because the XksProxyUriEndpoint is already\n associated with another external key store in this Amazon Web Services Region. To identify the cause,\n see the error message that accompanies the exception.
The request was rejected because the XksProxyUriEndpoint is already\n associated with another external key store in this Amazon Web Services Region. To identify the cause, see\n the error message that accompanies the exception.
A list of the account IDs of Amazon Web Services accounts of third-party applications\n that are allowed to access data managed by Lake Formation.
" } + }, + "ShareRecipients": { + "target": "com.amazonaws.lakeformation#DataLakePrincipalList", + "traits": { + "smithy.api#documentation": "A list of Amazon Web Services account IDs and/or Amazon Web Services organization/organizational unit ARNs\n that are allowed to access data managed by Lake Formation.
\nIf the ShareRecipients list includes valid values, a resource share is created with the principals you want to have access to the resources.
If the ShareRecipients value is null or the list is empty, no resource share is created.
The Amazon Resource Name (ARN) of the integrated application.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lake Formation application integrated with IAM Identity Center.
" } } }, @@ -3070,7 +3076,7 @@ "ApplicationArn": { "target": "com.amazonaws.lakeformation#ApplicationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the integrated application.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lake Formation application integrated with IAM Identity Center.
" } }, "ExternalFiltering": { @@ -3078,6 +3084,18 @@ "traits": { "smithy.api#documentation": "Indicates if external filtering is enabled.
" } + }, + "ShareRecipients": { + "target": "com.amazonaws.lakeformation#DataLakePrincipalList", + "traits": { + "smithy.api#documentation": "A list of Amazon Web Services account IDs or Amazon Web Services organization/organizational unit ARNs that\n are allowed to access data managed by Lake Formation.
\nIf the ShareRecipients list includes valid values, a resource share is created with the principals you want to have access to the resources as the ShareRecipients.
If the ShareRecipients value is null or the list is empty, no resource share is created.
The Amazon Resource Name (ARN) of the RAM share.
" + } } }, "traits": { @@ -7778,6 +7796,12 @@ "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the\n persistent metadata store. It contains database definitions, table definitions, view\n definitions, and other control information to manage your Lake Formation\n environment.
" } }, + "ShareRecipients": { + "target": "com.amazonaws.lakeformation#DataLakePrincipalList", + "traits": { + "smithy.api#documentation": "A list of Amazon Web Services account IDs or Amazon Web Services organization/organizational unit ARNs that\n are allowed to access to access data managed by Lake Formation.
\nIf the ShareRecipients list includes valid values, then the resource share is updated with the principals you want to have access to the resources.
If the ShareRecipients value is null, both the list of share recipients and\n the resource share remain unchanged.
If the ShareRecipients value is an empty list, then the existing share\n recipients list will be cleared, and the resource share will be deleted.
Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.
" } + }, + "restartBatchJobIdentifier": { + "target": "com.amazonaws.m2#RestartBatchJobIdentifier", + "traits": { + "smithy.api#documentation": "Specifies the required information for restart, including execution ID and jobsteprestartmarker.
" + } } }, "traits": { @@ -1350,6 +1363,12 @@ } } }, + "com.amazonaws.m2#BatchJobStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#JobStep" + } + }, "com.amazonaws.m2#BatchJobType": { "type": "string", "traits": { @@ -3381,6 +3400,12 @@ "traits": { "smithy.api#documentation": "The unique identifier of this batch job.
" } + }, + "jobStepRestartMarker": { + "target": "com.amazonaws.m2#JobStepRestartMarker", + "traits": { + "smithy.api#documentation": "The restart steps information for the most recent restart operation.
" + } } } }, @@ -4039,6 +4064,86 @@ "smithy.api#documentation": "Identifies a specific batch job.
" } }, + "com.amazonaws.m2#JobStep": { + "type": "structure", + "members": { + "stepNumber": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of a step.
" + } + }, + "stepName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of a step.
" + } + }, + "procStepNumber": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of a procedure step.
" + } + }, + "procStepName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of a procedure step.
" + } + }, + "stepCondCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The condition code of a step.
" + } + }, + "stepRestartable": { + "target": "com.amazonaws.m2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies if a step can be restarted or not.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information related to a job step.
" + } + }, + "com.amazonaws.m2#JobStepRestartMarker": { + "type": "structure", + "members": { + "fromStep": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The step name that a batch job restart was from.
", + "smithy.api#required": {} + } + }, + "fromProcStep": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The procedure step name that a job was restarted from.
" + } + }, + "toStep": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The step name that a job was restarted to.
" + } + }, + "toProcStep": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The procedure step name that a batch job was restarted to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides restart step information for the most recent restart operation.
" + } + }, "com.amazonaws.m2#ListApplicationVersions": { "type": "operation", "input": { @@ -4459,6 +4564,83 @@ } } }, + "com.amazonaws.m2#ListBatchJobRestartPoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListBatchJobRestartPointsRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListBatchJobRestartPointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Lists all the job steps for JCL files to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.
", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/batch-job-executions/{executionId}/steps", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#ListBatchJobRestartPointsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "The unique identifier of each batch job execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.m2#ListBatchJobRestartPointsResponse": { + "type": "structure", + "members": { + "batchJobSteps": { + "target": "com.amazonaws.m2#BatchJobStepList", + "traits": { + "smithy.api#documentation": "Returns all the batch job steps and related information for a batch job that previously ran.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.m2#ListDataSetImportHistory": { "type": "operation", "input": { @@ -5283,6 +5465,28 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.m2#RestartBatchJobIdentifier": { + "type": "structure", + "members": { + "executionId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "The executionId from the StartBatchJob response when the job ran for the first time.
", + "smithy.api#required": {} + } + }, + "jobStepRestartMarker": { + "target": "com.amazonaws.m2#JobStepRestartMarker", + "traits": { + "smithy.api#documentation": "The restart step information for the most recent restart operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An identifier for the StartBatchJob API to show that it is a restart operation.
" + } + }, "com.amazonaws.m2#S3BatchJobIdentifier": { "type": "structure", "members": { @@ -6144,6 +6348,14 @@ "value": "cannotParse", "name": "CANNOT_PARSE" }, + { + "value": "featureNotAvailable", + "name": "FEATURE_NOT_AVAILABLE" + }, + { + "value": "unsupportedEngineVersion", + "name": "UNSUPPORTED_ENGINE_VERSION" + }, { "value": "fieldValidationFailed", "name": "FIELD_VALIDATION_FAILED" diff --git a/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json b/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json index 8dd14fe52d6..f895d5fcede 100644 --- a/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json +++ b/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json @@ -2689,7 +2689,7 @@ } }, "traits": { - "smithy.api#documentation": "Set Style passthrough to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings." + "smithy.api#documentation": "To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. Note that MediaConvert uses default settings for any missing style or position information in your input captions To ignore the style and position information from your input captions and use default settings: Leave blank or keep the default value, Disabled. Default settings include white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings. You can also override any fonts by manually specifying custom font files." } }, "com.amazonaws.mediaconvert#BurninDestinationSettings": { @@ -2737,6 +2737,34 @@ "smithy.api#jsonName": "fontColor" } }, + "FontFileBold": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3TtfHttpsTtf", + "traits": { + "smithy.api#documentation": "Specify a bold TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, an italic, and a bold italic font file.", + "smithy.api#jsonName": "fontFileBold" + } + }, + "FontFileBoldItalic": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Specify a bold italic TrueType font file to use when rendering your output captions.\nEnter an S3, HTTP, or HTTPS URL.\nWhen you do, you must also separately specify a regular, a bold, and an italic font file.", + "smithy.api#jsonName": "fontFileBoldItalic" + } + }, + "FontFileItalic": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3TtfHttpsTtf", + "traits": { + "smithy.api#documentation": "Specify an italic TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, a bold, and a bold italic font file.", + "smithy.api#jsonName": "fontFileItalic" + } + }, + "FontFileRegular": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3TtfHttpsTtf", + "traits": { + "smithy.api#documentation": "Specify a regular TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a bold, an italic, and a bold italic font file.", + "smithy.api#jsonName": "fontFileRegular" + } + }, "FontOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { @@ -2817,7 +2845,7 @@ "StylePassthrough": { "target": "com.amazonaws.mediaconvert#BurnInSubtitleStylePassthrough", "traits": { - "smithy.api#documentation": "Set Style passthrough to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.", + "smithy.api#documentation": "To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. Note that MediaConvert uses default settings for any missing style or position information in your input captions To ignore the style and position information from your input captions and use default settings: Leave blank or keep the default value, Disabled. Default settings include white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings. You can also override any fonts by manually specifying custom font files.", "smithy.api#jsonName": "stylePassthrough" } }, @@ -6720,7 +6748,6 @@ "smithy.api#deprecated": { "message": "DescribeEndpoints and account specific endpoints are no longer required. We recommend that you send your requests directly to the regional endpoint instead." }, - "smithy.api#documentation": "DescribeEndpointsRequest", "smithy.api#input": {} } }, @@ -7099,6 +7126,34 @@ "smithy.api#jsonName": "fontColor" } }, + "FontFileBold": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3TtfHttpsTtf", + "traits": { + "smithy.api#documentation": "Specify a bold TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, an italic, and a bold italic font file.", + "smithy.api#jsonName": "fontFileBold" + } + }, + "FontFileBoldItalic": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3TtfHttpsTtf", + "traits": { + "smithy.api#documentation": "Specify a bold italic TrueType font file to use when rendering your output captions.\nEnter an S3, HTTP, or HTTPS URL.\nWhen you do, you must also separately specify a regular, a bold, and an italic font file.", + "smithy.api#jsonName": "fontFileBoldItalic" + } + }, + "FontFileItalic": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3TtfHttpsTtf", + "traits": { + "smithy.api#documentation": "Specify an italic TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, a bold, and a bold italic font file.", + "smithy.api#jsonName": "fontFileItalic" + } + }, + "FontFileRegular": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3TtfHttpsTtf", + "traits": { + "smithy.api#documentation": "Specify a regular TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a bold, an italic, and a bold italic font file.", + "smithy.api#jsonName": "fontFileRegular" + } + }, "FontOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { @@ -7186,7 +7241,7 @@ "StylePassthrough": { "target": "com.amazonaws.mediaconvert#DvbSubtitleStylePassthrough", "traits": { - "smithy.api#documentation": "Set Style passthrough to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.", + "smithy.api#documentation": "To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. Note that MediaConvert uses default settings for any missing style or position information in your input captions To ignore the style and position information from your input captions and use default settings: Leave blank or keep the default value, Disabled. Default settings include white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings. You can also override any fonts by manually specifying custom font files.", "smithy.api#jsonName": "stylePassthrough" } }, @@ -7516,7 +7571,7 @@ } }, "traits": { - "smithy.api#documentation": "Set Style passthrough to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings." + "smithy.api#documentation": "To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. Note that MediaConvert uses default settings for any missing style or position information in your input captions To ignore the style and position information from your input captions and use default settings: Leave blank or keep the default value, Disabled. Default settings include white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings. You can also override any fonts by manually specifying custom font files." } }, "com.amazonaws.mediaconvert#DvbSubtitleTeletextSpacing": { @@ -13798,7 +13853,7 @@ "ColorConversion3DLUTSettings": { "target": "com.amazonaws.mediaconvert#__listOfColorConversion3DLUTSetting", "traits": { - "smithy.api#documentation": "Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another. You can include up to 8 different 3D LUTs.", + "smithy.api#documentation": "Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another. You can include up to 8 different 3D LUTs. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/3d-luts.html", "smithy.api#jsonName": "colorConversion3DLUTSettings" } }, @@ -14071,7 +14126,7 @@ "ColorConversion3DLUTSettings": { "target": "com.amazonaws.mediaconvert#__listOfColorConversion3DLUTSetting", "traits": { - "smithy.api#documentation": "Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another. You can include up to 8 different 3D LUTs.", + "smithy.api#documentation": "Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another. You can include up to 8 different 3D LUTs. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/3d-luts.html", "smithy.api#jsonName": "colorConversion3DLUTSettings" } }, @@ -16129,6 +16184,26 @@ "smithy.api#documentation": "When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream." } }, + "com.amazonaws.mediaconvert#M2tsPreventBufferUnderflow": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert automatically attempts to prevent decoder buffer underflows in your transport stream output. Use if you are seeing decoder buffer underflows in your output and are unable to increase your transport stream's bitrate. For most workflows: We recommend that you keep the default value, Disabled. To prevent decoder buffer underflows in your output, when possible: Choose Enabled. Note that if MediaConvert prevents a decoder buffer underflow in your output, output video quality is reduced and your job will take longer to complete." + } + }, "com.amazonaws.mediaconvert#M2tsRateMode": { "type": "enum", "members": { @@ -16440,6 +16515,13 @@ "smithy.api#jsonName": "pmtPid" } }, + "PreventBufferUnderflow": { + "target": "com.amazonaws.mediaconvert#M2tsPreventBufferUnderflow", + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert automatically attempts to prevent decoder buffer underflows in your transport stream output. Use if you are seeing decoder buffer underflows in your output and are unable to increase your transport stream's bitrate. For most workflows: We recommend that you keep the default value, Disabled. To prevent decoder buffer underflows in your output, when possible: Choose Enabled. Note that if MediaConvert prevents a decoder buffer underflow in your output, output video quality is reduced and your job will take longer to complete.", + "smithy.api#jsonName": "preventBufferUnderflow" + } + }, "PrivateMetadataPid": { "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { @@ -26990,6 +27072,12 @@ "smithy.api#pattern": "^s3://([^\\/]+\\/+)+((([^\\/]*)))|^https?://[^\\/].*[^&]$" } }, + "com.amazonaws.mediaconvert#__stringPatternS3TtfHttpsTtf": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((s3://(.*?)\\.(ttf))|(https?://(.*?)\\.(ttf)(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" + } + }, "com.amazonaws.mediaconvert#__stringPatternSNManifestConfirmConditionNotificationNS": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json b/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json index 126e76a18ec..08e24986a11 100644 --- a/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json +++ b/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json @@ -3395,6 +3395,381 @@ "smithy.api#output": {} } }, + "com.amazonaws.medialive#CloudWatchAlarmTemplateComparisonOperator": { + "type": "enum", + "members": { + "GreaterThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" + } + }, + "GreaterThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanThreshold" + } + }, + "LessThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanThreshold" + } + }, + "LessThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqualToThreshold" + } + } + }, + "traits": { + "smithy.api#documentation": "The comparison operator used to compare the specified statistic and the threshold." + } + }, + "com.amazonaws.medialive#CloudWatchAlarmTemplateGroupSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "createdAt", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "id", + "smithy.api#required": {} + } + }, + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "modifiedAt" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" + } + }, + "TemplateCount": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of templates in a group.", + "smithy.api#jsonName": "templateCount", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for CloudWatchAlarmTemplateGroupSummary" + } + }, + "com.amazonaws.medialive#CloudWatchAlarmTemplateStatistic": { + "type": "enum", + "members": { + "SampleCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + }, + "Average": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "Sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + }, + "Minimum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + }, + "Maximum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + } + }, + "traits": { + "smithy.api#documentation": "The statistic to apply to the alarm's metric data." + } + }, + "com.amazonaws.medialive#CloudWatchAlarmTemplateSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveCloudwatchAlarmTemplate", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn", + "smithy.api#required": {} + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateComparisonOperator", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "comparisonOperator", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "createdAt", + "smithy.api#required": {} + } + }, + "DatapointsToAlarm": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm.", + "smithy.api#jsonName": "datapointsToAlarm" + } + }, + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } + }, + "EvaluationPeriods": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of periods over which data is compared to the specified threshold.", + "smithy.api#jsonName": "evaluationPeriods", + "smithy.api#required": {} + } + }, + "GroupId": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "groupId", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`", + "smithy.api#jsonName": "id", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.medialive#__stringMax64", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType.", + "smithy.api#jsonName": "metricName", + "smithy.api#required": {} + } + }, + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "modifiedAt" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Period": { + "target": "com.amazonaws.medialive#__integerMin10Max86400", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The period, in seconds, over which the specified statistic is applied.", + "smithy.api#jsonName": "period", + "smithy.api#required": {} + } + }, + "Statistic": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateStatistic", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "statistic", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" + } + }, + "TargetResourceType": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTargetResourceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "targetResourceType", + "smithy.api#required": {} + } + }, + "Threshold": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The threshold value to compare with the specified statistic.", + "smithy.api#jsonName": "threshold", + "smithy.api#required": {} + } + }, + "TreatMissingData": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTreatMissingData", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "treatMissingData", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for CloudWatchAlarmTemplateSummary" + } + }, + "com.amazonaws.medialive#CloudWatchAlarmTemplateTargetResourceType": { + "type": "enum", + "members": { + "CLOUDFRONT_DISTRIBUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDFRONT_DISTRIBUTION" + } + }, + "MEDIALIVE_MULTIPLEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIALIVE_MULTIPLEX" + } + }, + "MEDIALIVE_CHANNEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIALIVE_CHANNEL" + } + }, + "MEDIALIVE_INPUT_DEVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIALIVE_INPUT_DEVICE" + } + }, + "MEDIAPACKAGE_CHANNEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAPACKAGE_CHANNEL" + } + }, + "MEDIAPACKAGE_ORIGIN_ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAPACKAGE_ORIGIN_ENDPOINT" + } + }, + "MEDIACONNECT_FLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIACONNECT_FLOW" + } + }, + "S3_BUCKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_BUCKET" + } + } + }, + "traits": { + "smithy.api#documentation": "The resource type this template should dynamically generate cloudwatch metric alarms for." + } + }, + "com.amazonaws.medialive#CloudWatchAlarmTemplateTreatMissingData": { + "type": "enum", + "members": { + "notBreaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "notBreaching" + } + }, + "breaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "breaching" + } + }, + "ignore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ignore" + } + }, + "missing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "missing" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies how missing data points are treated when evaluating the alarm's condition." + } + }, "com.amazonaws.medialive#CmafIngestGroupSettings": { "type": "structure", "members": { @@ -3788,230 +4163,448 @@ "smithy.api#output": {} } }, - "com.amazonaws.medialive#CreateInput": { + "com.amazonaws.medialive#CreateCloudWatchAlarmTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#CreateInputRequest" + "target": "com.amazonaws.medialive#CreateCloudWatchAlarmTemplateRequest" }, "output": { - "target": "com.amazonaws.medialive#CreateInputResponse" + "target": "com.amazonaws.medialive#CreateCloudWatchAlarmTemplateResponse" }, "errors": [ { - "target": "com.amazonaws.medialive#BadGatewayException" + "target": "com.amazonaws.medialive#BadRequestException" }, { - "target": "com.amazonaws.medialive#BadRequestException" + "target": "com.amazonaws.medialive#ConflictException" }, { "target": "com.amazonaws.medialive#ForbiddenException" }, { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/cloudwatch-alarm-templates", + "code": 201 + } + } + }, + "com.amazonaws.medialive#CreateCloudWatchAlarmTemplateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#CreateCloudWatchAlarmTemplateGroupRequest" + }, + "output": { + "target": "com.amazonaws.medialive#CreateCloudWatchAlarmTemplateGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" }, { "target": "com.amazonaws.medialive#InternalServerErrorException" }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, { "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Create an input", + "smithy.api#documentation": "Creates a cloudwatch alarm template group to group your cloudwatch alarm templates and to attach to signal maps for dynamically creating alarms.", "smithy.api#http": { "method": "POST", - "uri": "/prod/inputs", + "uri": "/prod/cloudwatch-alarm-template-groups", "code": 201 } } }, - "com.amazonaws.medialive#CreateInputRequest": { + "com.amazonaws.medialive#CreateCloudWatchAlarmTemplateGroupRequest": { "type": "structure", "members": { - "Destinations": { - "target": "com.amazonaws.medialive#__listOfInputDestinationRequest", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#documentation": "Destination settings for PUSH type inputs.", - "smithy.api#jsonName": "destinations" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "InputDevices": { - "target": "com.amazonaws.medialive#__listOfInputDeviceSettings", + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#documentation": "Settings for the devices.", - "smithy.api#jsonName": "inputDevices" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } }, - "InputSecurityGroups": { - "target": "com.amazonaws.medialive#__listOf__string", + "Tags": { + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#documentation": "A list of security groups referenced by IDs to attach to the input.", - "smithy.api#jsonName": "inputSecurityGroups" + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateGroupRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#CreateCloudWatchAlarmTemplateGroupResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup", + "traits": { + "smithy.api#documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" } }, - "MediaConnectFlows": { - "target": "com.amazonaws.medialive#__listOfMediaConnectFlowRequest", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "mediaConnectFlows" + "smithy.api#jsonName": "createdAt" + } + }, + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "id" + } + }, + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "modifiedAt" } }, "Name": { - "target": "com.amazonaws.medialive#__string", + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#documentation": "Name of the input.", + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", "smithy.api#jsonName": "name" } }, - "RequestId": { - "target": "com.amazonaws.medialive#__string", + "Tags": { + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "requestId" + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateGroupResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#CreateCloudWatchAlarmTemplateRequest": { + "type": "structure", + "members": { + "ComparisonOperator": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateComparisonOperator", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "comparisonOperator", + "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", + "DatapointsToAlarm": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation.", - "smithy.api#jsonName": "roleArn" + "smithy.api#documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm.", + "smithy.api#jsonName": "datapointsToAlarm" } }, - "Sources": { - "target": "com.amazonaws.medialive#__listOfInputSourceRequest", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "sources" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } + }, + "EvaluationPeriods": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of periods over which data is compared to the specified threshold.", + "smithy.api#jsonName": "evaluationPeriods", + "smithy.api#required": {} + } + }, + "GroupIdentifier": { + "target": "com.amazonaws.medialive#__stringPatternS", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name.", + "smithy.api#jsonName": "groupIdentifier", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.medialive#__stringMax64", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType.", + "smithy.api#jsonName": "metricName", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Period": { + "target": "com.amazonaws.medialive#__integerMin10Max86400", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The period, in seconds, over which the specified statistic is applied.", + "smithy.api#jsonName": "period", + "smithy.api#required": {} + } + }, + "Statistic": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateStatistic", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "statistic", + "smithy.api#required": {} } }, "Tags": { - "target": "com.amazonaws.medialive#Tags", + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } }, - "Type": { - "target": "com.amazonaws.medialive#InputType", + "TargetResourceType": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTargetResourceType", "traits": { - "smithy.api#jsonName": "type" + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "targetResourceType", + "smithy.api#required": {} } }, - "Vpc": { - "target": "com.amazonaws.medialive#InputVpcRequest", + "Threshold": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#jsonName": "vpc" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The threshold value to compare with the specified statistic.", + "smithy.api#jsonName": "threshold", + "smithy.api#required": {} + } + }, + "TreatMissingData": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTreatMissingData", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "treatMissingData", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The name of the input", + "smithy.api#documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#CreateInputResponse": { + "com.amazonaws.medialive#CreateCloudWatchAlarmTemplateResponse": { "type": "structure", "members": { - "Input": { - "target": "com.amazonaws.medialive#Input", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveCloudwatchAlarmTemplate", "traits": { - "smithy.api#jsonName": "input" + "smithy.api#documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateComparisonOperator", + "traits": { + "smithy.api#jsonName": "comparisonOperator" + } + }, + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "createdAt" + } + }, + "DatapointsToAlarm": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm.", + "smithy.api#jsonName": "datapointsToAlarm" + } + }, + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } + }, + "EvaluationPeriods": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#documentation": "The number of periods over which data is compared to the specified threshold.", + "smithy.api#jsonName": "evaluationPeriods" + } + }, + "GroupId": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "groupId" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`", + "smithy.api#jsonName": "id" + } + }, + "MetricName": { + "target": "com.amazonaws.medialive#__stringMax64", + "traits": { + "smithy.api#documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType.", + "smithy.api#jsonName": "metricName" + } + }, + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "modifiedAt" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" + } + }, + "Period": { + "target": "com.amazonaws.medialive#__integerMin10Max86400", + "traits": { + "smithy.api#documentation": "The period, in seconds, over which the specified statistic is applied.", + "smithy.api#jsonName": "period" + } + }, + "Statistic": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateStatistic", + "traits": { + "smithy.api#jsonName": "statistic" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" + } + }, + "TargetResourceType": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTargetResourceType", + "traits": { + "smithy.api#jsonName": "targetResourceType" + } + }, + "Threshold": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "The threshold value to compare with the specified statistic.", + "smithy.api#jsonName": "threshold" + } + }, + "TreatMissingData": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTreatMissingData", + "traits": { + "smithy.api#jsonName": "treatMissingData" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for CreateInputResponse", + "smithy.api#documentation": "Placeholder documentation for CreateCloudWatchAlarmTemplateResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#CreateInputSecurityGroup": { + "com.amazonaws.medialive#CreateEventBridgeRuleTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#CreateInputSecurityGroupRequest" + "target": "com.amazonaws.medialive#CreateEventBridgeRuleTemplateRequest" }, "output": { - "target": "com.amazonaws.medialive#CreateInputSecurityGroupResponse" + "target": "com.amazonaws.medialive#CreateEventBridgeRuleTemplateResponse" }, "errors": [ { - "target": "com.amazonaws.medialive#BadGatewayException" + "target": "com.amazonaws.medialive#BadRequestException" }, { - "target": "com.amazonaws.medialive#BadRequestException" + "target": "com.amazonaws.medialive#ConflictException" }, { "target": "com.amazonaws.medialive#ForbiddenException" }, { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "target": "com.amazonaws.medialive#InternalServerErrorException" }, { - "target": "com.amazonaws.medialive#InternalServerErrorException" + "target": "com.amazonaws.medialive#NotFoundException" }, { "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Creates a Input Security Group", + "smithy.api#documentation": "Creates an eventbridge rule template to monitor events and send notifications to your targeted resources.", "smithy.api#http": { "method": "POST", - "uri": "/prod/inputSecurityGroups", - "code": 200 + "uri": "/prod/eventbridge-rule-templates", + "code": 201 } } }, - "com.amazonaws.medialive#CreateInputSecurityGroupRequest": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.medialive#Tags", - "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" - } - }, - "WhitelistRules": { - "target": "com.amazonaws.medialive#__listOfInputWhitelistRuleCidr", - "traits": { - "smithy.api#documentation": "List of IPv4 CIDR addresses to whitelist", - "smithy.api#jsonName": "whitelistRules" - } - } - }, - "traits": { - "smithy.api#documentation": "The IPv4 CIDRs to whitelist for this Input Security Group", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#CreateInputSecurityGroupResponse": { - "type": "structure", - "members": { - "SecurityGroup": { - "target": "com.amazonaws.medialive#InputSecurityGroup", - "traits": { - "smithy.api#jsonName": "securityGroup" - } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for CreateInputSecurityGroupResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#CreateMultiplex": { + "com.amazonaws.medialive#CreateEventBridgeRuleTemplateGroup": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#CreateMultiplexRequest" + "target": "com.amazonaws.medialive#CreateEventBridgeRuleTemplateGroupRequest" }, "output": { - "target": "com.amazonaws.medialive#CreateMultiplexResponse" + "target": "com.amazonaws.medialive#CreateEventBridgeRuleTemplateGroupResponse" }, "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, { "target": "com.amazonaws.medialive#BadRequestException" }, @@ -4021,208 +4614,246 @@ { "target": "com.amazonaws.medialive#ForbiddenException" }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, { "target": "com.amazonaws.medialive#InternalServerErrorException" }, { - "target": "com.amazonaws.medialive#TooManyRequestsException" - }, - { - "target": "com.amazonaws.medialive#UnprocessableEntityException" - } - ], - "traits": { - "smithy.api#documentation": "Create a new multiplex.", - "smithy.api#http": { - "method": "POST", - "uri": "/prod/multiplexes", - "code": 201 - } - } - }, - "com.amazonaws.medialive#CreateMultiplexProgram": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#CreateMultiplexProgramRequest" - }, - "output": { - "target": "com.amazonaws.medialive#CreateMultiplexProgramResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ConflictException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" + "target": "com.amazonaws.medialive#NotFoundException" }, { "target": "com.amazonaws.medialive#TooManyRequestsException" - }, - { - "target": "com.amazonaws.medialive#UnprocessableEntityException" } ], "traits": { - "smithy.api#documentation": "Create a new program in the multiplex.", + "smithy.api#documentation": "Creates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.", "smithy.api#http": { "method": "POST", - "uri": "/prod/multiplexes/{MultiplexId}/programs", + "uri": "/prod/eventbridge-rule-template-groups", "code": 201 } } }, - "com.amazonaws.medialive#CreateMultiplexProgramRequest": { + "com.amazonaws.medialive#CreateEventBridgeRuleTemplateGroupRequest": { "type": "structure", "members": { - "MultiplexId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "ID of the multiplex where the program is to be created.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MultiplexProgramSettings": { - "target": "com.amazonaws.medialive#MultiplexProgramSettings", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The settings for this multiplex program.", - "smithy.api#jsonName": "multiplexProgramSettings", - "smithy.api#required": {} + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "ProgramName": { - "target": "com.amazonaws.medialive#__string", + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of multiplex program.", - "smithy.api#jsonName": "programName", + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name", "smithy.api#required": {} } }, - "RequestId": { - "target": "com.amazonaws.medialive#__string", + "Tags": { + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Unique request ID. This prevents retries from creating multiple\nresources.", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "requestId", - "smithy.api#required": {} + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "A request to create a program in a multiplex.", + "smithy.api#documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateGroupRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#CreateMultiplexProgramResponse": { + "com.amazonaws.medialive#CreateEventBridgeRuleTemplateGroupResponse": { "type": "structure", "members": { - "MultiplexProgram": { - "target": "com.amazonaws.medialive#MultiplexProgram", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveEventbridgeRuleTemplateGroup", "traits": { - "smithy.api#documentation": "The newly created multiplex program.", - "smithy.api#jsonName": "multiplexProgram" + "smithy.api#documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" + } + }, + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "createdAt" + } + }, + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "id" + } + }, + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "modifiedAt" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for CreateMultiplexProgramResponse", + "smithy.api#documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateGroupResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#CreateMultiplexRequest": { + "com.amazonaws.medialive#CreateEventBridgeRuleTemplateRequest": { "type": "structure", "members": { - "AvailabilityZones": { - "target": "com.amazonaws.medialive#__listOf__string", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of availability zones for the multiplex. You must specify exactly two.", - "smithy.api#jsonName": "availabilityZones", - "smithy.api#required": {} + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexSettings", + "EventTargets": { + "target": "com.amazonaws.medialive#__listOfEventBridgeRuleTemplateTarget", + "traits": { + "smithy.api#jsonName": "eventTargets" + } + }, + "EventType": { + "target": "com.amazonaws.medialive#EventBridgeRuleTemplateEventType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configuration for a multiplex event.", - "smithy.api#jsonName": "multiplexSettings", + "smithy.api#jsonName": "eventType", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "GroupIdentifier": { + "target": "com.amazonaws.medialive#__stringPatternS", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of multiplex.", - "smithy.api#jsonName": "name", + "smithy.api#documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name.", + "smithy.api#jsonName": "groupIdentifier", "smithy.api#required": {} } }, - "RequestId": { - "target": "com.amazonaws.medialive#__string", + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Unique request ID. This prevents retries from creating multiple\nresources.", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "requestId", + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name", "smithy.api#required": {} } }, "Tags": { - "target": "com.amazonaws.medialive#Tags", + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "A request to create a multiplex.", + "smithy.api#documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#CreateMultiplexResponse": { + "com.amazonaws.medialive#CreateEventBridgeRuleTemplateResponse": { "type": "structure", "members": { - "Multiplex": { - "target": "com.amazonaws.medialive#Multiplex", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveEventbridgeRuleTemplate", "traits": { - "smithy.api#documentation": "The newly created multiplex.", - "smithy.api#jsonName": "multiplex" + "smithy.api#documentation": "An eventbridge rule template's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" + } + }, + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "createdAt" + } + }, + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } + }, + "EventTargets": { + "target": "com.amazonaws.medialive#__listOfEventBridgeRuleTemplateTarget", + "traits": { + "smithy.api#jsonName": "eventTargets" + } + }, + "EventType": { + "target": "com.amazonaws.medialive#EventBridgeRuleTemplateEventType", + "traits": { + "smithy.api#jsonName": "eventType" + } + }, + "GroupId": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "groupId" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`", + "smithy.api#jsonName": "id" + } + }, + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "modifiedAt" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for CreateMultiplexResponse", + "smithy.api#documentation": "Placeholder documentation for CreateEventBridgeRuleTemplateResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#CreatePartnerInput": { + "com.amazonaws.medialive#CreateInput": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#CreatePartnerInputRequest" + "target": "com.amazonaws.medialive#CreateInputRequest" }, "output": { - "target": "com.amazonaws.medialive#CreatePartnerInputResponse" + "target": "com.amazonaws.medialive#CreateInputResponse" }, "errors": [ { @@ -4245,47 +4876,100 @@ } ], "traits": { - "smithy.api#documentation": "Create a partner input", + "smithy.api#documentation": "Create an input", "smithy.api#http": { "method": "POST", - "uri": "/prod/inputs/{InputId}/partners", + "uri": "/prod/inputs", "code": 201 } } }, - "com.amazonaws.medialive#CreatePartnerInputRequest": { + "com.amazonaws.medialive#CreateInputRequest": { "type": "structure", "members": { - "InputId": { - "target": "com.amazonaws.medialive#__string", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfInputDestinationRequest", "traits": { - "smithy.api#documentation": "Unique ID of the input.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Destination settings for PUSH type inputs.", + "smithy.api#jsonName": "destinations" } }, - "RequestId": { - "target": "com.amazonaws.medialive#__string", + "InputDevices": { + "target": "com.amazonaws.medialive#__listOfInputDeviceSettings", "traits": { - "smithy.api#documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "Settings for the devices.", + "smithy.api#jsonName": "inputDevices" + } + }, + "InputSecurityGroups": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "A list of security groups referenced by IDs to attach to the input.", + "smithy.api#jsonName": "inputSecurityGroups" + } + }, + "MediaConnectFlows": { + "target": "com.amazonaws.medialive#__listOfMediaConnectFlowRequest", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "mediaConnectFlows" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Name of the input.", + "smithy.api#jsonName": "name" + } + }, + "RequestId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.", + "smithy.api#idempotencyToken": {}, "smithy.api#jsonName": "requestId" } }, + "RoleArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation.", + "smithy.api#jsonName": "roleArn" + } + }, + "Sources": { + "target": "com.amazonaws.medialive#__listOfInputSourceRequest", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "sources" + } + }, "Tags": { "target": "com.amazonaws.medialive#Tags", "traits": { "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } + }, + "Type": { + "target": "com.amazonaws.medialive#InputType", + "traits": { + "smithy.api#jsonName": "type" + } + }, + "Vpc": { + "target": "com.amazonaws.medialive#InputVpcRequest", + "traits": { + "smithy.api#jsonName": "vpc" + } } }, "traits": { - "smithy.api#documentation": "A request to create a partner input", + "smithy.api#documentation": "The name of the input", "smithy.api#input": {} } }, - "com.amazonaws.medialive#CreatePartnerInputResponse": { + "com.amazonaws.medialive#CreateInputResponse": { "type": "structure", "members": { "Input": { @@ -4296,218 +4980,92 @@ } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for CreatePartnerInputResponse", + "smithy.api#documentation": "Placeholder documentation for CreateInputResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#CreateTags": { + "com.amazonaws.medialive#CreateInputSecurityGroup": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#CreateTagsRequest" + "target": "com.amazonaws.medialive#CreateInputSecurityGroupRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.medialive#CreateInputSecurityGroupResponse" }, "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, { "target": "com.amazonaws.medialive#BadRequestException" }, { "target": "com.amazonaws.medialive#ForbiddenException" }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, { "target": "com.amazonaws.medialive#InternalServerErrorException" }, { - "target": "com.amazonaws.medialive#NotFoundException" + "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Create tags for a resource", + "smithy.api#documentation": "Creates a Input Security Group", "smithy.api#http": { "method": "POST", - "uri": "/prod/tags/{ResourceArn}", - "code": 204 + "uri": "/prod/inputSecurityGroups", + "code": 200 } } }, - "com.amazonaws.medialive#CreateTagsRequest": { + "com.amazonaws.medialive#CreateInputSecurityGroupRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.medialive#Tags", "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for CreateTagsRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#DashRoleAudio": { - "type": "enum", - "members": { - "ALTERNATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALTERNATE" - } - }, - "COMMENTARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMMENTARY" - } - }, - "DESCRIPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESCRIPTION" - } - }, - "DUB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DUB" - } - }, - "EMERGENCY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMERGENCY" - } - }, - "ENHANCED_AUDIO_INTELLIGIBILITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENHANCED-AUDIO-INTELLIGIBILITY" - } - }, - "KARAOKE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KARAOKE" - } - }, - "MAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAIN" - } }, - "SUPPLEMENTARY": { - "target": "smithy.api#Unit", + "WhitelistRules": { + "target": "com.amazonaws.medialive#__listOfInputWhitelistRuleCidr", "traits": { - "smithy.api#enumValue": "SUPPLEMENTARY" + "smithy.api#documentation": "List of IPv4 CIDR addresses to whitelist", + "smithy.api#jsonName": "whitelistRules" } } }, "traits": { - "smithy.api#documentation": "Dash Role Audio" + "smithy.api#documentation": "The IPv4 CIDRs to whitelist for this Input Security Group", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#DashRoleCaption": { - "type": "enum", + "com.amazonaws.medialive#CreateInputSecurityGroupResponse": { + "type": "structure", "members": { - "ALTERNATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALTERNATE" - } - }, - "CAPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CAPTION" - } - }, - "COMMENTARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMMENTARY" - } - }, - "DESCRIPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESCRIPTION" - } - }, - "DUB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DUB" - } - }, - "EASYREADER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EASYREADER" - } - }, - "EMERGENCY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMERGENCY" - } - }, - "FORCED_SUBTITLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FORCED-SUBTITLE" - } - }, - "KARAOKE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KARAOKE" - } - }, - "MAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAIN" - } - }, - "METADATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "METADATA" - } - }, - "SUBTITLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUBTITLE" - } - }, - "SUPPLEMENTARY": { - "target": "smithy.api#Unit", + "SecurityGroup": { + "target": "com.amazonaws.medialive#InputSecurityGroup", "traits": { - "smithy.api#enumValue": "SUPPLEMENTARY" + "smithy.api#jsonName": "securityGroup" } } }, "traits": { - "smithy.api#documentation": "Dash Role Caption" + "smithy.api#documentation": "Placeholder documentation for CreateInputSecurityGroupResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#DeleteChannel": { + "com.amazonaws.medialive#CreateMultiplex": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DeleteChannelRequest" + "target": "com.amazonaws.medialive#CreateMultiplexRequest" }, "output": { - "target": "com.amazonaws.medialive#DeleteChannelResponse" + "target": "com.amazonaws.medialive#CreateMultiplexResponse" }, "errors": [ { @@ -4529,149 +5087,163 @@ "target": "com.amazonaws.medialive#InternalServerErrorException" }, { - "target": "com.amazonaws.medialive#NotFoundException" + "target": "com.amazonaws.medialive#TooManyRequestsException" }, { - "target": "com.amazonaws.medialive#TooManyRequestsException" + "target": "com.amazonaws.medialive#UnprocessableEntityException" } ], "traits": { - "smithy.api#documentation": "Starts deletion of channel. The associated outputs are also deleted.", + "smithy.api#documentation": "Create a new multiplex.", "smithy.api#http": { - "method": "DELETE", - "uri": "/prod/channels/{ChannelId}", - "code": 200 + "method": "POST", + "uri": "/prod/multiplexes", + "code": 201 } } }, - "com.amazonaws.medialive#DeleteChannelRequest": { - "type": "structure", - "members": { - "ChannelId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Unique ID of the channel.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } + "com.amazonaws.medialive#CreateMultiplexProgram": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#CreateMultiplexProgramRequest" + }, + "output": { + "target": "com.amazonaws.medialive#CreateMultiplexProgramResponse" }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteChannelRequest", - "smithy.api#input": {} + "smithy.api#documentation": "Create a new program in the multiplex.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/multiplexes/{MultiplexId}/programs", + "code": 201 + } } }, - "com.amazonaws.medialive#DeleteChannelResponse": { + "com.amazonaws.medialive#CreateMultiplexProgramRequest": { "type": "structure", "members": { - "Arn": { + "MultiplexId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique arn of the channel.", - "smithy.api#jsonName": "arn" - } - }, - "CdiInputSpecification": { - "target": "com.amazonaws.medialive#CdiInputSpecification", - "traits": { - "smithy.api#documentation": "Specification of CDI inputs for this channel", - "smithy.api#jsonName": "cdiInputSpecification" - } - }, - "ChannelClass": { - "target": "com.amazonaws.medialive#ChannelClass", - "traits": { - "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", - "smithy.api#jsonName": "channelClass" - } - }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfOutputDestination", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "destinations" - } - }, - "EgressEndpoints": { - "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", - "traits": { - "smithy.api#documentation": "The endpoints where outgoing connections initiate from", - "smithy.api#jsonName": "egressEndpoints" + "smithy.api#documentation": "ID of the multiplex where the program is to be created.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "EncoderSettings": { - "target": "com.amazonaws.medialive#EncoderSettings", + "MultiplexProgramSettings": { + "target": "com.amazonaws.medialive#MultiplexProgramSettings", "traits": { - "smithy.api#jsonName": "encoderSettings" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The settings for this multiplex program.", + "smithy.api#jsonName": "multiplexProgramSettings", + "smithy.api#required": {} } }, - "Id": { + "ProgramName": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique id of the channel.", - "smithy.api#jsonName": "id" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of multiplex program.", + "smithy.api#jsonName": "programName", + "smithy.api#required": {} } }, - "InputAttachments": { - "target": "com.amazonaws.medialive#__listOfInputAttachment", + "RequestId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "List of input attachments for channel.", - "smithy.api#jsonName": "inputAttachments" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Unique request ID. This prevents retries from creating multiple\nresources.", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "requestId", + "smithy.api#required": {} } - }, - "InputSpecification": { - "target": "com.amazonaws.medialive#InputSpecification", + } + }, + "traits": { + "smithy.api#documentation": "A request to create a program in a multiplex.", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#CreateMultiplexProgramResponse": { + "type": "structure", + "members": { + "MultiplexProgram": { + "target": "com.amazonaws.medialive#MultiplexProgram", "traits": { - "smithy.api#documentation": "Specification of network and file inputs for this channel", - "smithy.api#jsonName": "inputSpecification" + "smithy.api#documentation": "The newly created multiplex program.", + "smithy.api#jsonName": "multiplexProgram" } - }, - "LogLevel": { - "target": "com.amazonaws.medialive#LogLevel", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for CreateMultiplexProgramResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#CreateMultiplexRequest": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "The log level being written to CloudWatch Logs.", - "smithy.api#jsonName": "logLevel" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of availability zones for the multiplex. You must specify exactly two.", + "smithy.api#jsonName": "availabilityZones", + "smithy.api#required": {} } }, - "Maintenance": { - "target": "com.amazonaws.medialive#MaintenanceStatus", + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexSettings", "traits": { - "smithy.api#documentation": "Maintenance settings for this channel.", - "smithy.api#jsonName": "maintenance" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configuration for a multiplex event.", + "smithy.api#jsonName": "multiplexSettings", + "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The name of the channel. (user-mutable)", - "smithy.api#jsonName": "name" - } - }, - "PipelineDetails": { - "target": "com.amazonaws.medialive#__listOfPipelineDetail", - "traits": { - "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", - "smithy.api#jsonName": "pipelineDetails" - } - }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", - "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of multiplex.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } }, - "RoleArn": { + "RequestId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", - "smithy.api#jsonName": "roleArn" - } - }, - "State": { - "target": "com.amazonaws.medialive#ChannelState", - "traits": { - "smithy.api#jsonName": "state" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Unique request ID. This prevents retries from creating multiple\nresources.", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "requestId", + "smithy.api#required": {} } }, "Tags": { @@ -4680,27 +5252,36 @@ "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } - }, - "Vpc": { - "target": "com.amazonaws.medialive#VpcOutputSettingsDescription", + } + }, + "traits": { + "smithy.api#documentation": "A request to create a multiplex.", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#CreateMultiplexResponse": { + "type": "structure", + "members": { + "Multiplex": { + "target": "com.amazonaws.medialive#Multiplex", "traits": { - "smithy.api#documentation": "Settings for VPC output", - "smithy.api#jsonName": "vpc" + "smithy.api#documentation": "The newly created multiplex.", + "smithy.api#jsonName": "multiplex" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteChannelResponse", + "smithy.api#documentation": "Placeholder documentation for CreateMultiplexResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#DeleteInput": { + "com.amazonaws.medialive#CreatePartnerInput": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DeleteInputRequest" + "target": "com.amazonaws.medialive#CreatePartnerInputRequest" }, "output": { - "target": "com.amazonaws.medialive#DeleteInputResponse" + "target": "com.amazonaws.medialive#CreatePartnerInputResponse" }, "errors": [ { @@ -4709,9 +5290,6 @@ { "target": "com.amazonaws.medialive#BadRequestException" }, - { - "target": "com.amazonaws.medialive#ConflictException" - }, { "target": "com.amazonaws.medialive#ForbiddenException" }, @@ -4721,67 +5299,83 @@ { "target": "com.amazonaws.medialive#InternalServerErrorException" }, - { - "target": "com.amazonaws.medialive#NotFoundException" - }, { "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Deletes the input end point", + "smithy.api#documentation": "Create a partner input", "smithy.api#http": { - "method": "DELETE", - "uri": "/prod/inputs/{InputId}", - "code": 200 + "method": "POST", + "uri": "/prod/inputs/{InputId}/partners", + "code": 201 } } }, - "com.amazonaws.medialive#DeleteInputRequest": { + "com.amazonaws.medialive#CreatePartnerInputRequest": { "type": "structure", "members": { "InputId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Unique ID of the input", + "smithy.api#documentation": "Unique ID of the input.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteInputRequest", + }, + "RequestId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "requestId" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to create a partner input", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DeleteInputResponse": { + "com.amazonaws.medialive#CreatePartnerInputResponse": { "type": "structure", - "members": {}, + "members": { + "Input": { + "target": "com.amazonaws.medialive#Input", + "traits": { + "smithy.api#jsonName": "input" + } + } + }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteInputResponse", + "smithy.api#documentation": "Placeholder documentation for CreatePartnerInputResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#DeleteInputSecurityGroup": { + "com.amazonaws.medialive#CreateSignalMap": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DeleteInputSecurityGroupRequest" + "target": "com.amazonaws.medialive#CreateSignalMapRequest" }, "output": { - "target": "com.amazonaws.medialive#DeleteInputSecurityGroupResponse" + "target": "com.amazonaws.medialive#CreateSignalMapResponse" }, "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, { "target": "com.amazonaws.medialive#BadRequestException" }, { - "target": "com.amazonaws.medialive#ForbiddenException" + "target": "com.amazonaws.medialive#ConflictException" }, { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "target": "com.amazonaws.medialive#ForbiddenException" }, { "target": "com.amazonaws.medialive#InternalServerErrorException" @@ -4794,297 +5388,398 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Input Security Group", + "smithy.api#documentation": "Initiates the creation of a new signal map. Will discover a new mediaResourceMap based on the provided discoveryEntryPointArn.", "smithy.api#http": { - "method": "DELETE", - "uri": "/prod/inputSecurityGroups/{InputSecurityGroupId}", - "code": 200 + "method": "POST", + "uri": "/prod/signal-maps", + "code": 201 } } }, - "com.amazonaws.medialive#DeleteInputSecurityGroupRequest": { + "com.amazonaws.medialive#CreateSignalMapRequest": { "type": "structure", "members": { - "InputSecurityGroupId": { - "target": "com.amazonaws.medialive#__string", + "CloudWatchAlarmTemplateGroupIdentifiers": { + "target": "com.amazonaws.medialive#__listOf__stringPatternS", "traits": { - "smithy.api#documentation": "The Input Security Group to delete", - "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "cloudWatchAlarmTemplateGroupIdentifiers" + } + }, + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } + }, + "DiscoveryEntryPointArn": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A top-level supported AWS resource ARN to discovery a signal map from.", + "smithy.api#jsonName": "discoveryEntryPointArn", + "smithy.api#required": {} + } + }, + "EventBridgeRuleTemplateGroupIdentifiers": { + "target": "com.amazonaws.medialive#__listOf__stringPatternS", + "traits": { + "smithy.api#jsonName": "eventBridgeRuleTemplateGroupIdentifiers" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" + } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteInputSecurityGroupRequest", + "smithy.api#documentation": "Placeholder documentation for CreateSignalMapRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DeleteInputSecurityGroupResponse": { + "com.amazonaws.medialive#CreateSignalMapResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteInputSecurityGroupResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#DeleteMultiplex": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#DeleteMultiplexRequest" - }, - "output": { - "target": "com.amazonaws.medialive#DeleteMultiplexResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveSignalMap", + "traits": { + "smithy.api#documentation": "A signal map's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" + } }, - { - "target": "com.amazonaws.medialive#BadRequestException" + "CloudWatchAlarmTemplateGroupIds": { + "target": "com.amazonaws.medialive#__listOf__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#jsonName": "cloudWatchAlarmTemplateGroupIds" + } }, - { - "target": "com.amazonaws.medialive#ConflictException" + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "createdAt" + } }, - { - "target": "com.amazonaws.medialive#ForbiddenException" + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "DiscoveryEntryPointArn": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", + "traits": { + "smithy.api#documentation": "A top-level supported AWS resource ARN to discovery a signal map from.", + "smithy.api#jsonName": "discoveryEntryPointArn" + } }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" + "ErrorMessage": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", + "traits": { + "smithy.api#documentation": "Error message associated with a failed creation or failed update attempt of a signal map.", + "smithy.api#jsonName": "errorMessage" + } }, - { - "target": "com.amazonaws.medialive#NotFoundException" + "EventBridgeRuleTemplateGroupIds": { + "target": "com.amazonaws.medialive#__listOf__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#jsonName": "eventBridgeRuleTemplateGroupIds" + } }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" + "FailedMediaResourceMap": { + "target": "com.amazonaws.medialive#FailedMediaResourceMap", + "traits": { + "smithy.api#jsonName": "failedMediaResourceMap" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#documentation": "A signal map's id.", + "smithy.api#jsonName": "id" + } + }, + "LastDiscoveredAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "lastDiscoveredAt" + } + }, + "LastSuccessfulMonitorDeployment": { + "target": "com.amazonaws.medialive#SuccessfulMonitorDeployment", + "traits": { + "smithy.api#jsonName": "lastSuccessfulMonitorDeployment" + } + }, + "MediaResourceMap": { + "target": "com.amazonaws.medialive#MediaResourceMap", + "traits": { + "smithy.api#jsonName": "mediaResourceMap" + } + }, + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "modifiedAt" + } + }, + "MonitorChangesPendingDeployment": { + "target": "com.amazonaws.medialive#__boolean", + "traits": { + "smithy.api#documentation": "If true, there are pending monitor changes for this signal map that can be deployed.", + "smithy.api#jsonName": "monitorChangesPendingDeployment" + } + }, + "MonitorDeployment": { + "target": "com.amazonaws.medialive#MonitorDeployment", + "traits": { + "smithy.api#jsonName": "monitorDeployment" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.medialive#SignalMapStatus", + "traits": { + "smithy.api#jsonName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" + } } - ], + }, "traits": { - "smithy.api#documentation": "Delete a multiplex. The multiplex must be idle.", - "smithy.api#http": { - "method": "DELETE", - "uri": "/prod/multiplexes/{MultiplexId}", - "code": 202 - } + "smithy.api#documentation": "Placeholder documentation for CreateSignalMapResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#DeleteMultiplexProgram": { + "com.amazonaws.medialive#CreateTags": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DeleteMultiplexProgramRequest" + "target": "com.amazonaws.medialive#CreateTagsRequest" }, "output": { - "target": "com.amazonaws.medialive#DeleteMultiplexProgramResponse" + "target": "smithy.api#Unit" }, "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, { "target": "com.amazonaws.medialive#BadRequestException" }, - { - "target": "com.amazonaws.medialive#ConflictException" - }, { "target": "com.amazonaws.medialive#ForbiddenException" }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, { "target": "com.amazonaws.medialive#InternalServerErrorException" }, { "target": "com.amazonaws.medialive#NotFoundException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Delete a program from a multiplex.", + "smithy.api#documentation": "Create tags for a resource", "smithy.api#http": { - "method": "DELETE", - "uri": "/prod/multiplexes/{MultiplexId}/programs/{ProgramName}", - "code": 200 + "method": "POST", + "uri": "/prod/tags/{ResourceArn}", + "code": 204 } } }, - "com.amazonaws.medialive#DeleteMultiplexProgramRequest": { + "com.amazonaws.medialive#CreateTagsRequest": { "type": "structure", "members": { - "MultiplexId": { + "ResourceArn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ID of the multiplex that the program belongs to.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ProgramName": { - "target": "com.amazonaws.medialive#__string", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "The multiplex program name.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteMultiplexProgramRequest", + "smithy.api#documentation": "Placeholder documentation for CreateTagsRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DeleteMultiplexProgramResponse": { - "type": "structure", + "com.amazonaws.medialive#DashRoleAudio": { + "type": "enum", "members": { - "ChannelId": { - "target": "com.amazonaws.medialive#__string", + "ALTERNATE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The MediaLive channel associated with the program.", - "smithy.api#jsonName": "channelId" + "smithy.api#enumValue": "ALTERNATE" } }, - "MultiplexProgramSettings": { - "target": "com.amazonaws.medialive#MultiplexProgramSettings", + "COMMENTARY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The settings for this multiplex program.", - "smithy.api#jsonName": "multiplexProgramSettings" + "smithy.api#enumValue": "COMMENTARY" } }, - "PacketIdentifiersMap": { - "target": "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap", + "DESCRIPTION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The packet identifier map for this multiplex program.", - "smithy.api#jsonName": "packetIdentifiersMap" + "smithy.api#enumValue": "DESCRIPTION" } }, - "PipelineDetails": { - "target": "com.amazonaws.medialive#__listOfMultiplexProgramPipelineDetail", + "DUB": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "pipelineDetails" + "smithy.api#enumValue": "DUB" } }, - "ProgramName": { - "target": "com.amazonaws.medialive#__string", + "EMERGENCY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the multiplex program.", - "smithy.api#jsonName": "programName" + "smithy.api#enumValue": "EMERGENCY" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteMultiplexProgramResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#DeleteMultiplexRequest": { - "type": "structure", - "members": { - "MultiplexId": { - "target": "com.amazonaws.medialive#__string", + }, + "ENHANCED_AUDIO_INTELLIGIBILITY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The ID of the multiplex.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "ENHANCED-AUDIO-INTELLIGIBILITY" + } + }, + "KARAOKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KARAOKE" + } + }, + "MAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAIN" + } + }, + "SUPPLEMENTARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPPLEMENTARY" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteMultiplexRequest", - "smithy.api#input": {} + "smithy.api#documentation": "Dash Role Audio" } }, - "com.amazonaws.medialive#DeleteMultiplexResponse": { - "type": "structure", + "com.amazonaws.medialive#DashRoleCaption": { + "type": "enum", "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", + "ALTERNATE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique arn of the multiplex.", - "smithy.api#jsonName": "arn" + "smithy.api#enumValue": "ALTERNATE" } }, - "AvailabilityZones": { - "target": "com.amazonaws.medialive#__listOf__string", + "CAPTION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A list of availability zones for the multiplex.", - "smithy.api#jsonName": "availabilityZones" + "smithy.api#enumValue": "CAPTION" } }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", + "COMMENTARY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A list of the multiplex output destinations.", - "smithy.api#jsonName": "destinations" + "smithy.api#enumValue": "COMMENTARY" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "DESCRIPTION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique id of the multiplex.", - "smithy.api#jsonName": "id" + "smithy.api#enumValue": "DESCRIPTION" } }, - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexSettings", + "DUB": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Configuration for a multiplex event.", - "smithy.api#jsonName": "multiplexSettings" + "smithy.api#enumValue": "DUB" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "EASYREADER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the multiplex.", - "smithy.api#jsonName": "name" + "smithy.api#enumValue": "EASYREADER" } }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", + "EMERGENCY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" + "smithy.api#enumValue": "EMERGENCY" } }, - "ProgramCount": { - "target": "com.amazonaws.medialive#__integer", + "FORCED_SUBTITLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The number of programs in the multiplex.", - "smithy.api#jsonName": "programCount" + "smithy.api#enumValue": "FORCED-SUBTITLE" } }, - "State": { - "target": "com.amazonaws.medialive#MultiplexState", + "KARAOKE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The current state of the multiplex.", - "smithy.api#jsonName": "state" + "smithy.api#enumValue": "KARAOKE" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "MAIN": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#enumValue": "MAIN" + } + }, + "METADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METADATA" + } + }, + "SUBTITLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBTITLE" + } + }, + "SUPPLEMENTARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPPLEMENTARY" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteMultiplexResponse", - "smithy.api#output": {} + "smithy.api#documentation": "Dash Role Caption" } }, - "com.amazonaws.medialive#DeleteReservation": { + "com.amazonaws.medialive#DeleteChannel": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DeleteReservationRequest" + "target": "com.amazonaws.medialive#DeleteChannelRequest" }, "output": { - "target": "com.amazonaws.medialive#DeleteReservationResponse" + "target": "com.amazonaws.medialive#DeleteChannelResponse" }, "errors": [ { @@ -5113,193 +5808,218 @@ } ], "traits": { - "smithy.api#documentation": "Delete an expired reservation.", + "smithy.api#documentation": "Starts deletion of channel. The associated outputs are also deleted.", "smithy.api#http": { "method": "DELETE", - "uri": "/prod/reservations/{ReservationId}", + "uri": "/prod/channels/{ChannelId}", "code": 200 } } }, - "com.amazonaws.medialive#DeleteReservationRequest": { + "com.amazonaws.medialive#DeleteChannelRequest": { "type": "structure", "members": { - "ReservationId": { + "ChannelId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", + "smithy.api#documentation": "Unique ID of the channel.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteReservationRequest", + "smithy.api#documentation": "Placeholder documentation for DeleteChannelRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DeleteReservationResponse": { + "com.amazonaws.medialive#DeleteChannelResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'", + "smithy.api#documentation": "The unique arn of the channel.", "smithy.api#jsonName": "arn" } }, - "Count": { - "target": "com.amazonaws.medialive#__integer", + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", "traits": { - "smithy.api#documentation": "Number of reserved resources", - "smithy.api#jsonName": "count" + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" } }, - "CurrencyCode": { - "target": "com.amazonaws.medialive#__string", + "ChannelClass": { + "target": "com.amazonaws.medialive#ChannelClass", "traits": { - "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", - "smithy.api#jsonName": "currencyCode" + "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", + "smithy.api#jsonName": "channelClass" } }, - "Duration": { - "target": "com.amazonaws.medialive#__integer", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfOutputDestination", "traits": { - "smithy.api#documentation": "Lease duration, e.g. '12'", - "smithy.api#jsonName": "duration" + "smithy.api#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.", + "smithy.api#jsonName": "destinations" } }, - "DurationUnits": { - "target": "com.amazonaws.medialive#OfferingDurationUnits", + "EgressEndpoints": { + "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", "traits": { - "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", - "smithy.api#jsonName": "durationUnits" + "smithy.api#documentation": "The endpoints where outgoing connections initiate from", + "smithy.api#jsonName": "egressEndpoints" } }, - "End": { - "target": "com.amazonaws.medialive#__string", + "EncoderSettings": { + "target": "com.amazonaws.medialive#EncoderSettings", "traits": { - "smithy.api#documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'", - "smithy.api#jsonName": "end" + "smithy.api#jsonName": "encoderSettings" } }, - "FixedPrice": { - "target": "com.amazonaws.medialive#__double", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", - "smithy.api#jsonName": "fixedPrice" + "smithy.api#documentation": "The unique id of the channel.", + "smithy.api#jsonName": "id" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "InputAttachments": { + "target": "com.amazonaws.medialive#__listOfInputAttachment", "traits": { - "smithy.api#documentation": "User specified reservation name", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "List of input attachments for channel.", + "smithy.api#jsonName": "inputAttachments" } }, - "OfferingDescription": { - "target": "com.amazonaws.medialive#__string", + "InputSpecification": { + "target": "com.amazonaws.medialive#InputSpecification", "traits": { - "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", - "smithy.api#jsonName": "offeringDescription" + "smithy.api#documentation": "Specification of network and file inputs for this channel", + "smithy.api#jsonName": "inputSpecification" } }, - "OfferingId": { - "target": "com.amazonaws.medialive#__string", + "LogLevel": { + "target": "com.amazonaws.medialive#LogLevel", "traits": { - "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", - "smithy.api#jsonName": "offeringId" + "smithy.api#documentation": "The log level being written to CloudWatch Logs.", + "smithy.api#jsonName": "logLevel" } }, - "OfferingType": { - "target": "com.amazonaws.medialive#OfferingType", + "Maintenance": { + "target": "com.amazonaws.medialive#MaintenanceStatus", "traits": { - "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", - "smithy.api#jsonName": "offeringType" + "smithy.api#documentation": "Maintenance settings for this channel.", + "smithy.api#jsonName": "maintenance" } }, - "Region": { + "Name": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", - "smithy.api#jsonName": "region" + "smithy.api#documentation": "The name of the channel. (user-mutable)", + "smithy.api#jsonName": "name" } }, - "RenewalSettings": { - "target": "com.amazonaws.medialive#RenewalSettings", + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfPipelineDetail", "traits": { - "smithy.api#documentation": "Renewal settings for the reservation", - "smithy.api#jsonName": "renewalSettings" + "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", + "smithy.api#jsonName": "pipelineDetails" } }, - "ReservationId": { - "target": "com.amazonaws.medialive#__string", + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", - "smithy.api#jsonName": "reservationId" - } - }, - "ResourceSpecification": { - "target": "com.amazonaws.medialive#ReservationResourceSpecification", - "traits": { - "smithy.api#documentation": "Resource configuration details", - "smithy.api#jsonName": "resourceSpecification" + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" } }, - "Start": { + "RoleArn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'", - "smithy.api#jsonName": "start" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", + "smithy.api#jsonName": "roleArn" } }, "State": { - "target": "com.amazonaws.medialive#ReservationState", + "target": "com.amazonaws.medialive#ChannelState", "traits": { - "smithy.api#documentation": "Current state of reservation, e.g. 'ACTIVE'", "smithy.api#jsonName": "state" } }, "Tags": { "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "A collection of key-value pairs", + "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } }, - "UsagePrice": { - "target": "com.amazonaws.medialive#__double", + "Vpc": { + "target": "com.amazonaws.medialive#VpcOutputSettingsDescription", "traits": { - "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", - "smithy.api#jsonName": "usagePrice" + "smithy.api#documentation": "Settings for VPC output", + "smithy.api#jsonName": "vpc" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteReservationResponse", + "smithy.api#documentation": "Placeholder documentation for DeleteChannelResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#DeleteSchedule": { + "com.amazonaws.medialive#DeleteCloudWatchAlarmTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DeleteScheduleRequest" + "target": "com.amazonaws.medialive#DeleteCloudWatchAlarmTemplateRequest" }, "output": { - "target": "com.amazonaws.medialive#DeleteScheduleResponse" + "target": "smithy.api#Unit" }, "errors": [ { - "target": "com.amazonaws.medialive#BadGatewayException" + "target": "com.amazonaws.medialive#BadRequestException" }, { - "target": "com.amazonaws.medialive#BadRequestException" + "target": "com.amazonaws.medialive#ConflictException" }, { "target": "com.amazonaws.medialive#ForbiddenException" }, { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a cloudwatch alarm template.", + "smithy.api#http": { + "method": "DELETE", + "uri": "/prod/cloudwatch-alarm-templates/{Identifier}", + "code": 204 + } + } + }, + "com.amazonaws.medialive#DeleteCloudWatchAlarmTemplateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DeleteCloudWatchAlarmTemplateGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" }, { "target": "com.amazonaws.medialive#InternalServerErrorException" @@ -5312,43 +6032,52 @@ } ], "traits": { - "smithy.api#documentation": "Delete all schedule actions on a channel.", + "smithy.api#documentation": "Deletes a cloudwatch alarm template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.", "smithy.api#http": { "method": "DELETE", - "uri": "/prod/channels/{ChannelId}/schedule", - "code": 200 + "uri": "/prod/cloudwatch-alarm-template-groups/{Identifier}", + "code": 204 } } }, - "com.amazonaws.medialive#DeleteScheduleRequest": { + "com.amazonaws.medialive#DeleteCloudWatchAlarmTemplateGroupRequest": { "type": "structure", "members": { - "ChannelId": { + "Identifier": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Id of the channel whose schedule is being deleted.", + "smithy.api#documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteScheduleRequest", + "smithy.api#documentation": "Placeholder documentation for DeleteCloudWatchAlarmTemplateGroupRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DeleteScheduleResponse": { + "com.amazonaws.medialive#DeleteCloudWatchAlarmTemplateRequest": { "type": "structure", - "members": {}, + "members": { + "Identifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "A cloudwatch alarm template's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteScheduleResponse", - "smithy.api#output": {} + "smithy.api#documentation": "Placeholder documentation for DeleteCloudWatchAlarmTemplateRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#DeleteTags": { + "com.amazonaws.medialive#DeleteEventBridgeRuleTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DeleteTagsRequest" + "target": "com.amazonaws.medialive#DeleteEventBridgeRuleTemplateRequest" }, "output": { "target": "smithy.api#Unit" @@ -5357,6 +6086,9 @@ { "target": "com.amazonaws.medialive#BadRequestException" }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, { "target": "com.amazonaws.medialive#ForbiddenException" }, @@ -5365,49 +6097,98 @@ }, { "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Removes tags for a resource", + "smithy.api#documentation": "Deletes an eventbridge rule template.", "smithy.api#http": { "method": "DELETE", - "uri": "/prod/tags/{ResourceArn}", + "uri": "/prod/eventbridge-rule-templates/{Identifier}", "code": 204 } } }, - "com.amazonaws.medialive#DeleteTagsRequest": { + "com.amazonaws.medialive#DeleteEventBridgeRuleTemplateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DeleteEventBridgeRuleTemplateGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an eventbridge rule template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.", + "smithy.api#http": { + "method": "DELETE", + "uri": "/prod/eventbridge-rule-template-groups/{Identifier}", + "code": 204 + } + } + }, + "com.amazonaws.medialive#DeleteEventBridgeRuleTemplateGroupRequest": { "type": "structure", "members": { - "ResourceArn": { + "Identifier": { "target": "com.amazonaws.medialive#__string", "traits": { + "smithy.api#documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "TagKeys": { - "target": "com.amazonaws.medialive#__listOf__string", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DeleteEventBridgeRuleTemplateGroupRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#DeleteEventBridgeRuleTemplateRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of tag keys to delete", - "smithy.api#httpQuery": "tagKeys", + "smithy.api#documentation": "An eventbridge rule template's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DeleteTagsRequest", + "smithy.api#documentation": "Placeholder documentation for DeleteEventBridgeRuleTemplateRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DescribeAccountConfiguration": { + "com.amazonaws.medialive#DeleteInput": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DescribeAccountConfigurationRequest" + "target": "com.amazonaws.medialive#DeleteInputRequest" }, "output": { - "target": "com.amazonaws.medialive#DescribeAccountConfigurationResponse" + "target": "com.amazonaws.medialive#DeleteInputResponse" }, "errors": [ { @@ -5416,6 +6197,9 @@ { "target": "com.amazonaws.medialive#BadRequestException" }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, { "target": "com.amazonaws.medialive#ForbiddenException" }, @@ -5425,49 +6209,54 @@ { "target": "com.amazonaws.medialive#InternalServerErrorException" }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, { "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Describe account configuration", + "smithy.api#documentation": "Deletes the input end point", "smithy.api#http": { - "method": "GET", - "uri": "/prod/accountConfiguration", + "method": "DELETE", + "uri": "/prod/inputs/{InputId}", "code": 200 } } }, - "com.amazonaws.medialive#DescribeAccountConfigurationRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeAccountConfigurationRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#DescribeAccountConfigurationResponse": { + "com.amazonaws.medialive#DeleteInputRequest": { "type": "structure", "members": { - "AccountConfiguration": { - "target": "com.amazonaws.medialive#AccountConfiguration", + "InputId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#jsonName": "accountConfiguration" + "smithy.api#documentation": "Unique ID of the input", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeAccountConfigurationResponse", + "smithy.api#documentation": "Placeholder documentation for DeleteInputRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#DeleteInputResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DeleteInputResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#DescribeChannel": { + "com.amazonaws.medialive#DeleteInputSecurityGroup": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DescribeChannelRequest" + "target": "com.amazonaws.medialive#DeleteInputSecurityGroupRequest" }, "output": { - "target": "com.amazonaws.medialive#DescribeChannelResponse" + "target": "com.amazonaws.medialive#DeleteInputSecurityGroupResponse" }, "errors": [ { @@ -5493,264 +6282,256 @@ } ], "traits": { - "smithy.api#documentation": "Gets details about a channel", + "smithy.api#documentation": "Deletes an Input Security Group", "smithy.api#http": { - "method": "GET", - "uri": "/prod/channels/{ChannelId}", + "method": "DELETE", + "uri": "/prod/inputSecurityGroups/{InputSecurityGroupId}", "code": 200 + } + } + }, + "com.amazonaws.medialive#DeleteInputSecurityGroupRequest": { + "type": "structure", + "members": { + "InputSecurityGroupId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Input Security Group to delete", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DeleteInputSecurityGroupRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#DeleteInputSecurityGroupResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DeleteInputSecurityGroupResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#DeleteMultiplex": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DeleteMultiplexRequest" + }, + "output": { + "target": "com.amazonaws.medialive#DeleteMultiplexResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "smithy.waiters#waitable": { - "ChannelCreated": { - "documentation": "Wait until a channel has been created", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "State", - "expected": "IDLE", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { - "path": "State", - "expected": "CREATING", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InternalServerErrorException" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "State", - "expected": "CREATE_FAILED", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 3 - }, - "ChannelDeleted": { - "documentation": "Wait until a channel has been deleted", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "State", - "expected": "DELETED", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { - "path": "State", - "expected": "DELETING", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InternalServerErrorException" - } - } - ], - "minDelay": 5 - }, - "ChannelRunning": { - "documentation": "Wait until a channel is running", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "State", - "expected": "RUNNING", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { - "path": "State", - "expected": "STARTING", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InternalServerErrorException" - } - } - ], - "minDelay": 5 - }, - "ChannelStopped": { - "documentation": "Wait until a channel has is stopped", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "State", - "expected": "IDLE", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { - "path": "State", - "expected": "STOPPING", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InternalServerErrorException" - } - } - ], - "minDelay": 5 - } + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Delete a multiplex. The multiplex must be idle.", + "smithy.api#http": { + "method": "DELETE", + "uri": "/prod/multiplexes/{MultiplexId}", + "code": 202 } } }, - "com.amazonaws.medialive#DescribeChannelRequest": { + "com.amazonaws.medialive#DeleteMultiplexProgram": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DeleteMultiplexProgramRequest" + }, + "output": { + "target": "com.amazonaws.medialive#DeleteMultiplexProgramResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Delete a program from a multiplex.", + "smithy.api#http": { + "method": "DELETE", + "uri": "/prod/multiplexes/{MultiplexId}/programs/{ProgramName}", + "code": 200 + } + } + }, + "com.amazonaws.medialive#DeleteMultiplexProgramRequest": { "type": "structure", "members": { - "ChannelId": { + "MultiplexId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "channel ID", + "smithy.api#documentation": "The ID of the multiplex that the program belongs to.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProgramName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The multiplex program name.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeChannelRequest", + "smithy.api#documentation": "Placeholder documentation for DeleteMultiplexProgramRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DescribeChannelResponse": { + "com.amazonaws.medialive#DeleteMultiplexProgramResponse": { "type": "structure", "members": { - "Arn": { + "ChannelId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique arn of the channel.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The MediaLive channel associated with the program.", + "smithy.api#jsonName": "channelId" } }, - "CdiInputSpecification": { - "target": "com.amazonaws.medialive#CdiInputSpecification", + "MultiplexProgramSettings": { + "target": "com.amazonaws.medialive#MultiplexProgramSettings", "traits": { - "smithy.api#documentation": "Specification of CDI inputs for this channel", - "smithy.api#jsonName": "cdiInputSpecification" + "smithy.api#documentation": "The settings for this multiplex program.", + "smithy.api#jsonName": "multiplexProgramSettings" } }, - "ChannelClass": { - "target": "com.amazonaws.medialive#ChannelClass", + "PacketIdentifiersMap": { + "target": "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap", "traits": { - "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", - "smithy.api#jsonName": "channelClass" + "smithy.api#documentation": "The packet identifier map for this multiplex program.", + "smithy.api#jsonName": "packetIdentifiersMap" } }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfOutputDestination", + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfMultiplexProgramPipelineDetail", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "destinations" + "smithy.api#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.", + "smithy.api#jsonName": "pipelineDetails" } }, - "EgressEndpoints": { - "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", + "ProgramName": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The endpoints where outgoing connections initiate from", - "smithy.api#jsonName": "egressEndpoints" + "smithy.api#documentation": "The name of the multiplex program.", + "smithy.api#jsonName": "programName" } - }, - "EncoderSettings": { - "target": "com.amazonaws.medialive#EncoderSettings", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DeleteMultiplexProgramResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#DeleteMultiplexRequest": { + "type": "structure", + "members": { + "MultiplexId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#jsonName": "encoderSettings" + "smithy.api#documentation": "The ID of the multiplex.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - }, - "Id": { + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DeleteMultiplexRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#DeleteMultiplexResponse": { + "type": "structure", + "members": { + "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique id of the channel.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The unique arn of the multiplex.", + "smithy.api#jsonName": "arn" } }, - "InputAttachments": { - "target": "com.amazonaws.medialive#__listOfInputAttachment", + "AvailabilityZones": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "List of input attachments for channel.", - "smithy.api#jsonName": "inputAttachments" + "smithy.api#documentation": "A list of availability zones for the multiplex.", + "smithy.api#jsonName": "availabilityZones" } }, - "InputSpecification": { - "target": "com.amazonaws.medialive#InputSpecification", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", "traits": { - "smithy.api#documentation": "Specification of network and file inputs for this channel", - "smithy.api#jsonName": "inputSpecification" + "smithy.api#documentation": "A list of the multiplex output destinations.", + "smithy.api#jsonName": "destinations" } }, - "LogLevel": { - "target": "com.amazonaws.medialive#LogLevel", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The log level being written to CloudWatch Logs.", - "smithy.api#jsonName": "logLevel" + "smithy.api#documentation": "The unique id of the multiplex.", + "smithy.api#jsonName": "id" } }, - "Maintenance": { - "target": "com.amazonaws.medialive#MaintenanceStatus", + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexSettings", "traits": { - "smithy.api#documentation": "Maintenance settings for this channel.", - "smithy.api#jsonName": "maintenance" + "smithy.api#documentation": "Configuration for a multiplex event.", + "smithy.api#jsonName": "multiplexSettings" } }, "Name": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The name of the channel. (user-mutable)", + "smithy.api#documentation": "The name of the multiplex.", "smithy.api#jsonName": "name" } }, - "PipelineDetails": { - "target": "com.amazonaws.medialive#__listOfPipelineDetail", - "traits": { - "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", - "smithy.api#jsonName": "pipelineDetails" - } - }, "PipelinesRunningCount": { "target": "com.amazonaws.medialive#__integer", "traits": { @@ -5758,16 +6539,17 @@ "smithy.api#jsonName": "pipelinesRunningCount" } }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", + "ProgramCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", - "smithy.api#jsonName": "roleArn" + "smithy.api#documentation": "The number of programs in the multiplex.", + "smithy.api#jsonName": "programCount" } }, "State": { - "target": "com.amazonaws.medialive#ChannelState", + "target": "com.amazonaws.medialive#MultiplexState", "traits": { + "smithy.api#documentation": "The current state of the multiplex.", "smithy.api#jsonName": "state" } }, @@ -5777,27 +6559,20 @@ "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } - }, - "Vpc": { - "target": "com.amazonaws.medialive#VpcOutputSettingsDescription", - "traits": { - "smithy.api#documentation": "Settings for VPC output", - "smithy.api#jsonName": "vpc" - } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeChannelResponse", + "smithy.api#documentation": "Placeholder documentation for DeleteMultiplexResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#DescribeInput": { + "com.amazonaws.medialive#DeleteReservation": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DescribeInputRequest" + "target": "com.amazonaws.medialive#DeleteReservationRequest" }, "output": { - "target": "com.amazonaws.medialive#DescribeInputResponse" + "target": "com.amazonaws.medialive#DeleteReservationResponse" }, "errors": [ { @@ -5806,6 +6581,9 @@ { "target": "com.amazonaws.medialive#BadRequestException" }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, { "target": "com.amazonaws.medialive#ForbiddenException" }, @@ -5823,307 +6601,180 @@ } ], "traits": { - "smithy.api#documentation": "Produces details about an input", + "smithy.api#documentation": "Delete an expired reservation.", "smithy.api#http": { - "method": "GET", - "uri": "/prod/inputs/{InputId}", + "method": "DELETE", + "uri": "/prod/reservations/{ReservationId}", "code": 200 - }, - "smithy.waiters#waitable": { - "InputAttached": { - "documentation": "Wait until an input has been attached", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "State", - "expected": "ATTACHED", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { - "path": "State", - "expected": "DETACHED", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InternalServerErrorException" - } - } - ], - "minDelay": 5 - }, - "InputDeleted": { - "documentation": "Wait until an input has been deleted", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "State", - "expected": "DELETED", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { - "path": "State", - "expected": "DELETING", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InternalServerErrorException" - } - } - ], - "minDelay": 5 - }, - "InputDetached": { - "documentation": "Wait until an input has been detached", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "State", - "expected": "DETACHED", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { - "path": "State", - "expected": "CREATING", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { - "path": "State", - "expected": "ATTACHED", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InternalServerErrorException" - } - } - ], - "minDelay": 5 - } } } }, - "com.amazonaws.medialive#DescribeInputDevice": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#DescribeInputDeviceRequest" - }, - "output": { - "target": "com.amazonaws.medialive#DescribeInputDeviceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#NotFoundException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "Gets the details for the input device", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/inputDevices/{InputDeviceId}", - "code": 200 - } - } - }, - "com.amazonaws.medialive#DescribeInputDeviceRequest": { - "type": "structure", - "members": { - "InputDeviceId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique ID of this input device. For example, hd-123456789abcdef.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } + "com.amazonaws.medialive#DeleteReservationRequest": { + "type": "structure", + "members": { + "ReservationId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeInputDeviceRequest", + "smithy.api#documentation": "Placeholder documentation for DeleteReservationRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DescribeInputDeviceResponse": { + "com.amazonaws.medialive#DeleteReservationResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique ARN of the input device.", + "smithy.api#documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'", "smithy.api#jsonName": "arn" } }, - "ConnectionState": { - "target": "com.amazonaws.medialive#InputDeviceConnectionState", + "Count": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The state of the connection between the input device and AWS.", - "smithy.api#jsonName": "connectionState" + "smithy.api#documentation": "Number of reserved resources", + "smithy.api#jsonName": "count" } }, - "DeviceSettingsSyncState": { - "target": "com.amazonaws.medialive#DeviceSettingsSyncState", + "CurrencyCode": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "deviceSettingsSyncState" + "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", + "smithy.api#jsonName": "currencyCode" } }, - "DeviceUpdateStatus": { - "target": "com.amazonaws.medialive#DeviceUpdateStatus", + "Duration": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The status of software on the input device.", - "smithy.api#jsonName": "deviceUpdateStatus" + "smithy.api#documentation": "Lease duration, e.g. '12'", + "smithy.api#jsonName": "duration" } }, - "HdDeviceSettings": { - "target": "com.amazonaws.medialive#InputDeviceHdSettings", + "DurationUnits": { + "target": "com.amazonaws.medialive#OfferingDurationUnits", "traits": { - "smithy.api#documentation": "Settings that describe an input device that is type HD.", - "smithy.api#jsonName": "hdDeviceSettings" + "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", + "smithy.api#jsonName": "durationUnits" } }, - "Id": { + "End": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique ID of the input device.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'", + "smithy.api#jsonName": "end" } }, - "MacAddress": { - "target": "com.amazonaws.medialive#__string", + "FixedPrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "The network MAC address of the input device.", - "smithy.api#jsonName": "macAddress" + "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", + "smithy.api#jsonName": "fixedPrice" } }, "Name": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "A name that you specify for the input device.", + "smithy.api#documentation": "User specified reservation name", "smithy.api#jsonName": "name" } }, - "NetworkSettings": { - "target": "com.amazonaws.medialive#InputDeviceNetworkSettings", + "OfferingDescription": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The network settings for the input device.", - "smithy.api#jsonName": "networkSettings" + "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", + "smithy.api#jsonName": "offeringDescription" } }, - "SerialNumber": { + "OfferingId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique serial number of the input device.", - "smithy.api#jsonName": "serialNumber" + "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#jsonName": "offeringId" } }, - "Type": { - "target": "com.amazonaws.medialive#InputDeviceType", + "OfferingType": { + "target": "com.amazonaws.medialive#OfferingType", "traits": { - "smithy.api#documentation": "The type of the input device.", - "smithy.api#jsonName": "type" + "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", + "smithy.api#jsonName": "offeringType" } }, - "UhdDeviceSettings": { - "target": "com.amazonaws.medialive#InputDeviceUhdSettings", + "Region": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Settings that describe an input device that is type UHD.", - "smithy.api#jsonName": "uhdDeviceSettings" + "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", + "smithy.api#jsonName": "region" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "RenewalSettings": { + "target": "com.amazonaws.medialive#RenewalSettings", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Renewal settings for the reservation", + "smithy.api#jsonName": "renewalSettings" } }, - "AvailabilityZone": { + "ReservationId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The Availability Zone associated with this input device.", - "smithy.api#jsonName": "availabilityZone" + "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", + "smithy.api#jsonName": "reservationId" } }, - "MedialiveInputArns": { - "target": "com.amazonaws.medialive#__listOf__string", + "ResourceSpecification": { + "target": "com.amazonaws.medialive#ReservationResourceSpecification", "traits": { - "smithy.api#documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.", - "smithy.api#jsonName": "medialiveInputArns" + "smithy.api#documentation": "Resource configuration details", + "smithy.api#jsonName": "resourceSpecification" } }, - "OutputType": { - "target": "com.amazonaws.medialive#InputDeviceOutputType", + "Start": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "outputType" + "smithy.api#documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'", + "smithy.api#jsonName": "start" + } + }, + "State": { + "target": "com.amazonaws.medialive#ReservationState", + "traits": { + "smithy.api#documentation": "Current state of reservation, e.g. 'ACTIVE'", + "smithy.api#jsonName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs", + "smithy.api#jsonName": "tags" + } + }, + "UsagePrice": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", + "smithy.api#jsonName": "usagePrice" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeInputDeviceResponse", + "smithy.api#documentation": "Placeholder documentation for DeleteReservationResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#DescribeInputDeviceThumbnail": { + "com.amazonaws.medialive#DeleteSchedule": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DescribeInputDeviceThumbnailRequest" + "target": "com.amazonaws.medialive#DeleteScheduleRequest" }, "output": { - "target": "com.amazonaws.medialive#DescribeInputDeviceThumbnailResponse" + "target": "com.amazonaws.medialive#DeleteScheduleResponse" }, "errors": [ { @@ -6149,337 +6800,156 @@ } ], "traits": { - "smithy.api#documentation": "Get the latest thumbnail data for the input device.", + "smithy.api#documentation": "Delete all schedule actions on a channel.", "smithy.api#http": { - "method": "GET", - "uri": "/prod/inputDevices/{InputDeviceId}/thumbnailData", + "method": "DELETE", + "uri": "/prod/channels/{ChannelId}/schedule", "code": 200 } } }, - "com.amazonaws.medialive#DescribeInputDeviceThumbnailRequest": { + "com.amazonaws.medialive#DeleteScheduleRequest": { "type": "structure", "members": { - "InputDeviceId": { + "ChannelId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique ID of this input device. For example, hd-123456789abcdef.", + "smithy.api#documentation": "Id of the channel whose schedule is being deleted.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Accept": { - "target": "com.amazonaws.medialive#AcceptHeader", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The HTTP Accept header. Indicates the requested type for the thumbnail.", - "smithy.api#httpHeader": "accept", - "smithy.api#required": {} - } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeInputDeviceThumbnailRequest", + "smithy.api#documentation": "Placeholder documentation for DeleteScheduleRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DescribeInputDeviceThumbnailResponse": { + "com.amazonaws.medialive#DeleteScheduleResponse": { "type": "structure", - "members": { - "Body": { - "target": "com.amazonaws.medialive#InputDeviceThumbnail", - "traits": { - "smithy.api#default": "", - "smithy.api#documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive.", - "smithy.api#httpPayload": {}, - "smithy.api#jsonName": "body" - } - }, - "ContentType": { - "target": "com.amazonaws.medialive#ContentType", - "traits": { - "smithy.api#documentation": "Specifies the media type of the thumbnail.", - "smithy.api#httpHeader": "Content-Type" - } - }, - "ContentLength": { - "target": "com.amazonaws.medialive#__long", - "traits": { - "smithy.api#documentation": "The length of the content.", - "smithy.api#httpHeader": "Content-Length" - } - }, - "ETag": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique, cacheable version of this thumbnail.", - "smithy.api#httpHeader": "ETag" - } - }, - "LastModified": { - "target": "com.amazonaws.medialive#__timestamp", - "traits": { - "smithy.api#documentation": "The date and time the thumbnail was last updated at the device.", - "smithy.api#httpHeader": "Last-Modified" - } - } - }, + "members": {}, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeInputDeviceThumbnailResponse", + "smithy.api#documentation": "Placeholder documentation for DeleteScheduleResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#DescribeInputRequest": { - "type": "structure", - "members": { - "InputId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Unique ID of the input", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } + "com.amazonaws.medialive#DeleteSignalMap": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DeleteSignalMapRequest" }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeInputRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#DescribeInputResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The Unique ARN of the input (generated, immutable).", - "smithy.api#jsonName": "arn" - } - }, - "AttachedChannels": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).", - "smithy.api#jsonName": "attachedChannels" - } - }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfInputDestination", - "traits": { - "smithy.api#documentation": "A list of the destinations of the input (PUSH-type).", - "smithy.api#jsonName": "destinations" - } - }, - "Id": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The generated ID of the input (unique for user account, immutable).", - "smithy.api#jsonName": "id" - } - }, - "InputClass": { - "target": "com.amazonaws.medialive#InputClass", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "inputClass" - } - }, - "InputDevices": { - "target": "com.amazonaws.medialive#__listOfInputDeviceSettings", - "traits": { - "smithy.api#documentation": "Settings for the input devices.", - "smithy.api#jsonName": "inputDevices" - } + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "InputPartnerIds": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "A list of IDs for all Inputs which are partners of this one.", - "smithy.api#jsonName": "inputPartnerIds" - } + { + "target": "com.amazonaws.medialive#ConflictException" }, - "InputSourceType": { - "target": "com.amazonaws.medialive#InputSourceType", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "inputSourceType" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "MediaConnectFlows": { - "target": "com.amazonaws.medialive#__listOfMediaConnectFlow", - "traits": { - "smithy.api#documentation": "A list of MediaConnect Flows for this input.", - "smithy.api#jsonName": "mediaConnectFlows" - } + { + "target": "com.amazonaws.medialive#InternalServerErrorException" }, - "Name": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The user-assigned name (This is a mutable value).", - "smithy.api#jsonName": "name" - } + { + "target": "com.amazonaws.medialive#NotFoundException" }, - "RoleArn": { + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified signal map.", + "smithy.api#http": { + "method": "DELETE", + "uri": "/prod/signal-maps/{Identifier}", + "code": 204 + } + } + }, + "com.amazonaws.medialive#DeleteSignalMapRequest": { + "type": "structure", + "members": { + "Identifier": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation.", - "smithy.api#jsonName": "roleArn" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "A list of IDs for all the Input Security Groups attached to the input.", - "smithy.api#jsonName": "securityGroups" - } - }, - "Sources": { - "target": "com.amazonaws.medialive#__listOfInputSource", - "traits": { - "smithy.api#documentation": "A list of the sources of the input (PULL-type).", - "smithy.api#jsonName": "sources" - } - }, - "State": { - "target": "com.amazonaws.medialive#InputState", - "traits": { - "smithy.api#jsonName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", - "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" - } - }, - "Type": { - "target": "com.amazonaws.medialive#InputType", - "traits": { - "smithy.api#jsonName": "type" + "smithy.api#documentation": "A signal map's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeInputResponse", - "smithy.api#output": {} + "smithy.api#documentation": "Placeholder documentation for DeleteSignalMapRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#DescribeInputSecurityGroup": { + "com.amazonaws.medialive#DeleteTags": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DescribeInputSecurityGroupRequest" + "target": "com.amazonaws.medialive#DeleteTagsRequest" }, "output": { - "target": "com.amazonaws.medialive#DescribeInputSecurityGroupResponse" + "target": "smithy.api#Unit" }, "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, { "target": "com.amazonaws.medialive#BadRequestException" }, { "target": "com.amazonaws.medialive#ForbiddenException" }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, { "target": "com.amazonaws.medialive#InternalServerErrorException" }, { "target": "com.amazonaws.medialive#NotFoundException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Produces a summary of an Input Security Group", + "smithy.api#documentation": "Removes tags for a resource", "smithy.api#http": { - "method": "GET", - "uri": "/prod/inputSecurityGroups/{InputSecurityGroupId}", - "code": 200 + "method": "DELETE", + "uri": "/prod/tags/{ResourceArn}", + "code": 204 } } }, - "com.amazonaws.medialive#DescribeInputSecurityGroupRequest": { + "com.amazonaws.medialive#DeleteTagsRequest": { "type": "structure", "members": { - "InputSecurityGroupId": { + "ResourceArn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The id of the Input Security Group to describe", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeInputSecurityGroupRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#DescribeInputSecurityGroupResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Unique ARN of Input Security Group", - "smithy.api#jsonName": "arn" - } }, - "Id": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The Id of the Input Security Group", - "smithy.api#jsonName": "id" - } - }, - "Inputs": { + "TagKeys": { "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "The list of inputs currently using this Input Security Group.", - "smithy.api#jsonName": "inputs" - } - }, - "State": { - "target": "com.amazonaws.medialive#InputSecurityGroupState", - "traits": { - "smithy.api#documentation": "The current state of the Input Security Group.", - "smithy.api#jsonName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", - "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" - } - }, - "WhitelistRules": { - "target": "com.amazonaws.medialive#__listOfInputWhitelistRule", - "traits": { - "smithy.api#documentation": "Whitelist rules and their sync status", - "smithy.api#jsonName": "whitelistRules" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of tag keys to delete", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeInputSecurityGroupResponse", - "smithy.api#output": {} + "smithy.api#documentation": "Placeholder documentation for DeleteTagsRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#DescribeMultiplex": { + "com.amazonaws.medialive#DescribeAccountConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DescribeMultiplexRequest" + "target": "com.amazonaws.medialive#DescribeAccountConfigurationRequest" }, "output": { - "target": "com.amazonaws.medialive#DescribeMultiplexResponse" + "target": "com.amazonaws.medialive#DescribeAccountConfigurationResponse" }, "errors": [ { @@ -6497,38 +6967,98 @@ { "target": "com.amazonaws.medialive#InternalServerErrorException" }, - { - "target": "com.amazonaws.medialive#NotFoundException" - }, { "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Gets details about a multiplex.", + "smithy.api#documentation": "Describe account configuration", "smithy.api#http": { "method": "GET", - "uri": "/prod/multiplexes/{MultiplexId}", + "uri": "/prod/accountConfiguration", "code": 200 - }, - "smithy.waiters#waitable": { - "MultiplexCreated": { - "documentation": "Wait until a multiplex has been created", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "State", - "expected": "IDLE", - "comparator": "stringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { + } + } + }, + "com.amazonaws.medialive#DescribeAccountConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DescribeAccountConfigurationRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#DescribeAccountConfigurationResponse": { + "type": "structure", + "members": { + "AccountConfiguration": { + "target": "com.amazonaws.medialive#AccountConfiguration", + "traits": { + "smithy.api#jsonName": "accountConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DescribeAccountConfigurationResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#DescribeChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DescribeChannelRequest" + }, + "output": { + "target": "com.amazonaws.medialive#DescribeChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Gets details about a channel", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/channels/{ChannelId}", + "code": 200 + }, + "smithy.waiters#waitable": { + "ChannelCreated": { + "documentation": "Wait until a channel has been created", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "IDLE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { "path": "State", "expected": "CREATING", "comparator": "stringEquals" @@ -6554,8 +7084,8 @@ ], "minDelay": 3 }, - "MultiplexDeleted": { - "documentation": "Wait until a multiplex has been deleted", + "ChannelDeleted": { + "documentation": "Wait until a channel has been deleted", "acceptors": [ { "state": "success", @@ -6586,8 +7116,8 @@ ], "minDelay": 5 }, - "MultiplexRunning": { - "documentation": "Wait until a multiplex is running", + "ChannelRunning": { + "documentation": "Wait until a channel is running", "acceptors": [ { "state": "success", @@ -6618,8 +7148,8 @@ ], "minDelay": 5 }, - "MultiplexStopped": { - "documentation": "Wait until a multiplex has is stopped", + "ChannelStopped": { + "documentation": "Wait until a channel has is stopped", "acceptors": [ { "state": "success", @@ -6653,195 +7183,133 @@ } } }, - "com.amazonaws.medialive#DescribeMultiplexProgram": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#DescribeMultiplexProgramRequest" - }, - "output": { - "target": "com.amazonaws.medialive#DescribeMultiplexProgramResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#NotFoundException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "Get the details for a program in a multiplex.", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/multiplexes/{MultiplexId}/programs/{ProgramName}", - "code": 200 - } - } - }, - "com.amazonaws.medialive#DescribeMultiplexProgramRequest": { + "com.amazonaws.medialive#DescribeChannelRequest": { "type": "structure", "members": { - "MultiplexId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The ID of the multiplex that the program belongs to.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ProgramName": { + "ChannelId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The name of the program.", + "smithy.api#documentation": "channel ID", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeMultiplexProgramRequest", + "smithy.api#documentation": "Placeholder documentation for DescribeChannelRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DescribeMultiplexProgramResponse": { + "com.amazonaws.medialive#DescribeChannelResponse": { "type": "structure", "members": { - "ChannelId": { + "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The MediaLive channel associated with the program.", - "smithy.api#jsonName": "channelId" - } - }, - "MultiplexProgramSettings": { - "target": "com.amazonaws.medialive#MultiplexProgramSettings", - "traits": { - "smithy.api#documentation": "The settings for this multiplex program.", - "smithy.api#jsonName": "multiplexProgramSettings" + "smithy.api#documentation": "The unique arn of the channel.", + "smithy.api#jsonName": "arn" } }, - "PacketIdentifiersMap": { - "target": "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap", + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", "traits": { - "smithy.api#documentation": "The packet identifier map for this multiplex program.", - "smithy.api#jsonName": "packetIdentifiersMap" + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" } }, - "PipelineDetails": { - "target": "com.amazonaws.medialive#__listOfMultiplexProgramPipelineDetail", + "ChannelClass": { + "target": "com.amazonaws.medialive#ChannelClass", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "pipelineDetails" + "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", + "smithy.api#jsonName": "channelClass" } }, - "ProgramName": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The name of the multiplex program.", - "smithy.api#jsonName": "programName" - } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeMultiplexProgramResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#DescribeMultiplexRequest": { - "type": "structure", - "members": { - "MultiplexId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The ID of the multiplex.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeMultiplexRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#DescribeMultiplexResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfOutputDestination", "traits": { - "smithy.api#documentation": "The unique arn of the multiplex.", - "smithy.api#jsonName": "arn" + "smithy.api#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.", + "smithy.api#jsonName": "destinations" } }, - "AvailabilityZones": { - "target": "com.amazonaws.medialive#__listOf__string", + "EgressEndpoints": { + "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", "traits": { - "smithy.api#documentation": "A list of availability zones for the multiplex.", - "smithy.api#jsonName": "availabilityZones" + "smithy.api#documentation": "The endpoints where outgoing connections initiate from", + "smithy.api#jsonName": "egressEndpoints" } }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", + "EncoderSettings": { + "target": "com.amazonaws.medialive#EncoderSettings", "traits": { - "smithy.api#documentation": "A list of the multiplex output destinations.", - "smithy.api#jsonName": "destinations" + "smithy.api#jsonName": "encoderSettings" } }, "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique id of the multiplex.", + "smithy.api#documentation": "The unique id of the channel.", "smithy.api#jsonName": "id" } }, - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexSettings", + "InputAttachments": { + "target": "com.amazonaws.medialive#__listOfInputAttachment", "traits": { - "smithy.api#documentation": "Configuration for a multiplex event.", - "smithy.api#jsonName": "multiplexSettings" + "smithy.api#documentation": "List of input attachments for channel.", + "smithy.api#jsonName": "inputAttachments" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "InputSpecification": { + "target": "com.amazonaws.medialive#InputSpecification", "traits": { - "smithy.api#documentation": "The name of the multiplex.", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "Specification of network and file inputs for this channel", + "smithy.api#jsonName": "inputSpecification" } }, - "PipelinesRunningCount": { + "LogLevel": { + "target": "com.amazonaws.medialive#LogLevel", + "traits": { + "smithy.api#documentation": "The log level being written to CloudWatch Logs.", + "smithy.api#jsonName": "logLevel" + } + }, + "Maintenance": { + "target": "com.amazonaws.medialive#MaintenanceStatus", + "traits": { + "smithy.api#documentation": "Maintenance settings for this channel.", + "smithy.api#jsonName": "maintenance" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the channel. (user-mutable)", + "smithy.api#jsonName": "name" + } + }, + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfPipelineDetail", + "traits": { + "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", + "smithy.api#jsonName": "pipelineDetails" + } + }, + "PipelinesRunningCount": { "target": "com.amazonaws.medialive#__integer", "traits": { "smithy.api#documentation": "The number of currently healthy pipelines.", "smithy.api#jsonName": "pipelinesRunningCount" } }, - "ProgramCount": { - "target": "com.amazonaws.medialive#__integer", + "RoleArn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The number of programs in the multiplex.", - "smithy.api#jsonName": "programCount" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", + "smithy.api#jsonName": "roleArn" } }, "State": { - "target": "com.amazonaws.medialive#MultiplexState", + "target": "com.amazonaws.medialive#ChannelState", "traits": { - "smithy.api#documentation": "The current state of the multiplex.", "smithy.api#jsonName": "state" } }, @@ -6851,20 +7319,27 @@ "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } + }, + "Vpc": { + "target": "com.amazonaws.medialive#VpcOutputSettingsDescription", + "traits": { + "smithy.api#documentation": "Settings for VPC output", + "smithy.api#jsonName": "vpc" + } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeMultiplexResponse", + "smithy.api#documentation": "Placeholder documentation for DescribeChannelResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#DescribeOffering": { + "com.amazonaws.medialive#DescribeInput": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DescribeOfferingRequest" + "target": "com.amazonaws.medialive#DescribeInputRequest" }, "output": { - "target": "com.amazonaws.medialive#DescribeOfferingResponse" + "target": "com.amazonaws.medialive#DescribeInputResponse" }, "errors": [ { @@ -6890,124 +7365,307 @@ } ], "traits": { - "smithy.api#documentation": "Get details for an offering.", + "smithy.api#documentation": "Produces details about an input", "smithy.api#http": { "method": "GET", - "uri": "/prod/offerings/{OfferingId}", + "uri": "/prod/inputs/{InputId}", + "code": 200 + }, + "smithy.waiters#waitable": { + "InputAttached": { + "documentation": "Wait until an input has been attached", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "ATTACHED", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "DETACHED", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InternalServerErrorException" + } + } + ], + "minDelay": 5 + }, + "InputDeleted": { + "documentation": "Wait until an input has been deleted", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "DELETED", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "DELETING", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InternalServerErrorException" + } + } + ], + "minDelay": 5 + }, + "InputDetached": { + "documentation": "Wait until an input has been detached", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "DETACHED", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "CREATING", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "ATTACHED", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InternalServerErrorException" + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.medialive#DescribeInputDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DescribeInputDeviceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#DescribeInputDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the details for the input device", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/inputDevices/{InputDeviceId}", "code": 200 } } }, - "com.amazonaws.medialive#DescribeOfferingRequest": { + "com.amazonaws.medialive#DescribeInputDeviceRequest": { "type": "structure", "members": { - "OfferingId": { + "InputDeviceId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#documentation": "The unique ID of this input device. For example, hd-123456789abcdef.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeOfferingRequest", + "smithy.api#documentation": "Placeholder documentation for DescribeInputDeviceRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DescribeOfferingResponse": { + "com.amazonaws.medialive#DescribeInputDeviceResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'", + "smithy.api#documentation": "The unique ARN of the input device.", "smithy.api#jsonName": "arn" } }, - "CurrencyCode": { - "target": "com.amazonaws.medialive#__string", + "ConnectionState": { + "target": "com.amazonaws.medialive#InputDeviceConnectionState", "traits": { - "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", - "smithy.api#jsonName": "currencyCode" + "smithy.api#documentation": "The state of the connection between the input device and AWS.", + "smithy.api#jsonName": "connectionState" } }, - "Duration": { - "target": "com.amazonaws.medialive#__integer", + "DeviceSettingsSyncState": { + "target": "com.amazonaws.medialive#DeviceSettingsSyncState", "traits": { - "smithy.api#documentation": "Lease duration, e.g. '12'", - "smithy.api#jsonName": "duration" + "smithy.api#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.", + "smithy.api#jsonName": "deviceSettingsSyncState" } }, - "DurationUnits": { - "target": "com.amazonaws.medialive#OfferingDurationUnits", + "DeviceUpdateStatus": { + "target": "com.amazonaws.medialive#DeviceUpdateStatus", "traits": { - "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", - "smithy.api#jsonName": "durationUnits" + "smithy.api#documentation": "The status of software on the input device.", + "smithy.api#jsonName": "deviceUpdateStatus" } }, - "FixedPrice": { - "target": "com.amazonaws.medialive#__double", + "HdDeviceSettings": { + "target": "com.amazonaws.medialive#InputDeviceHdSettings", "traits": { - "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", - "smithy.api#jsonName": "fixedPrice" + "smithy.api#documentation": "Settings that describe an input device that is type HD.", + "smithy.api#jsonName": "hdDeviceSettings" } }, - "OfferingDescription": { + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", - "smithy.api#jsonName": "offeringDescription" - } + "smithy.api#documentation": "The unique ID of the input device.", + "smithy.api#jsonName": "id" + } }, - "OfferingId": { + "MacAddress": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", - "smithy.api#jsonName": "offeringId" + "smithy.api#documentation": "The network MAC address of the input device.", + "smithy.api#jsonName": "macAddress" } }, - "OfferingType": { - "target": "com.amazonaws.medialive#OfferingType", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", - "smithy.api#jsonName": "offeringType" + "smithy.api#documentation": "A name that you specify for the input device.", + "smithy.api#jsonName": "name" } }, - "Region": { + "NetworkSettings": { + "target": "com.amazonaws.medialive#InputDeviceNetworkSettings", + "traits": { + "smithy.api#documentation": "The network settings for the input device.", + "smithy.api#jsonName": "networkSettings" + } + }, + "SerialNumber": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", - "smithy.api#jsonName": "region" + "smithy.api#documentation": "The unique serial number of the input device.", + "smithy.api#jsonName": "serialNumber" } }, - "ResourceSpecification": { - "target": "com.amazonaws.medialive#ReservationResourceSpecification", + "Type": { + "target": "com.amazonaws.medialive#InputDeviceType", "traits": { - "smithy.api#documentation": "Resource configuration details", - "smithy.api#jsonName": "resourceSpecification" + "smithy.api#documentation": "The type of the input device.", + "smithy.api#jsonName": "type" } }, - "UsagePrice": { - "target": "com.amazonaws.medialive#__double", + "UhdDeviceSettings": { + "target": "com.amazonaws.medialive#InputDeviceUhdSettings", "traits": { - "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", - "smithy.api#jsonName": "usagePrice" + "smithy.api#documentation": "Settings that describe an input device that is type UHD.", + "smithy.api#jsonName": "uhdDeviceSettings" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Availability Zone associated with this input device.", + "smithy.api#jsonName": "availabilityZone" + } + }, + "MedialiveInputArns": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.", + "smithy.api#jsonName": "medialiveInputArns" + } + }, + "OutputType": { + "target": "com.amazonaws.medialive#InputDeviceOutputType", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "outputType" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeOfferingResponse", + "smithy.api#documentation": "Placeholder documentation for DescribeInputDeviceResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#DescribeReservation": { + "com.amazonaws.medialive#DescribeInputDeviceThumbnail": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DescribeReservationRequest" + "target": "com.amazonaws.medialive#DescribeInputDeviceThumbnailRequest" }, "output": { - "target": "com.amazonaws.medialive#DescribeReservationResponse" + "target": "com.amazonaws.medialive#DescribeInputDeviceThumbnailResponse" }, "errors": [ { @@ -7033,180 +7691,229 @@ } ], "traits": { - "smithy.api#documentation": "Get details for a reservation.", + "smithy.api#documentation": "Get the latest thumbnail data for the input device.", "smithy.api#http": { "method": "GET", - "uri": "/prod/reservations/{ReservationId}", + "uri": "/prod/inputDevices/{InputDeviceId}/thumbnailData", "code": 200 } } }, - "com.amazonaws.medialive#DescribeReservationRequest": { + "com.amazonaws.medialive#DescribeInputDeviceThumbnailRequest": { "type": "structure", "members": { - "ReservationId": { + "InputDeviceId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", + "smithy.api#documentation": "The unique ID of this input device. For example, hd-123456789abcdef.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Accept": { + "target": "com.amazonaws.medialive#AcceptHeader", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The HTTP Accept header. Indicates the requested type for the thumbnail.", + "smithy.api#httpHeader": "accept", + "smithy.api#required": {} + } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeReservationRequest", + "smithy.api#documentation": "Placeholder documentation for DescribeInputDeviceThumbnailRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DescribeReservationResponse": { + "com.amazonaws.medialive#DescribeInputDeviceThumbnailResponse": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", + "Body": { + "target": "com.amazonaws.medialive#InputDeviceThumbnail", "traits": { - "smithy.api#documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'", - "smithy.api#jsonName": "arn" + "smithy.api#default": "", + "smithy.api#documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive.", + "smithy.api#httpPayload": {}, + "smithy.api#jsonName": "body" } }, - "Count": { - "target": "com.amazonaws.medialive#__integer", + "ContentType": { + "target": "com.amazonaws.medialive#ContentType", "traits": { - "smithy.api#documentation": "Number of reserved resources", - "smithy.api#jsonName": "count" + "smithy.api#documentation": "Specifies the media type of the thumbnail.", + "smithy.api#httpHeader": "Content-Type" } }, - "CurrencyCode": { - "target": "com.amazonaws.medialive#__string", + "ContentLength": { + "target": "com.amazonaws.medialive#__long", "traits": { - "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", - "smithy.api#jsonName": "currencyCode" + "smithy.api#documentation": "The length of the content.", + "smithy.api#httpHeader": "Content-Length" } }, - "Duration": { - "target": "com.amazonaws.medialive#__integer", + "ETag": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Lease duration, e.g. '12'", - "smithy.api#jsonName": "duration" + "smithy.api#documentation": "The unique, cacheable version of this thumbnail.", + "smithy.api#httpHeader": "ETag" } }, - "DurationUnits": { - "target": "com.amazonaws.medialive#OfferingDurationUnits", + "LastModified": { + "target": "com.amazonaws.medialive#__timestamp", "traits": { - "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", - "smithy.api#jsonName": "durationUnits" + "smithy.api#documentation": "The date and time the thumbnail was last updated at the device.", + "smithy.api#httpHeader": "Last-Modified" } - }, - "End": { + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DescribeInputDeviceThumbnailResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#DescribeInputRequest": { + "type": "structure", + "members": { + "InputId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'", - "smithy.api#jsonName": "end" + "smithy.api#documentation": "Unique ID of the input", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - }, - "FixedPrice": { - "target": "com.amazonaws.medialive#__double", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DescribeInputRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#DescribeInputResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", - "smithy.api#jsonName": "fixedPrice" + "smithy.api#documentation": "The Unique ARN of the input (generated, immutable).", + "smithy.api#jsonName": "arn" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "AttachedChannels": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "User specified reservation name", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).", + "smithy.api#jsonName": "attachedChannels" } }, - "OfferingDescription": { - "target": "com.amazonaws.medialive#__string", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfInputDestination", "traits": { - "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", - "smithy.api#jsonName": "offeringDescription" + "smithy.api#documentation": "A list of the destinations of the input (PUSH-type).", + "smithy.api#jsonName": "destinations" } }, - "OfferingId": { + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", - "smithy.api#jsonName": "offeringId" + "smithy.api#documentation": "The generated ID of the input (unique for user account, immutable).", + "smithy.api#jsonName": "id" } }, - "OfferingType": { - "target": "com.amazonaws.medialive#OfferingType", + "InputClass": { + "target": "com.amazonaws.medialive#InputClass", "traits": { - "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", - "smithy.api#jsonName": "offeringType" + "smithy.api#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.", + "smithy.api#jsonName": "inputClass" } }, - "Region": { - "target": "com.amazonaws.medialive#__string", + "InputDevices": { + "target": "com.amazonaws.medialive#__listOfInputDeviceSettings", "traits": { - "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", - "smithy.api#jsonName": "region" + "smithy.api#documentation": "Settings for the input devices.", + "smithy.api#jsonName": "inputDevices" } }, - "RenewalSettings": { - "target": "com.amazonaws.medialive#RenewalSettings", + "InputPartnerIds": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "Renewal settings for the reservation", - "smithy.api#jsonName": "renewalSettings" + "smithy.api#documentation": "A list of IDs for all Inputs which are partners of this one.", + "smithy.api#jsonName": "inputPartnerIds" } }, - "ReservationId": { - "target": "com.amazonaws.medialive#__string", + "InputSourceType": { + "target": "com.amazonaws.medialive#InputSourceType", "traits": { - "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", - "smithy.api#jsonName": "reservationId" + "smithy.api#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.", + "smithy.api#jsonName": "inputSourceType" } }, - "ResourceSpecification": { - "target": "com.amazonaws.medialive#ReservationResourceSpecification", + "MediaConnectFlows": { + "target": "com.amazonaws.medialive#__listOfMediaConnectFlow", "traits": { - "smithy.api#documentation": "Resource configuration details", - "smithy.api#jsonName": "resourceSpecification" + "smithy.api#documentation": "A list of MediaConnect Flows for this input.", + "smithy.api#jsonName": "mediaConnectFlows" } }, - "Start": { + "Name": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'", - "smithy.api#jsonName": "start" + "smithy.api#documentation": "The user-assigned name (This is a mutable value).", + "smithy.api#jsonName": "name" } }, - "State": { - "target": "com.amazonaws.medialive#ReservationState", + "RoleArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation.", + "smithy.api#jsonName": "roleArn" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "A list of IDs for all the Input Security Groups attached to the input.", + "smithy.api#jsonName": "securityGroups" + } + }, + "Sources": { + "target": "com.amazonaws.medialive#__listOfInputSource", + "traits": { + "smithy.api#documentation": "A list of the sources of the input (PULL-type).", + "smithy.api#jsonName": "sources" + } + }, + "State": { + "target": "com.amazonaws.medialive#InputState", "traits": { - "smithy.api#documentation": "Current state of reservation, e.g. 'ACTIVE'", "smithy.api#jsonName": "state" } }, "Tags": { "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "A collection of key-value pairs", + "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } }, - "UsagePrice": { - "target": "com.amazonaws.medialive#__double", + "Type": { + "target": "com.amazonaws.medialive#InputType", "traits": { - "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", - "smithy.api#jsonName": "usagePrice" + "smithy.api#jsonName": "type" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeReservationResponse", + "smithy.api#documentation": "Placeholder documentation for DescribeInputResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#DescribeSchedule": { + "com.amazonaws.medialive#DescribeInputSecurityGroup": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DescribeScheduleRequest" + "target": "com.amazonaws.medialive#DescribeInputSecurityGroupRequest" }, "output": { - "target": "com.amazonaws.medialive#DescribeScheduleResponse" + "target": "com.amazonaws.medialive#DescribeInputSecurityGroupResponse" }, "errors": [ { @@ -7232,79 +7939,89 @@ } ], "traits": { - "smithy.api#documentation": "Get a channel schedule", + "smithy.api#documentation": "Produces a summary of an Input Security Group", "smithy.api#http": { "method": "GET", - "uri": "/prod/channels/{ChannelId}/schedule", + "uri": "/prod/inputSecurityGroups/{InputSecurityGroupId}", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ScheduleActions", - "pageSize": "MaxResults" } } }, - "com.amazonaws.medialive#DescribeScheduleRequest": { + "com.amazonaws.medialive#DescribeInputSecurityGroupRequest": { "type": "structure", "members": { - "ChannelId": { + "InputSecurityGroupId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Id of the channel whose schedule is being updated.", + "smithy.api#documentation": "The id of the Input Security Group to describe", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", - "traits": { - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#httpQuery": "nextToken" - } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeScheduleRequest", + "smithy.api#documentation": "Placeholder documentation for DescribeInputSecurityGroupRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#DescribeScheduleResponse": { + "com.amazonaws.medialive#DescribeInputSecurityGroupResponse": { "type": "structure", "members": { - "NextToken": { + "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The next token; for use in pagination.", - "smithy.api#jsonName": "nextToken" + "smithy.api#documentation": "Unique ARN of Input Security Group", + "smithy.api#jsonName": "arn" } }, - "ScheduleActions": { - "target": "com.amazonaws.medialive#__listOfScheduleAction", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The list of actions in the schedule.", - "smithy.api#jsonName": "scheduleActions" + "smithy.api#documentation": "The Id of the Input Security Group", + "smithy.api#jsonName": "id" + } + }, + "Inputs": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "The list of inputs currently using this Input Security Group.", + "smithy.api#jsonName": "inputs" + } + }, + "State": { + "target": "com.amazonaws.medialive#InputSecurityGroupState", + "traits": { + "smithy.api#documentation": "The current state of the Input Security Group.", + "smithy.api#jsonName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + }, + "WhitelistRules": { + "target": "com.amazonaws.medialive#__listOfInputWhitelistRule", + "traits": { + "smithy.api#documentation": "Whitelist rules and their sync status", + "smithy.api#jsonName": "whitelistRules" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeScheduleResponse", + "smithy.api#documentation": "Placeholder documentation for DescribeInputSecurityGroupResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#DescribeThumbnails": { + "com.amazonaws.medialive#DescribeMultiplex": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#DescribeThumbnailsRequest" + "target": "com.amazonaws.medialive#DescribeMultiplexRequest" }, "output": { - "target": "com.amazonaws.medialive#DescribeThumbnailsResponse" + "target": "com.amazonaws.medialive#DescribeMultiplexResponse" }, "errors": [ { @@ -7313,9 +8030,6 @@ { "target": "com.amazonaws.medialive#BadRequestException" }, - { - "target": "com.amazonaws.medialive#ConflictException" - }, { "target": "com.amazonaws.medialive#ForbiddenException" }, @@ -7333,1476 +8047,1808 @@ } ], "traits": { - "smithy.api#documentation": "Describe the latest thumbnails data.", + "smithy.api#documentation": "Gets details about a multiplex.", "smithy.api#http": { "method": "GET", - "uri": "/prod/channels/{ChannelId}/thumbnails", + "uri": "/prod/multiplexes/{MultiplexId}", "code": 200 - } - } - }, - "com.amazonaws.medialive#DescribeThumbnailsRequest": { - "type": "structure", - "members": { - "ChannelId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Unique ID of the channel", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PipelineId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Pipeline ID (\"0\" or \"1\")", - "smithy.api#httpQuery": "pipelineId", - "smithy.api#required": {} - } - }, - "ThumbnailType": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "thumbnail type", - "smithy.api#httpQuery": "thumbnailType", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeThumbnailsRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#DescribeThumbnailsResponse": { - "type": "structure", - "members": { - "ThumbnailDetails": { - "target": "com.amazonaws.medialive#__listOfThumbnailDetail", - "traits": { - "smithy.api#jsonName": "thumbnailDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for DescribeThumbnailsResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#DeviceSettingsSyncState": { - "type": "enum", - "members": { - "SYNCED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SYNCED" - } - }, - "SYNCING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SYNCING" - } - } - }, - "traits": { - "smithy.api#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." - } - }, - "com.amazonaws.medialive#DeviceUpdateStatus": { - "type": "enum", - "members": { - "UP_TO_DATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UP_TO_DATE" - } - }, - "NOT_UP_TO_DATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_UP_TO_DATE" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - } - }, - "traits": { - "smithy.api#documentation": "The status of software on the input device." - } - }, - "com.amazonaws.medialive#DolbyEProgramSelection": { - "type": "enum", - "members": { - "ALL_CHANNELS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_CHANNELS" - } - }, - "PROGRAM_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROGRAM_1" - } - }, - "PROGRAM_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROGRAM_2" - } - }, - "PROGRAM_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROGRAM_3" - } }, - "PROGRAM_4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROGRAM_4" + "smithy.waiters#waitable": { + "MultiplexCreated": { + "documentation": "Wait until a multiplex has been created", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "IDLE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "CREATING", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InternalServerErrorException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "State", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 3 + }, + "MultiplexDeleted": { + "documentation": "Wait until a multiplex has been deleted", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "DELETED", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "DELETING", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InternalServerErrorException" + } + } + ], + "minDelay": 5 + }, + "MultiplexRunning": { + "documentation": "Wait until a multiplex is running", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "RUNNING", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "STARTING", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InternalServerErrorException" + } + } + ], + "minDelay": 5 + }, + "MultiplexStopped": { + "documentation": "Wait until a multiplex has is stopped", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "IDLE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "STOPPING", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InternalServerErrorException" + } + } + ], + "minDelay": 5 } + } + } + }, + "com.amazonaws.medialive#DescribeMultiplexProgram": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DescribeMultiplexProgramRequest" + }, + "output": { + "target": "com.amazonaws.medialive#DescribeMultiplexProgramResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "PROGRAM_5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROGRAM_5" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "PROGRAM_6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROGRAM_6" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "PROGRAM_7": { - "target": "smithy.api#Unit", + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Get the details for a program in a multiplex.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/multiplexes/{MultiplexId}/programs/{ProgramName}", + "code": 200 + } + } + }, + "com.amazonaws.medialive#DescribeMultiplexProgramRequest": { + "type": "structure", + "members": { + "MultiplexId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "PROGRAM_7" + "smithy.api#documentation": "The ID of the multiplex that the program belongs to.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "PROGRAM_8": { - "target": "smithy.api#Unit", + "ProgramName": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "PROGRAM_8" + "smithy.api#documentation": "The name of the program.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Dolby EProgram Selection" + "smithy.api#documentation": "Placeholder documentation for DescribeMultiplexProgramRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#DolbyVision81Settings": { + "com.amazonaws.medialive#DescribeMultiplexProgramResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Dolby Vision81 Settings" - } - }, - "com.amazonaws.medialive#DvbDashAccessibility": { - "type": "enum", "members": { - "DVBDASH_1_VISUALLY_IMPAIRED": { - "target": "smithy.api#Unit", + "ChannelId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "DVBDASH_1_VISUALLY_IMPAIRED" + "smithy.api#documentation": "The MediaLive channel associated with the program.", + "smithy.api#jsonName": "channelId" } }, - "DVBDASH_2_HARD_OF_HEARING": { - "target": "smithy.api#Unit", + "MultiplexProgramSettings": { + "target": "com.amazonaws.medialive#MultiplexProgramSettings", "traits": { - "smithy.api#enumValue": "DVBDASH_2_HARD_OF_HEARING" + "smithy.api#documentation": "The settings for this multiplex program.", + "smithy.api#jsonName": "multiplexProgramSettings" } }, - "DVBDASH_3_SUPPLEMENTAL_COMMENTARY": { - "target": "smithy.api#Unit", + "PacketIdentifiersMap": { + "target": "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap", "traits": { - "smithy.api#enumValue": "DVBDASH_3_SUPPLEMENTAL_COMMENTARY" + "smithy.api#documentation": "The packet identifier map for this multiplex program.", + "smithy.api#jsonName": "packetIdentifiersMap" } }, - "DVBDASH_4_DIRECTORS_COMMENTARY": { - "target": "smithy.api#Unit", + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfMultiplexProgramPipelineDetail", "traits": { - "smithy.api#enumValue": "DVBDASH_4_DIRECTORS_COMMENTARY" + "smithy.api#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.", + "smithy.api#jsonName": "pipelineDetails" } }, - "DVBDASH_5_EDUCATIONAL_NOTES": { - "target": "smithy.api#Unit", + "ProgramName": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "DVBDASH_5_EDUCATIONAL_NOTES" - } - }, - "DVBDASH_6_MAIN_PROGRAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DVBDASH_6_MAIN_PROGRAM" - } - }, - "DVBDASH_7_CLEAN_FEED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DVBDASH_7_CLEAN_FEED" + "smithy.api#documentation": "The name of the multiplex program.", + "smithy.api#jsonName": "programName" } } }, "traits": { - "smithy.api#documentation": "Dvb Dash Accessibility" + "smithy.api#documentation": "Placeholder documentation for DescribeMultiplexProgramResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#DvbNitSettings": { + "com.amazonaws.medialive#DescribeMultiplexRequest": { "type": "structure", "members": { - "NetworkId": { - "target": "com.amazonaws.medialive#__integerMin0Max65536", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The numeric value placed in the Network Information Table (NIT).", - "smithy.api#jsonName": "networkId", - "smithy.api#required": {} - } - }, - "NetworkName": { - "target": "com.amazonaws.medialive#__stringMin1Max256", + "MultiplexId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.", - "smithy.api#jsonName": "networkName", + "smithy.api#documentation": "The ID of the multiplex.", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "RepInterval": { - "target": "com.amazonaws.medialive#__integerMin25Max10000", - "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", - "smithy.api#jsonName": "repInterval" - } } }, "traits": { - "smithy.api#documentation": "DVB Network Information Table (NIT)" + "smithy.api#documentation": "Placeholder documentation for DescribeMultiplexRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#DvbSdtOutputSdt": { - "type": "enum", + "com.amazonaws.medialive#DescribeMultiplexResponse": { + "type": "structure", "members": { - "SDT_FOLLOW": { - "target": "smithy.api#Unit", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "SDT_FOLLOW" + "smithy.api#documentation": "The unique arn of the multiplex.", + "smithy.api#jsonName": "arn" } }, - "SDT_FOLLOW_IF_PRESENT": { - "target": "smithy.api#Unit", + "AvailabilityZones": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#enumValue": "SDT_FOLLOW_IF_PRESENT" + "smithy.api#documentation": "A list of availability zones for the multiplex.", + "smithy.api#jsonName": "availabilityZones" } }, - "SDT_MANUAL": { - "target": "smithy.api#Unit", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", "traits": { - "smithy.api#enumValue": "SDT_MANUAL" + "smithy.api#documentation": "A list of the multiplex output destinations.", + "smithy.api#jsonName": "destinations" } }, - "SDT_NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SDT_NONE" - } - } - }, - "traits": { - "smithy.api#documentation": "Dvb Sdt Output Sdt" - } - }, - "com.amazonaws.medialive#DvbSdtSettings": { - "type": "structure", - "members": { - "OutputSdt": { - "target": "com.amazonaws.medialive#DvbSdtOutputSdt", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "outputSdt" + "smithy.api#documentation": "The unique id of the multiplex.", + "smithy.api#jsonName": "id" } }, - "RepInterval": { - "target": "com.amazonaws.medialive#__integerMin25Max2000", + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexSettings", "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", - "smithy.api#jsonName": "repInterval" + "smithy.api#documentation": "Configuration for a multiplex event.", + "smithy.api#jsonName": "multiplexSettings" } }, - "ServiceName": { - "target": "com.amazonaws.medialive#__stringMin1Max256", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.", - "smithy.api#jsonName": "serviceName" + "smithy.api#documentation": "The name of the multiplex.", + "smithy.api#jsonName": "name" } }, - "ServiceProviderName": { - "target": "com.amazonaws.medialive#__stringMin1Max256", + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.", - "smithy.api#jsonName": "serviceProviderName" + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" } - } - }, - "traits": { - "smithy.api#documentation": "DVB Service Description Table (SDT)" - } - }, - "com.amazonaws.medialive#DvbSubDestinationAlignment": { - "type": "enum", - "members": { - "CENTERED": { - "target": "smithy.api#Unit", + }, + "ProgramCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#enumValue": "CENTERED" + "smithy.api#documentation": "The number of programs in the multiplex.", + "smithy.api#jsonName": "programCount" } }, - "LEFT": { - "target": "smithy.api#Unit", + "State": { + "target": "com.amazonaws.medialive#MultiplexState", "traits": { - "smithy.api#enumValue": "LEFT" + "smithy.api#documentation": "The current state of the multiplex.", + "smithy.api#jsonName": "state" } }, - "SMART": { - "target": "smithy.api#Unit", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#enumValue": "SMART" + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "Dvb Sub Destination Alignment" + "smithy.api#documentation": "Placeholder documentation for DescribeMultiplexResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#DvbSubDestinationBackgroundColor": { - "type": "enum", - "members": { - "BLACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BLACK" - } + "com.amazonaws.medialive#DescribeOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DescribeOfferingRequest" + }, + "output": { + "target": "com.amazonaws.medialive#DescribeOfferingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "WHITE": { - "target": "smithy.api#Unit", + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Get details for an offering.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/offerings/{OfferingId}", + "code": 200 + } + } + }, + "com.amazonaws.medialive#DescribeOfferingRequest": { + "type": "structure", + "members": { + "OfferingId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "WHITE" + "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Dvb Sub Destination Background Color" + "smithy.api#documentation": "Placeholder documentation for DescribeOfferingRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#DvbSubDestinationFontColor": { - "type": "enum", + "com.amazonaws.medialive#DescribeOfferingResponse": { + "type": "structure", "members": { - "BLACK": { - "target": "smithy.api#Unit", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "BLACK" + "smithy.api#documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'", + "smithy.api#jsonName": "arn" } }, - "BLUE": { - "target": "smithy.api#Unit", + "CurrencyCode": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "BLUE" + "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", + "smithy.api#jsonName": "currencyCode" } }, - "GREEN": { - "target": "smithy.api#Unit", + "Duration": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#enumValue": "GREEN" + "smithy.api#documentation": "Lease duration, e.g. '12'", + "smithy.api#jsonName": "duration" } }, - "RED": { - "target": "smithy.api#Unit", + "DurationUnits": { + "target": "com.amazonaws.medialive#OfferingDurationUnits", "traits": { - "smithy.api#enumValue": "RED" + "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", + "smithy.api#jsonName": "durationUnits" } }, - "WHITE": { - "target": "smithy.api#Unit", + "FixedPrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#enumValue": "WHITE" + "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", + "smithy.api#jsonName": "fixedPrice" } }, - "YELLOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "YELLOW" + "OfferingDescription": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", + "smithy.api#jsonName": "offeringDescription" } - } - }, - "traits": { - "smithy.api#documentation": "Dvb Sub Destination Font Color" - } - }, - "com.amazonaws.medialive#DvbSubDestinationOutlineColor": { - "type": "enum", - "members": { - "BLACK": { - "target": "smithy.api#Unit", + }, + "OfferingId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "BLACK" + "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#jsonName": "offeringId" } }, - "BLUE": { - "target": "smithy.api#Unit", + "OfferingType": { + "target": "com.amazonaws.medialive#OfferingType", "traits": { - "smithy.api#enumValue": "BLUE" + "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", + "smithy.api#jsonName": "offeringType" } }, - "GREEN": { - "target": "smithy.api#Unit", + "Region": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "GREEN" + "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", + "smithy.api#jsonName": "region" } }, - "RED": { - "target": "smithy.api#Unit", + "ResourceSpecification": { + "target": "com.amazonaws.medialive#ReservationResourceSpecification", "traits": { - "smithy.api#enumValue": "RED" + "smithy.api#documentation": "Resource configuration details", + "smithy.api#jsonName": "resourceSpecification" } }, - "WHITE": { - "target": "smithy.api#Unit", + "UsagePrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#enumValue": "WHITE" + "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", + "smithy.api#jsonName": "usagePrice" } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DescribeOfferingResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#DescribeReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DescribeReservationRequest" + }, + "output": { + "target": "com.amazonaws.medialive#DescribeReservationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "YELLOW": { - "target": "smithy.api#Unit", + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Get details for a reservation.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/reservations/{ReservationId}", + "code": 200 + } + } + }, + "com.amazonaws.medialive#DescribeReservationRequest": { + "type": "structure", + "members": { + "ReservationId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "YELLOW" + "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Dvb Sub Destination Outline Color" + "smithy.api#documentation": "Placeholder documentation for DescribeReservationRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#DvbSubDestinationSettings": { + "com.amazonaws.medialive#DescribeReservationResponse": { "type": "structure", "members": { - "Alignment": { - "target": "com.amazonaws.medialive#DvbSubDestinationAlignment", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "alignment" + "smithy.api#documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'", + "smithy.api#jsonName": "arn" } }, - "BackgroundColor": { - "target": "com.amazonaws.medialive#DvbSubDestinationBackgroundColor", + "Count": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "backgroundColor" + "smithy.api#documentation": "Number of reserved resources", + "smithy.api#jsonName": "count" } }, - "BackgroundOpacity": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "CurrencyCode": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "backgroundOpacity" + "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", + "smithy.api#jsonName": "currencyCode" } }, - "Font": { - "target": "com.amazonaws.medialive#InputLocation", + "Duration": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "font" + "smithy.api#documentation": "Lease duration, e.g. '12'", + "smithy.api#jsonName": "duration" } }, - "FontColor": { - "target": "com.amazonaws.medialive#DvbSubDestinationFontColor", + "DurationUnits": { + "target": "com.amazonaws.medialive#OfferingDurationUnits", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "fontColor" + "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", + "smithy.api#jsonName": "durationUnits" } }, - "FontOpacity": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "End": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "fontOpacity" + "smithy.api#documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'", + "smithy.api#jsonName": "end" } }, - "FontResolution": { - "target": "com.amazonaws.medialive#__integerMin96Max600", + "FixedPrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontResolution" + "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", + "smithy.api#jsonName": "fixedPrice" } }, - "FontSize": { + "Name": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "fontSize" + "smithy.api#documentation": "User specified reservation name", + "smithy.api#jsonName": "name" } }, - "OutlineColor": { - "target": "com.amazonaws.medialive#DvbSubDestinationOutlineColor", + "OfferingDescription": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "outlineColor" + "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", + "smithy.api#jsonName": "offeringDescription" } }, - "OutlineSize": { - "target": "com.amazonaws.medialive#__integerMin0Max10", + "OfferingId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "outlineSize" + "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#jsonName": "offeringId" } }, - "ShadowColor": { - "target": "com.amazonaws.medialive#DvbSubDestinationShadowColor", + "OfferingType": { + "target": "com.amazonaws.medialive#OfferingType", "traits": { - "smithy.api#documentation": "Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowColor" + "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", + "smithy.api#jsonName": "offeringType" } }, - "ShadowOpacity": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "Region": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "shadowOpacity" + "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", + "smithy.api#jsonName": "region" } }, - "ShadowXOffset": { - "target": "com.amazonaws.medialive#__integer", + "RenewalSettings": { + "target": "com.amazonaws.medialive#RenewalSettings", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "shadowXOffset" + "smithy.api#documentation": "Renewal settings for the reservation", + "smithy.api#jsonName": "renewalSettings" } }, - "ShadowYOffset": { - "target": "com.amazonaws.medialive#__integer", + "ReservationId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "shadowYOffset" + "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", + "smithy.api#jsonName": "reservationId" } }, - "TeletextGridControl": { - "target": "com.amazonaws.medialive#DvbSubDestinationTeletextGridControl", + "ResourceSpecification": { + "target": "com.amazonaws.medialive#ReservationResourceSpecification", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "teletextGridControl" + "smithy.api#documentation": "Resource configuration details", + "smithy.api#jsonName": "resourceSpecification" } }, - "XPosition": { - "target": "com.amazonaws.medialive#__integerMin0", + "Start": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "xPosition" + "smithy.api#documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'", + "smithy.api#jsonName": "start" } }, - "YPosition": { - "target": "com.amazonaws.medialive#__integerMin0", + "State": { + "target": "com.amazonaws.medialive#ReservationState", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "yPosition" - } - } - }, - "traits": { - "smithy.api#documentation": "Dvb Sub Destination Settings" - } - }, - "com.amazonaws.medialive#DvbSubDestinationShadowColor": { - "type": "enum", - "members": { - "BLACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BLACK" + "smithy.api#documentation": "Current state of reservation, e.g. 'ACTIVE'", + "smithy.api#jsonName": "state" } }, - "NONE": { - "target": "smithy.api#Unit", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#documentation": "A collection of key-value pairs", + "smithy.api#jsonName": "tags" } }, - "WHITE": { - "target": "smithy.api#Unit", + "UsagePrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#enumValue": "WHITE" + "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", + "smithy.api#jsonName": "usagePrice" } } }, "traits": { - "smithy.api#documentation": "Dvb Sub Destination Shadow Color" + "smithy.api#documentation": "Placeholder documentation for DescribeReservationResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#DvbSubDestinationTeletextGridControl": { - "type": "enum", + "com.amazonaws.medialive#DescribeSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DescribeScheduleRequest" + }, + "output": { + "target": "com.amazonaws.medialive#DescribeScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Get a channel schedule", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/channels/{ChannelId}/schedule", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScheduleActions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#DescribeScheduleRequest": { + "type": "structure", "members": { - "FIXED": { - "target": "smithy.api#Unit", + "ChannelId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "FIXED" + "smithy.api#documentation": "Id of the channel whose schedule is being updated.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "SCALED": { - "target": "smithy.api#Unit", + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", "traits": { - "smithy.api#enumValue": "SCALED" + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#httpQuery": "nextToken" } } }, "traits": { - "smithy.api#documentation": "Dvb Sub Destination Teletext Grid Control" + "smithy.api#documentation": "Placeholder documentation for DescribeScheduleRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#DvbSubOcrLanguage": { - "type": "enum", + "com.amazonaws.medialive#DescribeScheduleResponse": { + "type": "structure", "members": { - "DEU": { - "target": "smithy.api#Unit", + "NextToken": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "DEU" + "smithy.api#documentation": "The next token; for use in pagination.", + "smithy.api#jsonName": "nextToken" } }, - "ENG": { - "target": "smithy.api#Unit", + "ScheduleActions": { + "target": "com.amazonaws.medialive#__listOfScheduleAction", "traits": { - "smithy.api#enumValue": "ENG" + "smithy.api#documentation": "The list of actions in the schedule.", + "smithy.api#jsonName": "scheduleActions" } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DescribeScheduleResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#DescribeThumbnails": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DescribeThumbnailsRequest" + }, + "output": { + "target": "com.amazonaws.medialive#DescribeThumbnailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "FRA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FRA" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "NLD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NLD" - } + { + "target": "com.amazonaws.medialive#ConflictException" }, - "POR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POR" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "SPA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPA" - } + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" } - }, + ], "traits": { - "smithy.api#documentation": "Dvb Sub Ocr Language" + "smithy.api#documentation": "Describe the latest thumbnails data.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/channels/{ChannelId}/thumbnails", + "code": 200 + } } }, - "com.amazonaws.medialive#DvbSubSourceSettings": { + "com.amazonaws.medialive#DescribeThumbnailsRequest": { "type": "structure", "members": { - "OcrLanguage": { - "target": "com.amazonaws.medialive#DvbSubOcrLanguage", + "ChannelId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "ocrLanguage" + "smithy.api#documentation": "Unique ID of the channel", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "Pid": { - "target": "com.amazonaws.medialive#__integerMin1", + "PipelineId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "pid" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Pipeline ID (\"0\" or \"1\")", + "smithy.api#httpQuery": "pipelineId", + "smithy.api#required": {} + } + }, + "ThumbnailType": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "thumbnail type", + "smithy.api#httpQuery": "thumbnailType", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Dvb Sub Source Settings" + "smithy.api#documentation": "Placeholder documentation for DescribeThumbnailsRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#DvbTdtSettings": { + "com.amazonaws.medialive#DescribeThumbnailsResponse": { "type": "structure", "members": { - "RepInterval": { - "target": "com.amazonaws.medialive#__integerMin1000Max30000", + "ThumbnailDetails": { + "target": "com.amazonaws.medialive#__listOfThumbnailDetail", "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", - "smithy.api#jsonName": "repInterval" + "smithy.api#jsonName": "thumbnailDetails" } } }, "traits": { - "smithy.api#documentation": "DVB Time and Date Table (SDT)" + "smithy.api#documentation": "Placeholder documentation for DescribeThumbnailsResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#Eac3AtmosCodingMode": { + "com.amazonaws.medialive#DeviceSettingsSyncState": { "type": "enum", "members": { - "CODING_MODE_5_1_4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CODING_MODE_5_1_4" - } - }, - "CODING_MODE_7_1_4": { + "SYNCED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CODING_MODE_7_1_4" + "smithy.api#enumValue": "SYNCED" } }, - "CODING_MODE_9_1_6": { + "SYNCING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CODING_MODE_9_1_6" + "smithy.api#enumValue": "SYNCING" } } }, "traits": { - "smithy.api#documentation": "Eac3 Atmos Coding Mode" + "smithy.api#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." } }, - "com.amazonaws.medialive#Eac3AtmosDrcLine": { + "com.amazonaws.medialive#DeviceUpdateStatus": { "type": "enum", "members": { - "FILM_LIGHT": { + "UP_TO_DATE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FILM_LIGHT" + "smithy.api#enumValue": "UP_TO_DATE" } }, - "FILM_STANDARD": { + "NOT_UP_TO_DATE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FILM_STANDARD" + "smithy.api#enumValue": "NOT_UP_TO_DATE" } }, - "MUSIC_LIGHT": { + "UPDATING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MUSIC_LIGHT" + "smithy.api#enumValue": "UPDATING" } - }, - "MUSIC_STANDARD": { + } + }, + "traits": { + "smithy.api#documentation": "The status of software on the input device." + } + }, + "com.amazonaws.medialive#DolbyEProgramSelection": { + "type": "enum", + "members": { + "ALL_CHANNELS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MUSIC_STANDARD" + "smithy.api#enumValue": "ALL_CHANNELS" } }, - "NONE": { + "PROGRAM_1": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "PROGRAM_1" } }, - "SPEECH": { + "PROGRAM_2": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SPEECH" + "smithy.api#enumValue": "PROGRAM_2" } - } - }, - "traits": { - "smithy.api#documentation": "Eac3 Atmos Drc Line" - } - }, - "com.amazonaws.medialive#Eac3AtmosDrcRf": { - "type": "enum", - "members": { - "FILM_LIGHT": { + }, + "PROGRAM_3": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FILM_LIGHT" + "smithy.api#enumValue": "PROGRAM_3" } }, - "FILM_STANDARD": { + "PROGRAM_4": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FILM_STANDARD" + "smithy.api#enumValue": "PROGRAM_4" } }, - "MUSIC_LIGHT": { + "PROGRAM_5": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MUSIC_LIGHT" + "smithy.api#enumValue": "PROGRAM_5" } }, - "MUSIC_STANDARD": { + "PROGRAM_6": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MUSIC_STANDARD" + "smithy.api#enumValue": "PROGRAM_6" } }, - "NONE": { + "PROGRAM_7": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "PROGRAM_7" } }, - "SPEECH": { + "PROGRAM_8": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SPEECH" + "smithy.api#enumValue": "PROGRAM_8" } } }, "traits": { - "smithy.api#documentation": "Eac3 Atmos Drc Rf" + "smithy.api#documentation": "Dolby EProgram Selection" } }, - "com.amazonaws.medialive#Eac3AtmosSettings": { + "com.amazonaws.medialive#DolbyVision81Settings": { "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Dolby Vision81 Settings" + } + }, + "com.amazonaws.medialive#DvbDashAccessibility": { + "type": "enum", "members": { - "Bitrate": { - "target": "com.amazonaws.medialive#__double", + "DVBDASH_1_VISUALLY_IMPAIRED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode.\n// * @affectsRightSizing true", - "smithy.api#jsonName": "bitrate" + "smithy.api#enumValue": "DVBDASH_1_VISUALLY_IMPAIRED" } }, - "CodingMode": { - "target": "com.amazonaws.medialive#Eac3AtmosCodingMode", + "DVBDASH_2_HARD_OF_HEARING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Dolby Digital Plus with Dolby Atmos coding mode. Determines number of channels.", - "smithy.api#jsonName": "codingMode" + "smithy.api#enumValue": "DVBDASH_2_HARD_OF_HEARING" } }, - "Dialnorm": { - "target": "com.amazonaws.medialive#__integerMin1Max31", + "DVBDASH_3_SUPPLEMENTAL_COMMENTARY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Sets the dialnorm for the output. Default 23.", - "smithy.api#jsonName": "dialnorm" + "smithy.api#enumValue": "DVBDASH_3_SUPPLEMENTAL_COMMENTARY" } }, - "DrcLine": { - "target": "com.amazonaws.medialive#Eac3AtmosDrcLine", + "DVBDASH_4_DIRECTORS_COMMENTARY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Sets the Dolby dynamic range compression profile.", - "smithy.api#jsonName": "drcLine" + "smithy.api#enumValue": "DVBDASH_4_DIRECTORS_COMMENTARY" } }, - "DrcRf": { - "target": "com.amazonaws.medialive#Eac3AtmosDrcRf", + "DVBDASH_5_EDUCATIONAL_NOTES": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.", - "smithy.api#jsonName": "drcRf" + "smithy.api#enumValue": "DVBDASH_5_EDUCATIONAL_NOTES" } }, - "HeightTrim": { - "target": "com.amazonaws.medialive#__double", + "DVBDASH_6_MAIN_PROGRAM": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "heightTrim" + "smithy.api#enumValue": "DVBDASH_6_MAIN_PROGRAM" } }, - "SurroundTrim": { - "target": "com.amazonaws.medialive#__double", + "DVBDASH_7_CLEAN_FEED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "surroundTrim" + "smithy.api#enumValue": "DVBDASH_7_CLEAN_FEED" } } }, "traits": { - "smithy.api#documentation": "Eac3 Atmos Settings" + "smithy.api#documentation": "Dvb Dash Accessibility" } }, - "com.amazonaws.medialive#Eac3AttenuationControl": { - "type": "enum", + "com.amazonaws.medialive#DvbNitSettings": { + "type": "structure", "members": { - "ATTENUATE_3_DB": { - "target": "smithy.api#Unit", + "NetworkId": { + "target": "com.amazonaws.medialive#__integerMin0Max65536", "traits": { - "smithy.api#enumValue": "ATTENUATE_3_DB" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The numeric value placed in the Network Information Table (NIT).", + "smithy.api#jsonName": "networkId", + "smithy.api#required": {} } }, - "NONE": { - "target": "smithy.api#Unit", + "NetworkName": { + "target": "com.amazonaws.medialive#__stringMin1Max256", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.", + "smithy.api#jsonName": "networkName", + "smithy.api#required": {} + } + }, + "RepInterval": { + "target": "com.amazonaws.medialive#__integerMin25Max10000", + "traits": { + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", + "smithy.api#jsonName": "repInterval" } } }, "traits": { - "smithy.api#documentation": "Eac3 Attenuation Control" + "smithy.api#documentation": "DVB Network Information Table (NIT)" } }, - "com.amazonaws.medialive#Eac3BitstreamMode": { + "com.amazonaws.medialive#DvbSdtOutputSdt": { "type": "enum", "members": { - "COMMENTARY": { + "SDT_FOLLOW": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "COMMENTARY" + "smithy.api#enumValue": "SDT_FOLLOW" } }, - "COMPLETE_MAIN": { + "SDT_FOLLOW_IF_PRESENT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "COMPLETE_MAIN" + "smithy.api#enumValue": "SDT_FOLLOW_IF_PRESENT" } }, - "EMERGENCY": { + "SDT_MANUAL": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EMERGENCY" + "smithy.api#enumValue": "SDT_MANUAL" } }, - "HEARING_IMPAIRED": { + "SDT_NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HEARING_IMPAIRED" + "smithy.api#enumValue": "SDT_NONE" + } + } + }, + "traits": { + "smithy.api#documentation": "Dvb Sdt Output Sdt" + } + }, + "com.amazonaws.medialive#DvbSdtSettings": { + "type": "structure", + "members": { + "OutputSdt": { + "target": "com.amazonaws.medialive#DvbSdtOutputSdt", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "outputSdt" } }, - "VISUALLY_IMPAIRED": { - "target": "smithy.api#Unit", + "RepInterval": { + "target": "com.amazonaws.medialive#__integerMin25Max2000", "traits": { - "smithy.api#enumValue": "VISUALLY_IMPAIRED" + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", + "smithy.api#jsonName": "repInterval" + } + }, + "ServiceName": { + "target": "com.amazonaws.medialive#__stringMin1Max256", + "traits": { + "smithy.api#documentation": "The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.", + "smithy.api#jsonName": "serviceName" + } + }, + "ServiceProviderName": { + "target": "com.amazonaws.medialive#__stringMin1Max256", + "traits": { + "smithy.api#documentation": "The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.", + "smithy.api#jsonName": "serviceProviderName" } } }, "traits": { - "smithy.api#documentation": "Eac3 Bitstream Mode" + "smithy.api#documentation": "DVB Service Description Table (SDT)" } }, - "com.amazonaws.medialive#Eac3CodingMode": { + "com.amazonaws.medialive#DvbSubDestinationAlignment": { "type": "enum", "members": { - "CODING_MODE_1_0": { + "CENTERED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CODING_MODE_1_0" + "smithy.api#enumValue": "CENTERED" } }, - "CODING_MODE_2_0": { + "LEFT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CODING_MODE_2_0" + "smithy.api#enumValue": "LEFT" } }, - "CODING_MODE_3_2": { + "SMART": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CODING_MODE_3_2" + "smithy.api#enumValue": "SMART" } } }, "traits": { - "smithy.api#documentation": "Eac3 Coding Mode" + "smithy.api#documentation": "Dvb Sub Destination Alignment" } }, - "com.amazonaws.medialive#Eac3DcFilter": { + "com.amazonaws.medialive#DvbSubDestinationBackgroundColor": { "type": "enum", "members": { - "DISABLED": { + "BLACK": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "BLACK" } }, - "ENABLED": { + "NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "NONE" + } + }, + "WHITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WHITE" } } }, "traits": { - "smithy.api#documentation": "Eac3 Dc Filter" + "smithy.api#documentation": "Dvb Sub Destination Background Color" } }, - "com.amazonaws.medialive#Eac3DrcLine": { + "com.amazonaws.medialive#DvbSubDestinationFontColor": { "type": "enum", "members": { - "FILM_LIGHT": { + "BLACK": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FILM_LIGHT" + "smithy.api#enumValue": "BLACK" } }, - "FILM_STANDARD": { + "BLUE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FILM_STANDARD" + "smithy.api#enumValue": "BLUE" } }, - "MUSIC_LIGHT": { + "GREEN": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MUSIC_LIGHT" + "smithy.api#enumValue": "GREEN" } }, - "MUSIC_STANDARD": { + "RED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MUSIC_STANDARD" + "smithy.api#enumValue": "RED" } }, - "NONE": { + "WHITE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "WHITE" } }, - "SPEECH": { + "YELLOW": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SPEECH" + "smithy.api#enumValue": "YELLOW" } } }, "traits": { - "smithy.api#documentation": "Eac3 Drc Line" + "smithy.api#documentation": "Dvb Sub Destination Font Color" } }, - "com.amazonaws.medialive#Eac3DrcRf": { + "com.amazonaws.medialive#DvbSubDestinationOutlineColor": { "type": "enum", "members": { - "FILM_LIGHT": { + "BLACK": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FILM_LIGHT" + "smithy.api#enumValue": "BLACK" } }, - "FILM_STANDARD": { + "BLUE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FILM_STANDARD" + "smithy.api#enumValue": "BLUE" } }, - "MUSIC_LIGHT": { + "GREEN": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MUSIC_LIGHT" + "smithy.api#enumValue": "GREEN" } }, - "MUSIC_STANDARD": { + "RED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MUSIC_STANDARD" + "smithy.api#enumValue": "RED" } }, - "NONE": { + "WHITE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "WHITE" } }, - "SPEECH": { + "YELLOW": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SPEECH" + "smithy.api#enumValue": "YELLOW" } } }, "traits": { - "smithy.api#documentation": "Eac3 Drc Rf" + "smithy.api#documentation": "Dvb Sub Destination Outline Color" } }, - "com.amazonaws.medialive#Eac3LfeControl": { - "type": "enum", + "com.amazonaws.medialive#DvbSubDestinationSettings": { + "type": "structure", "members": { - "LFE": { - "target": "smithy.api#Unit", + "Alignment": { + "target": "com.amazonaws.medialive#DvbSubDestinationAlignment", "traits": { - "smithy.api#enumValue": "LFE" + "smithy.api#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.", + "smithy.api#jsonName": "alignment" } }, - "NO_LFE": { - "target": "smithy.api#Unit", + "BackgroundColor": { + "target": "com.amazonaws.medialive#DvbSubDestinationBackgroundColor", "traits": { - "smithy.api#enumValue": "NO_LFE" + "smithy.api#documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "backgroundColor" + } + }, + "BackgroundOpacity": { + "target": "com.amazonaws.medialive#__integerMin0Max255", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "backgroundOpacity" + } + }, + "Font": { + "target": "com.amazonaws.medialive#InputLocation", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "font" + } + }, + "FontColor": { + "target": "com.amazonaws.medialive#DvbSubDestinationFontColor", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "fontColor" + } + }, + "FontOpacity": { + "target": "com.amazonaws.medialive#__integerMin0Max255", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "fontOpacity" + } + }, + "FontResolution": { + "target": "com.amazonaws.medialive#__integerMin96Max600", + "traits": { + "smithy.api#documentation": "Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontResolution" + } + }, + "FontSize": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "fontSize" + } + }, + "OutlineColor": { + "target": "com.amazonaws.medialive#DvbSubDestinationOutlineColor", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "outlineColor" + } + }, + "OutlineSize": { + "target": "com.amazonaws.medialive#__integerMin0Max10", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "outlineSize" + } + }, + "ShadowColor": { + "target": "com.amazonaws.medialive#DvbSubDestinationShadowColor", + "traits": { + "smithy.api#documentation": "Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowColor" + } + }, + "ShadowOpacity": { + "target": "com.amazonaws.medialive#__integerMin0Max255", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "shadowOpacity" + } + }, + "ShadowXOffset": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "shadowXOffset" + } + }, + "ShadowYOffset": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "shadowYOffset" + } + }, + "TeletextGridControl": { + "target": "com.amazonaws.medialive#DvbSubDestinationTeletextGridControl", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "teletextGridControl" + } + }, + "XPosition": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "xPosition" + } + }, + "YPosition": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "yPosition" } } }, "traits": { - "smithy.api#documentation": "Eac3 Lfe Control" + "smithy.api#documentation": "Dvb Sub Destination Settings" } }, - "com.amazonaws.medialive#Eac3LfeFilter": { + "com.amazonaws.medialive#DvbSubDestinationShadowColor": { "type": "enum", "members": { - "DISABLED": { + "BLACK": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "BLACK" } }, - "ENABLED": { + "NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "NONE" + } + }, + "WHITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WHITE" } } }, "traits": { - "smithy.api#documentation": "Eac3 Lfe Filter" + "smithy.api#documentation": "Dvb Sub Destination Shadow Color" } }, - "com.amazonaws.medialive#Eac3MetadataControl": { + "com.amazonaws.medialive#DvbSubDestinationTeletextGridControl": { "type": "enum", "members": { - "FOLLOW_INPUT": { + "FIXED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FOLLOW_INPUT" + "smithy.api#enumValue": "FIXED" } }, - "USE_CONFIGURED": { + "SCALED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "USE_CONFIGURED" + "smithy.api#enumValue": "SCALED" } } }, "traits": { - "smithy.api#documentation": "Eac3 Metadata Control" + "smithy.api#documentation": "Dvb Sub Destination Teletext Grid Control" } }, - "com.amazonaws.medialive#Eac3PassthroughControl": { + "com.amazonaws.medialive#DvbSubOcrLanguage": { "type": "enum", "members": { - "NO_PASSTHROUGH": { + "DEU": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NO_PASSTHROUGH" + "smithy.api#enumValue": "DEU" } }, - "WHEN_POSSIBLE": { + "ENG": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "WHEN_POSSIBLE" + "smithy.api#enumValue": "ENG" } - } - }, - "traits": { - "smithy.api#documentation": "Eac3 Passthrough Control" - } - }, - "com.amazonaws.medialive#Eac3PhaseControl": { - "type": "enum", - "members": { - "NO_SHIFT": { + }, + "FRA": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NO_SHIFT" + "smithy.api#enumValue": "FRA" } }, - "SHIFT_90_DEGREES": { + "NLD": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SHIFT_90_DEGREES" + "smithy.api#enumValue": "NLD" + } + }, + "POR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POR" + } + }, + "SPA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPA" } } }, "traits": { - "smithy.api#documentation": "Eac3 Phase Control" + "smithy.api#documentation": "Dvb Sub Ocr Language" } }, - "com.amazonaws.medialive#Eac3Settings": { + "com.amazonaws.medialive#DvbSubSourceSettings": { "type": "structure", "members": { - "AttenuationControl": { - "target": "com.amazonaws.medialive#Eac3AttenuationControl", + "OcrLanguage": { + "target": "com.amazonaws.medialive#DvbSubOcrLanguage", "traits": { - "smithy.api#documentation": "When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "attenuationControl" + "smithy.api#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.", + "smithy.api#jsonName": "ocrLanguage" } }, - "Bitrate": { - "target": "com.amazonaws.medialive#__double", + "Pid": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode.", - "smithy.api#jsonName": "bitrate" + "smithy.api#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.", + "smithy.api#jsonName": "pid" } - }, - "BitstreamMode": { - "target": "com.amazonaws.medialive#Eac3BitstreamMode", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "bitstreamMode" - } - }, - "CodingMode": { - "target": "com.amazonaws.medialive#Eac3CodingMode", - "traits": { - "smithy.api#documentation": "Dolby Digital Plus coding mode. Determines number of channels.", - "smithy.api#jsonName": "codingMode" - } - }, - "DcFilter": { - "target": "com.amazonaws.medialive#Eac3DcFilter", + } + }, + "traits": { + "smithy.api#documentation": "Dvb Sub Source Settings" + } + }, + "com.amazonaws.medialive#DvbTdtSettings": { + "type": "structure", + "members": { + "RepInterval": { + "target": "com.amazonaws.medialive#__integerMin1000Max30000", "traits": { - "smithy.api#documentation": "When set to enabled, activates a DC highpass filter for all input channels.", - "smithy.api#jsonName": "dcFilter" + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", + "smithy.api#jsonName": "repInterval" } - }, - "Dialnorm": { - "target": "com.amazonaws.medialive#__integerMin1Max31", + } + }, + "traits": { + "smithy.api#documentation": "DVB Time and Date Table (SDT)" + } + }, + "com.amazonaws.medialive#Eac3AtmosCodingMode": { + "type": "enum", + "members": { + "CODING_MODE_5_1_4": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.", - "smithy.api#jsonName": "dialnorm" + "smithy.api#enumValue": "CODING_MODE_5_1_4" } }, - "DrcLine": { - "target": "com.amazonaws.medialive#Eac3DrcLine", + "CODING_MODE_7_1_4": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Sets the Dolby dynamic range compression profile.", - "smithy.api#jsonName": "drcLine" + "smithy.api#enumValue": "CODING_MODE_7_1_4" } }, - "DrcRf": { - "target": "com.amazonaws.medialive#Eac3DrcRf", + "CODING_MODE_9_1_6": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.", - "smithy.api#jsonName": "drcRf" + "smithy.api#enumValue": "CODING_MODE_9_1_6" } - }, - "LfeControl": { - "target": "com.amazonaws.medialive#Eac3LfeControl", + } + }, + "traits": { + "smithy.api#documentation": "Eac3 Atmos Coding Mode" + } + }, + "com.amazonaws.medialive#Eac3AtmosDrcLine": { + "type": "enum", + "members": { + "FILM_LIGHT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When encoding 3/2 audio, setting to lfe enables the LFE channel", - "smithy.api#jsonName": "lfeControl" + "smithy.api#enumValue": "FILM_LIGHT" } }, - "LfeFilter": { - "target": "com.amazonaws.medialive#Eac3LfeFilter", + "FILM_STANDARD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.", - "smithy.api#jsonName": "lfeFilter" + "smithy.api#enumValue": "FILM_STANDARD" } }, - "LoRoCenterMixLevel": { - "target": "com.amazonaws.medialive#__double", + "MUSIC_LIGHT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Left only/Right only center mix level. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "loRoCenterMixLevel" + "smithy.api#enumValue": "MUSIC_LIGHT" } }, - "LoRoSurroundMixLevel": { - "target": "com.amazonaws.medialive#__double", + "MUSIC_STANDARD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Left only/Right only surround mix level. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "loRoSurroundMixLevel" + "smithy.api#enumValue": "MUSIC_STANDARD" } }, - "LtRtCenterMixLevel": { - "target": "com.amazonaws.medialive#__double", + "NONE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Left total/Right total center mix level. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "ltRtCenterMixLevel" + "smithy.api#enumValue": "NONE" } }, - "LtRtSurroundMixLevel": { - "target": "com.amazonaws.medialive#__double", + "SPEECH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Left total/Right total surround mix level. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "ltRtSurroundMixLevel" + "smithy.api#enumValue": "SPEECH" } - }, - "MetadataControl": { - "target": "com.amazonaws.medialive#Eac3MetadataControl", + } + }, + "traits": { + "smithy.api#documentation": "Eac3 Atmos Drc Line" + } + }, + "com.amazonaws.medialive#Eac3AtmosDrcRf": { + "type": "enum", + "members": { + "FILM_LIGHT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "metadataControl" + "smithy.api#enumValue": "FILM_LIGHT" } }, - "PassthroughControl": { - "target": "com.amazonaws.medialive#Eac3PassthroughControl", + "FILM_STANDARD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "passthroughControl" + "smithy.api#enumValue": "FILM_STANDARD" } }, - "PhaseControl": { - "target": "com.amazonaws.medialive#Eac3PhaseControl", + "MUSIC_LIGHT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "phaseControl" + "smithy.api#enumValue": "MUSIC_LIGHT" } }, - "StereoDownmix": { - "target": "com.amazonaws.medialive#Eac3StereoDownmix", + "MUSIC_STANDARD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Stereo downmix preference. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "stereoDownmix" + "smithy.api#enumValue": "MUSIC_STANDARD" } }, - "SurroundExMode": { - "target": "com.amazonaws.medialive#Eac3SurroundExMode", + "NONE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.", - "smithy.api#jsonName": "surroundExMode" + "smithy.api#enumValue": "NONE" } }, - "SurroundMode": { - "target": "com.amazonaws.medialive#Eac3SurroundMode", + "SPEECH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.", - "smithy.api#jsonName": "surroundMode" + "smithy.api#enumValue": "SPEECH" } } }, "traits": { - "smithy.api#documentation": "Eac3 Settings" + "smithy.api#documentation": "Eac3 Atmos Drc Rf" } }, - "com.amazonaws.medialive#Eac3StereoDownmix": { - "type": "enum", + "com.amazonaws.medialive#Eac3AtmosSettings": { + "type": "structure", "members": { - "DPL2": { - "target": "smithy.api#Unit", + "Bitrate": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#enumValue": "DPL2" + "smithy.api#documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode.\n// * @affectsRightSizing true", + "smithy.api#jsonName": "bitrate" } }, - "LO_RO": { - "target": "smithy.api#Unit", + "CodingMode": { + "target": "com.amazonaws.medialive#Eac3AtmosCodingMode", "traits": { - "smithy.api#enumValue": "LO_RO" + "smithy.api#documentation": "Dolby Digital Plus with Dolby Atmos coding mode. Determines number of channels.", + "smithy.api#jsonName": "codingMode" } }, - "LT_RT": { - "target": "smithy.api#Unit", + "Dialnorm": { + "target": "com.amazonaws.medialive#__integerMin1Max31", "traits": { - "smithy.api#enumValue": "LT_RT" + "smithy.api#documentation": "Sets the dialnorm for the output. Default 23.", + "smithy.api#jsonName": "dialnorm" } }, - "NOT_INDICATED": { - "target": "smithy.api#Unit", + "DrcLine": { + "target": "com.amazonaws.medialive#Eac3AtmosDrcLine", "traits": { - "smithy.api#enumValue": "NOT_INDICATED" + "smithy.api#documentation": "Sets the Dolby dynamic range compression profile.", + "smithy.api#jsonName": "drcLine" + } + }, + "DrcRf": { + "target": "com.amazonaws.medialive#Eac3AtmosDrcRf", + "traits": { + "smithy.api#documentation": "Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.", + "smithy.api#jsonName": "drcRf" + } + }, + "HeightTrim": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "heightTrim" + } + }, + "SurroundTrim": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "surroundTrim" } } }, "traits": { - "smithy.api#documentation": "Eac3 Stereo Downmix" + "smithy.api#documentation": "Eac3 Atmos Settings" } }, - "com.amazonaws.medialive#Eac3SurroundExMode": { + "com.amazonaws.medialive#Eac3AttenuationControl": { "type": "enum", "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "ENABLED": { + "ATTENUATE_3_DB": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "ATTENUATE_3_DB" } }, - "NOT_INDICATED": { + "NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NOT_INDICATED" + "smithy.api#enumValue": "NONE" } } }, "traits": { - "smithy.api#documentation": "Eac3 Surround Ex Mode" + "smithy.api#documentation": "Eac3 Attenuation Control" } }, - "com.amazonaws.medialive#Eac3SurroundMode": { + "com.amazonaws.medialive#Eac3BitstreamMode": { "type": "enum", "members": { - "DISABLED": { + "COMMENTARY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "COMMENTARY" } }, - "ENABLED": { + "COMPLETE_MAIN": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "COMPLETE_MAIN" } }, - "NOT_INDICATED": { + "EMERGENCY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NOT_INDICATED" - } - } - }, - "traits": { - "smithy.api#documentation": "Eac3 Surround Mode" - } - }, - "com.amazonaws.medialive#EbuTtDDestinationSettings": { - "type": "structure", - "members": { - "CopyrightHolder": { - "target": "com.amazonaws.medialive#__stringMax1000", - "traits": { - "smithy.api#documentation": "Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata.", - "smithy.api#jsonName": "copyrightHolder" - } - }, - "FillLineGap": { - "target": "com.amazonaws.medialive#EbuTtDFillLineGapControl", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "fillLineGap" + "smithy.api#enumValue": "EMERGENCY" } }, - "FontFamily": { - "target": "com.amazonaws.medialive#__string", + "HEARING_IMPAIRED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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”.", - "smithy.api#jsonName": "fontFamily" + "smithy.api#enumValue": "HEARING_IMPAIRED" } }, - "StyleControl": { - "target": "com.amazonaws.medialive#EbuTtDDestinationStyleControl", + "VISUALLY_IMPAIRED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "styleControl" + "smithy.api#enumValue": "VISUALLY_IMPAIRED" } } }, "traits": { - "smithy.api#documentation": "Ebu Tt DDestination Settings" + "smithy.api#documentation": "Eac3 Bitstream Mode" } }, - "com.amazonaws.medialive#EbuTtDDestinationStyleControl": { + "com.amazonaws.medialive#Eac3CodingMode": { "type": "enum", "members": { - "EXCLUDE": { + "CODING_MODE_1_0": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EXCLUDE" + "smithy.api#enumValue": "CODING_MODE_1_0" } }, - "INCLUDE": { + "CODING_MODE_2_0": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INCLUDE" + "smithy.api#enumValue": "CODING_MODE_2_0" + } + }, + "CODING_MODE_3_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODING_MODE_3_2" } } }, "traits": { - "smithy.api#documentation": "Ebu Tt DDestination Style Control" + "smithy.api#documentation": "Eac3 Coding Mode" } }, - "com.amazonaws.medialive#EbuTtDFillLineGapControl": { + "com.amazonaws.medialive#Eac3DcFilter": { "type": "enum", "members": { "DISABLED": { @@ -8819,1131 +9865,1123 @@ } }, "traits": { - "smithy.api#documentation": "Ebu Tt DFill Line Gap Control" + "smithy.api#documentation": "Eac3 Dc Filter" } }, - "com.amazonaws.medialive#EmbeddedConvert608To708": { + "com.amazonaws.medialive#Eac3DrcLine": { "type": "enum", "members": { - "DISABLED": { + "FILM_LIGHT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "FILM_LIGHT" } }, - "UPCONVERT": { + "FILM_STANDARD": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "UPCONVERT" + "smithy.api#enumValue": "FILM_STANDARD" + } + }, + "MUSIC_LIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUSIC_LIGHT" + } + }, + "MUSIC_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUSIC_STANDARD" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "SPEECH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPEECH" } } }, "traits": { - "smithy.api#documentation": "Embedded Convert608 To708" - } - }, - "com.amazonaws.medialive#EmbeddedDestinationSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Embedded Destination Settings" - } - }, - "com.amazonaws.medialive#EmbeddedPlusScte20DestinationSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Embedded Plus Scte20 Destination Settings" + "smithy.api#documentation": "Eac3 Drc Line" } }, - "com.amazonaws.medialive#EmbeddedScte20Detection": { + "com.amazonaws.medialive#Eac3DrcRf": { "type": "enum", "members": { - "AUTO": { + "FILM_LIGHT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AUTO" + "smithy.api#enumValue": "FILM_LIGHT" } }, - "OFF": { + "FILM_STANDARD": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "OFF" + "smithy.api#enumValue": "FILM_STANDARD" } - } - }, - "traits": { - "smithy.api#documentation": "Embedded Scte20 Detection" - } - }, - "com.amazonaws.medialive#EmbeddedSourceSettings": { - "type": "structure", - "members": { - "Convert608To708": { - "target": "com.amazonaws.medialive#EmbeddedConvert608To708", + }, + "MUSIC_LIGHT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "convert608To708" + "smithy.api#enumValue": "MUSIC_LIGHT" } }, - "Scte20Detection": { - "target": "com.amazonaws.medialive#EmbeddedScte20Detection", + "MUSIC_STANDARD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Set to \"auto\" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.", - "smithy.api#jsonName": "scte20Detection" + "smithy.api#enumValue": "MUSIC_STANDARD" } }, - "Source608ChannelNumber": { - "target": "com.amazonaws.medialive#__integerMin1Max4", + "NONE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.", - "smithy.api#jsonName": "source608ChannelNumber" + "smithy.api#enumValue": "NONE" } }, - "Source608TrackNumber": { - "target": "com.amazonaws.medialive#__integerMin1Max5", + "SPEECH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "This field is unused and deprecated.", - "smithy.api#jsonName": "source608TrackNumber" + "smithy.api#enumValue": "SPEECH" } } }, "traits": { - "smithy.api#documentation": "Embedded Source Settings" + "smithy.api#documentation": "Eac3 Drc Rf" } }, - "com.amazonaws.medialive#EncoderSettings": { - "type": "structure", + "com.amazonaws.medialive#Eac3LfeControl": { + "type": "enum", "members": { - "AudioDescriptions": { - "target": "com.amazonaws.medialive#__listOfAudioDescription", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#jsonName": "audioDescriptions", - "smithy.api#required": {} - } - }, - "AvailBlanking": { - "target": "com.amazonaws.medialive#AvailBlanking", + "LFE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Settings for ad avail blanking.", - "smithy.api#jsonName": "availBlanking" + "smithy.api#enumValue": "LFE" } }, - "AvailConfiguration": { - "target": "com.amazonaws.medialive#AvailConfiguration", + "NO_LFE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Event-wide configuration settings for ad avail insertion.", - "smithy.api#jsonName": "availConfiguration" + "smithy.api#enumValue": "NO_LFE" } - }, - "BlackoutSlate": { - "target": "com.amazonaws.medialive#BlackoutSlate", + } + }, + "traits": { + "smithy.api#documentation": "Eac3 Lfe Control" + } + }, + "com.amazonaws.medialive#Eac3LfeFilter": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Settings for blackout slate.", - "smithy.api#jsonName": "blackoutSlate" + "smithy.api#enumValue": "DISABLED" } }, - "CaptionDescriptions": { - "target": "com.amazonaws.medialive#__listOfCaptionDescription", + "ENABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Settings for caption decriptions", - "smithy.api#jsonName": "captionDescriptions" + "smithy.api#enumValue": "ENABLED" } - }, - "FeatureActivations": { - "target": "com.amazonaws.medialive#FeatureActivations", + } + }, + "traits": { + "smithy.api#documentation": "Eac3 Lfe Filter" + } + }, + "com.amazonaws.medialive#Eac3MetadataControl": { + "type": "enum", + "members": { + "FOLLOW_INPUT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Feature Activations", - "smithy.api#jsonName": "featureActivations" + "smithy.api#enumValue": "FOLLOW_INPUT" } }, - "GlobalConfiguration": { - "target": "com.amazonaws.medialive#GlobalConfiguration", + "USE_CONFIGURED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Configuration settings that apply to the event as a whole.", - "smithy.api#jsonName": "globalConfiguration" + "smithy.api#enumValue": "USE_CONFIGURED" } - }, - "MotionGraphicsConfiguration": { - "target": "com.amazonaws.medialive#MotionGraphicsConfiguration", + } + }, + "traits": { + "smithy.api#documentation": "Eac3 Metadata Control" + } + }, + "com.amazonaws.medialive#Eac3PassthroughControl": { + "type": "enum", + "members": { + "NO_PASSTHROUGH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Settings for motion graphics.", - "smithy.api#jsonName": "motionGraphicsConfiguration" + "smithy.api#enumValue": "NO_PASSTHROUGH" } }, - "NielsenConfiguration": { - "target": "com.amazonaws.medialive#NielsenConfiguration", + "WHEN_POSSIBLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Nielsen configuration settings.", - "smithy.api#jsonName": "nielsenConfiguration" + "smithy.api#enumValue": "WHEN_POSSIBLE" } - }, - "OutputGroups": { - "target": "com.amazonaws.medialive#__listOfOutputGroup", + } + }, + "traits": { + "smithy.api#documentation": "Eac3 Passthrough Control" + } + }, + "com.amazonaws.medialive#Eac3PhaseControl": { + "type": "enum", + "members": { + "NO_SHIFT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#jsonName": "outputGroups", - "smithy.api#required": {} + "smithy.api#enumValue": "NO_SHIFT" } }, - "TimecodeConfig": { - "target": "com.amazonaws.medialive#TimecodeConfig", + "SHIFT_90_DEGREES": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Contains settings used to acquire and adjust timecode information from inputs.", - "smithy.api#jsonName": "timecodeConfig", - "smithy.api#required": {} + "smithy.api#enumValue": "SHIFT_90_DEGREES" + } + } + }, + "traits": { + "smithy.api#documentation": "Eac3 Phase Control" + } + }, + "com.amazonaws.medialive#Eac3Settings": { + "type": "structure", + "members": { + "AttenuationControl": { + "target": "com.amazonaws.medialive#Eac3AttenuationControl", + "traits": { + "smithy.api#documentation": "When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "attenuationControl" } }, - "VideoDescriptions": { - "target": "com.amazonaws.medialive#__listOfVideoDescription", + "Bitrate": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#jsonName": "videoDescriptions", - "smithy.api#required": {} + "smithy.api#documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode.", + "smithy.api#jsonName": "bitrate" } }, - "ThumbnailConfiguration": { - "target": "com.amazonaws.medialive#ThumbnailConfiguration", + "BitstreamMode": { + "target": "com.amazonaws.medialive#Eac3BitstreamMode", "traits": { - "smithy.api#documentation": "Thumbnail configuration settings.", - "smithy.api#jsonName": "thumbnailConfiguration" + "smithy.api#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.", + "smithy.api#jsonName": "bitstreamMode" } }, - "ColorCorrectionSettings": { - "target": "com.amazonaws.medialive#ColorCorrectionSettings", + "CodingMode": { + "target": "com.amazonaws.medialive#Eac3CodingMode", "traits": { - "smithy.api#documentation": "Color Correction Settings", - "smithy.api#jsonName": "colorCorrectionSettings" + "smithy.api#documentation": "Dolby Digital Plus coding mode. Determines number of channels.", + "smithy.api#jsonName": "codingMode" } - } - }, - "traits": { - "smithy.api#documentation": "Encoder Settings" - } - }, - "com.amazonaws.medialive#EpochLockingSettings": { - "type": "structure", - "members": { - "CustomEpoch": { - "target": "com.amazonaws.medialive#__string", + }, + "DcFilter": { + "target": "com.amazonaws.medialive#Eac3DcFilter", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "customEpoch" + "smithy.api#documentation": "When set to enabled, activates a DC highpass filter for all input channels.", + "smithy.api#jsonName": "dcFilter" } }, - "JamSyncTime": { - "target": "com.amazonaws.medialive#__string", + "Dialnorm": { + "target": "com.amazonaws.medialive#__integerMin1Max31", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "jamSyncTime" + "smithy.api#documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.", + "smithy.api#jsonName": "dialnorm" } - } - }, - "traits": { - "smithy.api#documentation": "Epoch Locking Settings" - } - }, - "com.amazonaws.medialive#Esam": { - "type": "structure", - "members": { - "AcquisitionPointId": { - "target": "com.amazonaws.medialive#__stringMax256", + }, + "DrcLine": { + "target": "com.amazonaws.medialive#Eac3DrcLine", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Sent as acquisitionPointIdentity to identify the MediaLive channel to the POIS.", - "smithy.api#jsonName": "acquisitionPointId", - "smithy.api#required": {} + "smithy.api#documentation": "Sets the Dolby dynamic range compression profile.", + "smithy.api#jsonName": "drcLine" } }, - "AdAvailOffset": { - "target": "com.amazonaws.medialive#__integerMinNegative1000Max1000", + "DrcRf": { + "target": "com.amazonaws.medialive#Eac3DrcRf", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "adAvailOffset" + "smithy.api#documentation": "Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.", + "smithy.api#jsonName": "drcRf" } }, - "PasswordParam": { - "target": "com.amazonaws.medialive#__string", + "LfeControl": { + "target": "com.amazonaws.medialive#Eac3LfeControl", "traits": { - "smithy.api#documentation": "Documentation update needed", - "smithy.api#jsonName": "passwordParam" + "smithy.api#documentation": "When encoding 3/2 audio, setting to lfe enables the LFE channel", + "smithy.api#jsonName": "lfeControl" } }, - "PoisEndpoint": { - "target": "com.amazonaws.medialive#__stringMax2048", + "LfeFilter": { + "target": "com.amazonaws.medialive#Eac3LfeFilter", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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.", - "smithy.api#jsonName": "poisEndpoint", - "smithy.api#required": {} + "smithy.api#documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.", + "smithy.api#jsonName": "lfeFilter" } }, - "Username": { - "target": "com.amazonaws.medialive#__string", + "LoRoCenterMixLevel": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Documentation update needed", - "smithy.api#jsonName": "username" + "smithy.api#documentation": "Left only/Right only center mix level. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "loRoCenterMixLevel" } }, - "ZoneIdentity": { - "target": "com.amazonaws.medialive#__stringMax256", + "LoRoSurroundMixLevel": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Optional data sent as zoneIdentity to identify the MediaLive channel to the POIS.", - "smithy.api#jsonName": "zoneIdentity" + "smithy.api#documentation": "Left only/Right only surround mix level. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "loRoSurroundMixLevel" } - } - }, - "traits": { - "smithy.api#documentation": "Esam" - } - }, - "com.amazonaws.medialive#FailoverCondition": { - "type": "structure", - "members": { - "FailoverConditionSettings": { - "target": "com.amazonaws.medialive#FailoverConditionSettings", + }, + "LtRtCenterMixLevel": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Failover condition type-specific settings.", - "smithy.api#jsonName": "failoverConditionSettings" + "smithy.api#documentation": "Left total/Right total center mix level. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "ltRtCenterMixLevel" } - } - }, - "traits": { - "smithy.api#documentation": "Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings." - } - }, - "com.amazonaws.medialive#FailoverConditionSettings": { - "type": "structure", - "members": { - "AudioSilenceSettings": { - "target": "com.amazonaws.medialive#AudioSilenceFailoverSettings", + }, + "LtRtSurroundMixLevel": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "MediaLive will perform a failover if the specified audio selector is silent for the specified period.", - "smithy.api#jsonName": "audioSilenceSettings" + "smithy.api#documentation": "Left total/Right total surround mix level. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "ltRtSurroundMixLevel" } }, - "InputLossSettings": { - "target": "com.amazonaws.medialive#InputLossFailoverSettings", + "MetadataControl": { + "target": "com.amazonaws.medialive#Eac3MetadataControl", "traits": { - "smithy.api#documentation": "MediaLive will perform a failover if content is not detected in this input for the specified period.", - "smithy.api#jsonName": "inputLossSettings" + "smithy.api#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.", + "smithy.api#jsonName": "metadataControl" } }, - "VideoBlackSettings": { - "target": "com.amazonaws.medialive#VideoBlackFailoverSettings", + "PassthroughControl": { + "target": "com.amazonaws.medialive#Eac3PassthroughControl", "traits": { - "smithy.api#documentation": "MediaLive will perform a failover if content is considered black for the specified period.", - "smithy.api#jsonName": "videoBlackSettings" + "smithy.api#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.", + "smithy.api#jsonName": "passthroughControl" } - } - }, - "traits": { - "smithy.api#documentation": "Settings for one failover condition." - } - }, - "com.amazonaws.medialive#FeatureActivations": { - "type": "structure", - "members": { - "InputPrepareScheduleActions": { - "target": "com.amazonaws.medialive#FeatureActivationsInputPrepareScheduleActions", + }, + "PhaseControl": { + "target": "com.amazonaws.medialive#Eac3PhaseControl", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "inputPrepareScheduleActions" + "smithy.api#documentation": "When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "phaseControl" } }, - "OutputStaticImageOverlayScheduleActions": { - "target": "com.amazonaws.medialive#FeatureActivationsOutputStaticImageOverlayScheduleActions", + "StereoDownmix": { + "target": "com.amazonaws.medialive#Eac3StereoDownmix", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "outputStaticImageOverlayScheduleActions" + "smithy.api#documentation": "Stereo downmix preference. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "stereoDownmix" + } + }, + "SurroundExMode": { + "target": "com.amazonaws.medialive#Eac3SurroundExMode", + "traits": { + "smithy.api#documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.", + "smithy.api#jsonName": "surroundExMode" + } + }, + "SurroundMode": { + "target": "com.amazonaws.medialive#Eac3SurroundMode", + "traits": { + "smithy.api#documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.", + "smithy.api#jsonName": "surroundMode" } } }, "traits": { - "smithy.api#documentation": "Feature Activations" + "smithy.api#documentation": "Eac3 Settings" } }, - "com.amazonaws.medialive#FeatureActivationsInputPrepareScheduleActions": { + "com.amazonaws.medialive#Eac3StereoDownmix": { "type": "enum", "members": { - "DISABLED": { + "DPL2": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "DPL2" } }, - "ENABLED": { + "LO_RO": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "LO_RO" } - } - }, - "traits": { - "smithy.api#documentation": "Feature Activations Input Prepare Schedule Actions" - } - }, - "com.amazonaws.medialive#FeatureActivationsOutputStaticImageOverlayScheduleActions": { - "type": "enum", - "members": { - "DISABLED": { + }, + "LT_RT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "LT_RT" } }, - "ENABLED": { + "NOT_INDICATED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "NOT_INDICATED" } } }, "traits": { - "smithy.api#documentation": "Feature Activations Output Static Image Overlay Schedule Actions" + "smithy.api#documentation": "Eac3 Stereo Downmix" } }, - "com.amazonaws.medialive#FecOutputIncludeFec": { + "com.amazonaws.medialive#Eac3SurroundExMode": { "type": "enum", "members": { - "COLUMN": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "COLUMN" + "smithy.api#enumValue": "DISABLED" } }, - "COLUMN_AND_ROW": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "COLUMN_AND_ROW" - } - } - }, - "traits": { - "smithy.api#documentation": "Fec Output Include Fec" - } - }, - "com.amazonaws.medialive#FecOutputSettings": { - "type": "structure", - "members": { - "ColumnDepth": { - "target": "com.amazonaws.medialive#__integerMin4Max20", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "columnDepth" - } - }, - "IncludeFec": { - "target": "com.amazonaws.medialive#FecOutputIncludeFec", - "traits": { - "smithy.api#documentation": "Enables column only or column and row based FEC", - "smithy.api#jsonName": "includeFec" + "smithy.api#enumValue": "ENABLED" } }, - "RowLength": { - "target": "com.amazonaws.medialive#__integerMin1Max20", + "NOT_INDICATED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "rowLength" + "smithy.api#enumValue": "NOT_INDICATED" } } }, "traits": { - "smithy.api#documentation": "Fec Output Settings" + "smithy.api#documentation": "Eac3 Surround Ex Mode" } }, - "com.amazonaws.medialive#FixedAfd": { + "com.amazonaws.medialive#Eac3SurroundMode": { "type": "enum", "members": { - "AFD_0000": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFD_0000" - } - }, - "AFD_0010": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFD_0010" - } - }, - "AFD_0011": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFD_0011" - } - }, - "AFD_0100": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFD_0100" - } - }, - "AFD_1000": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFD_1000" - } - }, - "AFD_1001": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFD_1001" - } - }, - "AFD_1010": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFD_1010" - } - }, - "AFD_1011": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFD_1011" - } - }, - "AFD_1101": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AFD_1101" + "smithy.api#enumValue": "DISABLED" } }, - "AFD_1110": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AFD_1110" + "smithy.api#enumValue": "ENABLED" } }, - "AFD_1111": { + "NOT_INDICATED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AFD_1111" + "smithy.api#enumValue": "NOT_INDICATED" } } }, "traits": { - "smithy.api#documentation": "Fixed Afd" + "smithy.api#documentation": "Eac3 Surround Mode" } }, - "com.amazonaws.medialive#FixedModeScheduleActionStartSettings": { + "com.amazonaws.medialive#EbuTtDDestinationSettings": { "type": "structure", "members": { - "Time": { - "target": "com.amazonaws.medialive#__string", + "CopyrightHolder": { + "target": "com.amazonaws.medialive#__stringMax1000", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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\".", - "smithy.api#jsonName": "time", - "smithy.api#required": {} + "smithy.api#documentation": "Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata.", + "smithy.api#jsonName": "copyrightHolder" } - } - }, - "traits": { - "smithy.api#documentation": "Start time for the action." - } - }, - "com.amazonaws.medialive#Fmp4HlsSettings": { - "type": "structure", - "members": { - "AudioRenditionSets": { - "target": "com.amazonaws.medialive#__string", + }, + "FillLineGap": { + "target": "com.amazonaws.medialive#EbuTtDFillLineGapControl", "traits": { - "smithy.api#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 ','.", - "smithy.api#jsonName": "audioRenditionSets" + "smithy.api#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.", + "smithy.api#jsonName": "fillLineGap" } }, - "NielsenId3Behavior": { - "target": "com.amazonaws.medialive#Fmp4NielsenId3Behavior", + "FontFamily": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "nielsenId3Behavior" + "smithy.api#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”.", + "smithy.api#jsonName": "fontFamily" } }, - "TimedMetadataBehavior": { - "target": "com.amazonaws.medialive#Fmp4TimedMetadataBehavior", + "StyleControl": { + "target": "com.amazonaws.medialive#EbuTtDDestinationStyleControl", "traits": { - "smithy.api#documentation": "When set to passthrough, timed metadata is passed through from input to output.", - "smithy.api#jsonName": "timedMetadataBehavior" + "smithy.api#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.", + "smithy.api#jsonName": "styleControl" } } }, "traits": { - "smithy.api#documentation": "Fmp4 Hls Settings" + "smithy.api#documentation": "Ebu Tt DDestination Settings" } }, - "com.amazonaws.medialive#Fmp4NielsenId3Behavior": { + "com.amazonaws.medialive#EbuTtDDestinationStyleControl": { "type": "enum", "members": { - "NO_PASSTHROUGH": { + "EXCLUDE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NO_PASSTHROUGH" + "smithy.api#enumValue": "EXCLUDE" } }, - "PASSTHROUGH": { + "INCLUDE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#enumValue": "INCLUDE" } } }, "traits": { - "smithy.api#documentation": "Fmp4 Nielsen Id3 Behavior" + "smithy.api#documentation": "Ebu Tt DDestination Style Control" } }, - "com.amazonaws.medialive#Fmp4TimedMetadataBehavior": { + "com.amazonaws.medialive#EbuTtDFillLineGapControl": { "type": "enum", "members": { - "NO_PASSTHROUGH": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NO_PASSTHROUGH" + "smithy.api#enumValue": "DISABLED" } }, - "PASSTHROUGH": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#enumValue": "ENABLED" } } }, "traits": { - "smithy.api#documentation": "Fmp4 Timed Metadata Behavior" + "smithy.api#documentation": "Ebu Tt DFill Line Gap Control" } }, - "com.amazonaws.medialive#FollowModeScheduleActionStartSettings": { - "type": "structure", + "com.amazonaws.medialive#EmbeddedConvert608To708": { + "type": "enum", "members": { - "FollowPoint": { - "target": "com.amazonaws.medialive#FollowPoint", + "DISABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies whether this action starts relative to the start or relative to the end of the reference action.", - "smithy.api#jsonName": "followPoint", - "smithy.api#required": {} + "smithy.api#enumValue": "DISABLED" } }, - "ReferenceActionName": { - "target": "com.amazonaws.medialive#__string", + "UPCONVERT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The action name of another action that this one refers to.", - "smithy.api#jsonName": "referenceActionName", - "smithy.api#required": {} + "smithy.api#enumValue": "UPCONVERT" } } }, "traits": { - "smithy.api#documentation": "Settings to specify if an action follows another." + "smithy.api#documentation": "Embedded Convert608 To708" } }, - "com.amazonaws.medialive#FollowPoint": { + "com.amazonaws.medialive#EmbeddedDestinationSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Embedded Destination Settings" + } + }, + "com.amazonaws.medialive#EmbeddedPlusScte20DestinationSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Embedded Plus Scte20 Destination Settings" + } + }, + "com.amazonaws.medialive#EmbeddedScte20Detection": { "type": "enum", "members": { - "END": { + "AUTO": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "END" + "smithy.api#enumValue": "AUTO" } }, - "START": { + "OFF": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "START" + "smithy.api#enumValue": "OFF" } } }, "traits": { - "smithy.api#documentation": "Follow reference point." + "smithy.api#documentation": "Embedded Scte20 Detection" } }, - "com.amazonaws.medialive#ForbiddenException": { + "com.amazonaws.medialive#EmbeddedSourceSettings": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.medialive#__string", + "Convert608To708": { + "target": "com.amazonaws.medialive#EmbeddedConvert608To708", "traits": { - "smithy.api#jsonName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for ForbiddenException", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.medialive#FrameCaptureCdnSettings": { - "type": "structure", - "members": { - "FrameCaptureS3Settings": { - "target": "com.amazonaws.medialive#FrameCaptureS3Settings", + "smithy.api#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.", + "smithy.api#jsonName": "convert608To708" + } + }, + "Scte20Detection": { + "target": "com.amazonaws.medialive#EmbeddedScte20Detection", "traits": { - "smithy.api#jsonName": "frameCaptureS3Settings" + "smithy.api#documentation": "Set to \"auto\" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.", + "smithy.api#jsonName": "scte20Detection" } - } - }, - "traits": { - "smithy.api#documentation": "Frame Capture Cdn Settings" - } - }, - "com.amazonaws.medialive#FrameCaptureGroupSettings": { - "type": "structure", - "members": { - "Destination": { - "target": "com.amazonaws.medialive#OutputLocationRef", + }, + "Source608ChannelNumber": { + "target": "com.amazonaws.medialive#__integerMin1Max4", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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", - "smithy.api#jsonName": "destination", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.", + "smithy.api#jsonName": "source608ChannelNumber" } }, - "FrameCaptureCdnSettings": { - "target": "com.amazonaws.medialive#FrameCaptureCdnSettings", + "Source608TrackNumber": { + "target": "com.amazonaws.medialive#__integerMin1Max5", "traits": { - "smithy.api#documentation": "Parameters that control interactions with the CDN.", - "smithy.api#jsonName": "frameCaptureCdnSettings" + "smithy.api#documentation": "This field is unused and deprecated.", + "smithy.api#jsonName": "source608TrackNumber" } } }, "traits": { - "smithy.api#documentation": "Frame Capture Group Settings" + "smithy.api#documentation": "Embedded Source Settings" } }, - "com.amazonaws.medialive#FrameCaptureHlsSettings": { + "com.amazonaws.medialive#EncoderSettings": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Frame Capture Hls Settings" - } - }, - "com.amazonaws.medialive#FrameCaptureIntervalUnit": { - "type": "enum", "members": { - "MILLISECONDS": { - "target": "smithy.api#Unit", + "AudioDescriptions": { + "target": "com.amazonaws.medialive#__listOfAudioDescription", "traits": { - "smithy.api#enumValue": "MILLISECONDS" + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "audioDescriptions", + "smithy.api#required": {} } }, - "SECONDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECONDS" - } - } - }, - "traits": { - "smithy.api#documentation": "Frame Capture Interval Unit" - } - }, - "com.amazonaws.medialive#FrameCaptureOutputSettings": { - "type": "structure", - "members": { - "NameModifier": { - "target": "com.amazonaws.medialive#__string", + "AvailBlanking": { + "target": "com.amazonaws.medialive#AvailBlanking", "traits": { - "smithy.api#documentation": "Required if the output group contains more than one output. This modifier forms part of the output file name.", - "smithy.api#jsonName": "nameModifier" + "smithy.api#documentation": "Settings for ad avail blanking.", + "smithy.api#jsonName": "availBlanking" } - } - }, - "traits": { - "smithy.api#documentation": "Frame Capture Output Settings" - } - }, - "com.amazonaws.medialive#FrameCaptureS3Settings": { - "type": "structure", - "members": { - "CannedAcl": { - "target": "com.amazonaws.medialive#S3CannedAcl", + }, + "AvailConfiguration": { + "target": "com.amazonaws.medialive#AvailConfiguration", "traits": { - "smithy.api#documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none.", - "smithy.api#jsonName": "cannedAcl" + "smithy.api#documentation": "Event-wide configuration settings for ad avail insertion.", + "smithy.api#jsonName": "availConfiguration" } - } - }, - "traits": { - "smithy.api#documentation": "Frame Capture S3 Settings" - } - }, - "com.amazonaws.medialive#FrameCaptureSettings": { - "type": "structure", - "members": { - "CaptureInterval": { - "target": "com.amazonaws.medialive#__integerMin1Max3600000", + }, + "BlackoutSlate": { + "target": "com.amazonaws.medialive#BlackoutSlate", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "captureInterval" + "smithy.api#documentation": "Settings for blackout slate.", + "smithy.api#jsonName": "blackoutSlate" } }, - "CaptureIntervalUnits": { - "target": "com.amazonaws.medialive#FrameCaptureIntervalUnit", + "CaptionDescriptions": { + "target": "com.amazonaws.medialive#__listOfCaptionDescription", "traits": { - "smithy.api#documentation": "Unit for the frame capture interval.", - "smithy.api#jsonName": "captureIntervalUnits" + "smithy.api#documentation": "Settings for caption decriptions", + "smithy.api#jsonName": "captionDescriptions" } }, - "TimecodeBurninSettings": { - "target": "com.amazonaws.medialive#TimecodeBurninSettings", + "FeatureActivations": { + "target": "com.amazonaws.medialive#FeatureActivations", "traits": { - "smithy.api#documentation": "Timecode burn-in settings", - "smithy.api#jsonName": "timecodeBurninSettings" + "smithy.api#documentation": "Feature Activations", + "smithy.api#jsonName": "featureActivations" } - } - }, - "traits": { - "smithy.api#documentation": "Frame Capture Settings" - } - }, - "com.amazonaws.medialive#GatewayTimeoutException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.medialive#__string", + }, + "GlobalConfiguration": { + "target": "com.amazonaws.medialive#GlobalConfiguration", "traits": { - "smithy.api#jsonName": "message" + "smithy.api#documentation": "Configuration settings that apply to the event as a whole.", + "smithy.api#jsonName": "globalConfiguration" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for GatewayTimeoutException", - "smithy.api#error": "server", - "smithy.api#httpError": 504 - } - }, - "com.amazonaws.medialive#GlobalConfiguration": { - "type": "structure", - "members": { - "InitialAudioGain": { - "target": "com.amazonaws.medialive#__integerMinNegative60Max60", + }, + "MotionGraphicsConfiguration": { + "target": "com.amazonaws.medialive#MotionGraphicsConfiguration", "traits": { - "smithy.api#documentation": "Value to set the initial audio gain for the Live Event.", - "smithy.api#jsonName": "initialAudioGain" + "smithy.api#documentation": "Settings for motion graphics.", + "smithy.api#jsonName": "motionGraphicsConfiguration" } }, - "InputEndAction": { - "target": "com.amazonaws.medialive#GlobalConfigurationInputEndAction", + "NielsenConfiguration": { + "target": "com.amazonaws.medialive#NielsenConfiguration", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "inputEndAction" + "smithy.api#documentation": "Nielsen configuration settings.", + "smithy.api#jsonName": "nielsenConfiguration" } }, - "InputLossBehavior": { - "target": "com.amazonaws.medialive#InputLossBehavior", + "OutputGroups": { + "target": "com.amazonaws.medialive#__listOfOutputGroup", "traits": { - "smithy.api#documentation": "Settings for system actions when input is lost.", - "smithy.api#jsonName": "inputLossBehavior" + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "outputGroups", + "smithy.api#required": {} } }, - "OutputLockingMode": { - "target": "com.amazonaws.medialive#GlobalConfigurationOutputLockingMode", + "TimecodeConfig": { + "target": "com.amazonaws.medialive#TimecodeConfig", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "outputLockingMode" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Contains settings used to acquire and adjust timecode information from inputs.", + "smithy.api#jsonName": "timecodeConfig", + "smithy.api#required": {} } }, - "OutputTimingSource": { - "target": "com.amazonaws.medialive#GlobalConfigurationOutputTimingSource", + "VideoDescriptions": { + "target": "com.amazonaws.medialive#__listOfVideoDescription", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "outputTimingSource" + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "videoDescriptions", + "smithy.api#required": {} } }, - "SupportLowFramerateInputs": { - "target": "com.amazonaws.medialive#GlobalConfigurationLowFramerateInputs", + "ThumbnailConfiguration": { + "target": "com.amazonaws.medialive#ThumbnailConfiguration", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "supportLowFramerateInputs" + "smithy.api#documentation": "Thumbnail configuration settings.", + "smithy.api#jsonName": "thumbnailConfiguration" } }, - "OutputLockingSettings": { - "target": "com.amazonaws.medialive#OutputLockingSettings", + "ColorCorrectionSettings": { + "target": "com.amazonaws.medialive#ColorCorrectionSettings", "traits": { - "smithy.api#documentation": "Advanced output locking settings", - "smithy.api#jsonName": "outputLockingSettings" + "smithy.api#documentation": "Color Correction Settings", + "smithy.api#jsonName": "colorCorrectionSettings" } } }, "traits": { - "smithy.api#documentation": "Global Configuration" + "smithy.api#documentation": "Encoder Settings" } }, - "com.amazonaws.medialive#GlobalConfigurationInputEndAction": { - "type": "enum", + "com.amazonaws.medialive#EpochLockingSettings": { + "type": "structure", "members": { - "NONE": { - "target": "smithy.api#Unit", + "CustomEpoch": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#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.", + "smithy.api#jsonName": "customEpoch" } }, - "SWITCH_AND_LOOP_INPUTS": { - "target": "smithy.api#Unit", + "JamSyncTime": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "SWITCH_AND_LOOP_INPUTS" + "smithy.api#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.", + "smithy.api#jsonName": "jamSyncTime" } } }, "traits": { - "smithy.api#documentation": "Global Configuration Input End Action" + "smithy.api#documentation": "Epoch Locking Settings" } }, - "com.amazonaws.medialive#GlobalConfigurationLowFramerateInputs": { - "type": "enum", + "com.amazonaws.medialive#Esam": { + "type": "structure", "members": { - "DISABLED": { - "target": "smithy.api#Unit", + "AcquisitionPointId": { + "target": "com.amazonaws.medialive#__stringMax256", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Sent as acquisitionPointIdentity to identify the MediaLive channel to the POIS.", + "smithy.api#jsonName": "acquisitionPointId", + "smithy.api#required": {} } }, - "ENABLED": { - "target": "smithy.api#Unit", + "AdAvailOffset": { + "target": "com.amazonaws.medialive#__integerMinNegative1000Max1000", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#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.", + "smithy.api#jsonName": "adAvailOffset" + } + }, + "PasswordParam": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Documentation update needed", + "smithy.api#jsonName": "passwordParam" + } + }, + "PoisEndpoint": { + "target": "com.amazonaws.medialive#__stringMax2048", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#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.", + "smithy.api#jsonName": "poisEndpoint", + "smithy.api#required": {} + } + }, + "Username": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Documentation update needed", + "smithy.api#jsonName": "username" + } + }, + "ZoneIdentity": { + "target": "com.amazonaws.medialive#__stringMax256", + "traits": { + "smithy.api#documentation": "Optional data sent as zoneIdentity to identify the MediaLive channel to the POIS.", + "smithy.api#jsonName": "zoneIdentity" } } }, "traits": { - "smithy.api#documentation": "Global Configuration Low Framerate Inputs" + "smithy.api#documentation": "Esam" } }, - "com.amazonaws.medialive#GlobalConfigurationOutputLockingMode": { + "com.amazonaws.medialive#EventBridgeRuleTemplateEventType": { "type": "enum", "members": { - "EPOCH_LOCKING": { + "MEDIALIVE_MULTIPLEX_ALERT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EPOCH_LOCKING" + "smithy.api#enumValue": "MEDIALIVE_MULTIPLEX_ALERT" } }, - "PIPELINE_LOCKING": { + "MEDIALIVE_MULTIPLEX_STATE_CHANGE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PIPELINE_LOCKING" + "smithy.api#enumValue": "MEDIALIVE_MULTIPLEX_STATE_CHANGE" } - } - }, - "traits": { - "smithy.api#documentation": "Global Configuration Output Locking Mode" - } - }, - "com.amazonaws.medialive#GlobalConfigurationOutputTimingSource": { - "type": "enum", - "members": { - "INPUT_CLOCK": { + }, + "MEDIALIVE_CHANNEL_ALERT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INPUT_CLOCK" + "smithy.api#enumValue": "MEDIALIVE_CHANNEL_ALERT" } }, - "SYSTEM_CLOCK": { + "MEDIALIVE_CHANNEL_INPUT_CHANGE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SYSTEM_CLOCK" + "smithy.api#enumValue": "MEDIALIVE_CHANNEL_INPUT_CHANGE" } - } - }, - "traits": { - "smithy.api#documentation": "Global Configuration Output Timing Source" - } - }, - "com.amazonaws.medialive#H264AdaptiveQuantization": { - "type": "enum", - "members": { - "AUTO": { + }, + "MEDIALIVE_CHANNEL_STATE_CHANGE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AUTO" + "smithy.api#enumValue": "MEDIALIVE_CHANNEL_STATE_CHANGE" } }, - "HIGH": { + "MEDIAPACKAGE_INPUT_NOTIFICATION": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HIGH" + "smithy.api#enumValue": "MEDIAPACKAGE_INPUT_NOTIFICATION" } }, - "HIGHER": { + "MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HIGHER" + "smithy.api#enumValue": "MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION" } }, - "LOW": { + "MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "LOW" + "smithy.api#enumValue": "MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION" } }, - "MAX": { + "SIGNAL_MAP_ACTIVE_ALARM": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MAX" + "smithy.api#enumValue": "SIGNAL_MAP_ACTIVE_ALARM" } }, - "MEDIUM": { + "MEDIACONNECT_ALERT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MEDIUM" + "smithy.api#enumValue": "MEDIACONNECT_ALERT" } }, - "OFF": { + "MEDIACONNECT_SOURCE_HEALTH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "OFF" + "smithy.api#enumValue": "MEDIACONNECT_SOURCE_HEALTH" } - } - }, - "traits": { - "smithy.api#documentation": "H264 Adaptive Quantization" - } - }, - "com.amazonaws.medialive#H264ColorMetadata": { - "type": "enum", - "members": { - "IGNORE": { + }, + "MEDIACONNECT_OUTPUT_HEALTH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "IGNORE" + "smithy.api#enumValue": "MEDIACONNECT_OUTPUT_HEALTH" } }, - "INSERT": { + "MEDIACONNECT_FLOW_STATUS_CHANGE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INSERT" + "smithy.api#enumValue": "MEDIACONNECT_FLOW_STATUS_CHANGE" } } }, "traits": { - "smithy.api#documentation": "H264 Color Metadata" + "smithy.api#documentation": "The type of event to match with the rule." } }, - "com.amazonaws.medialive#H264ColorSpaceSettings": { + "com.amazonaws.medialive#EventBridgeRuleTemplateGroupSummary": { "type": "structure", "members": { - "ColorSpacePassthroughSettings": { - "target": "com.amazonaws.medialive#ColorSpacePassthroughSettings", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveEventbridgeRuleTemplateGroup", "traits": { - "smithy.api#jsonName": "colorSpacePassthroughSettings" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn", + "smithy.api#required": {} } }, - "Rec601Settings": { - "target": "com.amazonaws.medialive#Rec601Settings", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#jsonName": "rec601Settings" + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "createdAt", + "smithy.api#required": {} } }, - "Rec709Settings": { - "target": "com.amazonaws.medialive#Rec709Settings", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#jsonName": "rec709Settings" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } - } - }, - "traits": { - "smithy.api#documentation": "H264 Color Space Settings" - } - }, - "com.amazonaws.medialive#H264EntropyEncoding": { - "type": "enum", - "members": { - "CABAC": { - "target": "smithy.api#Unit", + }, + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#enumValue": "CABAC" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "id", + "smithy.api#required": {} } }, - "CAVLC": { - "target": "smithy.api#Unit", + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "CAVLC" + "smithy.api#jsonName": "modifiedAt" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" + } + }, + "TemplateCount": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of templates in a group.", + "smithy.api#jsonName": "templateCount", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "H264 Entropy Encoding" + "smithy.api#documentation": "Placeholder documentation for EventBridgeRuleTemplateGroupSummary" } }, - "com.amazonaws.medialive#H264FilterSettings": { + "com.amazonaws.medialive#EventBridgeRuleTemplateSummary": { "type": "structure", "members": { - "TemporalFilterSettings": { - "target": "com.amazonaws.medialive#TemporalFilterSettings", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveEventbridgeRuleTemplate", "traits": { - "smithy.api#jsonName": "temporalFilterSettings" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An eventbridge rule template's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "H264 Filter Settings" - } - }, - "com.amazonaws.medialive#H264FlickerAq": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", + }, + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "createdAt", + "smithy.api#required": {} } }, - "ENABLED": { - "target": "smithy.api#Unit", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } - } - }, - "traits": { - "smithy.api#documentation": "H264 Flicker Aq" - } - }, - "com.amazonaws.medialive#H264ForceFieldPictures": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", + }, + "EventTargetCount": { + "target": "com.amazonaws.medialive#__integerMax5", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of targets configured to send matching events.", + "smithy.api#jsonName": "eventTargetCount", + "smithy.api#required": {} } }, - "ENABLED": { - "target": "smithy.api#Unit", + "EventType": { + "target": "com.amazonaws.medialive#EventBridgeRuleTemplateEventType", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "eventType", + "smithy.api#required": {} + } + }, + "GroupId": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "groupId", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`", + "smithy.api#jsonName": "id", + "smithy.api#required": {} + } + }, + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "modifiedAt" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "H264 Force Field Pictures" + "smithy.api#documentation": "Placeholder documentation for EventBridgeRuleTemplateSummary" } }, - "com.amazonaws.medialive#H264FramerateControl": { - "type": "enum", + "com.amazonaws.medialive#EventBridgeRuleTemplateTarget": { + "type": "structure", "members": { - "INITIALIZE_FROM_SOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INITIALIZE_FROM_SOURCE" - } - }, - "SPECIFIED": { - "target": "smithy.api#Unit", + "Arn": { + "target": "com.amazonaws.medialive#__stringMin1Max2048PatternArn", "traits": { - "smithy.api#enumValue": "SPECIFIED" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Target ARNs must be either an SNS topic or CloudWatch log group.", + "smithy.api#jsonName": "arn", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "H264 Framerate Control" + "smithy.api#documentation": "The target to which to send matching events." } }, - "com.amazonaws.medialive#H264GopBReference": { + "com.amazonaws.medialive#FailedMediaResourceMap": { + "type": "map", + "key": { + "target": "com.amazonaws.medialive#__string" + }, + "value": { + "target": "com.amazonaws.medialive#MediaResource" + }, + "traits": { + "smithy.api#documentation": "A map representing an incomplete AWS media workflow as a graph." + } + }, + "com.amazonaws.medialive#FailoverCondition": { + "type": "structure", + "members": { + "FailoverConditionSettings": { + "target": "com.amazonaws.medialive#FailoverConditionSettings", + "traits": { + "smithy.api#documentation": "Failover condition type-specific settings.", + "smithy.api#jsonName": "failoverConditionSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings." + } + }, + "com.amazonaws.medialive#FailoverConditionSettings": { + "type": "structure", + "members": { + "AudioSilenceSettings": { + "target": "com.amazonaws.medialive#AudioSilenceFailoverSettings", + "traits": { + "smithy.api#documentation": "MediaLive will perform a failover if the specified audio selector is silent for the specified period.", + "smithy.api#jsonName": "audioSilenceSettings" + } + }, + "InputLossSettings": { + "target": "com.amazonaws.medialive#InputLossFailoverSettings", + "traits": { + "smithy.api#documentation": "MediaLive will perform a failover if content is not detected in this input for the specified period.", + "smithy.api#jsonName": "inputLossSettings" + } + }, + "VideoBlackSettings": { + "target": "com.amazonaws.medialive#VideoBlackFailoverSettings", + "traits": { + "smithy.api#documentation": "MediaLive will perform a failover if content is considered black for the specified period.", + "smithy.api#jsonName": "videoBlackSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for one failover condition." + } + }, + "com.amazonaws.medialive#FeatureActivations": { + "type": "structure", + "members": { + "InputPrepareScheduleActions": { + "target": "com.amazonaws.medialive#FeatureActivationsInputPrepareScheduleActions", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "inputPrepareScheduleActions" + } + }, + "OutputStaticImageOverlayScheduleActions": { + "target": "com.amazonaws.medialive#FeatureActivationsOutputStaticImageOverlayScheduleActions", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "outputStaticImageOverlayScheduleActions" + } + } + }, + "traits": { + "smithy.api#documentation": "Feature Activations" + } + }, + "com.amazonaws.medialive#FeatureActivationsInputPrepareScheduleActions": { "type": "enum", "members": { "DISABLED": { @@ -9960,1044 +10998,1388 @@ } }, "traits": { - "smithy.api#documentation": "H264 Gop BReference" + "smithy.api#documentation": "Feature Activations Input Prepare Schedule Actions" } }, - "com.amazonaws.medialive#H264GopSizeUnits": { + "com.amazonaws.medialive#FeatureActivationsOutputStaticImageOverlayScheduleActions": { "type": "enum", "members": { - "FRAMES": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FRAMES" + "smithy.api#enumValue": "DISABLED" } }, - "SECONDS": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SECONDS" + "smithy.api#enumValue": "ENABLED" } } }, "traits": { - "smithy.api#documentation": "H264 Gop Size Units" + "smithy.api#documentation": "Feature Activations Output Static Image Overlay Schedule Actions" } }, - "com.amazonaws.medialive#H264Level": { + "com.amazonaws.medialive#FecOutputIncludeFec": { "type": "enum", "members": { - "H264_LEVEL_1": { + "COLUMN": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_1" + "smithy.api#enumValue": "COLUMN" } }, - "H264_LEVEL_1_1": { + "COLUMN_AND_ROW": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_1_1" + "smithy.api#enumValue": "COLUMN_AND_ROW" } - }, - "H264_LEVEL_1_2": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#documentation": "Fec Output Include Fec" + } + }, + "com.amazonaws.medialive#FecOutputSettings": { + "type": "structure", + "members": { + "ColumnDepth": { + "target": "com.amazonaws.medialive#__integerMin4Max20", "traits": { - "smithy.api#enumValue": "H264_LEVEL_1_2" + "smithy.api#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.", + "smithy.api#jsonName": "columnDepth" } }, - "H264_LEVEL_1_3": { - "target": "smithy.api#Unit", + "IncludeFec": { + "target": "com.amazonaws.medialive#FecOutputIncludeFec", "traits": { - "smithy.api#enumValue": "H264_LEVEL_1_3" + "smithy.api#documentation": "Enables column only or column and row based FEC", + "smithy.api#jsonName": "includeFec" } }, - "H264_LEVEL_2": { - "target": "smithy.api#Unit", + "RowLength": { + "target": "com.amazonaws.medialive#__integerMin1Max20", "traits": { - "smithy.api#enumValue": "H264_LEVEL_2" + "smithy.api#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.", + "smithy.api#jsonName": "rowLength" } - }, - "H264_LEVEL_2_1": { + } + }, + "traits": { + "smithy.api#documentation": "Fec Output Settings" + } + }, + "com.amazonaws.medialive#FixedAfd": { + "type": "enum", + "members": { + "AFD_0000": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_2_1" + "smithy.api#enumValue": "AFD_0000" } }, - "H264_LEVEL_2_2": { + "AFD_0010": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_2_2" + "smithy.api#enumValue": "AFD_0010" } }, - "H264_LEVEL_3": { + "AFD_0011": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_3" + "smithy.api#enumValue": "AFD_0011" } }, - "H264_LEVEL_3_1": { + "AFD_0100": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_3_1" + "smithy.api#enumValue": "AFD_0100" } }, - "H264_LEVEL_3_2": { + "AFD_1000": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_3_2" + "smithy.api#enumValue": "AFD_1000" } }, - "H264_LEVEL_4": { + "AFD_1001": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_4" + "smithy.api#enumValue": "AFD_1001" } }, - "H264_LEVEL_4_1": { + "AFD_1010": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_4_1" + "smithy.api#enumValue": "AFD_1010" } }, - "H264_LEVEL_4_2": { + "AFD_1011": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_4_2" + "smithy.api#enumValue": "AFD_1011" } }, - "H264_LEVEL_5": { + "AFD_1101": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_5" + "smithy.api#enumValue": "AFD_1101" } }, - "H264_LEVEL_5_1": { + "AFD_1110": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_5_1" + "smithy.api#enumValue": "AFD_1110" } }, - "H264_LEVEL_5_2": { + "AFD_1111": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "H264_LEVEL_5_2" + "smithy.api#enumValue": "AFD_1111" } - }, - "H264_LEVEL_AUTO": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#documentation": "Fixed Afd" + } + }, + "com.amazonaws.medialive#FixedModeScheduleActionStartSettings": { + "type": "structure", + "members": { + "Time": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "H264_LEVEL_AUTO" + "smithy.api#clientOptional": {}, + "smithy.api#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\".", + "smithy.api#jsonName": "time", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "H264 Level" + "smithy.api#documentation": "Start time for the action." } }, - "com.amazonaws.medialive#H264LookAheadRateControl": { - "type": "enum", + "com.amazonaws.medialive#Fmp4HlsSettings": { + "type": "structure", "members": { - "HIGH": { - "target": "smithy.api#Unit", + "AudioRenditionSets": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "HIGH" + "smithy.api#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 ','.", + "smithy.api#jsonName": "audioRenditionSets" } }, - "LOW": { - "target": "smithy.api#Unit", + "NielsenId3Behavior": { + "target": "com.amazonaws.medialive#Fmp4NielsenId3Behavior", "traits": { - "smithy.api#enumValue": "LOW" + "smithy.api#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.", + "smithy.api#jsonName": "nielsenId3Behavior" } }, - "MEDIUM": { - "target": "smithy.api#Unit", + "TimedMetadataBehavior": { + "target": "com.amazonaws.medialive#Fmp4TimedMetadataBehavior", "traits": { - "smithy.api#enumValue": "MEDIUM" + "smithy.api#documentation": "When set to passthrough, timed metadata is passed through from input to output.", + "smithy.api#jsonName": "timedMetadataBehavior" } } }, "traits": { - "smithy.api#documentation": "H264 Look Ahead Rate Control" + "smithy.api#documentation": "Fmp4 Hls Settings" } }, - "com.amazonaws.medialive#H264ParControl": { + "com.amazonaws.medialive#Fmp4NielsenId3Behavior": { "type": "enum", "members": { - "INITIALIZE_FROM_SOURCE": { + "NO_PASSTHROUGH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INITIALIZE_FROM_SOURCE" + "smithy.api#enumValue": "NO_PASSTHROUGH" } }, - "SPECIFIED": { + "PASSTHROUGH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SPECIFIED" + "smithy.api#enumValue": "PASSTHROUGH" } } }, "traits": { - "smithy.api#documentation": "H264 Par Control" + "smithy.api#documentation": "Fmp4 Nielsen Id3 Behavior" } }, - "com.amazonaws.medialive#H264Profile": { + "com.amazonaws.medialive#Fmp4TimedMetadataBehavior": { "type": "enum", "members": { - "BASELINE": { + "NO_PASSTHROUGH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "BASELINE" + "smithy.api#enumValue": "NO_PASSTHROUGH" } }, - "HIGH": { + "PASSTHROUGH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HIGH" - } - }, - "HIGH_10BIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIGH_10BIT" - } - }, - "HIGH_422": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIGH_422" - } - }, - "HIGH_422_10BIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIGH_422_10BIT" - } - }, - "MAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAIN" + "smithy.api#enumValue": "PASSTHROUGH" } } }, "traits": { - "smithy.api#documentation": "H264 Profile" + "smithy.api#documentation": "Fmp4 Timed Metadata Behavior" } }, - "com.amazonaws.medialive#H264QualityLevel": { - "type": "enum", + "com.amazonaws.medialive#FollowModeScheduleActionStartSettings": { + "type": "structure", "members": { - "ENHANCED_QUALITY": { - "target": "smithy.api#Unit", + "FollowPoint": { + "target": "com.amazonaws.medialive#FollowPoint", "traits": { - "smithy.api#enumValue": "ENHANCED_QUALITY" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Identifies whether this action starts relative to the start or relative to the end of the reference action.", + "smithy.api#jsonName": "followPoint", + "smithy.api#required": {} } }, - "STANDARD_QUALITY": { - "target": "smithy.api#Unit", + "ReferenceActionName": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "STANDARD_QUALITY" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The action name of another action that this one refers to.", + "smithy.api#jsonName": "referenceActionName", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "H264 Quality Level" + "smithy.api#documentation": "Settings to specify if an action follows another." } }, - "com.amazonaws.medialive#H264RateControlMode": { + "com.amazonaws.medialive#FollowPoint": { "type": "enum", "members": { - "CBR": { + "END": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CBR" + "smithy.api#enumValue": "END" } }, - "MULTIPLEX": { + "START": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MULTIPLEX" + "smithy.api#enumValue": "START" } - }, - "QVBR": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#documentation": "Follow reference point." + } + }, + "com.amazonaws.medialive#ForbiddenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "QVBR" + "smithy.api#jsonName": "message" } - }, - "VBR": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ForbiddenException", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.medialive#FrameCaptureCdnSettings": { + "type": "structure", + "members": { + "FrameCaptureS3Settings": { + "target": "com.amazonaws.medialive#FrameCaptureS3Settings", "traits": { - "smithy.api#enumValue": "VBR" + "smithy.api#jsonName": "frameCaptureS3Settings" } } }, "traits": { - "smithy.api#documentation": "H264 Rate Control Mode" + "smithy.api#documentation": "Frame Capture Cdn Settings" } }, - "com.amazonaws.medialive#H264ScanType": { - "type": "enum", + "com.amazonaws.medialive#FrameCaptureGroupSettings": { + "type": "structure", "members": { - "INTERLACED": { - "target": "smithy.api#Unit", + "Destination": { + "target": "com.amazonaws.medialive#OutputLocationRef", "traits": { - "smithy.api#enumValue": "INTERLACED" + "smithy.api#clientOptional": {}, + "smithy.api#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", + "smithy.api#jsonName": "destination", + "smithy.api#required": {} } }, - "PROGRESSIVE": { - "target": "smithy.api#Unit", + "FrameCaptureCdnSettings": { + "target": "com.amazonaws.medialive#FrameCaptureCdnSettings", "traits": { - "smithy.api#enumValue": "PROGRESSIVE" + "smithy.api#documentation": "Parameters that control interactions with the CDN.", + "smithy.api#jsonName": "frameCaptureCdnSettings" } } }, "traits": { - "smithy.api#documentation": "H264 Scan Type" + "smithy.api#documentation": "Frame Capture Group Settings" } }, - "com.amazonaws.medialive#H264SceneChangeDetect": { + "com.amazonaws.medialive#FrameCaptureHlsSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Frame Capture Hls Settings" + } + }, + "com.amazonaws.medialive#FrameCaptureIntervalUnit": { "type": "enum", "members": { - "DISABLED": { + "MILLISECONDS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "MILLISECONDS" } }, - "ENABLED": { + "SECONDS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "SECONDS" } } }, "traits": { - "smithy.api#documentation": "H264 Scene Change Detect" + "smithy.api#documentation": "Frame Capture Interval Unit" } }, - "com.amazonaws.medialive#H264Settings": { + "com.amazonaws.medialive#FrameCaptureOutputSettings": { "type": "structure", "members": { - "AdaptiveQuantization": { - "target": "com.amazonaws.medialive#H264AdaptiveQuantization", + "NameModifier": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "adaptiveQuantization" + "smithy.api#documentation": "Required if the output group contains more than one output. This modifier forms part of the output file name.", + "smithy.api#jsonName": "nameModifier" } - }, - "AfdSignaling": { - "target": "com.amazonaws.medialive#AfdSignaling", + } + }, + "traits": { + "smithy.api#documentation": "Frame Capture Output Settings" + } + }, + "com.amazonaws.medialive#FrameCaptureS3Settings": { + "type": "structure", + "members": { + "CannedAcl": { + "target": "com.amazonaws.medialive#S3CannedAcl", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "afdSignaling" + "smithy.api#documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none.", + "smithy.api#jsonName": "cannedAcl" } - }, - "Bitrate": { - "target": "com.amazonaws.medialive#__integerMin1000", + } + }, + "traits": { + "smithy.api#documentation": "Frame Capture S3 Settings" + } + }, + "com.amazonaws.medialive#FrameCaptureSettings": { + "type": "structure", + "members": { + "CaptureInterval": { + "target": "com.amazonaws.medialive#__integerMin1Max3600000", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "bitrate" + "smithy.api#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.", + "smithy.api#jsonName": "captureInterval" } }, - "BufFillPct": { - "target": "com.amazonaws.medialive#__integerMin0Max100", + "CaptureIntervalUnits": { + "target": "com.amazonaws.medialive#FrameCaptureIntervalUnit", "traits": { - "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", - "smithy.api#jsonName": "bufFillPct" + "smithy.api#documentation": "Unit for the frame capture interval.", + "smithy.api#jsonName": "captureIntervalUnits" } }, - "BufSize": { - "target": "com.amazonaws.medialive#__integerMin0", + "TimecodeBurninSettings": { + "target": "com.amazonaws.medialive#TimecodeBurninSettings", "traits": { - "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits.", - "smithy.api#jsonName": "bufSize" + "smithy.api#documentation": "Timecode burn-in settings", + "smithy.api#jsonName": "timecodeBurninSettings" } - }, - "ColorMetadata": { - "target": "com.amazonaws.medialive#H264ColorMetadata", + } + }, + "traits": { + "smithy.api#documentation": "Frame Capture Settings" + } + }, + "com.amazonaws.medialive#GatewayTimeoutException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Includes colorspace metadata in the output.", - "smithy.api#jsonName": "colorMetadata" + "smithy.api#jsonName": "message" } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for GatewayTimeoutException", + "smithy.api#error": "server", + "smithy.api#httpError": 504 + } + }, + "com.amazonaws.medialive#GetCloudWatchAlarmTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#GetCloudWatchAlarmTemplateRequest" + }, + "output": { + "target": "com.amazonaws.medialive#GetCloudWatchAlarmTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "ColorSpaceSettings": { - "target": "com.amazonaws.medialive#H264ColorSpaceSettings", - "traits": { - "smithy.api#documentation": "Color Space settings", - "smithy.api#jsonName": "colorSpaceSettings" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "EntropyEncoding": { - "target": "com.amazonaws.medialive#H264EntropyEncoding", - "traits": { - "smithy.api#documentation": "Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.", - "smithy.api#jsonName": "entropyEncoding" - } + { + "target": "com.amazonaws.medialive#InternalServerErrorException" }, - "FilterSettings": { - "target": "com.amazonaws.medialive#H264FilterSettings", - "traits": { - "smithy.api#documentation": "Optional filters that you can apply to an encode.", - "smithy.api#jsonName": "filterSettings" - } + { + "target": "com.amazonaws.medialive#NotFoundException" }, - "FixedAfd": { - "target": "com.amazonaws.medialive#FixedAfd", - "traits": { - "smithy.api#documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.", - "smithy.api#jsonName": "fixedAfd" - } - }, - "FlickerAq": { - "target": "com.amazonaws.medialive#H264FlickerAq", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "flickerAq" - } - }, - "ForceFieldPictures": { - "target": "com.amazonaws.medialive#H264ForceFieldPictures", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "forceFieldPictures" - } + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified cloudwatch alarm template.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/cloudwatch-alarm-templates/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.medialive#GetCloudWatchAlarmTemplateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#GetCloudWatchAlarmTemplateGroupRequest" + }, + "output": { + "target": "com.amazonaws.medialive#GetCloudWatchAlarmTemplateGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "FramerateControl": { - "target": "com.amazonaws.medialive#H264FramerateControl", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "framerateControl" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "FramerateDenominator": { - "target": "com.amazonaws.medialive#__integerMin1", - "traits": { - "smithy.api#documentation": "Framerate denominator.", - "smithy.api#jsonName": "framerateDenominator" - } + { + "target": "com.amazonaws.medialive#InternalServerErrorException" }, - "FramerateNumerator": { - "target": "com.amazonaws.medialive#__integerMin1", - "traits": { - "smithy.api#documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.", - "smithy.api#jsonName": "framerateNumerator" - } + { + "target": "com.amazonaws.medialive#NotFoundException" }, - "GopBReference": { - "target": "com.amazonaws.medialive#H264GopBReference", + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified cloudwatch alarm template group.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/cloudwatch-alarm-template-groups/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.medialive#GetCloudWatchAlarmTemplateGroupRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Documentation update needed", - "smithy.api#jsonName": "gopBReference" + "smithy.api#documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - }, - "GopClosedCadence": { - "target": "com.amazonaws.medialive#__integerMin0", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateGroupRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#GetCloudWatchAlarmTemplateGroupResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "gopClosedCadence" + "smithy.api#documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" } }, - "GopNumBFrames": { - "target": "com.amazonaws.medialive#__integerMin0Max7", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "Number of B-frames between reference frames.", - "smithy.api#jsonName": "gopNumBFrames" + "smithy.api#jsonName": "createdAt" } }, - "GopSize": { - "target": "com.amazonaws.medialive#__double", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "gopSize" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "GopSizeUnits": { - "target": "com.amazonaws.medialive#H264GopSizeUnits", + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "gopSizeUnits" + "smithy.api#documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "id" } }, - "Level": { - "target": "com.amazonaws.medialive#H264Level", + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "H.264 Level.", - "smithy.api#jsonName": "level" + "smithy.api#jsonName": "modifiedAt" } }, - "LookAheadRateControl": { - "target": "com.amazonaws.medialive#H264LookAheadRateControl", + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.", - "smithy.api#jsonName": "lookAheadRateControl" + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" } }, - "MaxBitrate": { - "target": "com.amazonaws.medialive#__integerMin1000", + "Tags": { + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#jsonName": "tags" } - }, - "MinIInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max30", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateGroupResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#GetCloudWatchAlarmTemplateRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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", - "smithy.api#jsonName": "minIInterval" + "smithy.api#documentation": "A cloudwatch alarm template's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - }, - "NumRefFrames": { - "target": "com.amazonaws.medialive#__integerMin1Max6", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#GetCloudWatchAlarmTemplateResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveCloudwatchAlarmTemplate", "traits": { - "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", - "smithy.api#jsonName": "numRefFrames" + "smithy.api#documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" } }, - "ParControl": { - "target": "com.amazonaws.medialive#H264ParControl", + "ComparisonOperator": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateComparisonOperator", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "parControl" + "smithy.api#jsonName": "comparisonOperator" } }, - "ParDenominator": { - "target": "com.amazonaws.medialive#__integerMin1", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "Pixel Aspect Ratio denominator.", - "smithy.api#jsonName": "parDenominator" + "smithy.api#jsonName": "createdAt" } }, - "ParNumerator": { + "DatapointsToAlarm": { "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Pixel Aspect Ratio numerator.", - "smithy.api#jsonName": "parNumerator" - } - }, - "Profile": { - "target": "com.amazonaws.medialive#H264Profile", - "traits": { - "smithy.api#documentation": "H.264 Profile.", - "smithy.api#jsonName": "profile" + "smithy.api#documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm.", + "smithy.api#jsonName": "datapointsToAlarm" } }, - "QualityLevel": { - "target": "com.amazonaws.medialive#H264QualityLevel", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "qualityLevel" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "QvbrQualityLevel": { - "target": "com.amazonaws.medialive#__integerMin1Max10", + "EvaluationPeriods": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#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", - "smithy.api#jsonName": "qvbrQualityLevel" + "smithy.api#documentation": "The number of periods over which data is compared to the specified threshold.", + "smithy.api#jsonName": "evaluationPeriods" } }, - "RateControlMode": { - "target": "com.amazonaws.medialive#H264RateControlMode", + "GroupId": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "rateControlMode" + "smithy.api#documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "groupId" } }, - "ScanType": { - "target": "com.amazonaws.medialive#H264ScanType", + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#documentation": "Sets the scan type of the output to progressive or top-field-first interlaced.", - "smithy.api#jsonName": "scanType" + "smithy.api#documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`", + "smithy.api#jsonName": "id" } }, - "SceneChangeDetect": { - "target": "com.amazonaws.medialive#H264SceneChangeDetect", + "MetricName": { + "target": "com.amazonaws.medialive#__stringMax64", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "sceneChangeDetect" + "smithy.api#documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType.", + "smithy.api#jsonName": "metricName" } }, - "Slices": { - "target": "com.amazonaws.medialive#__integerMin1Max32", + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "slices" + "smithy.api#jsonName": "modifiedAt" } }, - "Softness": { - "target": "com.amazonaws.medialive#__integerMin0Max128", + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "softness" + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" } }, - "SpatialAq": { - "target": "com.amazonaws.medialive#H264SpatialAq", + "Period": { + "target": "com.amazonaws.medialive#__integerMin10Max86400", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "spatialAq" + "smithy.api#documentation": "The period, in seconds, over which the specified statistic is applied.", + "smithy.api#jsonName": "period" } }, - "SubgopLength": { - "target": "com.amazonaws.medialive#H264SubGopLength", + "Statistic": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateStatistic", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "subgopLength" + "smithy.api#jsonName": "statistic" } }, - "Syntax": { - "target": "com.amazonaws.medialive#H264Syntax", + "Tags": { + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#documentation": "Produces a bitstream compliant with SMPTE RP-2027.", - "smithy.api#jsonName": "syntax" + "smithy.api#jsonName": "tags" } }, - "TemporalAq": { - "target": "com.amazonaws.medialive#H264TemporalAq", + "TargetResourceType": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTargetResourceType", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "temporalAq" + "smithy.api#jsonName": "targetResourceType" } }, - "TimecodeInsertion": { - "target": "com.amazonaws.medialive#H264TimecodeInsertionBehavior", + "Threshold": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#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", - "smithy.api#jsonName": "timecodeInsertion" + "smithy.api#documentation": "The threshold value to compare with the specified statistic.", + "smithy.api#jsonName": "threshold" } }, - "TimecodeBurninSettings": { - "target": "com.amazonaws.medialive#TimecodeBurninSettings", + "TreatMissingData": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTreatMissingData", "traits": { - "smithy.api#documentation": "Timecode burn-in settings", - "smithy.api#jsonName": "timecodeBurninSettings" + "smithy.api#jsonName": "treatMissingData" } } }, "traits": { - "smithy.api#documentation": "H264 Settings" + "smithy.api#documentation": "Placeholder documentation for GetCloudWatchAlarmTemplateResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#H264SpatialAq": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - } + "com.amazonaws.medialive#GetEventBridgeRuleTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#GetEventBridgeRuleTemplateRequest" }, - "traits": { - "smithy.api#documentation": "H264 Spatial Aq" - } - }, - "com.amazonaws.medialive#H264SubGopLength": { - "type": "enum", - "members": { - "DYNAMIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DYNAMIC" - } - }, - "FIXED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIXED" - } - } + "output": { + "target": "com.amazonaws.medialive#GetEventBridgeRuleTemplateResponse" }, - "traits": { - "smithy.api#documentation": "H264 Sub Gop Length" - } - }, - "com.amazonaws.medialive#H264Syntax": { - "type": "enum", - "members": { - "DEFAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULT" - } + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "RP2027": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RP2027" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" } - }, + ], "traits": { - "smithy.api#documentation": "H264 Syntax" + "smithy.api#documentation": "Retrieves the specified eventbridge rule template.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/eventbridge-rule-templates/{Identifier}", + "code": 200 + } } }, - "com.amazonaws.medialive#H264TemporalAq": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } + "com.amazonaws.medialive#GetEventBridgeRuleTemplateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#GetEventBridgeRuleTemplateGroupRequest" + }, + "output": { + "target": "com.amazonaws.medialive#GetEventBridgeRuleTemplateGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" } - }, + ], "traits": { - "smithy.api#documentation": "H264 Temporal Aq" + "smithy.api#documentation": "Retrieves the specified eventbridge rule template group.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/eventbridge-rule-template-groups/{Identifier}", + "code": 200 + } } }, - "com.amazonaws.medialive#H264TimecodeInsertionBehavior": { - "type": "enum", + "com.amazonaws.medialive#GetEventBridgeRuleTemplateGroupRequest": { + "type": "structure", "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "PIC_TIMING_SEI": { - "target": "smithy.api#Unit", + "Identifier": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "PIC_TIMING_SEI" + "smithy.api#documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "H264 Timecode Insertion Behavior" + "smithy.api#documentation": "Placeholder documentation for GetEventBridgeRuleTemplateGroupRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#H265AdaptiveQuantization": { - "type": "enum", + "com.amazonaws.medialive#GetEventBridgeRuleTemplateGroupResponse": { + "type": "structure", "members": { - "AUTO": { - "target": "smithy.api#Unit", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveEventbridgeRuleTemplateGroup", "traits": { - "smithy.api#enumValue": "AUTO" + "smithy.api#documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" } }, - "HIGH": { - "target": "smithy.api#Unit", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "HIGH" + "smithy.api#jsonName": "createdAt" } }, - "HIGHER": { - "target": "smithy.api#Unit", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#enumValue": "HIGHER" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "LOW": { - "target": "smithy.api#Unit", + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#enumValue": "LOW" + "smithy.api#documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "id" } }, - "MAX": { - "target": "smithy.api#Unit", + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "MAX" + "smithy.api#jsonName": "modifiedAt" } }, - "MEDIUM": { - "target": "smithy.api#Unit", + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#enumValue": "MEDIUM" + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" } }, - "OFF": { - "target": "smithy.api#Unit", + "Tags": { + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#enumValue": "OFF" + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "H265 Adaptive Quantization" + "smithy.api#documentation": "Placeholder documentation for GetEventBridgeRuleTemplateGroupResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#H265AlternativeTransferFunction": { - "type": "enum", + "com.amazonaws.medialive#GetEventBridgeRuleTemplateRequest": { + "type": "structure", "members": { - "INSERT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSERT" - } - }, - "OMIT": { - "target": "smithy.api#Unit", + "Identifier": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "OMIT" + "smithy.api#documentation": "An eventbridge rule template's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "H265 Alternative Transfer Function" + "smithy.api#documentation": "Placeholder documentation for GetEventBridgeRuleTemplateRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#H265ColorMetadata": { - "type": "enum", + "com.amazonaws.medialive#GetEventBridgeRuleTemplateResponse": { + "type": "structure", "members": { - "IGNORE": { - "target": "smithy.api#Unit", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveEventbridgeRuleTemplate", "traits": { - "smithy.api#enumValue": "IGNORE" + "smithy.api#documentation": "An eventbridge rule template's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" } }, - "INSERT": { - "target": "smithy.api#Unit", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "INSERT" + "smithy.api#jsonName": "createdAt" } - } - }, - "traits": { - "smithy.api#documentation": "H265 Color Metadata" - } - }, - "com.amazonaws.medialive#H265ColorSpaceSettings": { - "type": "structure", - "members": { - "ColorSpacePassthroughSettings": { - "target": "com.amazonaws.medialive#ColorSpacePassthroughSettings", + }, + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#jsonName": "colorSpacePassthroughSettings" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "DolbyVision81Settings": { - "target": "com.amazonaws.medialive#DolbyVision81Settings", + "EventTargets": { + "target": "com.amazonaws.medialive#__listOfEventBridgeRuleTemplateTarget", "traits": { - "smithy.api#jsonName": "dolbyVision81Settings" + "smithy.api#jsonName": "eventTargets" } }, - "Hdr10Settings": { - "target": "com.amazonaws.medialive#Hdr10Settings", + "EventType": { + "target": "com.amazonaws.medialive#EventBridgeRuleTemplateEventType", "traits": { - "smithy.api#jsonName": "hdr10Settings" + "smithy.api#jsonName": "eventType" } }, - "Rec601Settings": { - "target": "com.amazonaws.medialive#Rec601Settings", + "GroupId": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#jsonName": "rec601Settings" + "smithy.api#documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "groupId" } }, - "Rec709Settings": { - "target": "com.amazonaws.medialive#Rec709Settings", + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#jsonName": "rec709Settings" + "smithy.api#documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`", + "smithy.api#jsonName": "id" } - } - }, - "traits": { - "smithy.api#documentation": "H265 Color Space Settings" - } - }, - "com.amazonaws.medialive#H265FilterSettings": { - "type": "structure", - "members": { - "TemporalFilterSettings": { - "target": "com.amazonaws.medialive#TemporalFilterSettings", + }, + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#jsonName": "temporalFilterSettings" + "smithy.api#jsonName": "modifiedAt" } - } - }, - "traits": { - "smithy.api#documentation": "H265 Filter Settings" - } - }, - "com.amazonaws.medialive#H265FlickerAq": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" } }, - "ENABLED": { - "target": "smithy.api#Unit", + "Tags": { + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "H265 Flicker Aq" + "smithy.api#documentation": "Placeholder documentation for GetEventBridgeRuleTemplateResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#H265GopSizeUnits": { - "type": "enum", - "members": { - "FRAMES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FRAMES" - } - }, - "SECONDS": { - "target": "smithy.api#Unit", + "com.amazonaws.medialive#GetSignalMap": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#GetSignalMapRequest" + }, + "output": { + "target": "com.amazonaws.medialive#GetSignalMapResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified signal map.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/signal-maps/{Identifier}", + "code": 200 + }, + "smithy.waiters#waitable": { + "SignalMapCreated": { + "documentation": "Wait until a signal map has been created", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Status", + "expected": "CREATE_COMPLETE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "Status", + "expected": "CREATE_IN_PROGRESS", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Status", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5 + }, + "SignalMapMonitorDeleted": { + "documentation": "Wait until a signal map's monitor has been deleted", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "MonitorDeployment.Status", + "expected": "DELETE_COMPLETE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "MonitorDeployment.Status", + "expected": "DELETE_IN_PROGRESS", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "MonitorDeployment.Status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5 + }, + "SignalMapMonitorDeployed": { + "documentation": "Wait until a signal map's monitor has been deployed", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "MonitorDeployment.Status", + "expected": "DRY_RUN_DEPLOYMENT_COMPLETE", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "MonitorDeployment.Status", + "expected": "DEPLOYMENT_COMPLETE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "MonitorDeployment.Status", + "expected": "DRY_RUN_DEPLOYMENT_IN_PROGRESS", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "MonitorDeployment.Status", + "expected": "DEPLOYMENT_IN_PROGRESS", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "MonitorDeployment.Status", + "expected": "DRY_RUN_DEPLOYMENT_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "MonitorDeployment.Status", + "expected": "DEPLOYMENT_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5 + }, + "SignalMapUpdated": { + "documentation": "Wait until a signal map has been updated", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Status", + "expected": "UPDATE_COMPLETE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "Status", + "expected": "UPDATE_IN_PROGRESS", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Status", + "expected": "UPDATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Status", + "expected": "UPDATE_REVERTED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.medialive#GetSignalMapRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "SECONDS" + "smithy.api#documentation": "A signal map's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "H265 Gop Size Units" + "smithy.api#documentation": "Placeholder documentation for GetSignalMapRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#H265Level": { - "type": "enum", + "com.amazonaws.medialive#GetSignalMapResponse": { + "type": "structure", "members": { - "H265_LEVEL_1": { - "target": "smithy.api#Unit", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveSignalMap", "traits": { - "smithy.api#enumValue": "H265_LEVEL_1" + "smithy.api#documentation": "A signal map's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" } }, - "H265_LEVEL_2": { - "target": "smithy.api#Unit", + "CloudWatchAlarmTemplateGroupIds": { + "target": "com.amazonaws.medialive#__listOf__stringMin7Max11PatternAws097", "traits": { - "smithy.api#enumValue": "H265_LEVEL_2" + "smithy.api#jsonName": "cloudWatchAlarmTemplateGroupIds" } }, - "H265_LEVEL_2_1": { - "target": "smithy.api#Unit", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "H265_LEVEL_2_1" + "smithy.api#jsonName": "createdAt" } }, - "H265_LEVEL_3": { - "target": "smithy.api#Unit", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#enumValue": "H265_LEVEL_3" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "H265_LEVEL_3_1": { - "target": "smithy.api#Unit", + "DiscoveryEntryPointArn": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#enumValue": "H265_LEVEL_3_1" + "smithy.api#documentation": "A top-level supported AWS resource ARN to discovery a signal map from.", + "smithy.api#jsonName": "discoveryEntryPointArn" } }, - "H265_LEVEL_4": { - "target": "smithy.api#Unit", + "ErrorMessage": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#enumValue": "H265_LEVEL_4" + "smithy.api#documentation": "Error message associated with a failed creation or failed update attempt of a signal map.", + "smithy.api#jsonName": "errorMessage" } }, - "H265_LEVEL_4_1": { - "target": "smithy.api#Unit", + "EventBridgeRuleTemplateGroupIds": { + "target": "com.amazonaws.medialive#__listOf__stringMin7Max11PatternAws097", "traits": { - "smithy.api#enumValue": "H265_LEVEL_4_1" + "smithy.api#jsonName": "eventBridgeRuleTemplateGroupIds" } }, - "H265_LEVEL_5": { - "target": "smithy.api#Unit", + "FailedMediaResourceMap": { + "target": "com.amazonaws.medialive#FailedMediaResourceMap", "traits": { - "smithy.api#enumValue": "H265_LEVEL_5" + "smithy.api#jsonName": "failedMediaResourceMap" } }, - "H265_LEVEL_5_1": { - "target": "smithy.api#Unit", + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#enumValue": "H265_LEVEL_5_1" + "smithy.api#documentation": "A signal map's id.", + "smithy.api#jsonName": "id" } }, - "H265_LEVEL_5_2": { - "target": "smithy.api#Unit", + "LastDiscoveredAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "H265_LEVEL_5_2" + "smithy.api#jsonName": "lastDiscoveredAt" } }, - "H265_LEVEL_6": { - "target": "smithy.api#Unit", + "LastSuccessfulMonitorDeployment": { + "target": "com.amazonaws.medialive#SuccessfulMonitorDeployment", "traits": { - "smithy.api#enumValue": "H265_LEVEL_6" + "smithy.api#jsonName": "lastSuccessfulMonitorDeployment" } }, - "H265_LEVEL_6_1": { - "target": "smithy.api#Unit", + "MediaResourceMap": { + "target": "com.amazonaws.medialive#MediaResourceMap", "traits": { - "smithy.api#enumValue": "H265_LEVEL_6_1" + "smithy.api#jsonName": "mediaResourceMap" } }, - "H265_LEVEL_6_2": { - "target": "smithy.api#Unit", + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "H265_LEVEL_6_2" + "smithy.api#jsonName": "modifiedAt" } }, - "H265_LEVEL_AUTO": { - "target": "smithy.api#Unit", + "MonitorChangesPendingDeployment": { + "target": "com.amazonaws.medialive#__boolean", "traits": { - "smithy.api#enumValue": "H265_LEVEL_AUTO" + "smithy.api#documentation": "If true, there are pending monitor changes for this signal map that can be deployed.", + "smithy.api#jsonName": "monitorChangesPendingDeployment" } - } - }, - "traits": { - "smithy.api#documentation": "H265 Level" - } - }, - "com.amazonaws.medialive#H265LookAheadRateControl": { - "type": "enum", - "members": { - "HIGH": { - "target": "smithy.api#Unit", + }, + "MonitorDeployment": { + "target": "com.amazonaws.medialive#MonitorDeployment", "traits": { - "smithy.api#enumValue": "HIGH" + "smithy.api#jsonName": "monitorDeployment" } }, - "LOW": { - "target": "smithy.api#Unit", + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#enumValue": "LOW" + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" } }, - "MEDIUM": { - "target": "smithy.api#Unit", + "Status": { + "target": "com.amazonaws.medialive#SignalMapStatus", "traits": { - "smithy.api#enumValue": "MEDIUM" + "smithy.api#jsonName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "H265 Look Ahead Rate Control" + "smithy.api#documentation": "Placeholder documentation for GetSignalMapResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#H265MvOverPictureBoundaries": { + "com.amazonaws.medialive#GlobalConfiguration": { + "type": "structure", + "members": { + "InitialAudioGain": { + "target": "com.amazonaws.medialive#__integerMinNegative60Max60", + "traits": { + "smithy.api#documentation": "Value to set the initial audio gain for the Live Event.", + "smithy.api#jsonName": "initialAudioGain" + } + }, + "InputEndAction": { + "target": "com.amazonaws.medialive#GlobalConfigurationInputEndAction", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "inputEndAction" + } + }, + "InputLossBehavior": { + "target": "com.amazonaws.medialive#InputLossBehavior", + "traits": { + "smithy.api#documentation": "Settings for system actions when input is lost.", + "smithy.api#jsonName": "inputLossBehavior" + } + }, + "OutputLockingMode": { + "target": "com.amazonaws.medialive#GlobalConfigurationOutputLockingMode", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "outputLockingMode" + } + }, + "OutputTimingSource": { + "target": "com.amazonaws.medialive#GlobalConfigurationOutputTimingSource", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "outputTimingSource" + } + }, + "SupportLowFramerateInputs": { + "target": "com.amazonaws.medialive#GlobalConfigurationLowFramerateInputs", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "supportLowFramerateInputs" + } + }, + "OutputLockingSettings": { + "target": "com.amazonaws.medialive#OutputLockingSettings", + "traits": { + "smithy.api#documentation": "Advanced output locking settings", + "smithy.api#jsonName": "outputLockingSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Global Configuration" + } + }, + "com.amazonaws.medialive#GlobalConfigurationInputEndAction": { "type": "enum", "members": { - "DISABLED": { + "NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "NONE" } }, - "ENABLED": { + "SWITCH_AND_LOOP_INPUTS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "SWITCH_AND_LOOP_INPUTS" } } }, "traits": { - "smithy.api#documentation": "H265 Mv Over Picture Boundaries" + "smithy.api#documentation": "Global Configuration Input End Action" } }, - "com.amazonaws.medialive#H265MvTemporalPredictor": { + "com.amazonaws.medialive#GlobalConfigurationLowFramerateInputs": { "type": "enum", "members": { "DISABLED": { @@ -11014,360 +12396,390 @@ } }, "traits": { - "smithy.api#documentation": "H265 Mv Temporal Predictor" + "smithy.api#documentation": "Global Configuration Low Framerate Inputs" } }, - "com.amazonaws.medialive#H265Profile": { + "com.amazonaws.medialive#GlobalConfigurationOutputLockingMode": { "type": "enum", "members": { - "MAIN": { + "EPOCH_LOCKING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MAIN" + "smithy.api#enumValue": "EPOCH_LOCKING" } }, - "MAIN_10BIT": { + "PIPELINE_LOCKING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MAIN_10BIT" + "smithy.api#enumValue": "PIPELINE_LOCKING" } } }, "traits": { - "smithy.api#documentation": "H265 Profile" + "smithy.api#documentation": "Global Configuration Output Locking Mode" } }, - "com.amazonaws.medialive#H265RateControlMode": { + "com.amazonaws.medialive#GlobalConfigurationOutputTimingSource": { "type": "enum", "members": { - "CBR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CBR" - } - }, - "MULTIPLEX": { + "INPUT_CLOCK": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MULTIPLEX" + "smithy.api#enumValue": "INPUT_CLOCK" } }, - "QVBR": { + "SYSTEM_CLOCK": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "QVBR" + "smithy.api#enumValue": "SYSTEM_CLOCK" } } }, "traits": { - "smithy.api#documentation": "H265 Rate Control Mode" + "smithy.api#documentation": "Global Configuration Output Timing Source" } }, - "com.amazonaws.medialive#H265ScanType": { + "com.amazonaws.medialive#H264AdaptiveQuantization": { "type": "enum", "members": { - "INTERLACED": { + "AUTO": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INTERLACED" + "smithy.api#enumValue": "AUTO" } }, - "PROGRESSIVE": { + "HIGH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PROGRESSIVE" + "smithy.api#enumValue": "HIGH" + } + }, + "HIGHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGHER" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OFF" } } }, "traits": { - "smithy.api#documentation": "H265 Scan Type" + "smithy.api#documentation": "H264 Adaptive Quantization" } }, - "com.amazonaws.medialive#H265SceneChangeDetect": { + "com.amazonaws.medialive#H264ColorMetadata": { "type": "enum", "members": { - "DISABLED": { + "IGNORE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "IGNORE" } }, - "ENABLED": { + "INSERT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "INSERT" } } }, "traits": { - "smithy.api#documentation": "H265 Scene Change Detect" + "smithy.api#documentation": "H264 Color Metadata" } }, - "com.amazonaws.medialive#H265Settings": { + "com.amazonaws.medialive#H264ColorSpaceSettings": { "type": "structure", "members": { - "AdaptiveQuantization": { - "target": "com.amazonaws.medialive#H265AdaptiveQuantization", + "ColorSpacePassthroughSettings": { + "target": "com.amazonaws.medialive#ColorSpacePassthroughSettings", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", - "smithy.api#jsonName": "adaptiveQuantization" + "smithy.api#jsonName": "colorSpacePassthroughSettings" } }, - "AfdSignaling": { - "target": "com.amazonaws.medialive#AfdSignaling", + "Rec601Settings": { + "target": "com.amazonaws.medialive#Rec601Settings", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "afdSignaling" + "smithy.api#jsonName": "rec601Settings" } }, - "AlternativeTransferFunction": { - "target": "com.amazonaws.medialive#H265AlternativeTransferFunction", + "Rec709Settings": { + "target": "com.amazonaws.medialive#Rec709Settings", "traits": { - "smithy.api#documentation": "Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.", - "smithy.api#jsonName": "alternativeTransferFunction" + "smithy.api#jsonName": "rec709Settings" } - }, - "Bitrate": { - "target": "com.amazonaws.medialive#__integerMin100000Max40000000", + } + }, + "traits": { + "smithy.api#documentation": "H264 Color Space Settings" + } + }, + "com.amazonaws.medialive#H264EntropyEncoding": { + "type": "enum", + "members": { + "CABAC": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "bitrate" + "smithy.api#enumValue": "CABAC" } }, - "BufSize": { - "target": "com.amazonaws.medialive#__integerMin100000Max80000000", + "CAVLC": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits.", - "smithy.api#jsonName": "bufSize" + "smithy.api#enumValue": "CAVLC" } - }, - "ColorMetadata": { - "target": "com.amazonaws.medialive#H265ColorMetadata", + } + }, + "traits": { + "smithy.api#documentation": "H264 Entropy Encoding" + } + }, + "com.amazonaws.medialive#H264FilterSettings": { + "type": "structure", + "members": { + "TemporalFilterSettings": { + "target": "com.amazonaws.medialive#TemporalFilterSettings", "traits": { - "smithy.api#documentation": "Includes colorspace metadata in the output.", - "smithy.api#jsonName": "colorMetadata" + "smithy.api#jsonName": "temporalFilterSettings" } - }, - "ColorSpaceSettings": { - "target": "com.amazonaws.medialive#H265ColorSpaceSettings", + } + }, + "traits": { + "smithy.api#documentation": "H264 Filter Settings" + } + }, + "com.amazonaws.medialive#H264FlickerAq": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Color Space settings", - "smithy.api#jsonName": "colorSpaceSettings" + "smithy.api#enumValue": "DISABLED" } }, - "FilterSettings": { - "target": "com.amazonaws.medialive#H265FilterSettings", + "ENABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Optional filters that you can apply to an encode.", - "smithy.api#jsonName": "filterSettings" - } - }, - "FixedAfd": { - "target": "com.amazonaws.medialive#FixedAfd", - "traits": { - "smithy.api#documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.", - "smithy.api#jsonName": "fixedAfd" - } - }, - "FlickerAq": { - "target": "com.amazonaws.medialive#H265FlickerAq", - "traits": { - "smithy.api#documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", - "smithy.api#jsonName": "flickerAq" - } - }, - "FramerateDenominator": { - "target": "com.amazonaws.medialive#__integerMin1Max3003", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Framerate denominator.", - "smithy.api#jsonName": "framerateDenominator", - "smithy.api#required": {} + "smithy.api#enumValue": "ENABLED" } - }, - "FramerateNumerator": { - "target": "com.amazonaws.medialive#__integerMin1", + } + }, + "traits": { + "smithy.api#documentation": "H264 Flicker Aq" + } + }, + "com.amazonaws.medialive#H264ForceFieldPictures": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.", - "smithy.api#jsonName": "framerateNumerator", - "smithy.api#required": {} + "smithy.api#enumValue": "DISABLED" } }, - "GopClosedCadence": { - "target": "com.amazonaws.medialive#__integerMin0", + "ENABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "gopClosedCadence" + "smithy.api#enumValue": "ENABLED" } - }, - "GopSize": { - "target": "com.amazonaws.medialive#__double", + } + }, + "traits": { + "smithy.api#documentation": "H264 Force Field Pictures" + } + }, + "com.amazonaws.medialive#H264FramerateControl": { + "type": "enum", + "members": { + "INITIALIZE_FROM_SOURCE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "gopSize" + "smithy.api#enumValue": "INITIALIZE_FROM_SOURCE" } }, - "GopSizeUnits": { - "target": "com.amazonaws.medialive#H265GopSizeUnits", + "SPECIFIED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "gopSizeUnits" + "smithy.api#enumValue": "SPECIFIED" } - }, - "Level": { - "target": "com.amazonaws.medialive#H265Level", + } + }, + "traits": { + "smithy.api#documentation": "H264 Framerate Control" + } + }, + "com.amazonaws.medialive#H264GopBReference": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "H.265 Level.", - "smithy.api#jsonName": "level" + "smithy.api#enumValue": "DISABLED" } }, - "LookAheadRateControl": { - "target": "com.amazonaws.medialive#H265LookAheadRateControl", + "ENABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.", - "smithy.api#jsonName": "lookAheadRateControl" + "smithy.api#enumValue": "ENABLED" } - }, - "MaxBitrate": { - "target": "com.amazonaws.medialive#__integerMin100000Max40000000", + } + }, + "traits": { + "smithy.api#documentation": "H264 Gop BReference" + } + }, + "com.amazonaws.medialive#H264GopSizeUnits": { + "type": "enum", + "members": { + "FRAMES": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "For QVBR: See the tooltip for Quality level", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#enumValue": "FRAMES" } }, - "MinIInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max30", + "SECONDS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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", - "smithy.api#jsonName": "minIInterval" + "smithy.api#enumValue": "SECONDS" } - }, - "ParDenominator": { - "target": "com.amazonaws.medialive#__integerMin1", + } + }, + "traits": { + "smithy.api#documentation": "H264 Gop Size Units" + } + }, + "com.amazonaws.medialive#H264Level": { + "type": "enum", + "members": { + "H264_LEVEL_1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Pixel Aspect Ratio denominator.", - "smithy.api#jsonName": "parDenominator" + "smithy.api#enumValue": "H264_LEVEL_1" } }, - "ParNumerator": { - "target": "com.amazonaws.medialive#__integerMin1", + "H264_LEVEL_1_1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Pixel Aspect Ratio numerator.", - "smithy.api#jsonName": "parNumerator" + "smithy.api#enumValue": "H264_LEVEL_1_1" } }, - "Profile": { - "target": "com.amazonaws.medialive#H265Profile", + "H264_LEVEL_1_2": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "H.265 Profile.", - "smithy.api#jsonName": "profile" + "smithy.api#enumValue": "H264_LEVEL_1_2" } }, - "QvbrQualityLevel": { - "target": "com.amazonaws.medialive#__integerMin1Max10", + "H264_LEVEL_1_3": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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", - "smithy.api#jsonName": "qvbrQualityLevel" + "smithy.api#enumValue": "H264_LEVEL_1_3" } }, - "RateControlMode": { - "target": "com.amazonaws.medialive#H265RateControlMode", + "H264_LEVEL_2": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "rateControlMode" + "smithy.api#enumValue": "H264_LEVEL_2" } }, - "ScanType": { - "target": "com.amazonaws.medialive#H265ScanType", + "H264_LEVEL_2_1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Sets the scan type of the output to progressive or top-field-first interlaced.", - "smithy.api#jsonName": "scanType" + "smithy.api#enumValue": "H264_LEVEL_2_1" } }, - "SceneChangeDetect": { - "target": "com.amazonaws.medialive#H265SceneChangeDetect", + "H264_LEVEL_2_2": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Scene change detection.", - "smithy.api#jsonName": "sceneChangeDetect" + "smithy.api#enumValue": "H264_LEVEL_2_2" } }, - "Slices": { - "target": "com.amazonaws.medialive#__integerMin1Max16", + "H264_LEVEL_3": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "slices" + "smithy.api#enumValue": "H264_LEVEL_3" } }, - "Tier": { - "target": "com.amazonaws.medialive#H265Tier", + "H264_LEVEL_3_1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "H.265 Tier.", - "smithy.api#jsonName": "tier" + "smithy.api#enumValue": "H264_LEVEL_3_1" } }, - "TimecodeInsertion": { - "target": "com.amazonaws.medialive#H265TimecodeInsertionBehavior", + "H264_LEVEL_3_2": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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", - "smithy.api#jsonName": "timecodeInsertion" + "smithy.api#enumValue": "H264_LEVEL_3_2" } }, - "TimecodeBurninSettings": { - "target": "com.amazonaws.medialive#TimecodeBurninSettings", + "H264_LEVEL_4": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Timecode burn-in settings", - "smithy.api#jsonName": "timecodeBurninSettings" + "smithy.api#enumValue": "H264_LEVEL_4" } }, - "MvOverPictureBoundaries": { - "target": "com.amazonaws.medialive#H265MvOverPictureBoundaries", + "H264_LEVEL_4_1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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\".", - "smithy.api#jsonName": "mvOverPictureBoundaries" + "smithy.api#enumValue": "H264_LEVEL_4_1" } }, - "MvTemporalPredictor": { - "target": "com.amazonaws.medialive#H265MvTemporalPredictor", + "H264_LEVEL_4_2": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "If you are setting up the picture as a tile, you must set this to \"disabled\". In other configurations, you typically enter \"enabled\".", - "smithy.api#jsonName": "mvTemporalPredictor" + "smithy.api#enumValue": "H264_LEVEL_4_2" } }, - "TileHeight": { - "target": "com.amazonaws.medialive#__integerMin64Max2160", + "H264_LEVEL_5": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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", - "smithy.api#jsonName": "tileHeight" + "smithy.api#enumValue": "H264_LEVEL_5" } }, - "TilePadding": { - "target": "com.amazonaws.medialive#H265TilePadding", + "H264_LEVEL_5_1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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\".", - "smithy.api#jsonName": "tilePadding" + "smithy.api#enumValue": "H264_LEVEL_5_1" } }, - "TileWidth": { - "target": "com.amazonaws.medialive#__integerMin256Max3840", + "H264_LEVEL_5_2": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Set this field to set up the picture as a tile. See tileHeight for more information.", - "smithy.api#jsonName": "tileWidth" + "smithy.api#enumValue": "H264_LEVEL_5_2" } }, - "TreeblockSize": { - "target": "com.amazonaws.medialive#H265TreeblockSize", + "H264_LEVEL_AUTO": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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\".", - "smithy.api#jsonName": "treeblockSize" + "smithy.api#enumValue": "H264_LEVEL_AUTO" } } }, "traits": { - "smithy.api#documentation": "H265 Settings" + "smithy.api#documentation": "H264 Level" } }, - "com.amazonaws.medialive#H265Tier": { + "com.amazonaws.medialive#H264LookAheadRateControl": { "type": "enum", "members": { "HIGH": { @@ -11376,756 +12788,542 @@ "smithy.api#enumValue": "HIGH" } }, - "MAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAIN" - } - } - }, - "traits": { - "smithy.api#documentation": "H265 Tier" - } - }, - "com.amazonaws.medialive#H265TilePadding": { - "type": "enum", - "members": { - "NONE": { + "LOW": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "LOW" } }, - "PADDED": { + "MEDIUM": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PADDED" + "smithy.api#enumValue": "MEDIUM" } } }, "traits": { - "smithy.api#documentation": "H265 Tile Padding" + "smithy.api#documentation": "H264 Look Ahead Rate Control" } }, - "com.amazonaws.medialive#H265TimecodeInsertionBehavior": { + "com.amazonaws.medialive#H264ParControl": { "type": "enum", "members": { - "DISABLED": { + "INITIALIZE_FROM_SOURCE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "INITIALIZE_FROM_SOURCE" } }, - "PIC_TIMING_SEI": { + "SPECIFIED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PIC_TIMING_SEI" + "smithy.api#enumValue": "SPECIFIED" } } }, "traits": { - "smithy.api#documentation": "H265 Timecode Insertion Behavior" + "smithy.api#documentation": "H264 Par Control" } }, - "com.amazonaws.medialive#H265TreeblockSize": { + "com.amazonaws.medialive#H264Profile": { "type": "enum", "members": { - "AUTO": { + "BASELINE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AUTO" + "smithy.api#enumValue": "BASELINE" } }, - "TREE_SIZE_32X32": { + "HIGH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "TREE_SIZE_32X32" - } - } - }, - "traits": { - "smithy.api#documentation": "H265 Treeblock Size" - } - }, - "com.amazonaws.medialive#Hdr10Settings": { - "type": "structure", - "members": { - "MaxCll": { - "target": "com.amazonaws.medialive#__integerMin0Max32768", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "maxCll" + "smithy.api#enumValue": "HIGH" } }, - "MaxFall": { - "target": "com.amazonaws.medialive#__integerMin0Max32768", + "HIGH_10BIT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "maxFall" + "smithy.api#enumValue": "HIGH_10BIT" } - } - }, - "traits": { - "smithy.api#documentation": "Hdr10 Settings" - } - }, - "com.amazonaws.medialive#HlsAdMarkers": { - "type": "enum", - "members": { - "ADOBE": { + }, + "HIGH_422": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ADOBE" + "smithy.api#enumValue": "HIGH_422" } }, - "ELEMENTAL": { + "HIGH_422_10BIT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ELEMENTAL" + "smithy.api#enumValue": "HIGH_422_10BIT" } }, - "ELEMENTAL_SCTE35": { + "MAIN": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ELEMENTAL_SCTE35" + "smithy.api#enumValue": "MAIN" } } }, "traits": { - "smithy.api#documentation": "Hls Ad Markers" + "smithy.api#documentation": "H264 Profile" } }, - "com.amazonaws.medialive#HlsAkamaiHttpTransferMode": { + "com.amazonaws.medialive#H264QualityLevel": { "type": "enum", "members": { - "CHUNKED": { + "ENHANCED_QUALITY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CHUNKED" + "smithy.api#enumValue": "ENHANCED_QUALITY" } }, - "NON_CHUNKED": { + "STANDARD_QUALITY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NON_CHUNKED" + "smithy.api#enumValue": "STANDARD_QUALITY" } } }, "traits": { - "smithy.api#documentation": "Hls Akamai Http Transfer Mode" + "smithy.api#documentation": "H264 Quality Level" } }, - "com.amazonaws.medialive#HlsAkamaiSettings": { - "type": "structure", + "com.amazonaws.medialive#H264RateControlMode": { + "type": "enum", "members": { - "ConnectionRetryInterval": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", - "smithy.api#jsonName": "connectionRetryInterval" - } - }, - "FilecacheDuration": { - "target": "com.amazonaws.medialive#__integerMin0Max600", - "traits": { - "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", - "smithy.api#jsonName": "filecacheDuration" - } - }, - "HttpTransferMode": { - "target": "com.amazonaws.medialive#HlsAkamaiHttpTransferMode", - "traits": { - "smithy.api#documentation": "Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.", - "smithy.api#jsonName": "httpTransferMode" - } - }, - "NumRetries": { - "target": "com.amazonaws.medialive#__integerMin0", + "CBR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "numRetries" + "smithy.api#enumValue": "CBR" } }, - "RestartDelay": { - "target": "com.amazonaws.medialive#__integerMin0Max15", + "MULTIPLEX": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", - "smithy.api#jsonName": "restartDelay" + "smithy.api#enumValue": "MULTIPLEX" } }, - "Salt": { - "target": "com.amazonaws.medialive#__string", + "QVBR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Salt for authenticated Akamai.", - "smithy.api#jsonName": "salt" + "smithy.api#enumValue": "QVBR" } }, - "Token": { - "target": "com.amazonaws.medialive#__string", + "VBR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Token parameter for authenticated akamai. If not specified, _gda_ is used.", - "smithy.api#jsonName": "token" + "smithy.api#enumValue": "VBR" } } }, "traits": { - "smithy.api#documentation": "Hls Akamai Settings" + "smithy.api#documentation": "H264 Rate Control Mode" } }, - "com.amazonaws.medialive#HlsBasicPutSettings": { - "type": "structure", + "com.amazonaws.medialive#H264ScanType": { + "type": "enum", "members": { - "ConnectionRetryInterval": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", - "smithy.api#jsonName": "connectionRetryInterval" - } - }, - "FilecacheDuration": { - "target": "com.amazonaws.medialive#__integerMin0Max600", - "traits": { - "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", - "smithy.api#jsonName": "filecacheDuration" - } - }, - "NumRetries": { - "target": "com.amazonaws.medialive#__integerMin0", + "INTERLACED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "numRetries" + "smithy.api#enumValue": "INTERLACED" } }, - "RestartDelay": { - "target": "com.amazonaws.medialive#__integerMin0Max15", + "PROGRESSIVE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", - "smithy.api#jsonName": "restartDelay" + "smithy.api#enumValue": "PROGRESSIVE" } } }, "traits": { - "smithy.api#documentation": "Hls Basic Put Settings" + "smithy.api#documentation": "H264 Scan Type" } }, - "com.amazonaws.medialive#HlsCaptionLanguageSetting": { + "com.amazonaws.medialive#H264SceneChangeDetect": { "type": "enum", "members": { - "INSERT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSERT" - } - }, - "NONE": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "DISABLED" } }, - "OMIT": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "OMIT" + "smithy.api#enumValue": "ENABLED" } } }, "traits": { - "smithy.api#documentation": "Hls Caption Language Setting" + "smithy.api#documentation": "H264 Scene Change Detect" } }, - "com.amazonaws.medialive#HlsCdnSettings": { + "com.amazonaws.medialive#H264Settings": { "type": "structure", "members": { - "HlsAkamaiSettings": { - "target": "com.amazonaws.medialive#HlsAkamaiSettings", + "AdaptiveQuantization": { + "target": "com.amazonaws.medialive#H264AdaptiveQuantization", "traits": { - "smithy.api#jsonName": "hlsAkamaiSettings" + "smithy.api#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.", + "smithy.api#jsonName": "adaptiveQuantization" } }, - "HlsBasicPutSettings": { - "target": "com.amazonaws.medialive#HlsBasicPutSettings", + "AfdSignaling": { + "target": "com.amazonaws.medialive#AfdSignaling", "traits": { - "smithy.api#jsonName": "hlsBasicPutSettings" + "smithy.api#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.", + "smithy.api#jsonName": "afdSignaling" } }, - "HlsMediaStoreSettings": { - "target": "com.amazonaws.medialive#HlsMediaStoreSettings", + "Bitrate": { + "target": "com.amazonaws.medialive#__integerMin1000", "traits": { - "smithy.api#jsonName": "hlsMediaStoreSettings" + "smithy.api#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.", + "smithy.api#jsonName": "bitrate" } }, - "HlsS3Settings": { - "target": "com.amazonaws.medialive#HlsS3Settings", + "BufFillPct": { + "target": "com.amazonaws.medialive#__integerMin0Max100", "traits": { - "smithy.api#jsonName": "hlsS3Settings" + "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", + "smithy.api#jsonName": "bufFillPct" } }, - "HlsWebdavSettings": { - "target": "com.amazonaws.medialive#HlsWebdavSettings", + "BufSize": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#jsonName": "hlsWebdavSettings" - } - } - }, - "traits": { - "smithy.api#documentation": "Hls Cdn Settings" - } - }, - "com.amazonaws.medialive#HlsClientCache": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits.", + "smithy.api#jsonName": "bufSize" } }, - "ENABLED": { - "target": "smithy.api#Unit", + "ColorMetadata": { + "target": "com.amazonaws.medialive#H264ColorMetadata", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#documentation": "Includes colorspace metadata in the output.", + "smithy.api#jsonName": "colorMetadata" } - } - }, - "traits": { - "smithy.api#documentation": "Hls Client Cache" - } - }, - "com.amazonaws.medialive#HlsCodecSpecification": { - "type": "enum", - "members": { - "RFC_4281": { - "target": "smithy.api#Unit", + }, + "ColorSpaceSettings": { + "target": "com.amazonaws.medialive#H264ColorSpaceSettings", "traits": { - "smithy.api#enumValue": "RFC_4281" + "smithy.api#documentation": "Color Space settings", + "smithy.api#jsonName": "colorSpaceSettings" } }, - "RFC_6381": { - "target": "smithy.api#Unit", + "EntropyEncoding": { + "target": "com.amazonaws.medialive#H264EntropyEncoding", "traits": { - "smithy.api#enumValue": "RFC_6381" + "smithy.api#documentation": "Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.", + "smithy.api#jsonName": "entropyEncoding" } - } - }, - "traits": { - "smithy.api#documentation": "Hls Codec Specification" - } - }, - "com.amazonaws.medialive#HlsDirectoryStructure": { - "type": "enum", - "members": { - "SINGLE_DIRECTORY": { - "target": "smithy.api#Unit", + }, + "FilterSettings": { + "target": "com.amazonaws.medialive#H264FilterSettings", "traits": { - "smithy.api#enumValue": "SINGLE_DIRECTORY" + "smithy.api#documentation": "Optional filters that you can apply to an encode.", + "smithy.api#jsonName": "filterSettings" } }, - "SUBDIRECTORY_PER_STREAM": { - "target": "smithy.api#Unit", + "FixedAfd": { + "target": "com.amazonaws.medialive#FixedAfd", "traits": { - "smithy.api#enumValue": "SUBDIRECTORY_PER_STREAM" + "smithy.api#documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.", + "smithy.api#jsonName": "fixedAfd" } - } - }, - "traits": { - "smithy.api#documentation": "Hls Directory Structure" - } - }, - "com.amazonaws.medialive#HlsDiscontinuityTags": { - "type": "enum", - "members": { - "INSERT": { - "target": "smithy.api#Unit", + }, + "FlickerAq": { + "target": "com.amazonaws.medialive#H264FlickerAq", "traits": { - "smithy.api#enumValue": "INSERT" + "smithy.api#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.", + "smithy.api#jsonName": "flickerAq" } }, - "NEVER_INSERT": { - "target": "smithy.api#Unit", + "ForceFieldPictures": { + "target": "com.amazonaws.medialive#H264ForceFieldPictures", "traits": { - "smithy.api#enumValue": "NEVER_INSERT" + "smithy.api#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.", + "smithy.api#jsonName": "forceFieldPictures" } - } - }, - "traits": { - "smithy.api#documentation": "Hls Discontinuity Tags" - } - }, - "com.amazonaws.medialive#HlsEncryptionType": { - "type": "enum", - "members": { - "AES128": { - "target": "smithy.api#Unit", + }, + "FramerateControl": { + "target": "com.amazonaws.medialive#H264FramerateControl", "traits": { - "smithy.api#enumValue": "AES128" + "smithy.api#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.", + "smithy.api#jsonName": "framerateControl" } }, - "SAMPLE_AES": { - "target": "smithy.api#Unit", + "FramerateDenominator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#enumValue": "SAMPLE_AES" + "smithy.api#documentation": "Framerate denominator.", + "smithy.api#jsonName": "framerateDenominator" } - } - }, - "traits": { - "smithy.api#documentation": "Hls Encryption Type" - } - }, - "com.amazonaws.medialive#HlsGroupSettings": { - "type": "structure", - "members": { - "AdMarkers": { - "target": "com.amazonaws.medialive#__listOfHlsAdMarkers", + }, + "FramerateNumerator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.", - "smithy.api#jsonName": "adMarkers" + "smithy.api#documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.", + "smithy.api#jsonName": "framerateNumerator" } }, - "BaseUrlContent": { - "target": "com.amazonaws.medialive#__string", + "GopBReference": { + "target": "com.amazonaws.medialive#H264GopBReference", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "baseUrlContent" + "smithy.api#documentation": "Documentation update needed", + "smithy.api#jsonName": "gopBReference" } }, - "BaseUrlContent1": { - "target": "com.amazonaws.medialive#__string", + "GopClosedCadence": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "baseUrlContent1" + "smithy.api#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.", + "smithy.api#jsonName": "gopClosedCadence" } }, - "BaseUrlManifest": { - "target": "com.amazonaws.medialive#__string", + "GopNumBFrames": { + "target": "com.amazonaws.medialive#__integerMin0Max7", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "baseUrlManifest" + "smithy.api#documentation": "Number of B-frames between reference frames.", + "smithy.api#jsonName": "gopNumBFrames" } }, - "BaseUrlManifest1": { - "target": "com.amazonaws.medialive#__string", + "GopSize": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "baseUrlManifest1" + "smithy.api#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.", + "smithy.api#jsonName": "gopSize" } }, - "CaptionLanguageMappings": { - "target": "com.amazonaws.medialive#__listOfCaptionLanguageMapping", + "GopSizeUnits": { + "target": "com.amazonaws.medialive#H264GopSizeUnits", "traits": { - "smithy.api#documentation": "Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to \"insert\".", - "smithy.api#jsonName": "captionLanguageMappings" + "smithy.api#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.", + "smithy.api#jsonName": "gopSizeUnits" } }, - "CaptionLanguageSetting": { - "target": "com.amazonaws.medialive#HlsCaptionLanguageSetting", + "Level": { + "target": "com.amazonaws.medialive#H264Level", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "captionLanguageSetting" + "smithy.api#documentation": "H.264 Level.", + "smithy.api#jsonName": "level" } }, - "ClientCache": { - "target": "com.amazonaws.medialive#HlsClientCache", + "LookAheadRateControl": { + "target": "com.amazonaws.medialive#H264LookAheadRateControl", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "clientCache" + "smithy.api#documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.", + "smithy.api#jsonName": "lookAheadRateControl" } }, - "CodecSpecification": { - "target": "com.amazonaws.medialive#HlsCodecSpecification", + "MaxBitrate": { + "target": "com.amazonaws.medialive#__integerMin1000", "traits": { - "smithy.api#documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.", - "smithy.api#jsonName": "codecSpecification" + "smithy.api#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.", + "smithy.api#jsonName": "maxBitrate" } }, - "ConstantIv": { - "target": "com.amazonaws.medialive#__stringMin32Max32", + "MinIInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max30", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "constantIv" + "smithy.api#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", + "smithy.api#jsonName": "minIInterval" } }, - "Destination": { - "target": "com.amazonaws.medialive#OutputLocationRef", + "NumRefFrames": { + "target": "com.amazonaws.medialive#__integerMin1Max6", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).", - "smithy.api#jsonName": "destination", - "smithy.api#required": {} + "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", + "smithy.api#jsonName": "numRefFrames" } }, - "DirectoryStructure": { - "target": "com.amazonaws.medialive#HlsDirectoryStructure", + "ParControl": { + "target": "com.amazonaws.medialive#H264ParControl", "traits": { - "smithy.api#documentation": "Place segments in subdirectories.", - "smithy.api#jsonName": "directoryStructure" + "smithy.api#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.", + "smithy.api#jsonName": "parControl" } }, - "DiscontinuityTags": { - "target": "com.amazonaws.medialive#HlsDiscontinuityTags", + "ParDenominator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "discontinuityTags" + "smithy.api#documentation": "Pixel Aspect Ratio denominator.", + "smithy.api#jsonName": "parDenominator" } }, - "EncryptionType": { - "target": "com.amazonaws.medialive#HlsEncryptionType", + "ParNumerator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.", - "smithy.api#jsonName": "encryptionType" + "smithy.api#documentation": "Pixel Aspect Ratio numerator.", + "smithy.api#jsonName": "parNumerator" } }, - "HlsCdnSettings": { - "target": "com.amazonaws.medialive#HlsCdnSettings", + "Profile": { + "target": "com.amazonaws.medialive#H264Profile", "traits": { - "smithy.api#documentation": "Parameters that control interactions with the CDN.", - "smithy.api#jsonName": "hlsCdnSettings" + "smithy.api#documentation": "H.264 Profile.", + "smithy.api#jsonName": "profile" } }, - "HlsId3SegmentTagging": { - "target": "com.amazonaws.medialive#HlsId3SegmentTaggingState", + "QualityLevel": { + "target": "com.amazonaws.medialive#H264QualityLevel", "traits": { - "smithy.api#documentation": "State of HLS ID3 Segment Tagging", - "smithy.api#jsonName": "hlsId3SegmentTagging" + "smithy.api#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.", + "smithy.api#jsonName": "qualityLevel" } }, - "IFrameOnlyPlaylists": { - "target": "com.amazonaws.medialive#IFrameOnlyPlaylistType", + "QvbrQualityLevel": { + "target": "com.amazonaws.medialive#__integerMin1Max10", "traits": { - "smithy.api#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\"", - "smithy.api#jsonName": "iFrameOnlyPlaylists" + "smithy.api#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", + "smithy.api#jsonName": "qvbrQualityLevel" } }, - "IncompleteSegmentBehavior": { - "target": "com.amazonaws.medialive#HlsIncompleteSegmentBehavior", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "incompleteSegmentBehavior" - } - }, - "IndexNSegments": { - "target": "com.amazonaws.medialive#__integerMin3", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "indexNSegments" - } - }, - "InputLossAction": { - "target": "com.amazonaws.medialive#InputLossActionForHlsOut", - "traits": { - "smithy.api#documentation": "Parameter that control output group behavior on input loss.", - "smithy.api#jsonName": "inputLossAction" - } - }, - "IvInManifest": { - "target": "com.amazonaws.medialive#HlsIvInManifest", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "ivInManifest" - } - }, - "IvSource": { - "target": "com.amazonaws.medialive#HlsIvSource", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "ivSource" - } - }, - "KeepSegments": { - "target": "com.amazonaws.medialive#__integerMin1", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "keepSegments" - } - }, - "KeyFormat": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "keyFormat" - } - }, - "KeyFormatVersions": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Either a single positive integer version value or a slash delimited list of version values (1/2/3).", - "smithy.api#jsonName": "keyFormatVersions" - } - }, - "KeyProviderSettings": { - "target": "com.amazonaws.medialive#KeyProviderSettings", - "traits": { - "smithy.api#documentation": "The key provider settings.", - "smithy.api#jsonName": "keyProviderSettings" - } - }, - "ManifestCompression": { - "target": "com.amazonaws.medialive#HlsManifestCompression", - "traits": { - "smithy.api#documentation": "When set to gzip, compresses HLS playlist.", - "smithy.api#jsonName": "manifestCompression" - } - }, - "ManifestDurationFormat": { - "target": "com.amazonaws.medialive#HlsManifestDurationFormat", - "traits": { - "smithy.api#documentation": "Indicates whether the output manifest should use floating point or integer values for segment duration.", - "smithy.api#jsonName": "manifestDurationFormat" - } - }, - "MinSegmentLength": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "minSegmentLength" - } - }, - "Mode": { - "target": "com.amazonaws.medialive#HlsMode", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "mode" - } - }, - "OutputSelection": { - "target": "com.amazonaws.medialive#HlsOutputSelection", + "RateControlMode": { + "target": "com.amazonaws.medialive#H264RateControlMode", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "outputSelection" + "smithy.api#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.", + "smithy.api#jsonName": "rateControlMode" } }, - "ProgramDateTime": { - "target": "com.amazonaws.medialive#HlsProgramDateTime", + "ScanType": { + "target": "com.amazonaws.medialive#H264ScanType", "traits": { - "smithy.api#documentation": "Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.", - "smithy.api#jsonName": "programDateTime" + "smithy.api#documentation": "Sets the scan type of the output to progressive or top-field-first interlaced.", + "smithy.api#jsonName": "scanType" } }, - "ProgramDateTimeClock": { - "target": "com.amazonaws.medialive#HlsProgramDateTimeClock", + "SceneChangeDetect": { + "target": "com.amazonaws.medialive#H264SceneChangeDetect", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "programDateTimeClock" + "smithy.api#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.", + "smithy.api#jsonName": "sceneChangeDetect" } }, - "ProgramDateTimePeriod": { - "target": "com.amazonaws.medialive#__integerMin0Max3600", + "Slices": { + "target": "com.amazonaws.medialive#__integerMin1Max32", "traits": { - "smithy.api#documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.", - "smithy.api#jsonName": "programDateTimePeriod" + "smithy.api#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.", + "smithy.api#jsonName": "slices" } }, - "RedundantManifest": { - "target": "com.amazonaws.medialive#HlsRedundantManifest", + "Softness": { + "target": "com.amazonaws.medialive#__integerMin0Max128", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "redundantManifest" + "smithy.api#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.", + "smithy.api#jsonName": "softness" } }, - "SegmentLength": { - "target": "com.amazonaws.medialive#__integerMin1", + "SpatialAq": { + "target": "com.amazonaws.medialive#H264SpatialAq", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "segmentLength" + "smithy.api#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.", + "smithy.api#jsonName": "spatialAq" } }, - "SegmentationMode": { - "target": "com.amazonaws.medialive#HlsSegmentationMode", + "SubgopLength": { + "target": "com.amazonaws.medialive#H264SubGopLength", "traits": { - "smithy.api#documentation": "useInputSegmentation has been deprecated. The configured segment size is always used.", - "smithy.api#jsonName": "segmentationMode" + "smithy.api#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.", + "smithy.api#jsonName": "subgopLength" } }, - "SegmentsPerSubdirectory": { - "target": "com.amazonaws.medialive#__integerMin1", + "Syntax": { + "target": "com.amazonaws.medialive#H264Syntax", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "segmentsPerSubdirectory" + "smithy.api#documentation": "Produces a bitstream compliant with SMPTE RP-2027.", + "smithy.api#jsonName": "syntax" } }, - "StreamInfResolution": { - "target": "com.amazonaws.medialive#HlsStreamInfResolution", + "TemporalAq": { + "target": "com.amazonaws.medialive#H264TemporalAq", "traits": { - "smithy.api#documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", - "smithy.api#jsonName": "streamInfResolution" + "smithy.api#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.", + "smithy.api#jsonName": "temporalAq" } }, - "TimedMetadataId3Frame": { - "target": "com.amazonaws.medialive#HlsTimedMetadataId3Frame", + "TimecodeInsertion": { + "target": "com.amazonaws.medialive#H264TimecodeInsertionBehavior", "traits": { - "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", - "smithy.api#jsonName": "timedMetadataId3Frame" + "smithy.api#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", + "smithy.api#jsonName": "timecodeInsertion" } }, - "TimedMetadataId3Period": { - "target": "com.amazonaws.medialive#__integerMin0", + "TimecodeBurninSettings": { + "target": "com.amazonaws.medialive#TimecodeBurninSettings", "traits": { - "smithy.api#documentation": "Timed Metadata interval in seconds.", - "smithy.api#jsonName": "timedMetadataId3Period" + "smithy.api#documentation": "Timecode burn-in settings", + "smithy.api#jsonName": "timecodeBurninSettings" } - }, - "TimestampDeltaMilliseconds": { - "target": "com.amazonaws.medialive#__integerMin0", + } + }, + "traits": { + "smithy.api#documentation": "H264 Settings" + } + }, + "com.amazonaws.medialive#H264SpatialAq": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Provides an extra millisecond delta offset to fine tune the timestamps.", - "smithy.api#jsonName": "timestampDeltaMilliseconds" + "smithy.api#enumValue": "DISABLED" } }, - "TsFileMode": { - "target": "com.amazonaws.medialive#HlsTsFileMode", + "ENABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "tsFileMode" + "smithy.api#enumValue": "ENABLED" } } }, "traits": { - "smithy.api#documentation": "Hls Group Settings" + "smithy.api#documentation": "H264 Spatial Aq" } }, - "com.amazonaws.medialive#HlsH265PackagingType": { + "com.amazonaws.medialive#H264SubGopLength": { "type": "enum", "members": { - "HEV1": { + "DYNAMIC": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HEV1" + "smithy.api#enumValue": "DYNAMIC" } }, - "HVC1": { + "FIXED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HVC1" + "smithy.api#enumValue": "FIXED" } } }, "traits": { - "smithy.api#documentation": "Hls H265 Packaging Type" + "smithy.api#documentation": "H264 Sub Gop Length" } }, - "com.amazonaws.medialive#HlsId3SegmentTaggingScheduleActionSettings": { - "type": "structure", + "com.amazonaws.medialive#H264Syntax": { + "type": "enum", "members": { - "Tag": { - "target": "com.amazonaws.medialive#__string", + "DEFAULT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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", - "smithy.api#jsonName": "tag" + "smithy.api#enumValue": "DEFAULT" } }, - "Id3": { - "target": "com.amazonaws.medialive#__string", + "RP2027": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure", - "smithy.api#jsonName": "id3" + "smithy.api#enumValue": "RP2027" } } }, "traits": { - "smithy.api#documentation": "Settings for the action to insert a user-defined ID3 tag in each HLS segment" + "smithy.api#documentation": "H264 Syntax" } }, - "com.amazonaws.medialive#HlsId3SegmentTaggingState": { + "com.amazonaws.medialive#H264TemporalAq": { "type": "enum", "members": { "DISABLED": { @@ -12142,924 +13340,760 @@ } }, "traits": { - "smithy.api#documentation": "State of HLS ID3 Segment Tagging" + "smithy.api#documentation": "H264 Temporal Aq" } }, - "com.amazonaws.medialive#HlsIncompleteSegmentBehavior": { + "com.amazonaws.medialive#H264TimecodeInsertionBehavior": { "type": "enum", "members": { - "AUTO": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AUTO" + "smithy.api#enumValue": "DISABLED" } }, - "SUPPRESS": { + "PIC_TIMING_SEI": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SUPPRESS" + "smithy.api#enumValue": "PIC_TIMING_SEI" } } }, "traits": { - "smithy.api#documentation": "Hls Incomplete Segment Behavior" + "smithy.api#documentation": "H264 Timecode Insertion Behavior" } }, - "com.amazonaws.medialive#HlsInputSettings": { - "type": "structure", - "members": { - "Bandwidth": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "bandwidth" - } - }, - "BufferSegments": { - "target": "com.amazonaws.medialive#__integerMin0", + "com.amazonaws.medialive#H265AdaptiveQuantization": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "bufferSegments" + "smithy.api#enumValue": "AUTO" } }, - "Retries": { - "target": "com.amazonaws.medialive#__integerMin0", + "HIGH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.", - "smithy.api#jsonName": "retries" + "smithy.api#enumValue": "HIGH" } }, - "RetryInterval": { - "target": "com.amazonaws.medialive#__integerMin0", + "HIGHER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The number of seconds between retries when an attempt to read a manifest or segment fails.", - "smithy.api#jsonName": "retryInterval" + "smithy.api#enumValue": "HIGHER" } }, - "Scte35Source": { - "target": "com.amazonaws.medialive#HlsScte35SourceType", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "scte35Source" - } - } - }, - "traits": { - "smithy.api#documentation": "Hls Input Settings" - } - }, - "com.amazonaws.medialive#HlsIvInManifest": { - "type": "enum", - "members": { - "EXCLUDE": { + "LOW": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EXCLUDE" + "smithy.api#enumValue": "LOW" } }, - "INCLUDE": { + "MAX": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INCLUDE" + "smithy.api#enumValue": "MAX" } - } - }, - "traits": { - "smithy.api#documentation": "Hls Iv In Manifest" - } - }, - "com.amazonaws.medialive#HlsIvSource": { - "type": "enum", - "members": { - "EXPLICIT": { + }, + "MEDIUM": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EXPLICIT" + "smithy.api#enumValue": "MEDIUM" } }, - "FOLLOWS_SEGMENT_NUMBER": { + "OFF": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FOLLOWS_SEGMENT_NUMBER" + "smithy.api#enumValue": "OFF" } } }, "traits": { - "smithy.api#documentation": "Hls Iv Source" + "smithy.api#documentation": "H265 Adaptive Quantization" } }, - "com.amazonaws.medialive#HlsManifestCompression": { + "com.amazonaws.medialive#H265AlternativeTransferFunction": { "type": "enum", "members": { - "GZIP": { + "INSERT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "GZIP" + "smithy.api#enumValue": "INSERT" } }, - "NONE": { + "OMIT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "OMIT" } } }, "traits": { - "smithy.api#documentation": "Hls Manifest Compression" + "smithy.api#documentation": "H265 Alternative Transfer Function" } }, - "com.amazonaws.medialive#HlsManifestDurationFormat": { + "com.amazonaws.medialive#H265ColorMetadata": { "type": "enum", "members": { - "FLOATING_POINT": { + "IGNORE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FLOATING_POINT" + "smithy.api#enumValue": "IGNORE" } }, - "INTEGER": { + "INSERT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INTEGER" + "smithy.api#enumValue": "INSERT" } } }, "traits": { - "smithy.api#documentation": "Hls Manifest Duration Format" + "smithy.api#documentation": "H265 Color Metadata" } }, - "com.amazonaws.medialive#HlsMediaStoreSettings": { + "com.amazonaws.medialive#H265ColorSpaceSettings": { "type": "structure", "members": { - "ConnectionRetryInterval": { - "target": "com.amazonaws.medialive#__integerMin0", + "ColorSpacePassthroughSettings": { + "target": "com.amazonaws.medialive#ColorSpacePassthroughSettings", "traits": { - "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", - "smithy.api#jsonName": "connectionRetryInterval" + "smithy.api#jsonName": "colorSpacePassthroughSettings" } }, - "FilecacheDuration": { - "target": "com.amazonaws.medialive#__integerMin0Max600", + "DolbyVision81Settings": { + "target": "com.amazonaws.medialive#DolbyVision81Settings", "traits": { - "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", - "smithy.api#jsonName": "filecacheDuration" + "smithy.api#jsonName": "dolbyVision81Settings" } }, - "MediaStoreStorageClass": { - "target": "com.amazonaws.medialive#HlsMediaStoreStorageClass", + "Hdr10Settings": { + "target": "com.amazonaws.medialive#Hdr10Settings", "traits": { - "smithy.api#documentation": "When set to temporal, output files are stored in non-persistent memory for faster reading and writing.", - "smithy.api#jsonName": "mediaStoreStorageClass" + "smithy.api#jsonName": "hdr10Settings" } }, - "NumRetries": { - "target": "com.amazonaws.medialive#__integerMin0", + "Rec601Settings": { + "target": "com.amazonaws.medialive#Rec601Settings", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "numRetries" + "smithy.api#jsonName": "rec601Settings" } }, - "RestartDelay": { - "target": "com.amazonaws.medialive#__integerMin0Max15", + "Rec709Settings": { + "target": "com.amazonaws.medialive#Rec709Settings", "traits": { - "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", - "smithy.api#jsonName": "restartDelay" + "smithy.api#jsonName": "rec709Settings" } } }, "traits": { - "smithy.api#documentation": "Hls Media Store Settings" + "smithy.api#documentation": "H265 Color Space Settings" } }, - "com.amazonaws.medialive#HlsMediaStoreStorageClass": { - "type": "enum", + "com.amazonaws.medialive#H265FilterSettings": { + "type": "structure", "members": { - "TEMPORAL": { - "target": "smithy.api#Unit", + "TemporalFilterSettings": { + "target": "com.amazonaws.medialive#TemporalFilterSettings", "traits": { - "smithy.api#enumValue": "TEMPORAL" + "smithy.api#jsonName": "temporalFilterSettings" } } }, "traits": { - "smithy.api#documentation": "Hls Media Store Storage Class" + "smithy.api#documentation": "H265 Filter Settings" } }, - "com.amazonaws.medialive#HlsMode": { + "com.amazonaws.medialive#H265FlickerAq": { "type": "enum", "members": { - "LIVE": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "LIVE" + "smithy.api#enumValue": "DISABLED" } }, - "VOD": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "VOD" + "smithy.api#enumValue": "ENABLED" } } }, "traits": { - "smithy.api#documentation": "Hls Mode" + "smithy.api#documentation": "H265 Flicker Aq" } }, - "com.amazonaws.medialive#HlsOutputSelection": { + "com.amazonaws.medialive#H265GopSizeUnits": { "type": "enum", "members": { - "MANIFESTS_AND_SEGMENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANIFESTS_AND_SEGMENTS" - } - }, - "SEGMENTS_ONLY": { + "FRAMES": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SEGMENTS_ONLY" + "smithy.api#enumValue": "FRAMES" } }, - "VARIANT_MANIFESTS_AND_SEGMENTS": { + "SECONDS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "VARIANT_MANIFESTS_AND_SEGMENTS" + "smithy.api#enumValue": "SECONDS" } } }, "traits": { - "smithy.api#documentation": "Hls Output Selection" + "smithy.api#documentation": "H265 Gop Size Units" } }, - "com.amazonaws.medialive#HlsOutputSettings": { - "type": "structure", + "com.amazonaws.medialive#H265Level": { + "type": "enum", "members": { - "H265PackagingType": { - "target": "com.amazonaws.medialive#HlsH265PackagingType", + "H265_LEVEL_1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1.", - "smithy.api#jsonName": "h265PackagingType" + "smithy.api#enumValue": "H265_LEVEL_1" } }, - "HlsSettings": { - "target": "com.amazonaws.medialive#HlsSettings", + "H265_LEVEL_2": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Settings regarding the underlying stream. These settings are different for audio-only outputs.", - "smithy.api#jsonName": "hlsSettings", - "smithy.api#required": {} + "smithy.api#enumValue": "H265_LEVEL_2" } }, - "NameModifier": { - "target": "com.amazonaws.medialive#__stringMin1", + "H265_LEVEL_2_1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "String concatenated to the end of the destination filename. Accepts \\\"Format Identifiers\\\":#formatIdentifierParameters.", - "smithy.api#jsonName": "nameModifier" + "smithy.api#enumValue": "H265_LEVEL_2_1" } }, - "SegmentModifier": { - "target": "com.amazonaws.medialive#__string", + "H265_LEVEL_3": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "String concatenated to end of segment filenames.", - "smithy.api#jsonName": "segmentModifier" + "smithy.api#enumValue": "H265_LEVEL_3" } - } - }, - "traits": { - "smithy.api#documentation": "Hls Output Settings" - } - }, - "com.amazonaws.medialive#HlsProgramDateTime": { - "type": "enum", - "members": { - "EXCLUDE": { + }, + "H265_LEVEL_3_1": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EXCLUDE" + "smithy.api#enumValue": "H265_LEVEL_3_1" } }, - "INCLUDE": { + "H265_LEVEL_4": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INCLUDE" + "smithy.api#enumValue": "H265_LEVEL_4" } - } - }, - "traits": { - "smithy.api#documentation": "Hls Program Date Time" - } - }, - "com.amazonaws.medialive#HlsProgramDateTimeClock": { - "type": "enum", - "members": { - "INITIALIZE_FROM_OUTPUT_TIMECODE": { + }, + "H265_LEVEL_4_1": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INITIALIZE_FROM_OUTPUT_TIMECODE" + "smithy.api#enumValue": "H265_LEVEL_4_1" } }, - "SYSTEM_CLOCK": { + "H265_LEVEL_5": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SYSTEM_CLOCK" + "smithy.api#enumValue": "H265_LEVEL_5" } - } - }, - "traits": { - "smithy.api#documentation": "Hls Program Date Time Clock" - } - }, - "com.amazonaws.medialive#HlsRedundantManifest": { - "type": "enum", - "members": { - "DISABLED": { + }, + "H265_LEVEL_5_1": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "H265_LEVEL_5_1" } }, - "ENABLED": { + "H265_LEVEL_5_2": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "H265_LEVEL_5_2" } - } - }, - "traits": { - "smithy.api#documentation": "Hls Redundant Manifest" - } - }, - "com.amazonaws.medialive#HlsS3Settings": { - "type": "structure", - "members": { - "CannedAcl": { - "target": "com.amazonaws.medialive#S3CannedAcl", + }, + "H265_LEVEL_6": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none.", - "smithy.api#jsonName": "cannedAcl" + "smithy.api#enumValue": "H265_LEVEL_6" + } + }, + "H265_LEVEL_6_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "H265_LEVEL_6_1" + } + }, + "H265_LEVEL_6_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "H265_LEVEL_6_2" + } + }, + "H265_LEVEL_AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "H265_LEVEL_AUTO" } } }, "traits": { - "smithy.api#documentation": "Hls S3 Settings" + "smithy.api#documentation": "H265 Level" } }, - "com.amazonaws.medialive#HlsScte35SourceType": { + "com.amazonaws.medialive#H265LookAheadRateControl": { "type": "enum", "members": { - "MANIFEST": { + "HIGH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MANIFEST" + "smithy.api#enumValue": "HIGH" } }, - "SEGMENTS": { + "LOW": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SEGMENTS" + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" } } }, "traits": { - "smithy.api#documentation": "Hls Scte35 Source Type" + "smithy.api#documentation": "H265 Look Ahead Rate Control" } }, - "com.amazonaws.medialive#HlsSegmentationMode": { + "com.amazonaws.medialive#H265MvOverPictureBoundaries": { "type": "enum", "members": { - "USE_INPUT_SEGMENTATION": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "USE_INPUT_SEGMENTATION" + "smithy.api#enumValue": "DISABLED" } }, - "USE_SEGMENT_DURATION": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "USE_SEGMENT_DURATION" + "smithy.api#enumValue": "ENABLED" } } }, "traits": { - "smithy.api#documentation": "Hls Segmentation Mode" + "smithy.api#documentation": "H265 Mv Over Picture Boundaries" } }, - "com.amazonaws.medialive#HlsSettings": { - "type": "structure", + "com.amazonaws.medialive#H265MvTemporalPredictor": { + "type": "enum", "members": { - "AudioOnlyHlsSettings": { - "target": "com.amazonaws.medialive#AudioOnlyHlsSettings", - "traits": { - "smithy.api#jsonName": "audioOnlyHlsSettings" - } - }, - "Fmp4HlsSettings": { - "target": "com.amazonaws.medialive#Fmp4HlsSettings", - "traits": { - "smithy.api#jsonName": "fmp4HlsSettings" - } - }, - "FrameCaptureHlsSettings": { - "target": "com.amazonaws.medialive#FrameCaptureHlsSettings", + "DISABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "frameCaptureHlsSettings" + "smithy.api#enumValue": "DISABLED" } }, - "StandardHlsSettings": { - "target": "com.amazonaws.medialive#StandardHlsSettings", + "ENABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "standardHlsSettings" + "smithy.api#enumValue": "ENABLED" } } }, "traits": { - "smithy.api#documentation": "Hls Settings" + "smithy.api#documentation": "H265 Mv Temporal Predictor" } }, - "com.amazonaws.medialive#HlsStreamInfResolution": { + "com.amazonaws.medialive#H265Profile": { "type": "enum", "members": { - "EXCLUDE": { + "MAIN": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EXCLUDE" + "smithy.api#enumValue": "MAIN" } }, - "INCLUDE": { + "MAIN_10BIT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INCLUDE" + "smithy.api#enumValue": "MAIN_10BIT" } } }, "traits": { - "smithy.api#documentation": "Hls Stream Inf Resolution" + "smithy.api#documentation": "H265 Profile" } }, - "com.amazonaws.medialive#HlsTimedMetadataId3Frame": { + "com.amazonaws.medialive#H265RateControlMode": { "type": "enum", "members": { - "NONE": { + "CBR": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "CBR" } }, - "PRIV": { + "MULTIPLEX": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PRIV" + "smithy.api#enumValue": "MULTIPLEX" } }, - "TDRL": { + "QVBR": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "TDRL" - } - } - }, - "traits": { - "smithy.api#documentation": "Hls Timed Metadata Id3 Frame" - } - }, - "com.amazonaws.medialive#HlsTimedMetadataScheduleActionSettings": { - "type": "structure", - "members": { - "Id3": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure", - "smithy.api#jsonName": "id3", - "smithy.api#required": {} + "smithy.api#enumValue": "QVBR" } } }, "traits": { - "smithy.api#documentation": "Settings for the action to emit HLS metadata" + "smithy.api#documentation": "H265 Rate Control Mode" } }, - "com.amazonaws.medialive#HlsTsFileMode": { + "com.amazonaws.medialive#H265ScanType": { "type": "enum", "members": { - "SEGMENTED_FILES": { + "INTERLACED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SEGMENTED_FILES" + "smithy.api#enumValue": "INTERLACED" } }, - "SINGLE_FILE": { + "PROGRESSIVE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SINGLE_FILE" + "smithy.api#enumValue": "PROGRESSIVE" } } }, "traits": { - "smithy.api#documentation": "Hls Ts File Mode" + "smithy.api#documentation": "H265 Scan Type" } }, - "com.amazonaws.medialive#HlsWebdavHttpTransferMode": { + "com.amazonaws.medialive#H265SceneChangeDetect": { "type": "enum", "members": { - "CHUNKED": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CHUNKED" + "smithy.api#enumValue": "DISABLED" } }, - "NON_CHUNKED": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NON_CHUNKED" + "smithy.api#enumValue": "ENABLED" } } }, "traits": { - "smithy.api#documentation": "Hls Webdav Http Transfer Mode" + "smithy.api#documentation": "H265 Scene Change Detect" } }, - "com.amazonaws.medialive#HlsWebdavSettings": { + "com.amazonaws.medialive#H265Settings": { "type": "structure", "members": { - "ConnectionRetryInterval": { - "target": "com.amazonaws.medialive#__integerMin0", + "AdaptiveQuantization": { + "target": "com.amazonaws.medialive#H265AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", - "smithy.api#jsonName": "connectionRetryInterval" + "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "smithy.api#jsonName": "adaptiveQuantization" } }, - "FilecacheDuration": { - "target": "com.amazonaws.medialive#__integerMin0Max600", + "AfdSignaling": { + "target": "com.amazonaws.medialive#AfdSignaling", "traits": { - "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", - "smithy.api#jsonName": "filecacheDuration" + "smithy.api#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.", + "smithy.api#jsonName": "afdSignaling" } }, - "HttpTransferMode": { - "target": "com.amazonaws.medialive#HlsWebdavHttpTransferMode", + "AlternativeTransferFunction": { + "target": "com.amazonaws.medialive#H265AlternativeTransferFunction", "traits": { - "smithy.api#documentation": "Specify whether or not to use chunked transfer encoding to WebDAV.", - "smithy.api#jsonName": "httpTransferMode" + "smithy.api#documentation": "Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.", + "smithy.api#jsonName": "alternativeTransferFunction" } }, - "NumRetries": { - "target": "com.amazonaws.medialive#__integerMin0", + "Bitrate": { + "target": "com.amazonaws.medialive#__integerMin100000Max40000000", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "numRetries" + "smithy.api#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.", + "smithy.api#jsonName": "bitrate" } }, - "RestartDelay": { - "target": "com.amazonaws.medialive#__integerMin0Max15", + "BufSize": { + "target": "com.amazonaws.medialive#__integerMin100000Max80000000", "traits": { - "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", - "smithy.api#jsonName": "restartDelay" + "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits.", + "smithy.api#jsonName": "bufSize" } - } - }, - "traits": { - "smithy.api#documentation": "Hls Webdav Settings" - } - }, - "com.amazonaws.medialive#HtmlMotionGraphicsSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Html Motion Graphics Settings" - } - }, - "com.amazonaws.medialive#IFrameOnlyPlaylistType": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", + }, + "ColorMetadata": { + "target": "com.amazonaws.medialive#H265ColorMetadata", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#documentation": "Includes colorspace metadata in the output.", + "smithy.api#jsonName": "colorMetadata" } }, - "STANDARD": { - "target": "smithy.api#Unit", + "ColorSpaceSettings": { + "target": "com.amazonaws.medialive#H265ColorSpaceSettings", "traits": { - "smithy.api#enumValue": "STANDARD" + "smithy.api#documentation": "Color Space settings", + "smithy.api#jsonName": "colorSpaceSettings" } - } - }, - "traits": { - "smithy.api#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." - } - }, - "com.amazonaws.medialive#ImmediateModeScheduleActionStartSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Settings to configure an action so that it occurs as soon as possible." - } - }, - "com.amazonaws.medialive#IncludeFillerNalUnits": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", + }, + "FilterSettings": { + "target": "com.amazonaws.medialive#H265FilterSettings", "traits": { - "smithy.api#enumValue": "AUTO" + "smithy.api#documentation": "Optional filters that you can apply to an encode.", + "smithy.api#jsonName": "filterSettings" } }, - "DROP": { - "target": "smithy.api#Unit", + "FixedAfd": { + "target": "com.amazonaws.medialive#FixedAfd", "traits": { - "smithy.api#enumValue": "DROP" + "smithy.api#documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.", + "smithy.api#jsonName": "fixedAfd" } }, - "INCLUDE": { - "target": "smithy.api#Unit", + "FlickerAq": { + "target": "com.amazonaws.medialive#H265FlickerAq", "traits": { - "smithy.api#enumValue": "INCLUDE" + "smithy.api#documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", + "smithy.api#jsonName": "flickerAq" } - } - }, - "traits": { - "smithy.api#documentation": "Include Filler Nal Units" - } - }, - "com.amazonaws.medialive#Input": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", + }, + "FramerateDenominator": { + "target": "com.amazonaws.medialive#__integerMin1Max3003", "traits": { - "smithy.api#documentation": "The Unique ARN of the input (generated, immutable).", - "smithy.api#jsonName": "arn" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Framerate denominator.", + "smithy.api#jsonName": "framerateDenominator", + "smithy.api#required": {} } }, - "AttachedChannels": { - "target": "com.amazonaws.medialive#__listOf__string", + "FramerateNumerator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).", - "smithy.api#jsonName": "attachedChannels" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.", + "smithy.api#jsonName": "framerateNumerator", + "smithy.api#required": {} } }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfInputDestination", + "GopClosedCadence": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "A list of the destinations of the input (PUSH-type).", - "smithy.api#jsonName": "destinations" + "smithy.api#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.", + "smithy.api#jsonName": "gopClosedCadence" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "GopSize": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "The generated ID of the input (unique for user account, immutable).", - "smithy.api#jsonName": "id" + "smithy.api#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.", + "smithy.api#jsonName": "gopSize" } }, - "InputClass": { - "target": "com.amazonaws.medialive#InputClass", + "GopSizeUnits": { + "target": "com.amazonaws.medialive#H265GopSizeUnits", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "inputClass" + "smithy.api#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.", + "smithy.api#jsonName": "gopSizeUnits" } }, - "InputDevices": { - "target": "com.amazonaws.medialive#__listOfInputDeviceSettings", + "Level": { + "target": "com.amazonaws.medialive#H265Level", "traits": { - "smithy.api#documentation": "Settings for the input devices.", - "smithy.api#jsonName": "inputDevices" + "smithy.api#documentation": "H.265 Level.", + "smithy.api#jsonName": "level" } }, - "InputPartnerIds": { - "target": "com.amazonaws.medialive#__listOf__string", + "LookAheadRateControl": { + "target": "com.amazonaws.medialive#H265LookAheadRateControl", "traits": { - "smithy.api#documentation": "A list of IDs for all Inputs which are partners of this one.", - "smithy.api#jsonName": "inputPartnerIds" + "smithy.api#documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.", + "smithy.api#jsonName": "lookAheadRateControl" } }, - "InputSourceType": { - "target": "com.amazonaws.medialive#InputSourceType", + "MaxBitrate": { + "target": "com.amazonaws.medialive#__integerMin100000Max40000000", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "inputSourceType" + "smithy.api#documentation": "For QVBR: See the tooltip for Quality level", + "smithy.api#jsonName": "maxBitrate" } }, - "MediaConnectFlows": { - "target": "com.amazonaws.medialive#__listOfMediaConnectFlow", + "MinIInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max30", "traits": { - "smithy.api#documentation": "A list of MediaConnect Flows for this input.", - "smithy.api#jsonName": "mediaConnectFlows" + "smithy.api#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", + "smithy.api#jsonName": "minIInterval" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "ParDenominator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "The user-assigned name (This is a mutable value).", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "Pixel Aspect Ratio denominator.", + "smithy.api#jsonName": "parDenominator" } }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", + "ParNumerator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation.", - "smithy.api#jsonName": "roleArn" + "smithy.api#documentation": "Pixel Aspect Ratio numerator.", + "smithy.api#jsonName": "parNumerator" } }, - "SecurityGroups": { - "target": "com.amazonaws.medialive#__listOf__string", + "Profile": { + "target": "com.amazonaws.medialive#H265Profile", "traits": { - "smithy.api#documentation": "A list of IDs for all the Input Security Groups attached to the input.", - "smithy.api#jsonName": "securityGroups" + "smithy.api#documentation": "H.265 Profile.", + "smithy.api#jsonName": "profile" } }, - "Sources": { - "target": "com.amazonaws.medialive#__listOfInputSource", + "QvbrQualityLevel": { + "target": "com.amazonaws.medialive#__integerMin1Max10", "traits": { - "smithy.api#documentation": "A list of the sources of the input (PULL-type).", - "smithy.api#jsonName": "sources" + "smithy.api#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", + "smithy.api#jsonName": "qvbrQualityLevel" } }, - "State": { - "target": "com.amazonaws.medialive#InputState", + "RateControlMode": { + "target": "com.amazonaws.medialive#H265RateControlMode", "traits": { - "smithy.api#jsonName": "state" + "smithy.api#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.", + "smithy.api#jsonName": "rateControlMode" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "ScanType": { + "target": "com.amazonaws.medialive#H265ScanType", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Sets the scan type of the output to progressive or top-field-first interlaced.", + "smithy.api#jsonName": "scanType" } }, - "Type": { - "target": "com.amazonaws.medialive#InputType", + "SceneChangeDetect": { + "target": "com.amazonaws.medialive#H265SceneChangeDetect", "traits": { - "smithy.api#jsonName": "type" + "smithy.api#documentation": "Scene change detection.", + "smithy.api#jsonName": "sceneChangeDetect" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for Input" - } - }, - "com.amazonaws.medialive#InputAttachment": { - "type": "structure", - "members": { - "AutomaticInputFailoverSettings": { - "target": "com.amazonaws.medialive#AutomaticInputFailoverSettings", + }, + "Slices": { + "target": "com.amazonaws.medialive#__integerMin1Max16", "traits": { - "smithy.api#documentation": "User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input.", - "smithy.api#jsonName": "automaticInputFailoverSettings" + "smithy.api#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.", + "smithy.api#jsonName": "slices" } }, - "InputAttachmentName": { - "target": "com.amazonaws.medialive#__string", + "Tier": { + "target": "com.amazonaws.medialive#H265Tier", "traits": { - "smithy.api#documentation": "User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.", - "smithy.api#jsonName": "inputAttachmentName" + "smithy.api#documentation": "H.265 Tier.", + "smithy.api#jsonName": "tier" } }, - "InputId": { - "target": "com.amazonaws.medialive#__string", + "TimecodeInsertion": { + "target": "com.amazonaws.medialive#H265TimecodeInsertionBehavior", "traits": { - "smithy.api#documentation": "The ID of the input", - "smithy.api#jsonName": "inputId" + "smithy.api#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", + "smithy.api#jsonName": "timecodeInsertion" } }, - "InputSettings": { - "target": "com.amazonaws.medialive#InputSettings", + "TimecodeBurninSettings": { + "target": "com.amazonaws.medialive#TimecodeBurninSettings", "traits": { - "smithy.api#documentation": "Settings of an input (caption selector, etc.)", - "smithy.api#jsonName": "inputSettings" + "smithy.api#documentation": "Timecode burn-in settings", + "smithy.api#jsonName": "timecodeBurninSettings" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for InputAttachment" - } - }, - "com.amazonaws.medialive#InputChannelLevel": { - "type": "structure", - "members": { - "Gain": { - "target": "com.amazonaws.medialive#__integerMinNegative60Max6", + }, + "MvOverPictureBoundaries": { + "target": "com.amazonaws.medialive#H265MvOverPictureBoundaries", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.", - "smithy.api#jsonName": "gain", - "smithy.api#required": {} + "smithy.api#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\".", + "smithy.api#jsonName": "mvOverPictureBoundaries" } }, - "InputChannel": { - "target": "com.amazonaws.medialive#__integerMin0Max15", + "MvTemporalPredictor": { + "target": "com.amazonaws.medialive#H265MvTemporalPredictor", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The index of the input channel used as a source.", - "smithy.api#jsonName": "inputChannel", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Input Channel Level" - } - }, - "com.amazonaws.medialive#InputClass": { - "type": "enum", - "members": { - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STANDARD" + "smithy.api#documentation": "If you are setting up the picture as a tile, you must set this to \"disabled\". In other configurations, you typically enter \"enabled\".", + "smithy.api#jsonName": "mvTemporalPredictor" } }, - "SINGLE_PIPELINE": { - "target": "smithy.api#Unit", + "TileHeight": { + "target": "com.amazonaws.medialive#__integerMin64Max2160", "traits": { - "smithy.api#enumValue": "SINGLE_PIPELINE" + "smithy.api#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", + "smithy.api#jsonName": "tileHeight" } - } - }, - "traits": { - "smithy.api#documentation": "A standard input has two sources and a single pipeline input only has one." - } - }, - "com.amazonaws.medialive#InputClippingSettings": { - "type": "structure", - "members": { - "InputTimecodeSource": { - "target": "com.amazonaws.medialive#InputTimecodeSource", + }, + "TilePadding": { + "target": "com.amazonaws.medialive#H265TilePadding", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The source of the timecodes in the source being clipped.", - "smithy.api#jsonName": "inputTimecodeSource", - "smithy.api#required": {} + "smithy.api#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\".", + "smithy.api#jsonName": "tilePadding" } }, - "StartTimecode": { - "target": "com.amazonaws.medialive#StartTimecode", + "TileWidth": { + "target": "com.amazonaws.medialive#__integerMin256Max3840", "traits": { - "smithy.api#documentation": "Settings to identify the start of the clip.", - "smithy.api#jsonName": "startTimecode" + "smithy.api#documentation": "Set this field to set up the picture as a tile. See tileHeight for more information.", + "smithy.api#jsonName": "tileWidth" } }, - "StopTimecode": { - "target": "com.amazonaws.medialive#StopTimecode", + "TreeblockSize": { + "target": "com.amazonaws.medialive#H265TreeblockSize", "traits": { - "smithy.api#documentation": "Settings to identify the end of the clip.", - "smithy.api#jsonName": "stopTimecode" + "smithy.api#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\".", + "smithy.api#jsonName": "treeblockSize" } } }, "traits": { - "smithy.api#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." + "smithy.api#documentation": "H265 Settings" } }, - "com.amazonaws.medialive#InputCodec": { + "com.amazonaws.medialive#H265Tier": { "type": "enum", "members": { - "MPEG2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MPEG2" - } - }, - "AVC": { + "HIGH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AVC" + "smithy.api#enumValue": "HIGH" } }, - "HEVC": { + "MAIN": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HEVC" + "smithy.api#enumValue": "MAIN" } } }, "traits": { - "smithy.api#documentation": "codec in increasing order of complexity" + "smithy.api#documentation": "H265 Tier" } }, - "com.amazonaws.medialive#InputDeblockFilter": { + "com.amazonaws.medialive#H265TilePadding": { "type": "enum", "members": { - "DISABLED": { + "NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "NONE" } }, - "ENABLED": { + "PADDED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "PADDED" } } }, "traits": { - "smithy.api#documentation": "Input Deblock Filter" + "smithy.api#documentation": "H265 Tile Padding" } }, - "com.amazonaws.medialive#InputDenoiseFilter": { + "com.amazonaws.medialive#H265TimecodeInsertionBehavior": { "type": "enum", "members": { "DISABLED": { @@ -13068,795 +14102,716 @@ "smithy.api#enumValue": "DISABLED" } }, - "ENABLED": { + "PIC_TIMING_SEI": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "PIC_TIMING_SEI" } } }, "traits": { - "smithy.api#documentation": "Input Denoise Filter" + "smithy.api#documentation": "H265 Timecode Insertion Behavior" } }, - "com.amazonaws.medialive#InputDestination": { - "type": "structure", + "com.amazonaws.medialive#H265TreeblockSize": { + "type": "enum", "members": { - "Ip": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The system-generated static IP address of endpoint.\nIt remains fixed for the lifetime of the input.", - "smithy.api#jsonName": "ip" - } - }, - "Port": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The port number for the input.", - "smithy.api#jsonName": "port" - } - }, - "Url": { - "target": "com.amazonaws.medialive#__string", + "AUTO": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "This represents the endpoint that the customer stream will be\npushed to.", - "smithy.api#jsonName": "url" + "smithy.api#enumValue": "AUTO" } }, - "Vpc": { - "target": "com.amazonaws.medialive#InputDestinationVpc", - "traits": { - "smithy.api#jsonName": "vpc" - } - } - }, - "traits": { - "smithy.api#documentation": "The settings for a PUSH type input." - } - }, - "com.amazonaws.medialive#InputDestinationRequest": { - "type": "structure", - "members": { - "StreamName": { - "target": "com.amazonaws.medialive#__string", + "TREE_SIZE_32X32": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A unique name for the location the RTMP stream is being pushed\nto.", - "smithy.api#jsonName": "streamName" + "smithy.api#enumValue": "TREE_SIZE_32X32" } } }, "traits": { - "smithy.api#documentation": "Endpoint settings for a PUSH type input." + "smithy.api#documentation": "H265 Treeblock Size" } }, - "com.amazonaws.medialive#InputDestinationVpc": { + "com.amazonaws.medialive#Hdr10Settings": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.medialive#__string", + "MaxCll": { + "target": "com.amazonaws.medialive#__integerMin0Max32768", "traits": { - "smithy.api#documentation": "The availability zone of the Input destination.", - "smithy.api#jsonName": "availabilityZone" + "smithy.api#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.", + "smithy.api#jsonName": "maxCll" } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.medialive#__string", + "MaxFall": { + "target": "com.amazonaws.medialive#__integerMin0Max32768", "traits": { - "smithy.api#documentation": "The network interface ID of the Input destination in the VPC.", - "smithy.api#jsonName": "networkInterfaceId" + "smithy.api#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.", + "smithy.api#jsonName": "maxFall" } } }, "traits": { - "smithy.api#documentation": "The properties for a VPC type input destination." + "smithy.api#documentation": "Hdr10 Settings" } }, - "com.amazonaws.medialive#InputDeviceActiveInput": { + "com.amazonaws.medialive#HlsAdMarkers": { "type": "enum", "members": { - "HDMI": { + "ADOBE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HDMI" + "smithy.api#enumValue": "ADOBE" } }, - "SDI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SDI" - } - } - }, - "traits": { - "smithy.api#documentation": "The source at the input device that is currently active." - } - }, - "com.amazonaws.medialive#InputDeviceCodec": { - "type": "enum", - "members": { - "HEVC": { + "ELEMENTAL": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HEVC" + "smithy.api#enumValue": "ELEMENTAL" } }, - "AVC": { + "ELEMENTAL_SCTE35": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AVC" + "smithy.api#enumValue": "ELEMENTAL_SCTE35" } } }, "traits": { - "smithy.api#documentation": "The codec to use on the video that the device produces." + "smithy.api#documentation": "Hls Ad Markers" } }, - "com.amazonaws.medialive#InputDeviceConfigurableAudioChannelPairConfig": { - "type": "structure", + "com.amazonaws.medialive#HlsAkamaiHttpTransferMode": { + "type": "enum", "members": { - "Id": { - "target": "com.amazonaws.medialive#__integer", + "CHUNKED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The ID for one audio pair configuration, a value from 1 to 8.", - "smithy.api#jsonName": "id" + "smithy.api#enumValue": "CHUNKED" } }, - "Profile": { - "target": "com.amazonaws.medialive#InputDeviceConfigurableAudioChannelPairProfile", + "NON_CHUNKED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "profile" + "smithy.api#enumValue": "NON_CHUNKED" } } }, "traits": { - "smithy.api#documentation": "One audio configuration that specifies the format for one audio pair that the device produces as output." + "smithy.api#documentation": "Hls Akamai Http Transfer Mode" } }, - "com.amazonaws.medialive#InputDeviceConfigurableAudioChannelPairProfile": { - "type": "enum", + "com.amazonaws.medialive#HlsAkamaiSettings": { + "type": "structure", "members": { - "DISABLED": { - "target": "smithy.api#Unit", + "ConnectionRetryInterval": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", + "smithy.api#jsonName": "connectionRetryInterval" } }, - "VBR_AAC_HHE_16000": { - "target": "smithy.api#Unit", + "FilecacheDuration": { + "target": "com.amazonaws.medialive#__integerMin0Max600", "traits": { - "smithy.api#enumValue": "VBR-AAC_HHE-16000" + "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", + "smithy.api#jsonName": "filecacheDuration" } }, - "VBR_AAC_HE_64000": { - "target": "smithy.api#Unit", + "HttpTransferMode": { + "target": "com.amazonaws.medialive#HlsAkamaiHttpTransferMode", "traits": { - "smithy.api#enumValue": "VBR-AAC_HE-64000" + "smithy.api#documentation": "Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.", + "smithy.api#jsonName": "httpTransferMode" } }, - "VBR_AAC_LC_128000": { - "target": "smithy.api#Unit", + "NumRetries": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "VBR-AAC_LC-128000" + "smithy.api#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.", + "smithy.api#jsonName": "numRetries" } }, - "CBR_AAC_HQ_192000": { - "target": "smithy.api#Unit", + "RestartDelay": { + "target": "com.amazonaws.medialive#__integerMin0Max15", "traits": { - "smithy.api#enumValue": "CBR-AAC_HQ-192000" + "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", + "smithy.api#jsonName": "restartDelay" } }, - "CBR_AAC_HQ_256000": { - "target": "smithy.api#Unit", + "Salt": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "CBR-AAC_HQ-256000" + "smithy.api#documentation": "Salt for authenticated Akamai.", + "smithy.api#jsonName": "salt" } }, - "CBR_AAC_HQ_384000": { - "target": "smithy.api#Unit", + "Token": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "CBR-AAC_HQ-384000" - } - }, - "CBR_AAC_HQ_512000": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CBR-AAC_HQ-512000" + "smithy.api#documentation": "Token parameter for authenticated akamai. If not specified, _gda_ is used.", + "smithy.api#jsonName": "token" } } }, "traits": { - "smithy.api#documentation": "Property of InputDeviceConfigurableAudioChannelPairConfig, which configures one audio channel that the device produces." + "smithy.api#documentation": "Hls Akamai Settings" } }, - "com.amazonaws.medialive#InputDeviceConfigurableSettings": { + "com.amazonaws.medialive#HlsBasicPutSettings": { "type": "structure", "members": { - "ConfiguredInput": { - "target": "com.amazonaws.medialive#InputDeviceConfiguredInput", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "configuredInput" - } - }, - "MaxBitrate": { - "target": "com.amazonaws.medialive#__integer", - "traits": { - "smithy.api#documentation": "The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video.", - "smithy.api#jsonName": "maxBitrate" - } - }, - "LatencyMs": { - "target": "com.amazonaws.medialive#__integer", + "ConnectionRetryInterval": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "The Link device's buffer size (latency) in milliseconds (ms).", - "smithy.api#jsonName": "latencyMs" + "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", + "smithy.api#jsonName": "connectionRetryInterval" } }, - "Codec": { - "target": "com.amazonaws.medialive#InputDeviceCodec", + "FilecacheDuration": { + "target": "com.amazonaws.medialive#__integerMin0Max600", "traits": { - "smithy.api#documentation": "Choose the codec for the video that the device produces. Only UHD devices can specify this parameter.", - "smithy.api#jsonName": "codec" + "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", + "smithy.api#jsonName": "filecacheDuration" } }, - "MediaconnectSettings": { - "target": "com.amazonaws.medialive#InputDeviceMediaConnectConfigurableSettings", + "NumRetries": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "mediaconnectSettings" + "smithy.api#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.", + "smithy.api#jsonName": "numRetries" } }, - "AudioChannelPairs": { - "target": "com.amazonaws.medialive#__listOfInputDeviceConfigurableAudioChannelPairConfig", + "RestartDelay": { + "target": "com.amazonaws.medialive#__integerMin0Max15", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "audioChannelPairs" + "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", + "smithy.api#jsonName": "restartDelay" } } }, "traits": { - "smithy.api#documentation": "Configurable settings for the input device." + "smithy.api#documentation": "Hls Basic Put Settings" } }, - "com.amazonaws.medialive#InputDeviceConfiguredInput": { + "com.amazonaws.medialive#HlsCaptionLanguageSetting": { "type": "enum", "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "HDMI": { + "INSERT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HDMI" + "smithy.api#enumValue": "INSERT" } }, - "SDI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SDI" - } - } - }, - "traits": { - "smithy.api#documentation": "The source to activate (use) from the input device." - } - }, - "com.amazonaws.medialive#InputDeviceConnectionState": { - "type": "enum", - "members": { - "DISCONNECTED": { + "NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISCONNECTED" + "smithy.api#enumValue": "NONE" } }, - "CONNECTED": { + "OMIT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CONNECTED" + "smithy.api#enumValue": "OMIT" } } }, "traits": { - "smithy.api#documentation": "The state of the connection between the input device and AWS." + "smithy.api#documentation": "Hls Caption Language Setting" } }, - "com.amazonaws.medialive#InputDeviceHdSettings": { + "com.amazonaws.medialive#HlsCdnSettings": { "type": "structure", "members": { - "ActiveInput": { - "target": "com.amazonaws.medialive#InputDeviceActiveInput", + "HlsAkamaiSettings": { + "target": "com.amazonaws.medialive#HlsAkamaiSettings", "traits": { - "smithy.api#documentation": "If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).", - "smithy.api#jsonName": "activeInput" + "smithy.api#jsonName": "hlsAkamaiSettings" } }, - "ConfiguredInput": { - "target": "com.amazonaws.medialive#InputDeviceConfiguredInput", + "HlsBasicPutSettings": { + "target": "com.amazonaws.medialive#HlsBasicPutSettings", "traits": { - "smithy.api#documentation": "The source at the input device that is currently active. You can specify this source.", - "smithy.api#jsonName": "configuredInput" + "smithy.api#jsonName": "hlsBasicPutSettings" } }, - "DeviceState": { - "target": "com.amazonaws.medialive#InputDeviceState", + "HlsMediaStoreSettings": { + "target": "com.amazonaws.medialive#HlsMediaStoreSettings", "traits": { - "smithy.api#documentation": "The state of the input device.", - "smithy.api#jsonName": "deviceState" + "smithy.api#jsonName": "hlsMediaStoreSettings" } }, - "Framerate": { - "target": "com.amazonaws.medialive#__double", + "HlsS3Settings": { + "target": "com.amazonaws.medialive#HlsS3Settings", "traits": { - "smithy.api#documentation": "The frame rate of the video source.", - "smithy.api#jsonName": "framerate" + "smithy.api#jsonName": "hlsS3Settings" } }, - "Height": { - "target": "com.amazonaws.medialive#__integer", + "HlsWebdavSettings": { + "target": "com.amazonaws.medialive#HlsWebdavSettings", "traits": { - "smithy.api#documentation": "The height of the video source, in pixels.", - "smithy.api#jsonName": "height" + "smithy.api#jsonName": "hlsWebdavSettings" } - }, - "MaxBitrate": { - "target": "com.amazonaws.medialive#__integer", + } + }, + "traits": { + "smithy.api#documentation": "Hls Cdn Settings" + } + }, + "com.amazonaws.medialive#HlsClientCache": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#enumValue": "DISABLED" } }, - "ScanType": { - "target": "com.amazonaws.medialive#InputDeviceScanType", + "ENABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The scan type of the video source.", - "smithy.api#jsonName": "scanType" + "smithy.api#enumValue": "ENABLED" } - }, - "Width": { - "target": "com.amazonaws.medialive#__integer", + } + }, + "traits": { + "smithy.api#documentation": "Hls Client Cache" + } + }, + "com.amazonaws.medialive#HlsCodecSpecification": { + "type": "enum", + "members": { + "RFC_4281": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The width of the video source, in pixels.", - "smithy.api#jsonName": "width" + "smithy.api#enumValue": "RFC_4281" } }, - "LatencyMs": { - "target": "com.amazonaws.medialive#__integer", + "RFC_6381": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.", - "smithy.api#jsonName": "latencyMs" + "smithy.api#enumValue": "RFC_6381" } } }, "traits": { - "smithy.api#documentation": "Settings that describe the active source from the input device, and the video characteristics of that source." + "smithy.api#documentation": "Hls Codec Specification" } }, - "com.amazonaws.medialive#InputDeviceIpScheme": { + "com.amazonaws.medialive#HlsDirectoryStructure": { "type": "enum", "members": { - "STATIC": { + "SINGLE_DIRECTORY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "STATIC" + "smithy.api#enumValue": "SINGLE_DIRECTORY" } }, - "DHCP": { + "SUBDIRECTORY_PER_STREAM": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DHCP" + "smithy.api#enumValue": "SUBDIRECTORY_PER_STREAM" } } }, "traits": { - "smithy.api#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." + "smithy.api#documentation": "Hls Directory Structure" } }, - "com.amazonaws.medialive#InputDeviceMediaConnectConfigurableSettings": { - "type": "structure", + "com.amazonaws.medialive#HlsDiscontinuityTags": { + "type": "enum", "members": { - "FlowArn": { - "target": "com.amazonaws.medialive#__string", + "INSERT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The ARN of the MediaConnect flow to attach this device to.", - "smithy.api#jsonName": "flowArn" + "smithy.api#enumValue": "INSERT" } }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", + "NEVER_INSERT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "roleArn" + "smithy.api#enumValue": "NEVER_INSERT" } - }, - "SecretArn": { - "target": "com.amazonaws.medialive#__string", + } + }, + "traits": { + "smithy.api#documentation": "Hls Discontinuity Tags" + } + }, + "com.amazonaws.medialive#HlsEncryptionType": { + "type": "enum", + "members": { + "AES128": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The ARN for the secret that holds the encryption key to encrypt the content output by the device.", - "smithy.api#jsonName": "secretArn" + "smithy.api#enumValue": "AES128" } }, - "SourceName": { - "target": "com.amazonaws.medialive#__string", + "SAMPLE_AES": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the MediaConnect Flow source to stream to.", - "smithy.api#jsonName": "sourceName" + "smithy.api#enumValue": "SAMPLE_AES" } } }, "traits": { - "smithy.api#documentation": "Parameters required to attach a MediaConnect flow to the device." + "smithy.api#documentation": "Hls Encryption Type" } }, - "com.amazonaws.medialive#InputDeviceMediaConnectSettings": { + "com.amazonaws.medialive#HlsGroupSettings": { "type": "structure", "members": { - "FlowArn": { - "target": "com.amazonaws.medialive#__string", + "AdMarkers": { + "target": "com.amazonaws.medialive#__listOfHlsAdMarkers", "traits": { - "smithy.api#documentation": "The ARN of the MediaConnect flow.", - "smithy.api#jsonName": "flowArn" + "smithy.api#documentation": "Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.", + "smithy.api#jsonName": "adMarkers" } }, - "RoleArn": { + "BaseUrlContent": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ARN for the role that MediaLive assumes to access the attached flow and secret.", - "smithy.api#jsonName": "roleArn" + "smithy.api#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.", + "smithy.api#jsonName": "baseUrlContent" } }, - "SecretArn": { + "BaseUrlContent1": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ARN of the secret used to encrypt the stream.", - "smithy.api#jsonName": "secretArn" + "smithy.api#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.", + "smithy.api#jsonName": "baseUrlContent1" } }, - "SourceName": { + "BaseUrlManifest": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The name of the MediaConnect flow source.", - "smithy.api#jsonName": "sourceName" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the MediaConnect flow attached to the device." - } - }, - "com.amazonaws.medialive#InputDeviceNetworkSettings": { - "type": "structure", - "members": { - "DnsAddresses": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "The DNS addresses of the input device.", - "smithy.api#jsonName": "dnsAddresses" + "smithy.api#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.", + "smithy.api#jsonName": "baseUrlManifest" } }, - "Gateway": { + "BaseUrlManifest1": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The network gateway IP address.", - "smithy.api#jsonName": "gateway" + "smithy.api#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.", + "smithy.api#jsonName": "baseUrlManifest1" } }, - "IpAddress": { - "target": "com.amazonaws.medialive#__string", + "CaptionLanguageMappings": { + "target": "com.amazonaws.medialive#__listOfCaptionLanguageMapping", "traits": { - "smithy.api#documentation": "The IP address of the input device.", - "smithy.api#jsonName": "ipAddress" + "smithy.api#documentation": "Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to \"insert\".", + "smithy.api#jsonName": "captionLanguageMappings" } }, - "IpScheme": { - "target": "com.amazonaws.medialive#InputDeviceIpScheme", + "CaptionLanguageSetting": { + "target": "com.amazonaws.medialive#HlsCaptionLanguageSetting", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "ipScheme" + "smithy.api#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.", + "smithy.api#jsonName": "captionLanguageSetting" } }, - "SubnetMask": { - "target": "com.amazonaws.medialive#__string", + "ClientCache": { + "target": "com.amazonaws.medialive#HlsClientCache", "traits": { - "smithy.api#documentation": "The subnet mask of the input device.", - "smithy.api#jsonName": "subnetMask" + "smithy.api#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.", + "smithy.api#jsonName": "clientCache" } - } - }, - "traits": { - "smithy.api#documentation": "The network settings for the input device." - } - }, - "com.amazonaws.medialive#InputDeviceOutputType": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", + }, + "CodecSpecification": { + "target": "com.amazonaws.medialive#HlsCodecSpecification", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.", + "smithy.api#jsonName": "codecSpecification" } }, - "MEDIALIVE_INPUT": { - "target": "smithy.api#Unit", + "ConstantIv": { + "target": "com.amazonaws.medialive#__stringMin32Max32", "traits": { - "smithy.api#enumValue": "MEDIALIVE_INPUT" + "smithy.api#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.", + "smithy.api#jsonName": "constantIv" } }, - "MEDIACONNECT_FLOW": { - "target": "smithy.api#Unit", + "Destination": { + "target": "com.amazonaws.medialive#OutputLocationRef", "traits": { - "smithy.api#enumValue": "MEDIACONNECT_FLOW" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).", + "smithy.api#jsonName": "destination", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "The output attachment type of the input device." - } - }, - "com.amazonaws.medialive#InputDeviceRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.medialive#__string", + }, + "DirectoryStructure": { + "target": "com.amazonaws.medialive#HlsDirectoryStructure", "traits": { - "smithy.api#documentation": "The unique ID for the device.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Place segments in subdirectories.", + "smithy.api#jsonName": "directoryStructure" } - } - }, - "traits": { - "smithy.api#documentation": "Settings for an input device." - } - }, - "com.amazonaws.medialive#InputDeviceScanType": { - "type": "enum", - "members": { - "INTERLACED": { - "target": "smithy.api#Unit", + }, + "DiscontinuityTags": { + "target": "com.amazonaws.medialive#HlsDiscontinuityTags", "traits": { - "smithy.api#enumValue": "INTERLACED" + "smithy.api#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.", + "smithy.api#jsonName": "discontinuityTags" } }, - "PROGRESSIVE": { - "target": "smithy.api#Unit", + "EncryptionType": { + "target": "com.amazonaws.medialive#HlsEncryptionType", "traits": { - "smithy.api#enumValue": "PROGRESSIVE" + "smithy.api#documentation": "Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.", + "smithy.api#jsonName": "encryptionType" } - } - }, - "traits": { - "smithy.api#documentation": "The scan type of the video source." - } - }, - "com.amazonaws.medialive#InputDeviceSettings": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.medialive#__string", + }, + "HlsCdnSettings": { + "target": "com.amazonaws.medialive#HlsCdnSettings", "traits": { - "smithy.api#documentation": "The unique ID for the device.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Parameters that control interactions with the CDN.", + "smithy.api#jsonName": "hlsCdnSettings" } - } - }, - "traits": { - "smithy.api#documentation": "Settings for an input device." - } - }, - "com.amazonaws.medialive#InputDeviceState": { - "type": "enum", - "members": { - "IDLE": { - "target": "smithy.api#Unit", + }, + "HlsId3SegmentTagging": { + "target": "com.amazonaws.medialive#HlsId3SegmentTaggingState", "traits": { - "smithy.api#enumValue": "IDLE" + "smithy.api#documentation": "State of HLS ID3 Segment Tagging", + "smithy.api#jsonName": "hlsId3SegmentTagging" } }, - "STREAMING": { - "target": "smithy.api#Unit", + "IFrameOnlyPlaylists": { + "target": "com.amazonaws.medialive#IFrameOnlyPlaylistType", "traits": { - "smithy.api#enumValue": "STREAMING" + "smithy.api#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\"", + "smithy.api#jsonName": "iFrameOnlyPlaylists" } - } - }, - "traits": { - "smithy.api#documentation": "The state of the input device." - } - }, - "com.amazonaws.medialive#InputDeviceSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", + }, + "IncompleteSegmentBehavior": { + "target": "com.amazonaws.medialive#HlsIncompleteSegmentBehavior", "traits": { - "smithy.api#documentation": "The unique ARN of the input device.", - "smithy.api#jsonName": "arn" + "smithy.api#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.", + "smithy.api#jsonName": "incompleteSegmentBehavior" } }, - "ConnectionState": { - "target": "com.amazonaws.medialive#InputDeviceConnectionState", + "IndexNSegments": { + "target": "com.amazonaws.medialive#__integerMin3", "traits": { - "smithy.api#documentation": "The state of the connection between the input device and AWS.", - "smithy.api#jsonName": "connectionState" + "smithy.api#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.", + "smithy.api#jsonName": "indexNSegments" } }, - "DeviceSettingsSyncState": { - "target": "com.amazonaws.medialive#DeviceSettingsSyncState", + "InputLossAction": { + "target": "com.amazonaws.medialive#InputLossActionForHlsOut", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "deviceSettingsSyncState" + "smithy.api#documentation": "Parameter that control output group behavior on input loss.", + "smithy.api#jsonName": "inputLossAction" } }, - "DeviceUpdateStatus": { - "target": "com.amazonaws.medialive#DeviceUpdateStatus", + "IvInManifest": { + "target": "com.amazonaws.medialive#HlsIvInManifest", "traits": { - "smithy.api#documentation": "The status of software on the input device.", - "smithy.api#jsonName": "deviceUpdateStatus" + "smithy.api#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.", + "smithy.api#jsonName": "ivInManifest" } }, - "HdDeviceSettings": { - "target": "com.amazonaws.medialive#InputDeviceHdSettings", + "IvSource": { + "target": "com.amazonaws.medialive#HlsIvSource", "traits": { - "smithy.api#documentation": "Settings that describe an input device that is type HD.", - "smithy.api#jsonName": "hdDeviceSettings" + "smithy.api#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.", + "smithy.api#jsonName": "ivSource" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "KeepSegments": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "The unique ID of the input device.", - "smithy.api#jsonName": "id" + "smithy.api#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.", + "smithy.api#jsonName": "keepSegments" } }, - "MacAddress": { + "KeyFormat": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The network MAC address of the input device.", - "smithy.api#jsonName": "macAddress" + "smithy.api#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.", + "smithy.api#jsonName": "keyFormat" } }, - "Name": { + "KeyFormatVersions": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "A name that you specify for the input device.", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "Either a single positive integer version value or a slash delimited list of version values (1/2/3).", + "smithy.api#jsonName": "keyFormatVersions" } }, - "NetworkSettings": { - "target": "com.amazonaws.medialive#InputDeviceNetworkSettings", + "KeyProviderSettings": { + "target": "com.amazonaws.medialive#KeyProviderSettings", "traits": { - "smithy.api#documentation": "Network settings for the input device.", - "smithy.api#jsonName": "networkSettings" + "smithy.api#documentation": "The key provider settings.", + "smithy.api#jsonName": "keyProviderSettings" } }, - "SerialNumber": { - "target": "com.amazonaws.medialive#__string", + "ManifestCompression": { + "target": "com.amazonaws.medialive#HlsManifestCompression", "traits": { - "smithy.api#documentation": "The unique serial number of the input device.", - "smithy.api#jsonName": "serialNumber" - } + "smithy.api#documentation": "When set to gzip, compresses HLS playlist.", + "smithy.api#jsonName": "manifestCompression" + } }, - "Type": { - "target": "com.amazonaws.medialive#InputDeviceType", + "ManifestDurationFormat": { + "target": "com.amazonaws.medialive#HlsManifestDurationFormat", "traits": { - "smithy.api#documentation": "The type of the input device.", - "smithy.api#jsonName": "type" + "smithy.api#documentation": "Indicates whether the output manifest should use floating point or integer values for segment duration.", + "smithy.api#jsonName": "manifestDurationFormat" } }, - "UhdDeviceSettings": { - "target": "com.amazonaws.medialive#InputDeviceUhdSettings", + "MinSegmentLength": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Settings that describe an input device that is type UHD.", - "smithy.api#jsonName": "uhdDeviceSettings" + "smithy.api#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.", + "smithy.api#jsonName": "minSegmentLength" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "Mode": { + "target": "com.amazonaws.medialive#HlsMode", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#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.", + "smithy.api#jsonName": "mode" } }, - "AvailabilityZone": { - "target": "com.amazonaws.medialive#__string", + "OutputSelection": { + "target": "com.amazonaws.medialive#HlsOutputSelection", "traits": { - "smithy.api#documentation": "The Availability Zone associated with this input device.", - "smithy.api#jsonName": "availabilityZone" + "smithy.api#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.", + "smithy.api#jsonName": "outputSelection" } }, - "MedialiveInputArns": { - "target": "com.amazonaws.medialive#__listOf__string", + "ProgramDateTime": { + "target": "com.amazonaws.medialive#HlsProgramDateTime", "traits": { - "smithy.api#documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.", - "smithy.api#jsonName": "medialiveInputArns" + "smithy.api#documentation": "Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.", + "smithy.api#jsonName": "programDateTime" } }, - "OutputType": { - "target": "com.amazonaws.medialive#InputDeviceOutputType", + "ProgramDateTimeClock": { + "target": "com.amazonaws.medialive#HlsProgramDateTimeClock", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "outputType" + "smithy.api#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.", + "smithy.api#jsonName": "programDateTimeClock" } - } - }, - "traits": { - "smithy.api#documentation": "Details of the input device." - } - }, - "com.amazonaws.medialive#InputDeviceThumbnail": { - "type": "blob", - "traits": { - "smithy.api#documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive.", - "smithy.api#streaming": {} - } - }, - "com.amazonaws.medialive#InputDeviceTransferType": { - "type": "enum", - "members": { - "OUTGOING": { - "target": "smithy.api#Unit", + }, + "ProgramDateTimePeriod": { + "target": "com.amazonaws.medialive#__integerMin0Max3600", "traits": { - "smithy.api#enumValue": "OUTGOING" + "smithy.api#documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.", + "smithy.api#jsonName": "programDateTimePeriod" } }, - "INCOMING": { - "target": "smithy.api#Unit", + "RedundantManifest": { + "target": "com.amazonaws.medialive#HlsRedundantManifest", "traits": { - "smithy.api#enumValue": "INCOMING" + "smithy.api#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.", + "smithy.api#jsonName": "redundantManifest" + } + }, + "SegmentLength": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "segmentLength" + } + }, + "SegmentationMode": { + "target": "com.amazonaws.medialive#HlsSegmentationMode", + "traits": { + "smithy.api#documentation": "useInputSegmentation has been deprecated. The configured segment size is always used.", + "smithy.api#jsonName": "segmentationMode" + } + }, + "SegmentsPerSubdirectory": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "segmentsPerSubdirectory" + } + }, + "StreamInfResolution": { + "target": "com.amazonaws.medialive#HlsStreamInfResolution", + "traits": { + "smithy.api#documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", + "smithy.api#jsonName": "streamInfResolution" + } + }, + "TimedMetadataId3Frame": { + "target": "com.amazonaws.medialive#HlsTimedMetadataId3Frame", + "traits": { + "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", + "smithy.api#jsonName": "timedMetadataId3Frame" + } + }, + "TimedMetadataId3Period": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Timed Metadata interval in seconds.", + "smithy.api#jsonName": "timedMetadataId3Period" + } + }, + "TimestampDeltaMilliseconds": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Provides an extra millisecond delta offset to fine tune the timestamps.", + "smithy.api#jsonName": "timestampDeltaMilliseconds" + } + }, + "TsFileMode": { + "target": "com.amazonaws.medialive#HlsTsFileMode", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "tsFileMode" } } }, "traits": { - "smithy.api#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." + "smithy.api#documentation": "Hls Group Settings" } }, - "com.amazonaws.medialive#InputDeviceType": { + "com.amazonaws.medialive#HlsH265PackagingType": { "type": "enum", "members": { - "HD": { + "HEV1": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HD" + "smithy.api#enumValue": "HEV1" } }, - "UHD": { + "HVC1": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "UHD" + "smithy.api#enumValue": "HVC1" } } }, "traits": { - "smithy.api#documentation": "The type of the input device. For an AWS Elemental Link device that outputs resolutions up to 1080, choose \"HD\"." + "smithy.api#documentation": "Hls H265 Packaging Type" } }, - "com.amazonaws.medialive#InputDeviceUhdAudioChannelPairConfig": { + "com.amazonaws.medialive#HlsId3SegmentTaggingScheduleActionSettings": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.medialive#__integer", + "Tag": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ID for one audio pair configuration, a value from 1 to 8.", - "smithy.api#jsonName": "id" + "smithy.api#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", + "smithy.api#jsonName": "tag" } }, - "Profile": { - "target": "com.amazonaws.medialive#InputDeviceUhdAudioChannelPairProfile", + "Id3": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "profile" + "smithy.api#documentation": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure", + "smithy.api#jsonName": "id3" } } }, "traits": { - "smithy.api#documentation": "One audio configuration that specifies the format for one audio pair that the device produces as output." + "smithy.api#documentation": "Settings for the action to insert a user-defined ID3 tag in each HLS segment" } }, - "com.amazonaws.medialive#InputDeviceUhdAudioChannelPairProfile": { + "com.amazonaws.medialive#HlsId3SegmentTaggingState": { "type": "enum", "members": { "DISABLED": { @@ -13865,3470 +14820,5772 @@ "smithy.api#enumValue": "DISABLED" } }, - "VBR_AAC_HHE_16000": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "VBR-AAC_HHE-16000" + "smithy.api#enumValue": "ENABLED" } - }, - "VBR_AAC_HE_64000": { + } + }, + "traits": { + "smithy.api#documentation": "State of HLS ID3 Segment Tagging" + } + }, + "com.amazonaws.medialive#HlsIncompleteSegmentBehavior": { + "type": "enum", + "members": { + "AUTO": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "VBR-AAC_HE-64000" + "smithy.api#enumValue": "AUTO" } }, - "VBR_AAC_LC_128000": { + "SUPPRESS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "VBR-AAC_LC-128000" + "smithy.api#enumValue": "SUPPRESS" + } + } + }, + "traits": { + "smithy.api#documentation": "Hls Incomplete Segment Behavior" + } + }, + "com.amazonaws.medialive#HlsInputSettings": { + "type": "structure", + "members": { + "Bandwidth": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "bandwidth" } }, - "CBR_AAC_HQ_192000": { - "target": "smithy.api#Unit", + "BufferSegments": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "CBR-AAC_HQ-192000" + "smithy.api#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.", + "smithy.api#jsonName": "bufferSegments" } }, - "CBR_AAC_HQ_256000": { - "target": "smithy.api#Unit", + "Retries": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "CBR-AAC_HQ-256000" + "smithy.api#documentation": "The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.", + "smithy.api#jsonName": "retries" } }, - "CBR_AAC_HQ_384000": { - "target": "smithy.api#Unit", + "RetryInterval": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "CBR-AAC_HQ-384000" + "smithy.api#documentation": "The number of seconds between retries when an attempt to read a manifest or segment fails.", + "smithy.api#jsonName": "retryInterval" } }, - "CBR_AAC_HQ_512000": { - "target": "smithy.api#Unit", + "Scte35Source": { + "target": "com.amazonaws.medialive#HlsScte35SourceType", "traits": { - "smithy.api#enumValue": "CBR-AAC_HQ-512000" + "smithy.api#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.", + "smithy.api#jsonName": "scte35Source" } } }, "traits": { - "smithy.api#documentation": "Property of InputDeviceUhdAudioChannelPairConfig, which describes one audio channel that the device is configured to produce." + "smithy.api#documentation": "Hls Input Settings" } }, - "com.amazonaws.medialive#InputDeviceUhdSettings": { - "type": "structure", + "com.amazonaws.medialive#HlsIvInManifest": { + "type": "enum", "members": { - "ActiveInput": { - "target": "com.amazonaws.medialive#InputDeviceActiveInput", + "EXCLUDE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).", - "smithy.api#jsonName": "activeInput" + "smithy.api#enumValue": "EXCLUDE" } }, - "ConfiguredInput": { - "target": "com.amazonaws.medialive#InputDeviceConfiguredInput", + "INCLUDE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The source at the input device that is currently active. You can specify this source.", - "smithy.api#jsonName": "configuredInput" + "smithy.api#enumValue": "INCLUDE" } - }, - "DeviceState": { - "target": "com.amazonaws.medialive#InputDeviceState", + } + }, + "traits": { + "smithy.api#documentation": "Hls Iv In Manifest" + } + }, + "com.amazonaws.medialive#HlsIvSource": { + "type": "enum", + "members": { + "EXPLICIT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The state of the input device.", - "smithy.api#jsonName": "deviceState" + "smithy.api#enumValue": "EXPLICIT" } }, - "Framerate": { - "target": "com.amazonaws.medialive#__double", + "FOLLOWS_SEGMENT_NUMBER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The frame rate of the video source.", - "smithy.api#jsonName": "framerate" + "smithy.api#enumValue": "FOLLOWS_SEGMENT_NUMBER" } - }, - "Height": { - "target": "com.amazonaws.medialive#__integer", + } + }, + "traits": { + "smithy.api#documentation": "Hls Iv Source" + } + }, + "com.amazonaws.medialive#HlsManifestCompression": { + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The height of the video source, in pixels.", - "smithy.api#jsonName": "height" + "smithy.api#enumValue": "GZIP" } }, - "MaxBitrate": { - "target": "com.amazonaws.medialive#__integer", + "NONE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#enumValue": "NONE" } - }, - "ScanType": { - "target": "com.amazonaws.medialive#InputDeviceScanType", + } + }, + "traits": { + "smithy.api#documentation": "Hls Manifest Compression" + } + }, + "com.amazonaws.medialive#HlsManifestDurationFormat": { + "type": "enum", + "members": { + "FLOATING_POINT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The scan type of the video source.", - "smithy.api#jsonName": "scanType" + "smithy.api#enumValue": "FLOATING_POINT" } }, - "Width": { - "target": "com.amazonaws.medialive#__integer", + "INTEGER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The width of the video source, in pixels.", - "smithy.api#jsonName": "width" + "smithy.api#enumValue": "INTEGER" + } + } + }, + "traits": { + "smithy.api#documentation": "Hls Manifest Duration Format" + } + }, + "com.amazonaws.medialive#HlsMediaStoreSettings": { + "type": "structure", + "members": { + "ConnectionRetryInterval": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", + "smithy.api#jsonName": "connectionRetryInterval" } }, - "LatencyMs": { - "target": "com.amazonaws.medialive#__integer", + "FilecacheDuration": { + "target": "com.amazonaws.medialive#__integerMin0Max600", "traits": { - "smithy.api#documentation": "The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.", - "smithy.api#jsonName": "latencyMs" + "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", + "smithy.api#jsonName": "filecacheDuration" } }, - "Codec": { - "target": "com.amazonaws.medialive#InputDeviceCodec", + "MediaStoreStorageClass": { + "target": "com.amazonaws.medialive#HlsMediaStoreStorageClass", "traits": { - "smithy.api#documentation": "The codec for the video that the device produces.", - "smithy.api#jsonName": "codec" + "smithy.api#documentation": "When set to temporal, output files are stored in non-persistent memory for faster reading and writing.", + "smithy.api#jsonName": "mediaStoreStorageClass" } }, - "MediaconnectSettings": { - "target": "com.amazonaws.medialive#InputDeviceMediaConnectSettings", + "NumRetries": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Information about the MediaConnect flow attached to the device. Returned only if the outputType is MEDIACONNECT_FLOW.", - "smithy.api#jsonName": "mediaconnectSettings" + "smithy.api#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.", + "smithy.api#jsonName": "numRetries" } }, - "AudioChannelPairs": { - "target": "com.amazonaws.medialive#__listOfInputDeviceUhdAudioChannelPairConfig", + "RestartDelay": { + "target": "com.amazonaws.medialive#__integerMin0Max15", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "audioChannelPairs" + "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", + "smithy.api#jsonName": "restartDelay" } } }, "traits": { - "smithy.api#documentation": "Settings that describe the active source from the input device, and the video characteristics of that source." + "smithy.api#documentation": "Hls Media Store Settings" } }, - "com.amazonaws.medialive#InputFilter": { + "com.amazonaws.medialive#HlsMediaStoreStorageClass": { "type": "enum", "members": { - "AUTO": { + "TEMPORAL": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AUTO" + "smithy.api#enumValue": "TEMPORAL" } - }, - "DISABLED": { + } + }, + "traits": { + "smithy.api#documentation": "Hls Media Store Storage Class" + } + }, + "com.amazonaws.medialive#HlsMode": { + "type": "enum", + "members": { + "LIVE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "LIVE" } }, - "FORCED": { + "VOD": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FORCED" + "smithy.api#enumValue": "VOD" } } }, "traits": { - "smithy.api#documentation": "Input Filter" + "smithy.api#documentation": "Hls Mode" } }, - "com.amazonaws.medialive#InputLocation": { - "type": "structure", + "com.amazonaws.medialive#HlsOutputSelection": { + "type": "enum", "members": { - "PasswordParam": { - "target": "com.amazonaws.medialive#__string", + "MANIFESTS_AND_SEGMENTS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "key used to extract the password from EC2 Parameter store", - "smithy.api#jsonName": "passwordParam" + "smithy.api#enumValue": "MANIFESTS_AND_SEGMENTS" } }, - "Uri": { - "target": "com.amazonaws.medialive#__stringMax2048", + "SEGMENTS_ONLY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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\".", - "smithy.api#jsonName": "uri", - "smithy.api#required": {} + "smithy.api#enumValue": "SEGMENTS_ONLY" } }, - "Username": { - "target": "com.amazonaws.medialive#__string", + "VARIANT_MANIFESTS_AND_SEGMENTS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Documentation update needed", - "smithy.api#jsonName": "username" + "smithy.api#enumValue": "VARIANT_MANIFESTS_AND_SEGMENTS" } } }, "traits": { - "smithy.api#documentation": "Input Location" + "smithy.api#documentation": "Hls Output Selection" } }, - "com.amazonaws.medialive#InputLossActionForHlsOut": { - "type": "enum", + "com.amazonaws.medialive#HlsOutputSettings": { + "type": "structure", "members": { - "EMIT_OUTPUT": { - "target": "smithy.api#Unit", + "H265PackagingType": { + "target": "com.amazonaws.medialive#HlsH265PackagingType", "traits": { - "smithy.api#enumValue": "EMIT_OUTPUT" + "smithy.api#documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1.", + "smithy.api#jsonName": "h265PackagingType" } }, - "PAUSE_OUTPUT": { - "target": "smithy.api#Unit", + "HlsSettings": { + "target": "com.amazonaws.medialive#HlsSettings", "traits": { - "smithy.api#enumValue": "PAUSE_OUTPUT" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Settings regarding the underlying stream. These settings are different for audio-only outputs.", + "smithy.api#jsonName": "hlsSettings", + "smithy.api#required": {} + } + }, + "NameModifier": { + "target": "com.amazonaws.medialive#__stringMin1", + "traits": { + "smithy.api#documentation": "String concatenated to the end of the destination filename. Accepts \\\"Format Identifiers\\\":#formatIdentifierParameters.", + "smithy.api#jsonName": "nameModifier" + } + }, + "SegmentModifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "String concatenated to end of segment filenames.", + "smithy.api#jsonName": "segmentModifier" } } }, "traits": { - "smithy.api#documentation": "Input Loss Action For Hls Out" + "smithy.api#documentation": "Hls Output Settings" } }, - "com.amazonaws.medialive#InputLossActionForMsSmoothOut": { + "com.amazonaws.medialive#HlsProgramDateTime": { "type": "enum", "members": { - "EMIT_OUTPUT": { + "EXCLUDE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EMIT_OUTPUT" + "smithy.api#enumValue": "EXCLUDE" } }, - "PAUSE_OUTPUT": { + "INCLUDE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PAUSE_OUTPUT" + "smithy.api#enumValue": "INCLUDE" } } }, "traits": { - "smithy.api#documentation": "Input Loss Action For Ms Smooth Out" + "smithy.api#documentation": "Hls Program Date Time" } }, - "com.amazonaws.medialive#InputLossActionForRtmpOut": { + "com.amazonaws.medialive#HlsProgramDateTimeClock": { "type": "enum", "members": { - "EMIT_OUTPUT": { + "INITIALIZE_FROM_OUTPUT_TIMECODE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EMIT_OUTPUT" + "smithy.api#enumValue": "INITIALIZE_FROM_OUTPUT_TIMECODE" } }, - "PAUSE_OUTPUT": { + "SYSTEM_CLOCK": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PAUSE_OUTPUT" + "smithy.api#enumValue": "SYSTEM_CLOCK" } } }, "traits": { - "smithy.api#documentation": "Input Loss Action For Rtmp Out" + "smithy.api#documentation": "Hls Program Date Time Clock" } }, - "com.amazonaws.medialive#InputLossActionForUdpOut": { + "com.amazonaws.medialive#HlsRedundantManifest": { "type": "enum", "members": { - "DROP_PROGRAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DROP_PROGRAM" - } - }, - "DROP_TS": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DROP_TS" + "smithy.api#enumValue": "DISABLED" } }, - "EMIT_PROGRAM": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EMIT_PROGRAM" + "smithy.api#enumValue": "ENABLED" } } }, "traits": { - "smithy.api#documentation": "Input Loss Action For Udp Out" + "smithy.api#documentation": "Hls Redundant Manifest" } }, - "com.amazonaws.medialive#InputLossBehavior": { + "com.amazonaws.medialive#HlsS3Settings": { "type": "structure", "members": { - "BlackFrameMsec": { - "target": "com.amazonaws.medialive#__integerMin0Max1000000", + "CannedAcl": { + "target": "com.amazonaws.medialive#S3CannedAcl", "traits": { - "smithy.api#documentation": "Documentation update needed", - "smithy.api#jsonName": "blackFrameMsec" + "smithy.api#documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none.", + "smithy.api#jsonName": "cannedAcl" } - }, - "InputLossImageColor": { - "target": "com.amazonaws.medialive#__stringMin6Max6", + } + }, + "traits": { + "smithy.api#documentation": "Hls S3 Settings" + } + }, + "com.amazonaws.medialive#HlsScte35SourceType": { + "type": "enum", + "members": { + "MANIFEST": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When input loss image type is \"color\" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.", - "smithy.api#jsonName": "inputLossImageColor" + "smithy.api#enumValue": "MANIFEST" } }, - "InputLossImageSlate": { - "target": "com.amazonaws.medialive#InputLocation", + "SEGMENTS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When input loss image type is \"slate\" these fields specify the parameters for accessing the slate.", - "smithy.api#jsonName": "inputLossImageSlate" + "smithy.api#enumValue": "SEGMENTS" } - }, - "InputLossImageType": { - "target": "com.amazonaws.medialive#InputLossImageType", + } + }, + "traits": { + "smithy.api#documentation": "Hls Scte35 Source Type" + } + }, + "com.amazonaws.medialive#HlsSegmentationMode": { + "type": "enum", + "members": { + "USE_INPUT_SEGMENTATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.", - "smithy.api#jsonName": "inputLossImageType" + "smithy.api#enumValue": "USE_INPUT_SEGMENTATION" } }, - "RepeatFrameMsec": { - "target": "com.amazonaws.medialive#__integerMin0Max1000000", + "USE_SEGMENT_DURATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Documentation update needed", - "smithy.api#jsonName": "repeatFrameMsec" + "smithy.api#enumValue": "USE_SEGMENT_DURATION" } } }, "traits": { - "smithy.api#documentation": "Input Loss Behavior" + "smithy.api#documentation": "Hls Segmentation Mode" } }, - "com.amazonaws.medialive#InputLossFailoverSettings": { + "com.amazonaws.medialive#HlsSettings": { "type": "structure", "members": { - "InputLossThresholdMsec": { - "target": "com.amazonaws.medialive#__integerMin100", + "AudioOnlyHlsSettings": { + "target": "com.amazonaws.medialive#AudioOnlyHlsSettings", "traits": { - "smithy.api#documentation": "The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur.", - "smithy.api#jsonName": "inputLossThresholdMsec" + "smithy.api#jsonName": "audioOnlyHlsSettings" + } + }, + "Fmp4HlsSettings": { + "target": "com.amazonaws.medialive#Fmp4HlsSettings", + "traits": { + "smithy.api#jsonName": "fmp4HlsSettings" + } + }, + "FrameCaptureHlsSettings": { + "target": "com.amazonaws.medialive#FrameCaptureHlsSettings", + "traits": { + "smithy.api#jsonName": "frameCaptureHlsSettings" + } + }, + "StandardHlsSettings": { + "target": "com.amazonaws.medialive#StandardHlsSettings", + "traits": { + "smithy.api#jsonName": "standardHlsSettings" } } }, "traits": { - "smithy.api#documentation": "MediaLive will perform a failover if content is not detected in this input for the specified period." + "smithy.api#documentation": "Hls Settings" } }, - "com.amazonaws.medialive#InputLossImageType": { + "com.amazonaws.medialive#HlsStreamInfResolution": { "type": "enum", "members": { - "COLOR": { + "EXCLUDE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "COLOR" + "smithy.api#enumValue": "EXCLUDE" } }, - "SLATE": { + "INCLUDE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SLATE" + "smithy.api#enumValue": "INCLUDE" } } }, "traits": { - "smithy.api#documentation": "Input Loss Image Type" + "smithy.api#documentation": "Hls Stream Inf Resolution" } }, - "com.amazonaws.medialive#InputMaximumBitrate": { + "com.amazonaws.medialive#HlsTimedMetadataId3Frame": { "type": "enum", "members": { - "MAX_10_MBPS": { + "NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MAX_10_MBPS" + "smithy.api#enumValue": "NONE" } }, - "MAX_20_MBPS": { + "PRIV": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MAX_20_MBPS" + "smithy.api#enumValue": "PRIV" } }, - "MAX_50_MBPS": { + "TDRL": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MAX_50_MBPS" + "smithy.api#enumValue": "TDRL" } } }, "traits": { - "smithy.api#documentation": "Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently." + "smithy.api#documentation": "Hls Timed Metadata Id3 Frame" } }, - "com.amazonaws.medialive#InputPreference": { - "type": "enum", + "com.amazonaws.medialive#HlsTimedMetadataScheduleActionSettings": { + "type": "structure", "members": { - "EQUAL_INPUT_PREFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUAL_INPUT_PREFERENCE" - } - }, - "PRIMARY_INPUT_PREFERRED": { - "target": "smithy.api#Unit", + "Id3": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "PRIMARY_INPUT_PREFERRED" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure", + "smithy.api#jsonName": "id3", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#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." + "smithy.api#documentation": "Settings for the action to emit HLS metadata" } }, - "com.amazonaws.medialive#InputPrepareScheduleActionSettings": { - "type": "structure", + "com.amazonaws.medialive#HlsTsFileMode": { + "type": "enum", "members": { - "InputAttachmentNameReference": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "inputAttachmentNameReference" - } - }, - "InputClippingSettings": { - "target": "com.amazonaws.medialive#InputClippingSettings", + "SEGMENTED_FILES": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "inputClippingSettings" + "smithy.api#enumValue": "SEGMENTED_FILES" } }, - "UrlPath": { - "target": "com.amazonaws.medialive#__listOf__string", + "SINGLE_FILE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "urlPath" + "smithy.api#enumValue": "SINGLE_FILE" } } }, "traits": { - "smithy.api#documentation": "Action to prepare an input for a future immediate input switch." + "smithy.api#documentation": "Hls Ts File Mode" } }, - "com.amazonaws.medialive#InputResolution": { + "com.amazonaws.medialive#HlsWebdavHttpTransferMode": { "type": "enum", "members": { - "SD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SD" - } - }, - "HD": { + "CHUNKED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HD" + "smithy.api#enumValue": "CHUNKED" } }, - "UHD": { + "NON_CHUNKED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "UHD" + "smithy.api#enumValue": "NON_CHUNKED" } } }, "traits": { - "smithy.api#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" + "smithy.api#documentation": "Hls Webdav Http Transfer Mode" } }, - "com.amazonaws.medialive#InputSecurityGroup": { + "com.amazonaws.medialive#HlsWebdavSettings": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Unique ARN of Input Security Group", - "smithy.api#jsonName": "arn" - } - }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "ConnectionRetryInterval": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "The Id of the Input Security Group", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", + "smithy.api#jsonName": "connectionRetryInterval" } }, - "Inputs": { - "target": "com.amazonaws.medialive#__listOf__string", + "FilecacheDuration": { + "target": "com.amazonaws.medialive#__integerMin0Max600", "traits": { - "smithy.api#documentation": "The list of inputs currently using this Input Security Group.", - "smithy.api#jsonName": "inputs" + "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", + "smithy.api#jsonName": "filecacheDuration" } }, - "State": { - "target": "com.amazonaws.medialive#InputSecurityGroupState", + "HttpTransferMode": { + "target": "com.amazonaws.medialive#HlsWebdavHttpTransferMode", "traits": { - "smithy.api#documentation": "The current state of the Input Security Group.", - "smithy.api#jsonName": "state" + "smithy.api#documentation": "Specify whether or not to use chunked transfer encoding to WebDAV.", + "smithy.api#jsonName": "httpTransferMode" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "NumRetries": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#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.", + "smithy.api#jsonName": "numRetries" } }, - "WhitelistRules": { - "target": "com.amazonaws.medialive#__listOfInputWhitelistRule", + "RestartDelay": { + "target": "com.amazonaws.medialive#__integerMin0Max15", "traits": { - "smithy.api#documentation": "Whitelist rules and their sync status", - "smithy.api#jsonName": "whitelistRules" + "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", + "smithy.api#jsonName": "restartDelay" } } }, "traits": { - "smithy.api#documentation": "An Input Security Group" + "smithy.api#documentation": "Hls Webdav Settings" } }, - "com.amazonaws.medialive#InputSecurityGroupState": { + "com.amazonaws.medialive#HtmlMotionGraphicsSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Html Motion Graphics Settings" + } + }, + "com.amazonaws.medialive#IFrameOnlyPlaylistType": { "type": "enum", "members": { - "IDLE": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "IDLE" + "smithy.api#enumValue": "DISABLED" } }, - "IN_USE": { + "STANDARD": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "IN_USE" + "smithy.api#enumValue": "STANDARD" } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" + } + }, + "traits": { + "smithy.api#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." + } + }, + "com.amazonaws.medialive#ImmediateModeScheduleActionStartSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Settings to configure an action so that it occurs as soon as possible." + } + }, + "com.amazonaws.medialive#IncludeFillerNalUnits": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" } }, - "DELETED": { + "DROP": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DELETED" + "smithy.api#enumValue": "DROP" + } + }, + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for InputSecurityGroupState" + "smithy.api#documentation": "Include Filler Nal Units" } }, - "com.amazonaws.medialive#InputSettings": { + "com.amazonaws.medialive#Input": { "type": "structure", "members": { - "AudioSelectors": { - "target": "com.amazonaws.medialive#__listOfAudioSelector", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Used to select the audio stream to decode for inputs that have multiple available.", - "smithy.api#jsonName": "audioSelectors" + "smithy.api#documentation": "The Unique ARN of the input (generated, immutable).", + "smithy.api#jsonName": "arn" } }, - "CaptionSelectors": { - "target": "com.amazonaws.medialive#__listOfCaptionSelector", + "AttachedChannels": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "Used to select the caption input to use for inputs that have multiple available.", - "smithy.api#jsonName": "captionSelectors" + "smithy.api#documentation": "A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).", + "smithy.api#jsonName": "attachedChannels" } }, - "DeblockFilter": { - "target": "com.amazonaws.medialive#InputDeblockFilter", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfInputDestination", "traits": { - "smithy.api#documentation": "Enable or disable the deblock filter when filtering.", - "smithy.api#jsonName": "deblockFilter" + "smithy.api#documentation": "A list of the destinations of the input (PUSH-type).", + "smithy.api#jsonName": "destinations" } }, - "DenoiseFilter": { - "target": "com.amazonaws.medialive#InputDenoiseFilter", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Enable or disable the denoise filter when filtering.", - "smithy.api#jsonName": "denoiseFilter" + "smithy.api#documentation": "The generated ID of the input (unique for user account, immutable).", + "smithy.api#jsonName": "id" } }, - "FilterStrength": { - "target": "com.amazonaws.medialive#__integerMin1Max5", + "InputClass": { + "target": "com.amazonaws.medialive#InputClass", "traits": { - "smithy.api#documentation": "Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).", - "smithy.api#jsonName": "filterStrength" + "smithy.api#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.", + "smithy.api#jsonName": "inputClass" } }, - "InputFilter": { - "target": "com.amazonaws.medialive#InputFilter", + "InputDevices": { + "target": "com.amazonaws.medialive#__listOfInputDeviceSettings", "traits": { - "smithy.api#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", - "smithy.api#jsonName": "inputFilter" + "smithy.api#documentation": "Settings for the input devices.", + "smithy.api#jsonName": "inputDevices" } }, - "NetworkInputSettings": { - "target": "com.amazonaws.medialive#NetworkInputSettings", + "InputPartnerIds": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "Input settings.", - "smithy.api#jsonName": "networkInputSettings" + "smithy.api#documentation": "A list of IDs for all Inputs which are partners of this one.", + "smithy.api#jsonName": "inputPartnerIds" } }, - "Scte35Pid": { - "target": "com.amazonaws.medialive#__integerMin32Max8191", + "InputSourceType": { + "target": "com.amazonaws.medialive#InputSourceType", "traits": { - "smithy.api#documentation": "PID from which to read SCTE-35 messages. If left undefined, EML will select the first SCTE-35 PID found in the input.", - "smithy.api#jsonName": "scte35Pid" + "smithy.api#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.", + "smithy.api#jsonName": "inputSourceType" } }, - "Smpte2038DataPreference": { - "target": "com.amazonaws.medialive#Smpte2038DataPreference", + "MediaConnectFlows": { + "target": "com.amazonaws.medialive#__listOfMediaConnectFlow", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "smpte2038DataPreference" + "smithy.api#documentation": "A list of MediaConnect Flows for this input.", + "smithy.api#jsonName": "mediaConnectFlows" } }, - "SourceEndBehavior": { - "target": "com.amazonaws.medialive#InputSourceEndBehavior", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Loop input if it is a file. This allows a file input to be streamed indefinitely.", - "smithy.api#jsonName": "sourceEndBehavior" + "smithy.api#documentation": "The user-assigned name (This is a mutable value).", + "smithy.api#jsonName": "name" } }, - "VideoSelector": { - "target": "com.amazonaws.medialive#VideoSelector", + "RoleArn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Informs which video elementary stream to decode for input types that have multiple available.", - "smithy.api#jsonName": "videoSelector" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation.", + "smithy.api#jsonName": "roleArn" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "A list of IDs for all the Input Security Groups attached to the input.", + "smithy.api#jsonName": "securityGroups" + } + }, + "Sources": { + "target": "com.amazonaws.medialive#__listOfInputSource", + "traits": { + "smithy.api#documentation": "A list of the sources of the input (PULL-type).", + "smithy.api#jsonName": "sources" + } + }, + "State": { + "target": "com.amazonaws.medialive#InputState", + "traits": { + "smithy.api#jsonName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + }, + "Type": { + "target": "com.amazonaws.medialive#InputType", + "traits": { + "smithy.api#jsonName": "type" } } }, "traits": { - "smithy.api#documentation": "Live Event input parameters. There can be multiple inputs in a single Live Event." + "smithy.api#documentation": "Placeholder documentation for Input" } }, - "com.amazonaws.medialive#InputSource": { + "com.amazonaws.medialive#InputAttachment": { "type": "structure", "members": { - "PasswordParam": { - "target": "com.amazonaws.medialive#__string", + "AutomaticInputFailoverSettings": { + "target": "com.amazonaws.medialive#AutomaticInputFailoverSettings", "traits": { - "smithy.api#documentation": "The key used to extract the password from EC2 Parameter store.", - "smithy.api#jsonName": "passwordParam" + "smithy.api#documentation": "User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input.", + "smithy.api#jsonName": "automaticInputFailoverSettings" } }, - "Url": { + "InputAttachmentName": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "This represents the customer's source URL where stream is\npulled from.", - "smithy.api#jsonName": "url" + "smithy.api#documentation": "User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.", + "smithy.api#jsonName": "inputAttachmentName" } }, - "Username": { + "InputId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The username for the input source.", - "smithy.api#jsonName": "username" - } - } - }, - "traits": { - "smithy.api#documentation": "The settings for a PULL type input." - } - }, - "com.amazonaws.medialive#InputSourceEndBehavior": { - "type": "enum", - "members": { - "CONTINUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTINUE" + "smithy.api#documentation": "The ID of the input", + "smithy.api#jsonName": "inputId" } }, - "LOOP": { - "target": "smithy.api#Unit", + "InputSettings": { + "target": "com.amazonaws.medialive#InputSettings", "traits": { - "smithy.api#enumValue": "LOOP" + "smithy.api#documentation": "Settings of an input (caption selector, etc.)", + "smithy.api#jsonName": "inputSettings" } } }, "traits": { - "smithy.api#documentation": "Input Source End Behavior" + "smithy.api#documentation": "Placeholder documentation for InputAttachment" } }, - "com.amazonaws.medialive#InputSourceRequest": { + "com.amazonaws.medialive#InputChannelLevel": { "type": "structure", "members": { - "PasswordParam": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The key used to extract the password from EC2 Parameter store.", - "smithy.api#jsonName": "passwordParam" - } - }, - "Url": { - "target": "com.amazonaws.medialive#__string", + "Gain": { + "target": "com.amazonaws.medialive#__integerMinNegative60Max6", "traits": { - "smithy.api#documentation": "This represents the customer's source URL where stream is\npulled from.", - "smithy.api#jsonName": "url" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.", + "smithy.api#jsonName": "gain", + "smithy.api#required": {} } }, - "Username": { - "target": "com.amazonaws.medialive#__string", + "InputChannel": { + "target": "com.amazonaws.medialive#__integerMin0Max15", "traits": { - "smithy.api#documentation": "The username for the input source.", - "smithy.api#jsonName": "username" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The index of the input channel used as a source.", + "smithy.api#jsonName": "inputChannel", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Settings for for a PULL type input." + "smithy.api#documentation": "Input Channel Level" } }, - "com.amazonaws.medialive#InputSourceType": { + "com.amazonaws.medialive#InputClass": { "type": "enum", "members": { - "STATIC": { + "STANDARD": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "STATIC" + "smithy.api#enumValue": "STANDARD" } }, - "DYNAMIC": { + "SINGLE_PIPELINE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DYNAMIC" + "smithy.api#enumValue": "SINGLE_PIPELINE" } } }, "traits": { - "smithy.api#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." + "smithy.api#documentation": "A standard input has two sources and a single pipeline input only has one." } }, - "com.amazonaws.medialive#InputSpecification": { + "com.amazonaws.medialive#InputClippingSettings": { "type": "structure", "members": { - "Codec": { - "target": "com.amazonaws.medialive#InputCodec", + "InputTimecodeSource": { + "target": "com.amazonaws.medialive#InputTimecodeSource", "traits": { - "smithy.api#documentation": "Input codec", - "smithy.api#jsonName": "codec" - } - }, - "MaximumBitrate": { - "target": "com.amazonaws.medialive#InputMaximumBitrate", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The source of the timecodes in the source being clipped.", + "smithy.api#jsonName": "inputTimecodeSource", + "smithy.api#required": {} + } + }, + "StartTimecode": { + "target": "com.amazonaws.medialive#StartTimecode", "traits": { - "smithy.api#documentation": "Maximum input bitrate, categorized coarsely", - "smithy.api#jsonName": "maximumBitrate" + "smithy.api#documentation": "Settings to identify the start of the clip.", + "smithy.api#jsonName": "startTimecode" } }, - "Resolution": { - "target": "com.amazonaws.medialive#InputResolution", + "StopTimecode": { + "target": "com.amazonaws.medialive#StopTimecode", "traits": { - "smithy.api#documentation": "Input resolution, categorized coarsely", - "smithy.api#jsonName": "resolution" + "smithy.api#documentation": "Settings to identify the end of the clip.", + "smithy.api#jsonName": "stopTimecode" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for InputSpecification" + "smithy.api#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." } }, - "com.amazonaws.medialive#InputState": { + "com.amazonaws.medialive#InputCodec": { "type": "enum", "members": { - "CREATING": { + "MPEG2": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CREATING" + "smithy.api#enumValue": "MPEG2" } }, - "DETACHED": { + "AVC": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DETACHED" + "smithy.api#enumValue": "AVC" } }, - "ATTACHED": { + "HEVC": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ATTACHED" + "smithy.api#enumValue": "HEVC" + } + } + }, + "traits": { + "smithy.api#documentation": "codec in increasing order of complexity" + } + }, + "com.amazonaws.medialive#InputDeblockFilter": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" } }, - "DELETING": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DELETING" + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "Input Deblock Filter" + } + }, + "com.amazonaws.medialive#InputDenoiseFilter": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" } }, - "DELETED": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DELETED" + "smithy.api#enumValue": "ENABLED" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for InputState" + "smithy.api#documentation": "Input Denoise Filter" } }, - "com.amazonaws.medialive#InputSwitchScheduleActionSettings": { + "com.amazonaws.medialive#InputDestination": { "type": "structure", "members": { - "InputAttachmentNameReference": { + "Ip": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the input attachment (not the name of the input!) to switch to. The name is specified in the channel configuration.", - "smithy.api#jsonName": "inputAttachmentNameReference", - "smithy.api#required": {} + "smithy.api#documentation": "The system-generated static IP address of endpoint.\nIt remains fixed for the lifetime of the input.", + "smithy.api#jsonName": "ip" } }, - "InputClippingSettings": { - "target": "com.amazonaws.medialive#InputClippingSettings", + "Port": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "inputClippingSettings" + "smithy.api#documentation": "The port number for the input.", + "smithy.api#jsonName": "port" } }, - "UrlPath": { - "target": "com.amazonaws.medialive#__listOf__string", + "Url": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "urlPath" + "smithy.api#documentation": "This represents the endpoint that the customer stream will be\npushed to.", + "smithy.api#jsonName": "url" + } + }, + "Vpc": { + "target": "com.amazonaws.medialive#InputDestinationVpc", + "traits": { + "smithy.api#jsonName": "vpc" } } }, "traits": { - "smithy.api#documentation": "Settings for the \"switch input\" action: to switch from ingesting one input to ingesting another input." + "smithy.api#documentation": "The settings for a PUSH type input." } }, - "com.amazonaws.medialive#InputTimecodeSource": { + "com.amazonaws.medialive#InputDestinationRequest": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "A unique name for the location the RTMP stream is being pushed\nto.", + "smithy.api#jsonName": "streamName" + } + } + }, + "traits": { + "smithy.api#documentation": "Endpoint settings for a PUSH type input." + } + }, + "com.amazonaws.medialive#InputDestinationVpc": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The availability zone of the Input destination.", + "smithy.api#jsonName": "availabilityZone" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The network interface ID of the Input destination in the VPC.", + "smithy.api#jsonName": "networkInterfaceId" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties for a VPC type input destination." + } + }, + "com.amazonaws.medialive#InputDeviceActiveInput": { "type": "enum", "members": { - "ZEROBASED": { + "HDMI": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ZEROBASED" + "smithy.api#enumValue": "HDMI" } }, - "EMBEDDED": { + "SDI": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EMBEDDED" + "smithy.api#enumValue": "SDI" } } }, "traits": { - "smithy.api#documentation": "Documentation update needed" + "smithy.api#documentation": "The source at the input device that is currently active." } }, - "com.amazonaws.medialive#InputType": { + "com.amazonaws.medialive#InputDeviceCodec": { "type": "enum", "members": { - "UDP_PUSH": { + "HEVC": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "UDP_PUSH" + "smithy.api#enumValue": "HEVC" } }, - "RTP_PUSH": { + "AVC": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "RTP_PUSH" + "smithy.api#enumValue": "AVC" + } + } + }, + "traits": { + "smithy.api#documentation": "The codec to use on the video that the device produces." + } + }, + "com.amazonaws.medialive#InputDeviceConfigurableAudioChannelPairConfig": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The ID for one audio pair configuration, a value from 1 to 8.", + "smithy.api#jsonName": "id" } }, - "RTMP_PUSH": { + "Profile": { + "target": "com.amazonaws.medialive#InputDeviceConfigurableAudioChannelPairProfile", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "profile" + } + } + }, + "traits": { + "smithy.api#documentation": "One audio configuration that specifies the format for one audio pair that the device produces as output." + } + }, + "com.amazonaws.medialive#InputDeviceConfigurableAudioChannelPairProfile": { + "type": "enum", + "members": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "RTMP_PUSH" + "smithy.api#enumValue": "DISABLED" } }, - "RTMP_PULL": { + "VBR_AAC_HHE_16000": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "RTMP_PULL" + "smithy.api#enumValue": "VBR-AAC_HHE-16000" } }, - "URL_PULL": { + "VBR_AAC_HE_64000": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "URL_PULL" + "smithy.api#enumValue": "VBR-AAC_HE-64000" } }, - "MP4_FILE": { + "VBR_AAC_LC_128000": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MP4_FILE" + "smithy.api#enumValue": "VBR-AAC_LC-128000" } }, - "MEDIACONNECT": { + "CBR_AAC_HQ_192000": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MEDIACONNECT" + "smithy.api#enumValue": "CBR-AAC_HQ-192000" } }, - "INPUT_DEVICE": { + "CBR_AAC_HQ_256000": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INPUT_DEVICE" + "smithy.api#enumValue": "CBR-AAC_HQ-256000" } }, - "AWS_CDI": { + "CBR_AAC_HQ_384000": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AWS_CDI" + "smithy.api#enumValue": "CBR-AAC_HQ-384000" } }, - "TS_FILE": { + "CBR_AAC_HQ_512000": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "TS_FILE" + "smithy.api#enumValue": "CBR-AAC_HQ-512000" } } }, "traits": { - "smithy.api#documentation": "The different types of inputs that AWS Elemental MediaLive supports." + "smithy.api#documentation": "Property of InputDeviceConfigurableAudioChannelPairConfig, which configures one audio channel that the device produces." } }, - "com.amazonaws.medialive#InputVpcRequest": { + "com.amazonaws.medialive#InputDeviceConfigurableSettings": { "type": "structure", "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.medialive#__listOf__string", + "ConfiguredInput": { + "target": "com.amazonaws.medialive#InputDeviceConfiguredInput", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "securityGroupIds" + "smithy.api#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.", + "smithy.api#jsonName": "configuredInput" } }, - "SubnetIds": { - "target": "com.amazonaws.medialive#__listOf__string", + "MaxBitrate": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of 2 VPC subnet IDs from the same VPC.\nSubnet IDs must be mapped to two unique availability zones (AZ).", - "smithy.api#jsonName": "subnetIds", - "smithy.api#required": {} + "smithy.api#documentation": "The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video.", + "smithy.api#jsonName": "maxBitrate" } - } - }, - "traits": { - "smithy.api#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." - } - }, - "com.amazonaws.medialive#InputWhitelistRule": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.medialive#__string", + }, + "LatencyMs": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The IPv4 CIDR that's whitelisted.", - "smithy.api#jsonName": "cidr" + "smithy.api#documentation": "The Link device's buffer size (latency) in milliseconds (ms).", + "smithy.api#jsonName": "latencyMs" + } + }, + "Codec": { + "target": "com.amazonaws.medialive#InputDeviceCodec", + "traits": { + "smithy.api#documentation": "Choose the codec for the video that the device produces. Only UHD devices can specify this parameter.", + "smithy.api#jsonName": "codec" + } + }, + "MediaconnectSettings": { + "target": "com.amazonaws.medialive#InputDeviceMediaConnectConfigurableSettings", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "mediaconnectSettings" + } + }, + "AudioChannelPairs": { + "target": "com.amazonaws.medialive#__listOfInputDeviceConfigurableAudioChannelPairConfig", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "audioChannelPairs" } } }, "traits": { - "smithy.api#documentation": "Whitelist rule" + "smithy.api#documentation": "Configurable settings for the input device." } }, - "com.amazonaws.medialive#InputWhitelistRuleCidr": { - "type": "structure", + "com.amazonaws.medialive#InputDeviceConfiguredInput": { + "type": "enum", "members": { - "Cidr": { - "target": "com.amazonaws.medialive#__string", + "AUTO": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The IPv4 CIDR to whitelist.", - "smithy.api#jsonName": "cidr" + "smithy.api#enumValue": "AUTO" + } + }, + "HDMI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HDMI" + } + }, + "SDI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SDI" } } }, "traits": { - "smithy.api#documentation": "An IPv4 CIDR to whitelist." + "smithy.api#documentation": "The source to activate (use) from the input device." } }, - "com.amazonaws.medialive#InternalServerErrorException": { - "type": "structure", + "com.amazonaws.medialive#InputDeviceConnectionState": { + "type": "enum", "members": { - "Message": { - "target": "com.amazonaws.medialive#__string", + "DISCONNECTED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "message" + "smithy.api#enumValue": "DISCONNECTED" + } + }, + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTED" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for InternalServerErrorException", - "smithy.api#error": "server", - "smithy.api#httpError": 500 + "smithy.api#documentation": "The state of the connection between the input device and AWS." } }, - "com.amazonaws.medialive#KeyProviderSettings": { + "com.amazonaws.medialive#InputDeviceHdSettings": { "type": "structure", "members": { - "StaticKeySettings": { - "target": "com.amazonaws.medialive#StaticKeySettings", + "ActiveInput": { + "target": "com.amazonaws.medialive#InputDeviceActiveInput", "traits": { - "smithy.api#jsonName": "staticKeySettings" + "smithy.api#documentation": "If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).", + "smithy.api#jsonName": "activeInput" + } + }, + "ConfiguredInput": { + "target": "com.amazonaws.medialive#InputDeviceConfiguredInput", + "traits": { + "smithy.api#documentation": "The source at the input device that is currently active. You can specify this source.", + "smithy.api#jsonName": "configuredInput" + } + }, + "DeviceState": { + "target": "com.amazonaws.medialive#InputDeviceState", + "traits": { + "smithy.api#documentation": "The state of the input device.", + "smithy.api#jsonName": "deviceState" + } + }, + "Framerate": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "The frame rate of the video source.", + "smithy.api#jsonName": "framerate" + } + }, + "Height": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The height of the video source, in pixels.", + "smithy.api#jsonName": "height" + } + }, + "MaxBitrate": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.", + "smithy.api#jsonName": "maxBitrate" + } + }, + "ScanType": { + "target": "com.amazonaws.medialive#InputDeviceScanType", + "traits": { + "smithy.api#documentation": "The scan type of the video source.", + "smithy.api#jsonName": "scanType" + } + }, + "Width": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The width of the video source, in pixels.", + "smithy.api#jsonName": "width" + } + }, + "LatencyMs": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.", + "smithy.api#jsonName": "latencyMs" } } }, "traits": { - "smithy.api#documentation": "Key Provider Settings" + "smithy.api#documentation": "Settings that describe the active source from the input device, and the video characteristics of that source." } }, - "com.amazonaws.medialive#LastFrameClippingBehavior": { + "com.amazonaws.medialive#InputDeviceIpScheme": { "type": "enum", "members": { - "EXCLUDE_LAST_FRAME": { + "STATIC": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EXCLUDE_LAST_FRAME" + "smithy.api#enumValue": "STATIC" } }, - "INCLUDE_LAST_FRAME": { + "DHCP": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INCLUDE_LAST_FRAME" + "smithy.api#enumValue": "DHCP" } } }, "traits": { - "smithy.api#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." - } - }, - "com.amazonaws.medialive#ListChannels": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#ListChannelsRequest" - }, - "output": { - "target": "com.amazonaws.medialive#ListChannelsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "Produces list of channels that have been created", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/channels", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Channels", - "pageSize": "MaxResults" - } + "smithy.api#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." } }, - "com.amazonaws.medialive#ListChannelsRequest": { + "com.amazonaws.medialive#InputDeviceMediaConnectConfigurableSettings": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", + "FlowArn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "The ARN of the MediaConnect flow to attach this device to.", + "smithy.api#jsonName": "flowArn" } }, - "NextToken": { + "RoleArn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#httpQuery": "nextToken" + "smithy.api#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.", + "smithy.api#jsonName": "roleArn" + } + }, + "SecretArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ARN for the secret that holds the encryption key to encrypt the content output by the device.", + "smithy.api#jsonName": "secretArn" + } + }, + "SourceName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the MediaConnect Flow source to stream to.", + "smithy.api#jsonName": "sourceName" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListChannelsRequest", - "smithy.api#input": {} + "smithy.api#documentation": "Parameters required to attach a MediaConnect flow to the device." } }, - "com.amazonaws.medialive#ListChannelsResponse": { + "com.amazonaws.medialive#InputDeviceMediaConnectSettings": { "type": "structure", "members": { - "Channels": { - "target": "com.amazonaws.medialive#__listOfChannelSummary", + "FlowArn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#jsonName": "channels" + "smithy.api#documentation": "The ARN of the MediaConnect flow.", + "smithy.api#jsonName": "flowArn" } }, - "NextToken": { + "RoleArn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#jsonName": "nextToken" + "smithy.api#documentation": "The ARN for the role that MediaLive assumes to access the attached flow and secret.", + "smithy.api#jsonName": "roleArn" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for ListChannelsResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#ListInputDeviceTransfers": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#ListInputDeviceTransfersRequest" - }, - "output": { - "target": "com.amazonaws.medialive#ListInputDeviceTransfersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" + "SecretArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ARN of the secret used to encrypt the stream.", + "smithy.api#jsonName": "secretArn" + } }, - { - "target": "com.amazonaws.medialive#UnprocessableEntityException" + "SourceName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the MediaConnect flow source.", + "smithy.api#jsonName": "sourceName" + } } - ], + }, "traits": { - "smithy.api#documentation": "List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you.", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/inputDeviceTransfers", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InputDeviceTransfers", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "Information about the MediaConnect flow attached to the device." } }, - "com.amazonaws.medialive#ListInputDeviceTransfersRequest": { + "com.amazonaws.medialive#InputDeviceNetworkSettings": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", + "DnsAddresses": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "The DNS addresses of the input device.", + "smithy.api#jsonName": "dnsAddresses" } }, - "NextToken": { + "Gateway": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "The network gateway IP address.", + "smithy.api#jsonName": "gateway" } }, - "TransferType": { + "IpAddress": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#httpQuery": "transferType", - "smithy.api#required": {} + "smithy.api#documentation": "The IP address of the input device.", + "smithy.api#jsonName": "ipAddress" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputDeviceTransfersRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#ListInputDeviceTransfersResponse": { - "type": "structure", - "members": { - "InputDeviceTransfers": { - "target": "com.amazonaws.medialive#__listOfTransferringInputDeviceSummary", + }, + "IpScheme": { + "target": "com.amazonaws.medialive#InputDeviceIpScheme", "traits": { - "smithy.api#documentation": "The list of devices that you are transferring or are being transferred to you.", - "smithy.api#jsonName": "inputDeviceTransfers" + "smithy.api#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.", + "smithy.api#jsonName": "ipScheme" } }, - "NextToken": { + "SubnetMask": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "A token to get additional list results.", - "smithy.api#jsonName": "nextToken" + "smithy.api#documentation": "The subnet mask of the input device.", + "smithy.api#jsonName": "subnetMask" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputDeviceTransfersResponse", - "smithy.api#output": {} + "smithy.api#documentation": "The network settings for the input device." } }, - "com.amazonaws.medialive#ListInputDevices": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#ListInputDevicesRequest" - }, - "output": { - "target": "com.amazonaws.medialive#ListInputDevicesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "com.amazonaws.medialive#InputDeviceOutputType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" + "MEDIALIVE_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIALIVE_INPUT" + } }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" + "MEDIACONNECT_FLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIACONNECT_FLOW" + } } - ], + }, "traits": { - "smithy.api#documentation": "List input devices", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/inputDevices", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InputDevices", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "The output attachment type of the input device." } }, - "com.amazonaws.medialive#ListInputDevicesRequest": { + "com.amazonaws.medialive#InputDeviceRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", - "traits": { - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "The unique ID for the device.", + "smithy.api#jsonName": "id" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputDevicesRequest", - "smithy.api#input": {} + "smithy.api#documentation": "Settings for an input device." } }, - "com.amazonaws.medialive#ListInputDevicesResponse": { - "type": "structure", + "com.amazonaws.medialive#InputDeviceScanType": { + "type": "enum", "members": { - "InputDevices": { - "target": "com.amazonaws.medialive#__listOfInputDeviceSummary", + "INTERLACED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The list of input devices.", - "smithy.api#jsonName": "inputDevices" + "smithy.api#enumValue": "INTERLACED" } }, - "NextToken": { - "target": "com.amazonaws.medialive#__string", + "PROGRESSIVE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A token to get additional list results.", - "smithy.api#jsonName": "nextToken" + "smithy.api#enumValue": "PROGRESSIVE" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputDevicesResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#ListInputSecurityGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#ListInputSecurityGroupsRequest" - }, - "output": { - "target": "com.amazonaws.medialive#ListInputSecurityGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "Produces a list of Input Security Groups for an account", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/inputSecurityGroups", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InputSecurityGroups", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "The scan type of the video source." } }, - "com.amazonaws.medialive#ListInputSecurityGroupsRequest": { + "com.amazonaws.medialive#InputDeviceSettings": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", - "traits": { - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "The unique ID for the device.", + "smithy.api#jsonName": "id" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputSecurityGroupsRequest", - "smithy.api#input": {} + "smithy.api#documentation": "Settings for an input device." } }, - "com.amazonaws.medialive#ListInputSecurityGroupsResponse": { - "type": "structure", + "com.amazonaws.medialive#InputDeviceState": { + "type": "enum", "members": { - "InputSecurityGroups": { - "target": "com.amazonaws.medialive#__listOfInputSecurityGroup", + "IDLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "List of input security groups", - "smithy.api#jsonName": "inputSecurityGroups" + "smithy.api#enumValue": "IDLE" } }, - "NextToken": { - "target": "com.amazonaws.medialive#__string", + "STREAMING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "nextToken" + "smithy.api#enumValue": "STREAMING" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputSecurityGroupsResponse", - "smithy.api#output": {} + "smithy.api#documentation": "The state of the input device." } }, - "com.amazonaws.medialive#ListInputs": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#ListInputsRequest" - }, - "output": { - "target": "com.amazonaws.medialive#ListInputsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" + "com.amazonaws.medialive#InputDeviceSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ARN of the input device.", + "smithy.api#jsonName": "arn" + } }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "ConnectionState": { + "target": "com.amazonaws.medialive#InputDeviceConnectionState", + "traits": { + "smithy.api#documentation": "The state of the connection between the input device and AWS.", + "smithy.api#jsonName": "connectionState" + } }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" + "DeviceSettingsSyncState": { + "target": "com.amazonaws.medialive#DeviceSettingsSyncState", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "deviceSettingsSyncState" + } }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "Produces list of inputs that have been created", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/inputs", - "code": 200 + "DeviceUpdateStatus": { + "target": "com.amazonaws.medialive#DeviceUpdateStatus", + "traits": { + "smithy.api#documentation": "The status of software on the input device.", + "smithy.api#jsonName": "deviceUpdateStatus" + } }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Inputs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.medialive#ListInputsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", + "HdDeviceSettings": { + "target": "com.amazonaws.medialive#InputDeviceHdSettings", "traits": { - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "Settings that describe an input device that is type HD.", + "smithy.api#jsonName": "hdDeviceSettings" } }, - "NextToken": { + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "The unique ID of the input device.", + "smithy.api#jsonName": "id" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputsRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#ListInputsResponse": { - "type": "structure", - "members": { - "Inputs": { - "target": "com.amazonaws.medialive#__listOfInput", + }, + "MacAddress": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#jsonName": "inputs" + "smithy.api#documentation": "The network MAC address of the input device.", + "smithy.api#jsonName": "macAddress" } }, - "NextToken": { + "Name": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#jsonName": "nextToken" + "smithy.api#documentation": "A name that you specify for the input device.", + "smithy.api#jsonName": "name" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputsResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#ListMultiplexPrograms": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#ListMultiplexProgramsRequest" - }, - "output": { - "target": "com.amazonaws.medialive#ListMultiplexProgramsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "NetworkSettings": { + "target": "com.amazonaws.medialive#InputDeviceNetworkSettings", + "traits": { + "smithy.api#documentation": "Network settings for the input device.", + "smithy.api#jsonName": "networkSettings" + } }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" + "SerialNumber": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique serial number of the input device.", + "smithy.api#jsonName": "serialNumber" + } }, - { - "target": "com.amazonaws.medialive#NotFoundException" + "Type": { + "target": "com.amazonaws.medialive#InputDeviceType", + "traits": { + "smithy.api#documentation": "The type of the input device.", + "smithy.api#jsonName": "type" + } }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "List the programs that currently exist for a specific multiplex.", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/multiplexes/{MultiplexId}/programs", - "code": 200 + "UhdDeviceSettings": { + "target": "com.amazonaws.medialive#InputDeviceUhdSettings", + "traits": { + "smithy.api#documentation": "Settings that describe an input device that is type UHD.", + "smithy.api#jsonName": "uhdDeviceSettings" + } }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "MultiplexPrograms", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.medialive#ListMultiplexProgramsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "The maximum number of items to return.", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" } }, - "MultiplexId": { + "AvailabilityZone": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ID of the multiplex that the programs belong to.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The Availability Zone associated with this input device.", + "smithy.api#jsonName": "availabilityZone" } }, - "NextToken": { - "target": "com.amazonaws.medialive#__string", + "MedialiveInputArns": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "The token to retrieve the next page of results.", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.", + "smithy.api#jsonName": "medialiveInputArns" + } + }, + "OutputType": { + "target": "com.amazonaws.medialive#InputDeviceOutputType", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "outputType" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListMultiplexProgramsRequest", - "smithy.api#input": {} + "smithy.api#documentation": "Details of the input device." } }, - "com.amazonaws.medialive#ListMultiplexProgramsResponse": { - "type": "structure", + "com.amazonaws.medialive#InputDeviceThumbnail": { + "type": "blob", + "traits": { + "smithy.api#documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive.", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.medialive#InputDeviceTransferType": { + "type": "enum", "members": { - "MultiplexPrograms": { - "target": "com.amazonaws.medialive#__listOfMultiplexProgramSummary", + "OUTGOING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "List of multiplex programs.", - "smithy.api#jsonName": "multiplexPrograms" + "smithy.api#enumValue": "OUTGOING" } }, - "NextToken": { - "target": "com.amazonaws.medialive#__string", + "INCOMING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Token for the next ListMultiplexProgram request.", - "smithy.api#jsonName": "nextToken" + "smithy.api#enumValue": "INCOMING" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListMultiplexProgramsResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#ListMultiplexes": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#ListMultiplexesRequest" - }, - "output": { - "target": "com.amazonaws.medialive#ListMultiplexesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieve a list of the existing multiplexes.", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/multiplexes", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Multiplexes", - "pageSize": "MaxResults" - } + "smithy.api#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." } }, - "com.amazonaws.medialive#ListMultiplexesRequest": { - "type": "structure", + "com.amazonaws.medialive#InputDeviceType": { + "type": "enum", "members": { - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", + "HD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The maximum number of items to return.", - "smithy.api#httpQuery": "maxResults" + "smithy.api#enumValue": "HD" } }, - "NextToken": { - "target": "com.amazonaws.medialive#__string", + "UHD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The token to retrieve the next page of results.", - "smithy.api#httpQuery": "nextToken" + "smithy.api#enumValue": "UHD" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListMultiplexesRequest", - "smithy.api#input": {} + "smithy.api#documentation": "The type of the input device. For an AWS Elemental Link device that outputs resolutions up to 1080, choose \"HD\"." } }, - "com.amazonaws.medialive#ListMultiplexesResponse": { + "com.amazonaws.medialive#InputDeviceUhdAudioChannelPairConfig": { "type": "structure", "members": { - "Multiplexes": { - "target": "com.amazonaws.medialive#__listOfMultiplexSummary", + "Id": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "List of multiplexes.", - "smithy.api#jsonName": "multiplexes" + "smithy.api#documentation": "The ID for one audio pair configuration, a value from 1 to 8.", + "smithy.api#jsonName": "id" } }, - "NextToken": { - "target": "com.amazonaws.medialive#__string", + "Profile": { + "target": "com.amazonaws.medialive#InputDeviceUhdAudioChannelPairProfile", "traits": { - "smithy.api#documentation": "Token for the next ListMultiplexes request.", - "smithy.api#jsonName": "nextToken" + "smithy.api#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.", + "smithy.api#jsonName": "profile" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListMultiplexesResponse", - "smithy.api#output": {} + "smithy.api#documentation": "One audio configuration that specifies the format for one audio pair that the device produces as output." } }, - "com.amazonaws.medialive#ListOfferings": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#ListOfferingsRequest" - }, - "output": { - "target": "com.amazonaws.medialive#ListOfferingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" + "com.amazonaws.medialive#InputDeviceUhdAudioChannelPairProfile": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } }, - { - "target": "com.amazonaws.medialive#BadRequestException" + "VBR_AAC_HHE_16000": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VBR-AAC_HHE-16000" + } }, - { - "target": "com.amazonaws.medialive#ForbiddenException" + "VBR_AAC_HE_64000": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VBR-AAC_HE-64000" + } }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "VBR_AAC_LC_128000": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VBR-AAC_LC-128000" + } }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" + "CBR_AAC_HQ_192000": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CBR-AAC_HQ-192000" + } }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "List offerings available for purchase.", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/offerings", - "code": 200 + "CBR_AAC_HQ_256000": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CBR-AAC_HQ-256000" + } }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Offerings", - "pageSize": "MaxResults" + "CBR_AAC_HQ_384000": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CBR-AAC_HQ-384000" + } + }, + "CBR_AAC_HQ_512000": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CBR-AAC_HQ-512000" + } } + }, + "traits": { + "smithy.api#documentation": "Property of InputDeviceUhdAudioChannelPairConfig, which describes one audio channel that the device is configured to produce." } }, - "com.amazonaws.medialive#ListOfferingsRequest": { + "com.amazonaws.medialive#InputDeviceUhdSettings": { "type": "structure", "members": { - "ChannelClass": { - "target": "com.amazonaws.medialive#__string", + "ActiveInput": { + "target": "com.amazonaws.medialive#InputDeviceActiveInput", "traits": { - "smithy.api#documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'", - "smithy.api#httpQuery": "channelClass" + "smithy.api#documentation": "If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).", + "smithy.api#jsonName": "activeInput" } }, - "ChannelConfiguration": { - "target": "com.amazonaws.medialive#__string", + "ConfiguredInput": { + "target": "com.amazonaws.medialive#InputDeviceConfiguredInput", "traits": { - "smithy.api#documentation": "Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)", - "smithy.api#httpQuery": "channelConfiguration" + "smithy.api#documentation": "The source at the input device that is currently active. You can specify this source.", + "smithy.api#jsonName": "configuredInput" } }, - "Codec": { - "target": "com.amazonaws.medialive#__string", + "DeviceState": { + "target": "com.amazonaws.medialive#InputDeviceState", "traits": { - "smithy.api#documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'", - "smithy.api#httpQuery": "codec" + "smithy.api#documentation": "The state of the input device.", + "smithy.api#jsonName": "deviceState" } }, - "Duration": { - "target": "com.amazonaws.medialive#__string", + "Framerate": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Filter by offering duration, e.g. '12'", - "smithy.api#httpQuery": "duration" + "smithy.api#documentation": "The frame rate of the video source.", + "smithy.api#jsonName": "framerate" } }, - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", + "Height": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "The height of the video source, in pixels.", + "smithy.api#jsonName": "height" } }, - "MaximumBitrate": { - "target": "com.amazonaws.medialive#__string", + "MaxBitrate": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'", - "smithy.api#httpQuery": "maximumBitrate" + "smithy.api#documentation": "The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.", + "smithy.api#jsonName": "maxBitrate" } }, - "MaximumFramerate": { - "target": "com.amazonaws.medialive#__string", + "ScanType": { + "target": "com.amazonaws.medialive#InputDeviceScanType", "traits": { - "smithy.api#documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'", - "smithy.api#httpQuery": "maximumFramerate" + "smithy.api#documentation": "The scan type of the video source.", + "smithy.api#jsonName": "scanType" } }, - "NextToken": { - "target": "com.amazonaws.medialive#__string", + "Width": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "The width of the video source, in pixels.", + "smithy.api#jsonName": "width" } }, - "Resolution": { - "target": "com.amazonaws.medialive#__string", + "LatencyMs": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'", - "smithy.api#httpQuery": "resolution" + "smithy.api#documentation": "The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.", + "smithy.api#jsonName": "latencyMs" } }, - "ResourceType": { - "target": "com.amazonaws.medialive#__string", + "Codec": { + "target": "com.amazonaws.medialive#InputDeviceCodec", "traits": { - "smithy.api#documentation": "Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'", - "smithy.api#httpQuery": "resourceType" + "smithy.api#documentation": "The codec for the video that the device produces.", + "smithy.api#jsonName": "codec" } }, - "SpecialFeature": { - "target": "com.amazonaws.medialive#__string", + "MediaconnectSettings": { + "target": "com.amazonaws.medialive#InputDeviceMediaConnectSettings", "traits": { - "smithy.api#documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'", - "smithy.api#httpQuery": "specialFeature" + "smithy.api#documentation": "Information about the MediaConnect flow attached to the device. Returned only if the outputType is MEDIACONNECT_FLOW.", + "smithy.api#jsonName": "mediaconnectSettings" } }, - "VideoQuality": { - "target": "com.amazonaws.medialive#__string", + "AudioChannelPairs": { + "target": "com.amazonaws.medialive#__listOfInputDeviceUhdAudioChannelPairConfig", "traits": { - "smithy.api#documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'", - "smithy.api#httpQuery": "videoQuality" + "smithy.api#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.", + "smithy.api#jsonName": "audioChannelPairs" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListOfferingsRequest", - "smithy.api#input": {} + "smithy.api#documentation": "Settings that describe the active source from the input device, and the video characteristics of that source." } }, - "com.amazonaws.medialive#ListOfferingsResponse": { - "type": "structure", + "com.amazonaws.medialive#InputFilter": { + "type": "enum", "members": { - "NextToken": { - "target": "com.amazonaws.medialive#__string", + "AUTO": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Token to retrieve the next page of results", - "smithy.api#jsonName": "nextToken" + "smithy.api#enumValue": "AUTO" } }, - "Offerings": { - "target": "com.amazonaws.medialive#__listOfOffering", + "DISABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "List of offerings", - "smithy.api#jsonName": "offerings" + "smithy.api#enumValue": "DISABLED" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for ListOfferingsResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#ListReservations": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#ListReservationsRequest" - }, - "output": { - "target": "com.amazonaws.medialive#ListReservationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" + "FORCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORCED" + } } - ], + }, "traits": { - "smithy.api#documentation": "List purchased reservations.", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/reservations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Reservations", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "Input Filter" } }, - "com.amazonaws.medialive#ListReservationsRequest": { + "com.amazonaws.medialive#InputLocation": { "type": "structure", "members": { - "ChannelClass": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'", - "smithy.api#httpQuery": "channelClass" - } - }, - "Codec": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'", - "smithy.api#httpQuery": "codec" - } - }, - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", - "traits": { - "smithy.api#httpQuery": "maxResults" - } - }, - "MaximumBitrate": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'", - "smithy.api#httpQuery": "maximumBitrate" - } - }, - "MaximumFramerate": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'", - "smithy.api#httpQuery": "maximumFramerate" - } - }, - "NextToken": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#httpQuery": "nextToken" - } - }, - "Resolution": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'", - "smithy.api#httpQuery": "resolution" - } - }, - "ResourceType": { + "PasswordParam": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'", - "smithy.api#httpQuery": "resourceType" + "smithy.api#documentation": "key used to extract the password from EC2 Parameter store", + "smithy.api#jsonName": "passwordParam" } }, - "SpecialFeature": { - "target": "com.amazonaws.medialive#__string", + "Uri": { + "target": "com.amazonaws.medialive#__stringMax2048", "traits": { - "smithy.api#documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'", - "smithy.api#httpQuery": "specialFeature" + "smithy.api#clientOptional": {}, + "smithy.api#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\".", + "smithy.api#jsonName": "uri", + "smithy.api#required": {} } }, - "VideoQuality": { + "Username": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'", - "smithy.api#httpQuery": "videoQuality" + "smithy.api#documentation": "Documentation update needed", + "smithy.api#jsonName": "username" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListReservationsRequest", - "smithy.api#input": {} + "smithy.api#documentation": "Input Location" } }, - "com.amazonaws.medialive#ListReservationsResponse": { - "type": "structure", + "com.amazonaws.medialive#InputLossActionForHlsOut": { + "type": "enum", "members": { - "NextToken": { - "target": "com.amazonaws.medialive#__string", + "EMIT_OUTPUT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Token to retrieve the next page of results", - "smithy.api#jsonName": "nextToken" + "smithy.api#enumValue": "EMIT_OUTPUT" } }, - "Reservations": { - "target": "com.amazonaws.medialive#__listOfReservation", + "PAUSE_OUTPUT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "List of reservations", - "smithy.api#jsonName": "reservations" + "smithy.api#enumValue": "PAUSE_OUTPUT" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListReservationsResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.medialive#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#NotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Produces list of tags that have been created for a resource", - "smithy.api#http": { - "method": "GET", - "uri": "/prod/tags/{ResourceArn}", - "code": 200 - } + "smithy.api#documentation": "Input Loss Action For Hls Out" } }, - "com.amazonaws.medialive#ListTagsForResourceRequest": { - "type": "structure", + "com.amazonaws.medialive#InputLossActionForMsSmoothOut": { + "type": "enum", "members": { - "ResourceArn": { - "target": "com.amazonaws.medialive#__string", + "EMIT_OUTPUT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "EMIT_OUTPUT" + } + }, + "PAUSE_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAUSE_OUTPUT" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListTagsForResourceRequest", - "smithy.api#input": {} + "smithy.api#documentation": "Input Loss Action For Ms Smooth Out" } }, - "com.amazonaws.medialive#ListTagsForResourceResponse": { - "type": "structure", + "com.amazonaws.medialive#InputLossActionForRtmpOut": { + "type": "enum", "members": { - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "EMIT_OUTPUT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#enumValue": "EMIT_OUTPUT" + } + }, + "PAUSE_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAUSE_OUTPUT" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListTagsForResourceResponse", - "smithy.api#output": {} + "smithy.api#documentation": "Input Loss Action For Rtmp Out" } }, - "com.amazonaws.medialive#LogLevel": { + "com.amazonaws.medialive#InputLossActionForUdpOut": { "type": "enum", "members": { - "ERROR": { + "DROP_PROGRAM": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ERROR" + "smithy.api#enumValue": "DROP_PROGRAM" } }, - "WARNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WARNING" - } - }, - "INFO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFO" - } - }, - "DEBUG": { + "DROP_TS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DEBUG" + "smithy.api#enumValue": "DROP_TS" } }, - "DISABLED": { + "EMIT_PROGRAM": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "EMIT_PROGRAM" } } }, "traits": { - "smithy.api#documentation": "The log level the user wants for their channel." + "smithy.api#documentation": "Input Loss Action For Udp Out" } }, - "com.amazonaws.medialive#M2tsAbsentInputAudioBehavior": { - "type": "enum", + "com.amazonaws.medialive#InputLossBehavior": { + "type": "structure", "members": { - "DROP": { - "target": "smithy.api#Unit", + "BlackFrameMsec": { + "target": "com.amazonaws.medialive#__integerMin0Max1000000", "traits": { - "smithy.api#enumValue": "DROP" + "smithy.api#documentation": "Documentation update needed", + "smithy.api#jsonName": "blackFrameMsec" } }, - "ENCODE_SILENCE": { - "target": "smithy.api#Unit", + "InputLossImageColor": { + "target": "com.amazonaws.medialive#__stringMin6Max6", "traits": { - "smithy.api#enumValue": "ENCODE_SILENCE" + "smithy.api#documentation": "When input loss image type is \"color\" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.", + "smithy.api#jsonName": "inputLossImageColor" } - } - }, - "traits": { - "smithy.api#documentation": "M2ts Absent Input Audio Behavior" - } - }, - "com.amazonaws.medialive#M2tsArib": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", + }, + "InputLossImageSlate": { + "target": "com.amazonaws.medialive#InputLocation", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#documentation": "When input loss image type is \"slate\" these fields specify the parameters for accessing the slate.", + "smithy.api#jsonName": "inputLossImageSlate" } }, - "ENABLED": { - "target": "smithy.api#Unit", + "InputLossImageType": { + "target": "com.amazonaws.medialive#InputLossImageType", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#documentation": "Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.", + "smithy.api#jsonName": "inputLossImageType" + } + }, + "RepeatFrameMsec": { + "target": "com.amazonaws.medialive#__integerMin0Max1000000", + "traits": { + "smithy.api#documentation": "Documentation update needed", + "smithy.api#jsonName": "repeatFrameMsec" } } }, "traits": { - "smithy.api#documentation": "M2ts Arib" + "smithy.api#documentation": "Input Loss Behavior" } }, - "com.amazonaws.medialive#M2tsAribCaptionsPidControl": { - "type": "enum", + "com.amazonaws.medialive#InputLossFailoverSettings": { + "type": "structure", "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "USE_CONFIGURED": { - "target": "smithy.api#Unit", + "InputLossThresholdMsec": { + "target": "com.amazonaws.medialive#__integerMin100", "traits": { - "smithy.api#enumValue": "USE_CONFIGURED" + "smithy.api#documentation": "The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur.", + "smithy.api#jsonName": "inputLossThresholdMsec" } } }, "traits": { - "smithy.api#documentation": "M2ts Arib Captions Pid Control" + "smithy.api#documentation": "MediaLive will perform a failover if content is not detected in this input for the specified period." } }, - "com.amazonaws.medialive#M2tsAudioBufferModel": { + "com.amazonaws.medialive#InputLossImageType": { "type": "enum", "members": { - "ATSC": { + "COLOR": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ATSC" + "smithy.api#enumValue": "COLOR" } }, - "DVB": { + "SLATE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DVB" + "smithy.api#enumValue": "SLATE" } } }, "traits": { - "smithy.api#documentation": "M2ts Audio Buffer Model" + "smithy.api#documentation": "Input Loss Image Type" } }, - "com.amazonaws.medialive#M2tsAudioInterval": { + "com.amazonaws.medialive#InputMaximumBitrate": { "type": "enum", "members": { - "VIDEO_AND_FIXED_INTERVALS": { + "MAX_10_MBPS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "VIDEO_AND_FIXED_INTERVALS" + "smithy.api#enumValue": "MAX_10_MBPS" } }, - "VIDEO_INTERVAL": { + "MAX_20_MBPS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "VIDEO_INTERVAL" + "smithy.api#enumValue": "MAX_20_MBPS" + } + }, + "MAX_50_MBPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_50_MBPS" } } }, "traits": { - "smithy.api#documentation": "M2ts Audio Interval" + "smithy.api#documentation": "Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently." } }, - "com.amazonaws.medialive#M2tsAudioStreamType": { + "com.amazonaws.medialive#InputPreference": { "type": "enum", "members": { - "ATSC": { + "EQUAL_INPUT_PREFERENCE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ATSC" + "smithy.api#enumValue": "EQUAL_INPUT_PREFERENCE" } }, - "DVB": { + "PRIMARY_INPUT_PREFERRED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DVB" + "smithy.api#enumValue": "PRIMARY_INPUT_PREFERRED" } } }, "traits": { - "smithy.api#documentation": "M2ts Audio Stream Type" + "smithy.api#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." } }, - "com.amazonaws.medialive#M2tsBufferModel": { - "type": "enum", + "com.amazonaws.medialive#InputPrepareScheduleActionSettings": { + "type": "structure", "members": { - "MULTIPLEX": { - "target": "smithy.api#Unit", + "InputAttachmentNameReference": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "MULTIPLEX" + "smithy.api#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.", + "smithy.api#jsonName": "inputAttachmentNameReference" } }, - "NONE": { - "target": "smithy.api#Unit", + "InputClippingSettings": { + "target": "com.amazonaws.medialive#InputClippingSettings", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#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.", + "smithy.api#jsonName": "inputClippingSettings" + } + }, + "UrlPath": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "urlPath" } } }, "traits": { - "smithy.api#documentation": "M2ts Buffer Model" + "smithy.api#documentation": "Action to prepare an input for a future immediate input switch." } }, - "com.amazonaws.medialive#M2tsCcDescriptor": { + "com.amazonaws.medialive#InputResolution": { "type": "enum", "members": { - "DISABLED": { + "SD": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "SD" } }, - "ENABLED": { + "HD": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "HD" + } + }, + "UHD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UHD" } } }, "traits": { - "smithy.api#documentation": "M2ts Cc Descriptor" + "smithy.api#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" } }, - "com.amazonaws.medialive#M2tsEbifControl": { - "type": "enum", + "com.amazonaws.medialive#InputSecurityGroup": { + "type": "structure", "members": { - "NONE": { - "target": "smithy.api#Unit", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#documentation": "Unique ARN of Input Security Group", + "smithy.api#jsonName": "arn" } }, - "PASSTHROUGH": { - "target": "smithy.api#Unit", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#documentation": "The Id of the Input Security Group", + "smithy.api#jsonName": "id" + } + }, + "Inputs": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "The list of inputs currently using this Input Security Group.", + "smithy.api#jsonName": "inputs" + } + }, + "State": { + "target": "com.amazonaws.medialive#InputSecurityGroupState", + "traits": { + "smithy.api#documentation": "The current state of the Input Security Group.", + "smithy.api#jsonName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + }, + "WhitelistRules": { + "target": "com.amazonaws.medialive#__listOfInputWhitelistRule", + "traits": { + "smithy.api#documentation": "Whitelist rules and their sync status", + "smithy.api#jsonName": "whitelistRules" } } }, "traits": { - "smithy.api#documentation": "M2ts Ebif Control" + "smithy.api#documentation": "An Input Security Group" } }, - "com.amazonaws.medialive#M2tsEbpPlacement": { + "com.amazonaws.medialive#InputSecurityGroupState": { "type": "enum", "members": { - "VIDEO_AND_AUDIO_PIDS": { + "IDLE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "VIDEO_AND_AUDIO_PIDS" + "smithy.api#enumValue": "IDLE" } }, - "VIDEO_PID": { + "IN_USE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "VIDEO_PID" + "smithy.api#enumValue": "IN_USE" } - } - }, - "traits": { - "smithy.api#documentation": "M2ts Ebp Placement" - } - }, - "com.amazonaws.medialive#M2tsEsRateInPes": { - "type": "enum", - "members": { - "EXCLUDE": { + }, + "UPDATING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EXCLUDE" + "smithy.api#enumValue": "UPDATING" } }, - "INCLUDE": { + "DELETED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INCLUDE" + "smithy.api#enumValue": "DELETED" } } }, "traits": { - "smithy.api#documentation": "M2ts Es Rate In Pes" + "smithy.api#documentation": "Placeholder documentation for InputSecurityGroupState" } }, - "com.amazonaws.medialive#M2tsKlv": { - "type": "enum", + "com.amazonaws.medialive#InputSettings": { + "type": "structure", "members": { - "NONE": { - "target": "smithy.api#Unit", + "AudioSelectors": { + "target": "com.amazonaws.medialive#__listOfAudioSelector", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#documentation": "Used to select the audio stream to decode for inputs that have multiple available.", + "smithy.api#jsonName": "audioSelectors" } }, - "PASSTHROUGH": { - "target": "smithy.api#Unit", + "CaptionSelectors": { + "target": "com.amazonaws.medialive#__listOfCaptionSelector", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#documentation": "Used to select the caption input to use for inputs that have multiple available.", + "smithy.api#jsonName": "captionSelectors" + } + }, + "DeblockFilter": { + "target": "com.amazonaws.medialive#InputDeblockFilter", + "traits": { + "smithy.api#documentation": "Enable or disable the deblock filter when filtering.", + "smithy.api#jsonName": "deblockFilter" + } + }, + "DenoiseFilter": { + "target": "com.amazonaws.medialive#InputDenoiseFilter", + "traits": { + "smithy.api#documentation": "Enable or disable the denoise filter when filtering.", + "smithy.api#jsonName": "denoiseFilter" + } + }, + "FilterStrength": { + "target": "com.amazonaws.medialive#__integerMin1Max5", + "traits": { + "smithy.api#documentation": "Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).", + "smithy.api#jsonName": "filterStrength" + } + }, + "InputFilter": { + "target": "com.amazonaws.medialive#InputFilter", + "traits": { + "smithy.api#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", + "smithy.api#jsonName": "inputFilter" + } + }, + "NetworkInputSettings": { + "target": "com.amazonaws.medialive#NetworkInputSettings", + "traits": { + "smithy.api#documentation": "Input settings.", + "smithy.api#jsonName": "networkInputSettings" + } + }, + "Scte35Pid": { + "target": "com.amazonaws.medialive#__integerMin32Max8191", + "traits": { + "smithy.api#documentation": "PID from which to read SCTE-35 messages. If left undefined, EML will select the first SCTE-35 PID found in the input.", + "smithy.api#jsonName": "scte35Pid" + } + }, + "Smpte2038DataPreference": { + "target": "com.amazonaws.medialive#Smpte2038DataPreference", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "smpte2038DataPreference" + } + }, + "SourceEndBehavior": { + "target": "com.amazonaws.medialive#InputSourceEndBehavior", + "traits": { + "smithy.api#documentation": "Loop input if it is a file. This allows a file input to be streamed indefinitely.", + "smithy.api#jsonName": "sourceEndBehavior" + } + }, + "VideoSelector": { + "target": "com.amazonaws.medialive#VideoSelector", + "traits": { + "smithy.api#documentation": "Informs which video elementary stream to decode for input types that have multiple available.", + "smithy.api#jsonName": "videoSelector" } } }, "traits": { - "smithy.api#documentation": "M2ts Klv" + "smithy.api#documentation": "Live Event input parameters. There can be multiple inputs in a single Live Event." } }, - "com.amazonaws.medialive#M2tsNielsenId3Behavior": { - "type": "enum", + "com.amazonaws.medialive#InputSource": { + "type": "structure", "members": { - "NO_PASSTHROUGH": { - "target": "smithy.api#Unit", + "PasswordParam": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "NO_PASSTHROUGH" + "smithy.api#documentation": "The key used to extract the password from EC2 Parameter store.", + "smithy.api#jsonName": "passwordParam" } }, - "PASSTHROUGH": { - "target": "smithy.api#Unit", + "Url": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#documentation": "This represents the customer's source URL where stream is\npulled from.", + "smithy.api#jsonName": "url" + } + }, + "Username": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The username for the input source.", + "smithy.api#jsonName": "username" } } }, "traits": { - "smithy.api#documentation": "M2ts Nielsen Id3 Behavior" + "smithy.api#documentation": "The settings for a PULL type input." } }, - "com.amazonaws.medialive#M2tsPcrControl": { + "com.amazonaws.medialive#InputSourceEndBehavior": { "type": "enum", "members": { - "CONFIGURED_PCR_PERIOD": { + "CONTINUE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CONFIGURED_PCR_PERIOD" + "smithy.api#enumValue": "CONTINUE" } }, - "PCR_EVERY_PES_PACKET": { + "LOOP": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PCR_EVERY_PES_PACKET" + "smithy.api#enumValue": "LOOP" } } }, "traits": { - "smithy.api#documentation": "M2ts Pcr Control" + "smithy.api#documentation": "Input Source End Behavior" } }, - "com.amazonaws.medialive#M2tsRateMode": { - "type": "enum", + "com.amazonaws.medialive#InputSourceRequest": { + "type": "structure", "members": { - "CBR": { - "target": "smithy.api#Unit", + "PasswordParam": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "CBR" + "smithy.api#documentation": "The key used to extract the password from EC2 Parameter store.", + "smithy.api#jsonName": "passwordParam" } }, - "VBR": { - "target": "smithy.api#Unit", + "Url": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "VBR" + "smithy.api#documentation": "This represents the customer's source URL where stream is\npulled from.", + "smithy.api#jsonName": "url" + } + }, + "Username": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The username for the input source.", + "smithy.api#jsonName": "username" } } }, "traits": { - "smithy.api#documentation": "M2ts Rate Mode" + "smithy.api#documentation": "Settings for for a PULL type input." } }, - "com.amazonaws.medialive#M2tsScte35Control": { + "com.amazonaws.medialive#InputSourceType": { "type": "enum", "members": { - "NONE": { + "STATIC": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "STATIC" } }, - "PASSTHROUGH": { + "DYNAMIC": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#enumValue": "DYNAMIC" } } }, "traits": { - "smithy.api#documentation": "M2ts Scte35 Control" + "smithy.api#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." } }, - "com.amazonaws.medialive#M2tsSegmentationMarkers": { - "type": "enum", + "com.amazonaws.medialive#InputSpecification": { + "type": "structure", "members": { - "EBP": { - "target": "smithy.api#Unit", + "Codec": { + "target": "com.amazonaws.medialive#InputCodec", "traits": { - "smithy.api#enumValue": "EBP" + "smithy.api#documentation": "Input codec", + "smithy.api#jsonName": "codec" } }, - "EBP_LEGACY": { + "MaximumBitrate": { + "target": "com.amazonaws.medialive#InputMaximumBitrate", + "traits": { + "smithy.api#documentation": "Maximum input bitrate, categorized coarsely", + "smithy.api#jsonName": "maximumBitrate" + } + }, + "Resolution": { + "target": "com.amazonaws.medialive#InputResolution", + "traits": { + "smithy.api#documentation": "Input resolution, categorized coarsely", + "smithy.api#jsonName": "resolution" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for InputSpecification" + } + }, + "com.amazonaws.medialive#InputState": { + "type": "enum", + "members": { + "CREATING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EBP_LEGACY" + "smithy.api#enumValue": "CREATING" } }, - "NONE": { + "DETACHED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "DETACHED" } }, - "PSI_SEGSTART": { + "ATTACHED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PSI_SEGSTART" + "smithy.api#enumValue": "ATTACHED" } }, - "RAI_ADAPT": { + "DELETING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "RAI_ADAPT" + "smithy.api#enumValue": "DELETING" } }, - "RAI_SEGSTART": { + "DELETED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "RAI_SEGSTART" + "smithy.api#enumValue": "DELETED" } } }, "traits": { - "smithy.api#documentation": "M2ts Segmentation Markers" + "smithy.api#documentation": "Placeholder documentation for InputState" } }, - "com.amazonaws.medialive#M2tsSegmentationStyle": { - "type": "enum", + "com.amazonaws.medialive#InputSwitchScheduleActionSettings": { + "type": "structure", "members": { - "MAINTAIN_CADENCE": { - "target": "smithy.api#Unit", + "InputAttachmentNameReference": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "MAINTAIN_CADENCE" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the input attachment (not the name of the input!) to switch to. The name is specified in the channel configuration.", + "smithy.api#jsonName": "inputAttachmentNameReference", + "smithy.api#required": {} } }, - "RESET_CADENCE": { - "target": "smithy.api#Unit", + "InputClippingSettings": { + "target": "com.amazonaws.medialive#InputClippingSettings", "traits": { - "smithy.api#enumValue": "RESET_CADENCE" + "smithy.api#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.", + "smithy.api#jsonName": "inputClippingSettings" + } + }, + "UrlPath": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "urlPath" } } }, "traits": { - "smithy.api#documentation": "M2ts Segmentation Style" + "smithy.api#documentation": "Settings for the \"switch input\" action: to switch from ingesting one input to ingesting another input." } }, - "com.amazonaws.medialive#M2tsSettings": { - "type": "structure", + "com.amazonaws.medialive#InputTimecodeSource": { + "type": "enum", "members": { - "AbsentInputAudioBehavior": { - "target": "com.amazonaws.medialive#M2tsAbsentInputAudioBehavior", + "ZEROBASED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "absentInputAudioBehavior" + "smithy.api#enumValue": "ZEROBASED" } }, - "Arib": { - "target": "com.amazonaws.medialive#M2tsArib", + "EMBEDDED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.", - "smithy.api#jsonName": "arib" + "smithy.api#enumValue": "EMBEDDED" } - }, - "AribCaptionsPid": { - "target": "com.amazonaws.medialive#__string", + } + }, + "traits": { + "smithy.api#documentation": "Documentation update needed" + } + }, + "com.amazonaws.medialive#InputType": { + "type": "enum", + "members": { + "UDP_PUSH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "aribCaptionsPid" + "smithy.api#enumValue": "UDP_PUSH" } }, - "AribCaptionsPidControl": { - "target": "com.amazonaws.medialive#M2tsAribCaptionsPidControl", + "RTP_PUSH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "aribCaptionsPidControl" + "smithy.api#enumValue": "RTP_PUSH" } }, - "AudioBufferModel": { - "target": "com.amazonaws.medialive#M2tsAudioBufferModel", + "RTMP_PUSH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.", - "smithy.api#jsonName": "audioBufferModel" + "smithy.api#enumValue": "RTMP_PUSH" } }, - "AudioFramesPerPes": { - "target": "com.amazonaws.medialive#__integerMin0", + "RTMP_PULL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The number of audio frames to insert for each PES packet.", - "smithy.api#jsonName": "audioFramesPerPes" + "smithy.api#enumValue": "RTMP_PULL" } }, - "AudioPids": { - "target": "com.amazonaws.medialive#__string", + "URL_PULL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "audioPids" + "smithy.api#enumValue": "URL_PULL" } }, - "AudioStreamType": { - "target": "com.amazonaws.medialive#M2tsAudioStreamType", + "MP4_FILE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "audioStreamType" + "smithy.api#enumValue": "MP4_FILE" } }, - "Bitrate": { - "target": "com.amazonaws.medialive#__integerMin0", + "MEDIACONNECT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.", - "smithy.api#jsonName": "bitrate" + "smithy.api#enumValue": "MEDIACONNECT" } }, - "BufferModel": { - "target": "com.amazonaws.medialive#M2tsBufferModel", + "INPUT_DEVICE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "bufferModel" + "smithy.api#enumValue": "INPUT_DEVICE" } }, - "CcDescriptor": { - "target": "com.amazonaws.medialive#M2tsCcDescriptor", + "AWS_CDI": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "When set to enabled, generates captionServiceDescriptor in PMT.", - "smithy.api#jsonName": "ccDescriptor" + "smithy.api#enumValue": "AWS_CDI" } }, - "DvbNitSettings": { - "target": "com.amazonaws.medialive#DvbNitSettings", + "TS_FILE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbNitSettings" + "smithy.api#enumValue": "TS_FILE" } - }, - "DvbSdtSettings": { - "target": "com.amazonaws.medialive#DvbSdtSettings", + } + }, + "traits": { + "smithy.api#documentation": "The different types of inputs that AWS Elemental MediaLive supports." + } + }, + "com.amazonaws.medialive#InputVpcRequest": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "Inserts DVB Service Description Table (SDT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbSdtSettings" + "smithy.api#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.", + "smithy.api#jsonName": "securityGroupIds" } }, - "DvbSubPids": { - "target": "com.amazonaws.medialive#__string", + "SubnetIds": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "dvbSubPids" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of 2 VPC subnet IDs from the same VPC.\nSubnet IDs must be mapped to two unique availability zones (AZ).", + "smithy.api#jsonName": "subnetIds", + "smithy.api#required": {} } - }, - "DvbTdtSettings": { - "target": "com.amazonaws.medialive#DvbTdtSettings", + } + }, + "traits": { + "smithy.api#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." + } + }, + "com.amazonaws.medialive#InputWhitelistRule": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbTdtSettings" + "smithy.api#documentation": "The IPv4 CIDR that's whitelisted.", + "smithy.api#jsonName": "cidr" } - }, - "DvbTeletextPid": { + } + }, + "traits": { + "smithy.api#documentation": "Whitelist rule" + } + }, + "com.amazonaws.medialive#InputWhitelistRuleCidr": { + "type": "structure", + "members": { + "Cidr": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "dvbTeletextPid" + "smithy.api#documentation": "The IPv4 CIDR to whitelist.", + "smithy.api#jsonName": "cidr" } - }, - "Ebif": { - "target": "com.amazonaws.medialive#M2tsEbifControl", + } + }, + "traits": { + "smithy.api#documentation": "An IPv4 CIDR to whitelist." + } + }, + "com.amazonaws.medialive#InternalServerErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "If set to passthrough, passes any EBIF data from the input source to this output.", - "smithy.api#jsonName": "ebif" + "smithy.api#jsonName": "message" } - }, - "EbpAudioInterval": { - "target": "com.amazonaws.medialive#M2tsAudioInterval", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for InternalServerErrorException", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.medialive#KeyProviderSettings": { + "type": "structure", + "members": { + "StaticKeySettings": { + "target": "com.amazonaws.medialive#StaticKeySettings", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "ebpAudioInterval" + "smithy.api#jsonName": "staticKeySettings" } - }, - "EbpLookaheadMs": { - "target": "com.amazonaws.medialive#__integerMin0Max10000", + } + }, + "traits": { + "smithy.api#documentation": "Key Provider Settings" + } + }, + "com.amazonaws.medialive#LastFrameClippingBehavior": { + "type": "enum", + "members": { + "EXCLUDE_LAST_FRAME": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "ebpLookaheadMs" + "smithy.api#enumValue": "EXCLUDE_LAST_FRAME" } }, - "EbpPlacement": { - "target": "com.amazonaws.medialive#M2tsEbpPlacement", + "INCLUDE_LAST_FRAME": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "ebpPlacement" + "smithy.api#enumValue": "INCLUDE_LAST_FRAME" } + } + }, + "traits": { + "smithy.api#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." + } + }, + "com.amazonaws.medialive#ListChannels": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListChannelsRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListChannelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "EcmPid": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "This field is unused and deprecated.", - "smithy.api#jsonName": "ecmPid" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "EsRateInPes": { - "target": "com.amazonaws.medialive#M2tsEsRateInPes", - "traits": { - "smithy.api#documentation": "Include or exclude the ES Rate field in the PES header.", - "smithy.api#jsonName": "esRateInPes" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "EtvPlatformPid": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "etvPlatformPid" - } + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" }, - "EtvSignalPid": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "etvSignalPid" - } + { + "target": "com.amazonaws.medialive#InternalServerErrorException" }, - "FragmentTime": { - "target": "com.amazonaws.medialive#__doubleMin0", - "traits": { - "smithy.api#documentation": "The length in seconds of each fragment. Only used with EBP markers.", - "smithy.api#jsonName": "fragmentTime" - } + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Produces list of channels that have been created", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/channels", + "code": 200 }, - "Klv": { - "target": "com.amazonaws.medialive#M2tsKlv", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Channels", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListChannelsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", "traits": { - "smithy.api#documentation": "If set to passthrough, passes any KLV data from the input source to this output.", - "smithy.api#jsonName": "klv" + "smithy.api#httpQuery": "maxResults" } }, - "KlvDataPids": { + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "klvDataPids" + "smithy.api#httpQuery": "nextToken" } - }, - "NielsenId3Behavior": { - "target": "com.amazonaws.medialive#M2tsNielsenId3Behavior", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListChannelsRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#ListChannelsResponse": { + "type": "structure", + "members": { + "Channels": { + "target": "com.amazonaws.medialive#__listOfChannelSummary", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "nielsenId3Behavior" + "smithy.api#jsonName": "channels" } }, - "NullPacketBitrate": { - "target": "com.amazonaws.medialive#__doubleMin0", + "NextToken": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "nullPacketBitrate" + "smithy.api#jsonName": "nextToken" } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListChannelsResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#ListCloudWatchAlarmTemplateGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListCloudWatchAlarmTemplateGroupsRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListCloudWatchAlarmTemplateGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "PatInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max1000", - "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.", - "smithy.api#jsonName": "patInterval" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "PcrControl": { - "target": "com.amazonaws.medialive#M2tsPcrControl", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "pcrControl" - } + { + "target": "com.amazonaws.medialive#InternalServerErrorException" }, - "PcrPeriod": { - "target": "com.amazonaws.medialive#__integerMin0Max500", + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Lists cloudwatch alarm template groups.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/cloudwatch-alarm-template-groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CloudWatchAlarmTemplateGroups", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListCloudWatchAlarmTemplateGroupsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", "traits": { - "smithy.api#documentation": "Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.", - "smithy.api#jsonName": "pcrPeriod" + "smithy.api#httpQuery": "maxResults" } }, - "PcrPid": { + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "pcrPid" + "smithy.api#documentation": "A token used to retrieve the next set of results in paginated list responses.", + "smithy.api#httpQuery": "nextToken" } }, - "PmtInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max1000", + "Scope": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.", - "smithy.api#jsonName": "pmtInterval" + "smithy.api#documentation": "Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources.", + "smithy.api#httpQuery": "scope" } }, - "PmtPid": { + "SignalMapIdentifier": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "pmtPid" + "smithy.api#documentation": "A signal map's identifier. Can be either be its id or current name.", + "smithy.api#httpQuery": "signalMapIdentifier" } - }, - "ProgramNum": { - "target": "com.amazonaws.medialive#__integerMin0Max65535", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListCloudWatchAlarmTemplateGroupsRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#ListCloudWatchAlarmTemplateGroupsResponse": { + "type": "structure", + "members": { + "CloudWatchAlarmTemplateGroups": { + "target": "com.amazonaws.medialive#__listOfCloudWatchAlarmTemplateGroupSummary", "traits": { - "smithy.api#documentation": "The value of the program number field in the Program Map Table.", - "smithy.api#jsonName": "programNum" + "smithy.api#jsonName": "cloudWatchAlarmTemplateGroups" } }, - "RateMode": { - "target": "com.amazonaws.medialive#M2tsRateMode", + "NextToken": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "rateMode" + "smithy.api#documentation": "A token used to retrieve the next set of results in paginated list responses.", + "smithy.api#jsonName": "nextToken" } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListCloudWatchAlarmTemplateGroupsResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#ListCloudWatchAlarmTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListCloudWatchAlarmTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListCloudWatchAlarmTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "Scte27Pids": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "scte27Pids" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "Scte35Control": { - "target": "com.amazonaws.medialive#M2tsScte35Control", - "traits": { - "smithy.api#documentation": "Optionally pass SCTE-35 signals from the input source to this output.", - "smithy.api#jsonName": "scte35Control" - } + { + "target": "com.amazonaws.medialive#InternalServerErrorException" }, - "Scte35Pid": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "scte35Pid" - } + { + "target": "com.amazonaws.medialive#NotFoundException" }, - "SegmentationMarkers": { - "target": "com.amazonaws.medialive#M2tsSegmentationMarkers", + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Lists cloudwatch alarm templates.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/cloudwatch-alarm-templates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CloudWatchAlarmTemplates", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListCloudWatchAlarmTemplatesRequest": { + "type": "structure", + "members": { + "GroupIdentifier": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "segmentationMarkers" + "smithy.api#documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name.", + "smithy.api#httpQuery": "groupIdentifier" } }, - "SegmentationStyle": { - "target": "com.amazonaws.medialive#M2tsSegmentationStyle", + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "segmentationStyle" + "smithy.api#httpQuery": "maxResults" } }, - "SegmentationTime": { - "target": "com.amazonaws.medialive#__doubleMin1", + "NextToken": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The length in seconds of each segment. Required unless markers is set to _none_.", - "smithy.api#jsonName": "segmentationTime" + "smithy.api#documentation": "A token used to retrieve the next set of results in paginated list responses.", + "smithy.api#httpQuery": "nextToken" } }, - "TimedMetadataBehavior": { - "target": "com.amazonaws.medialive#M2tsTimedMetadataBehavior", + "Scope": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "When set to passthrough, timed metadata will be passed through from input to output.", - "smithy.api#jsonName": "timedMetadataBehavior" + "smithy.api#documentation": "Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources.", + "smithy.api#httpQuery": "scope" } }, - "TimedMetadataPid": { + "SignalMapIdentifier": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "timedMetadataPid" + "smithy.api#documentation": "A signal map's identifier. Can be either be its id or current name.", + "smithy.api#httpQuery": "signalMapIdentifier" } - }, - "TransportStreamId": { - "target": "com.amazonaws.medialive#__integerMin0Max65535", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListCloudWatchAlarmTemplatesRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#ListCloudWatchAlarmTemplatesResponse": { + "type": "structure", + "members": { + "CloudWatchAlarmTemplates": { + "target": "com.amazonaws.medialive#__listOfCloudWatchAlarmTemplateSummary", "traits": { - "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", - "smithy.api#jsonName": "transportStreamId" + "smithy.api#jsonName": "cloudWatchAlarmTemplates" } }, - "VideoPid": { - "target": "com.amazonaws.medialive#__string", + "NextToken": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "videoPid" - } - }, - "Scte35PrerollPullupMilliseconds": { - "target": "com.amazonaws.medialive#__doubleMin0Max5000", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "scte35PrerollPullupMilliseconds" + "smithy.api#documentation": "A token used to retrieve the next set of results in paginated list responses.", + "smithy.api#jsonName": "nextToken" } } }, "traits": { - "smithy.api#documentation": "M2ts Settings" + "smithy.api#documentation": "Placeholder documentation for ListCloudWatchAlarmTemplatesResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#M2tsTimedMetadataBehavior": { - "type": "enum", - "members": { - "NO_PASSTHROUGH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_PASSTHROUGH" - } + "com.amazonaws.medialive#ListEventBridgeRuleTemplateGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListEventBridgeRuleTemplateGroupsRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListEventBridgeRuleTemplateGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "PASSTHROUGH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PASSTHROUGH" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" } - }, + ], "traits": { - "smithy.api#documentation": "M2ts Timed Metadata Behavior" + "smithy.api#documentation": "Lists eventbridge rule template groups.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/eventbridge-rule-template-groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EventBridgeRuleTemplateGroups", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.medialive#M3u8KlvBehavior": { - "type": "enum", + "com.amazonaws.medialive#ListEventBridgeRuleTemplateGroupsRequest": { + "type": "structure", "members": { - "NO_PASSTHROUGH": { - "target": "smithy.api#Unit", + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", "traits": { - "smithy.api#enumValue": "NO_PASSTHROUGH" + "smithy.api#httpQuery": "maxResults" } }, - "PASSTHROUGH": { - "target": "smithy.api#Unit", + "NextToken": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#documentation": "A token used to retrieve the next set of results in paginated list responses.", + "smithy.api#httpQuery": "nextToken" + } + }, + "SignalMapIdentifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "A signal map's identifier. Can be either be its id or current name.", + "smithy.api#httpQuery": "signalMapIdentifier" } } }, "traits": { - "smithy.api#documentation": "M3u8 Klv Behavior" + "smithy.api#documentation": "Placeholder documentation for ListEventBridgeRuleTemplateGroupsRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#M3u8NielsenId3Behavior": { - "type": "enum", + "com.amazonaws.medialive#ListEventBridgeRuleTemplateGroupsResponse": { + "type": "structure", "members": { - "NO_PASSTHROUGH": { - "target": "smithy.api#Unit", + "EventBridgeRuleTemplateGroups": { + "target": "com.amazonaws.medialive#__listOfEventBridgeRuleTemplateGroupSummary", "traits": { - "smithy.api#enumValue": "NO_PASSTHROUGH" + "smithy.api#jsonName": "eventBridgeRuleTemplateGroups" } }, - "PASSTHROUGH": { - "target": "smithy.api#Unit", + "NextToken": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#documentation": "A token used to retrieve the next set of results in paginated list responses.", + "smithy.api#jsonName": "nextToken" } } }, "traits": { - "smithy.api#documentation": "M3u8 Nielsen Id3 Behavior" + "smithy.api#documentation": "Placeholder documentation for ListEventBridgeRuleTemplateGroupsResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#M3u8PcrControl": { - "type": "enum", + "com.amazonaws.medialive#ListEventBridgeRuleTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListEventBridgeRuleTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListEventBridgeRuleTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Lists eventbridge rule templates.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/eventbridge-rule-templates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EventBridgeRuleTemplates", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListEventBridgeRuleTemplatesRequest": { + "type": "structure", "members": { - "CONFIGURED_PCR_PERIOD": { - "target": "smithy.api#Unit", + "GroupIdentifier": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "CONFIGURED_PCR_PERIOD" + "smithy.api#documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name.", + "smithy.api#httpQuery": "groupIdentifier" } }, - "PCR_EVERY_PES_PACKET": { - "target": "smithy.api#Unit", + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", "traits": { - "smithy.api#enumValue": "PCR_EVERY_PES_PACKET" + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "A token used to retrieve the next set of results in paginated list responses.", + "smithy.api#httpQuery": "nextToken" + } + }, + "SignalMapIdentifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "A signal map's identifier. Can be either be its id or current name.", + "smithy.api#httpQuery": "signalMapIdentifier" } } }, "traits": { - "smithy.api#documentation": "M3u8 Pcr Control" + "smithy.api#documentation": "Placeholder documentation for ListEventBridgeRuleTemplatesRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#M3u8Scte35Behavior": { - "type": "enum", + "com.amazonaws.medialive#ListEventBridgeRuleTemplatesResponse": { + "type": "structure", "members": { - "NO_PASSTHROUGH": { - "target": "smithy.api#Unit", + "EventBridgeRuleTemplates": { + "target": "com.amazonaws.medialive#__listOfEventBridgeRuleTemplateSummary", "traits": { - "smithy.api#enumValue": "NO_PASSTHROUGH" + "smithy.api#jsonName": "eventBridgeRuleTemplates" } }, - "PASSTHROUGH": { - "target": "smithy.api#Unit", + "NextToken": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#documentation": "A token used to retrieve the next set of results in paginated list responses.", + "smithy.api#jsonName": "nextToken" } } }, "traits": { - "smithy.api#documentation": "M3u8 Scte35 Behavior" + "smithy.api#documentation": "Placeholder documentation for ListEventBridgeRuleTemplatesResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#M3u8Settings": { + "com.amazonaws.medialive#ListInputDeviceTransfers": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListInputDeviceTransfersRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListInputDeviceTransfersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/inputDeviceTransfers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InputDeviceTransfers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListInputDeviceTransfersRequest": { "type": "structure", "members": { - "AudioFramesPerPes": { - "target": "com.amazonaws.medialive#__integerMin0", + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", "traits": { - "smithy.api#documentation": "The number of audio frames to insert for each PES packet.", - "smithy.api#jsonName": "audioFramesPerPes" + "smithy.api#httpQuery": "maxResults" } }, - "AudioPids": { + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "audioPids" + "smithy.api#httpQuery": "nextToken" } }, - "EcmPid": { + "TransferType": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "This parameter is unused and deprecated.", - "smithy.api#jsonName": "ecmPid" + "smithy.api#clientOptional": {}, + "smithy.api#httpQuery": "transferType", + "smithy.api#required": {} } - }, - "NielsenId3Behavior": { - "target": "com.amazonaws.medialive#M3u8NielsenId3Behavior", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListInputDeviceTransfersRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#ListInputDeviceTransfersResponse": { + "type": "structure", + "members": { + "InputDeviceTransfers": { + "target": "com.amazonaws.medialive#__listOfTransferringInputDeviceSummary", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "nielsenId3Behavior" + "smithy.api#documentation": "The list of devices that you are transferring or are being transferred to you.", + "smithy.api#jsonName": "inputDeviceTransfers" } }, - "PatInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max1000", + "NextToken": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "patInterval" - } - }, - "PcrControl": { - "target": "com.amazonaws.medialive#M3u8PcrControl", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "pcrControl" + "smithy.api#documentation": "A token to get additional list results.", + "smithy.api#jsonName": "nextToken" } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListInputDeviceTransfersResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#ListInputDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListInputDevicesRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListInputDevicesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "PcrPeriod": { - "target": "com.amazonaws.medialive#__integerMin0Max500", - "traits": { - "smithy.api#documentation": "Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.", - "smithy.api#jsonName": "pcrPeriod" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "PcrPid": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "pcrPid" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "PmtInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max1000", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "pmtInterval" - } + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" }, - "PmtPid": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.", - "smithy.api#jsonName": "pmtPid" - } + { + "target": "com.amazonaws.medialive#InternalServerErrorException" }, - "ProgramNum": { - "target": "com.amazonaws.medialive#__integerMin0Max65535", - "traits": { - "smithy.api#documentation": "The value of the program number field in the Program Map Table.", - "smithy.api#jsonName": "programNum" - } + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "List input devices", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/inputDevices", + "code": 200 }, - "Scte35Behavior": { - "target": "com.amazonaws.medialive#M3u8Scte35Behavior", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InputDevices", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListInputDevicesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", "traits": { - "smithy.api#documentation": "If set to passthrough, passes any SCTE-35 signals from the input source to this output.", - "smithy.api#jsonName": "scte35Behavior" + "smithy.api#httpQuery": "maxResults" } }, - "Scte35Pid": { + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.", - "smithy.api#jsonName": "scte35Pid" + "smithy.api#httpQuery": "nextToken" } - }, - "TimedMetadataBehavior": { - "target": "com.amazonaws.medialive#M3u8TimedMetadataBehavior", + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListInputDevicesRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#ListInputDevicesResponse": { + "type": "structure", + "members": { + "InputDevices": { + "target": "com.amazonaws.medialive#__listOfInputDeviceSummary", "traits": { - "smithy.api#documentation": "When set to passthrough, timed metadata is passed through from input to output.", - "smithy.api#jsonName": "timedMetadataBehavior" + "smithy.api#documentation": "The list of input devices.", + "smithy.api#jsonName": "inputDevices" } }, - "TimedMetadataPid": { + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "timedMetadataPid" + "smithy.api#documentation": "A token to get additional list results.", + "smithy.api#jsonName": "nextToken" } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListInputDevicesResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#ListInputSecurityGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListInputSecurityGroupsRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListInputSecurityGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "TransportStreamId": { - "target": "com.amazonaws.medialive#__integerMin0Max65535", - "traits": { - "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", - "smithy.api#jsonName": "transportStreamId" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "VideoPid": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.", - "smithy.api#jsonName": "videoPid" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "KlvBehavior": { - "target": "com.amazonaws.medialive#M3u8KlvBehavior", - "traits": { - "smithy.api#documentation": "If set to passthrough, passes any KLV data from the input source to this output.", - "smithy.api#jsonName": "klvBehavior" - } + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" }, - "KlvDataPids": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "klvDataPids" - } + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" } - }, + ], "traits": { - "smithy.api#documentation": "Settings information for the .m3u8 container" + "smithy.api#documentation": "Produces a list of Input Security Groups for an account", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/inputSecurityGroups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InputSecurityGroups", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.medialive#M3u8TimedMetadataBehavior": { - "type": "enum", + "com.amazonaws.medialive#ListInputSecurityGroupsRequest": { + "type": "structure", "members": { - "NO_PASSTHROUGH": { - "target": "smithy.api#Unit", + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", "traits": { - "smithy.api#enumValue": "NO_PASSTHROUGH" + "smithy.api#httpQuery": "maxResults" } }, - "PASSTHROUGH": { - "target": "smithy.api#Unit", + "NextToken": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#httpQuery": "nextToken" } } }, "traits": { - "smithy.api#documentation": "M3u8 Timed Metadata Behavior" + "smithy.api#documentation": "Placeholder documentation for ListInputSecurityGroupsRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#MaintenanceCreateSettings": { + "com.amazonaws.medialive#ListInputSecurityGroupsResponse": { "type": "structure", "members": { - "MaintenanceDay": { - "target": "com.amazonaws.medialive#MaintenanceDay", + "InputSecurityGroups": { + "target": "com.amazonaws.medialive#__listOfInputSecurityGroup", "traits": { - "smithy.api#documentation": "Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows.", - "smithy.api#jsonName": "maintenanceDay" + "smithy.api#documentation": "List of input security groups", + "smithy.api#jsonName": "inputSecurityGroups" } }, - "MaintenanceStartTime": { - "target": "com.amazonaws.medialive#__stringPattern010920300", + "NextToken": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows.", - "smithy.api#jsonName": "maintenanceStartTime" + "smithy.api#jsonName": "nextToken" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for MaintenanceCreateSettings" + "smithy.api#documentation": "Placeholder documentation for ListInputSecurityGroupsResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#MaintenanceDay": { - "type": "enum", - "members": { - "MONDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONDAY" - } + "com.amazonaws.medialive#ListInputs": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListInputsRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListInputsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "TUESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TUESDAY" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "WEDNESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEDNESDAY" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "THURSDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THURSDAY" - } + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" }, - "FRIDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FRIDAY" - } + { + "target": "com.amazonaws.medialive#InternalServerErrorException" }, - "SATURDAY": { - "target": "smithy.api#Unit", + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Produces list of inputs that have been created", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/inputs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Inputs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListInputsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", "traits": { - "smithy.api#enumValue": "SATURDAY" + "smithy.api#httpQuery": "maxResults" } }, - "SUNDAY": { - "target": "smithy.api#Unit", + "NextToken": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "SUNDAY" + "smithy.api#httpQuery": "nextToken" } } }, "traits": { - "smithy.api#documentation": "The currently selected maintenance day." + "smithy.api#documentation": "Placeholder documentation for ListInputsRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#MaintenanceStatus": { + "com.amazonaws.medialive#ListInputsResponse": { "type": "structure", "members": { - "MaintenanceDay": { - "target": "com.amazonaws.medialive#MaintenanceDay", + "Inputs": { + "target": "com.amazonaws.medialive#__listOfInput", "traits": { - "smithy.api#documentation": "The currently selected maintenance day.", - "smithy.api#jsonName": "maintenanceDay" + "smithy.api#jsonName": "inputs" } }, - "MaintenanceDeadline": { + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Maintenance is required by the displayed date and time. Date and time is in ISO.", - "smithy.api#jsonName": "maintenanceDeadline" + "smithy.api#jsonName": "nextToken" } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListInputsResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#ListMultiplexPrograms": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListMultiplexProgramsRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListMultiplexProgramsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "MaintenanceScheduledDate": { + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "List the programs that currently exist for a specific multiplex.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/multiplexes/{MultiplexId}/programs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MultiplexPrograms", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListMultiplexProgramsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of items to return.", + "smithy.api#httpQuery": "maxResults" + } + }, + "MultiplexId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The currently scheduled maintenance date and time. Date and time is in ISO.", - "smithy.api#jsonName": "maintenanceScheduledDate" + "smithy.api#documentation": "The ID of the multiplex that the programs belong to.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "MaintenanceStartTime": { + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The currently selected maintenance start time. Time is in UTC.", - "smithy.api#jsonName": "maintenanceStartTime" + "smithy.api#documentation": "The token to retrieve the next page of results.", + "smithy.api#httpQuery": "nextToken" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for MaintenanceStatus" + "smithy.api#documentation": "Placeholder documentation for ListMultiplexProgramsRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#MaintenanceUpdateSettings": { + "com.amazonaws.medialive#ListMultiplexProgramsResponse": { "type": "structure", "members": { - "MaintenanceDay": { - "target": "com.amazonaws.medialive#MaintenanceDay", + "MultiplexPrograms": { + "target": "com.amazonaws.medialive#__listOfMultiplexProgramSummary", "traits": { - "smithy.api#documentation": "Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows.", - "smithy.api#jsonName": "maintenanceDay" + "smithy.api#documentation": "List of multiplex programs.", + "smithy.api#jsonName": "multiplexPrograms" } }, - "MaintenanceScheduledDate": { + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Choose a specific date for maintenance to occur. The chosen date is used for the next maintenance window only.", - "smithy.api#jsonName": "maintenanceScheduledDate" - } - }, - "MaintenanceStartTime": { - "target": "com.amazonaws.medialive#__stringPattern010920300", - "traits": { - "smithy.api#documentation": "Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows.", - "smithy.api#jsonName": "maintenanceStartTime" + "smithy.api#documentation": "Token for the next ListMultiplexProgram request.", + "smithy.api#jsonName": "nextToken" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for MaintenanceUpdateSettings" + "smithy.api#documentation": "Placeholder documentation for ListMultiplexProgramsResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#MaxResults": { - "type": "integer", + "com.amazonaws.medialive#ListMultiplexes": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListMultiplexesRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListMultiplexesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], "traits": { - "smithy.api#documentation": "Placeholder documentation for MaxResults", - "smithy.api#range": { - "min": 1, - "max": 1000 + "smithy.api#documentation": "Retrieve a list of the existing multiplexes.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/multiplexes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Multiplexes", + "pageSize": "MaxResults" } } }, - "com.amazonaws.medialive#MediaConnectFlow": { + "com.amazonaws.medialive#ListMultiplexesRequest": { "type": "structure", "members": { - "FlowArn": { + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of items to return.", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique ARN of the MediaConnect Flow being used as a source.", - "smithy.api#jsonName": "flowArn" + "smithy.api#documentation": "The token to retrieve the next page of results.", + "smithy.api#httpQuery": "nextToken" } } }, "traits": { - "smithy.api#documentation": "The settings for a MediaConnect Flow." + "smithy.api#documentation": "Placeholder documentation for ListMultiplexesRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#MediaConnectFlowRequest": { + "com.amazonaws.medialive#ListMultiplexesResponse": { "type": "structure", "members": { - "FlowArn": { + "Multiplexes": { + "target": "com.amazonaws.medialive#__listOfMultiplexSummary", + "traits": { + "smithy.api#documentation": "List of multiplexes.", + "smithy.api#jsonName": "multiplexes" + } + }, + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ARN of the MediaConnect Flow that you want to use as a source.", - "smithy.api#jsonName": "flowArn" + "smithy.api#documentation": "Token for the next ListMultiplexes request.", + "smithy.api#jsonName": "nextToken" } } }, "traits": { - "smithy.api#documentation": "The settings for a MediaConnect Flow." + "smithy.api#documentation": "Placeholder documentation for ListMultiplexesResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#MediaLive": { - "type": "service", - "version": "2017-10-14", - "operations": [ - { - "target": "com.amazonaws.medialive#AcceptInputDeviceTransfer" - }, + "com.amazonaws.medialive#ListOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListOfferingsResponse" + }, + "errors": [ { - "target": "com.amazonaws.medialive#BatchDelete" + "target": "com.amazonaws.medialive#BadGatewayException" }, { - "target": "com.amazonaws.medialive#BatchStart" + "target": "com.amazonaws.medialive#BadRequestException" }, { - "target": "com.amazonaws.medialive#BatchStop" + "target": "com.amazonaws.medialive#ForbiddenException" }, { - "target": "com.amazonaws.medialive#BatchUpdateSchedule" + "target": "com.amazonaws.medialive#GatewayTimeoutException" }, { - "target": "com.amazonaws.medialive#CancelInputDeviceTransfer" + "target": "com.amazonaws.medialive#InternalServerErrorException" }, { - "target": "com.amazonaws.medialive#ClaimDevice" + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "List offerings available for purchase.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/offerings", + "code": 200 }, - { - "target": "com.amazonaws.medialive#CreateChannel" + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Offerings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListOfferingsRequest": { + "type": "structure", + "members": { + "ChannelClass": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'", + "smithy.api#httpQuery": "channelClass" + } }, - { - "target": "com.amazonaws.medialive#CreateInput" + "ChannelConfiguration": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)", + "smithy.api#httpQuery": "channelConfiguration" + } }, - { - "target": "com.amazonaws.medialive#CreateInputSecurityGroup" + "Codec": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'", + "smithy.api#httpQuery": "codec" + } }, - { - "target": "com.amazonaws.medialive#CreateMultiplex" + "Duration": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by offering duration, e.g. '12'", + "smithy.api#httpQuery": "duration" + } }, - { - "target": "com.amazonaws.medialive#CreateMultiplexProgram" + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" + } }, - { - "target": "com.amazonaws.medialive#CreatePartnerInput" + "MaximumBitrate": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'", + "smithy.api#httpQuery": "maximumBitrate" + } }, - { - "target": "com.amazonaws.medialive#CreateTags" + "MaximumFramerate": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'", + "smithy.api#httpQuery": "maximumFramerate" + } }, - { - "target": "com.amazonaws.medialive#DeleteChannel" + "NextToken": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#httpQuery": "nextToken" + } }, - { - "target": "com.amazonaws.medialive#DeleteInput" + "Resolution": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'", + "smithy.api#httpQuery": "resolution" + } }, - { - "target": "com.amazonaws.medialive#DeleteInputSecurityGroup" + "ResourceType": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'", + "smithy.api#httpQuery": "resourceType" + } }, - { - "target": "com.amazonaws.medialive#DeleteMultiplex" + "SpecialFeature": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'", + "smithy.api#httpQuery": "specialFeature" + } }, - { - "target": "com.amazonaws.medialive#DeleteMultiplexProgram" + "VideoQuality": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'", + "smithy.api#httpQuery": "videoQuality" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListOfferingsRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#ListOfferingsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Token to retrieve the next page of results", + "smithy.api#jsonName": "nextToken" + } }, + "Offerings": { + "target": "com.amazonaws.medialive#__listOfOffering", + "traits": { + "smithy.api#documentation": "List of offerings", + "smithy.api#jsonName": "offerings" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListOfferingsResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#ListReservations": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListReservationsRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListReservationsResponse" + }, + "errors": [ { - "target": "com.amazonaws.medialive#DeleteReservation" + "target": "com.amazonaws.medialive#BadGatewayException" }, { - "target": "com.amazonaws.medialive#DeleteSchedule" + "target": "com.amazonaws.medialive#BadRequestException" }, { - "target": "com.amazonaws.medialive#DeleteTags" + "target": "com.amazonaws.medialive#ForbiddenException" }, { - "target": "com.amazonaws.medialive#DescribeAccountConfiguration" + "target": "com.amazonaws.medialive#GatewayTimeoutException" }, { - "target": "com.amazonaws.medialive#DescribeChannel" + "target": "com.amazonaws.medialive#InternalServerErrorException" }, { - "target": "com.amazonaws.medialive#DescribeInput" + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "List purchased reservations.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/reservations", + "code": 200 }, - { - "target": "com.amazonaws.medialive#DescribeInputDevice" + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Reservations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListReservationsRequest": { + "type": "structure", + "members": { + "ChannelClass": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'", + "smithy.api#httpQuery": "channelClass" + } }, - { - "target": "com.amazonaws.medialive#DescribeInputDeviceThumbnail" + "Codec": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'", + "smithy.api#httpQuery": "codec" + } }, - { - "target": "com.amazonaws.medialive#DescribeInputSecurityGroup" + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" + } }, - { - "target": "com.amazonaws.medialive#DescribeMultiplex" + "MaximumBitrate": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'", + "smithy.api#httpQuery": "maximumBitrate" + } }, - { - "target": "com.amazonaws.medialive#DescribeMultiplexProgram" + "MaximumFramerate": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'", + "smithy.api#httpQuery": "maximumFramerate" + } }, - { - "target": "com.amazonaws.medialive#DescribeOffering" + "NextToken": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#httpQuery": "nextToken" + } }, - { - "target": "com.amazonaws.medialive#DescribeReservation" - }, - { - "target": "com.amazonaws.medialive#DescribeSchedule" - }, - { - "target": "com.amazonaws.medialive#DescribeThumbnails" - }, - { - "target": "com.amazonaws.medialive#ListChannels" - }, - { - "target": "com.amazonaws.medialive#ListInputDevices" + "Resolution": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'", + "smithy.api#httpQuery": "resolution" + } }, - { - "target": "com.amazonaws.medialive#ListInputDeviceTransfers" + "ResourceType": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'", + "smithy.api#httpQuery": "resourceType" + } }, - { - "target": "com.amazonaws.medialive#ListInputs" + "SpecialFeature": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'", + "smithy.api#httpQuery": "specialFeature" + } }, - { - "target": "com.amazonaws.medialive#ListInputSecurityGroups" + "VideoQuality": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'", + "smithy.api#httpQuery": "videoQuality" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListReservationsRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#ListReservationsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Token to retrieve the next page of results", + "smithy.api#jsonName": "nextToken" + } }, + "Reservations": { + "target": "com.amazonaws.medialive#__listOfReservation", + "traits": { + "smithy.api#documentation": "List of reservations", + "smithy.api#jsonName": "reservations" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListReservationsResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#ListSignalMaps": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListSignalMapsRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListSignalMapsResponse" + }, + "errors": [ { - "target": "com.amazonaws.medialive#ListMultiplexes" + "target": "com.amazonaws.medialive#BadRequestException" }, { - "target": "com.amazonaws.medialive#ListMultiplexPrograms" + "target": "com.amazonaws.medialive#ForbiddenException" }, { - "target": "com.amazonaws.medialive#ListOfferings" + "target": "com.amazonaws.medialive#InternalServerErrorException" }, { - "target": "com.amazonaws.medialive#ListReservations" + "target": "com.amazonaws.medialive#NotFoundException" }, { - "target": "com.amazonaws.medialive#ListTagsForResource" + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Lists signal maps.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/signal-maps", + "code": 200 }, - { - "target": "com.amazonaws.medialive#PurchaseOffering" + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SignalMaps", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListSignalMapsRequest": { + "type": "structure", + "members": { + "CloudWatchAlarmTemplateGroupIdentifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name.", + "smithy.api#httpQuery": "cloudWatchAlarmTemplateGroupIdentifier" + } }, - { - "target": "com.amazonaws.medialive#RebootInputDevice" + "EventBridgeRuleTemplateGroupIdentifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name.", + "smithy.api#httpQuery": "eventBridgeRuleTemplateGroupIdentifier" + } }, - { - "target": "com.amazonaws.medialive#RejectInputDeviceTransfer" + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" + } }, - { - "target": "com.amazonaws.medialive#RestartChannelPipelines" + "NextToken": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "A token used to retrieve the next set of results in paginated list responses.", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListSignalMapsRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#ListSignalMapsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", + "traits": { + "smithy.api#documentation": "A token used to retrieve the next set of results in paginated list responses.", + "smithy.api#jsonName": "nextToken" + } }, + "SignalMaps": { + "target": "com.amazonaws.medialive#__listOfSignalMapSummary", + "traits": { + "smithy.api#jsonName": "signalMaps" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListSignalMapsResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListTagsForResourceResponse" + }, + "errors": [ { - "target": "com.amazonaws.medialive#StartChannel" + "target": "com.amazonaws.medialive#BadRequestException" }, { - "target": "com.amazonaws.medialive#StartInputDevice" + "target": "com.amazonaws.medialive#ForbiddenException" }, { - "target": "com.amazonaws.medialive#StartInputDeviceMaintenanceWindow" + "target": "com.amazonaws.medialive#InternalServerErrorException" }, { - "target": "com.amazonaws.medialive#StartMultiplex" + "target": "com.amazonaws.medialive#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Produces list of tags that have been created for a resource", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.medialive#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListTagsForResourceRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListTagsForResourceResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#LogLevel": { + "type": "enum", + "members": { + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } }, - { - "target": "com.amazonaws.medialive#StopChannel" + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARNING" + } }, - { - "target": "com.amazonaws.medialive#StopInputDevice" + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } }, - { - "target": "com.amazonaws.medialive#StopMultiplex" + "DEBUG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG" + } }, - { - "target": "com.amazonaws.medialive#TransferInputDevice" + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "The log level the user wants for their channel." + } + }, + "com.amazonaws.medialive#M2tsAbsentInputAudioBehavior": { + "type": "enum", + "members": { + "DROP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DROP" + } }, - { - "target": "com.amazonaws.medialive#UpdateAccountConfiguration" + "ENCODE_SILENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCODE_SILENCE" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Absent Input Audio Behavior" + } + }, + "com.amazonaws.medialive#M2tsArib": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } }, - { - "target": "com.amazonaws.medialive#UpdateChannel" + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Arib" + } + }, + "com.amazonaws.medialive#M2tsAribCaptionsPidControl": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } }, - { - "target": "com.amazonaws.medialive#UpdateChannelClass" + "USE_CONFIGURED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USE_CONFIGURED" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Arib Captions Pid Control" + } + }, + "com.amazonaws.medialive#M2tsAudioBufferModel": { + "type": "enum", + "members": { + "ATSC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATSC" + } }, - { - "target": "com.amazonaws.medialive#UpdateInput" + "DVB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DVB" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Audio Buffer Model" + } + }, + "com.amazonaws.medialive#M2tsAudioInterval": { + "type": "enum", + "members": { + "VIDEO_AND_FIXED_INTERVALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO_AND_FIXED_INTERVALS" + } }, - { - "target": "com.amazonaws.medialive#UpdateInputDevice" + "VIDEO_INTERVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO_INTERVAL" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Audio Interval" + } + }, + "com.amazonaws.medialive#M2tsAudioStreamType": { + "type": "enum", + "members": { + "ATSC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATSC" + } }, - { - "target": "com.amazonaws.medialive#UpdateInputSecurityGroup" + "DVB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DVB" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Audio Stream Type" + } + }, + "com.amazonaws.medialive#M2tsBufferModel": { + "type": "enum", + "members": { + "MULTIPLEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTIPLEX" + } }, - { - "target": "com.amazonaws.medialive#UpdateMultiplex" + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Buffer Model" + } + }, + "com.amazonaws.medialive#M2tsCcDescriptor": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } }, - { - "target": "com.amazonaws.medialive#UpdateMultiplexProgram" + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Cc Descriptor" + } + }, + "com.amazonaws.medialive#M2tsEbifControl": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } }, - { - "target": "com.amazonaws.medialive#UpdateReservation" + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } } - ], + }, "traits": { - "aws.api#service": { - "sdkId": "MediaLive", - "arnNamespace": "medialive", - "cloudFormationName": "MediaLive", - "cloudTrailEventSource": "medialive.amazonaws.com", - "endpointPrefix": "medialive" + "smithy.api#documentation": "M2ts Ebif Control" + } + }, + "com.amazonaws.medialive#M2tsEbpPlacement": { + "type": "enum", + "members": { + "VIDEO_AND_AUDIO_PIDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO_AND_AUDIO_PIDS" + } }, - "aws.auth#sigv4": { - "name": "medialive" + "VIDEO_PID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO_PID" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Ebp Placement" + } + }, + "com.amazonaws.medialive#M2tsEsRateInPes": { + "type": "enum", + "members": { + "EXCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUDE" + } }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "API for AWS Elemental MediaLive", - "smithy.api#title": "AWS Elemental MediaLive", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Es Rate In Pes" + } + }, + "com.amazonaws.medialive#M2tsKlv": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Klv" + } + }, + "com.amazonaws.medialive#M2tsNielsenId3Behavior": { + "type": "enum", + "members": { + "NO_PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_PASSTHROUGH" + } + }, + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Nielsen Id3 Behavior" + } + }, + "com.amazonaws.medialive#M2tsPcrControl": { + "type": "enum", + "members": { + "CONFIGURED_PCR_PERIOD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFIGURED_PCR_PERIOD" + } + }, + "PCR_EVERY_PES_PACKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PCR_EVERY_PES_PACKET" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Pcr Control" + } + }, + "com.amazonaws.medialive#M2tsRateMode": { + "type": "enum", + "members": { + "CBR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CBR" + } + }, + "VBR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VBR" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Rate Mode" + } + }, + "com.amazonaws.medialive#M2tsScte35Control": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Scte35 Control" + } + }, + "com.amazonaws.medialive#M2tsSegmentationMarkers": { + "type": "enum", + "members": { + "EBP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBP" + } + }, + "EBP_LEGACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBP_LEGACY" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "PSI_SEGSTART": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PSI_SEGSTART" + } + }, + "RAI_ADAPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RAI_ADAPT" + } + }, + "RAI_SEGSTART": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RAI_SEGSTART" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Segmentation Markers" + } + }, + "com.amazonaws.medialive#M2tsSegmentationStyle": { + "type": "enum", + "members": { + "MAINTAIN_CADENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAINTAIN_CADENCE" + } + }, + "RESET_CADENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESET_CADENCE" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Segmentation Style" + } + }, + "com.amazonaws.medialive#M2tsSettings": { + "type": "structure", + "members": { + "AbsentInputAudioBehavior": { + "target": "com.amazonaws.medialive#M2tsAbsentInputAudioBehavior", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "absentInputAudioBehavior" + } + }, + "Arib": { + "target": "com.amazonaws.medialive#M2tsArib", + "traits": { + "smithy.api#documentation": "When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.", + "smithy.api#jsonName": "arib" + } + }, + "AribCaptionsPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "aribCaptionsPid" + } + }, + "AribCaptionsPidControl": { + "target": "com.amazonaws.medialive#M2tsAribCaptionsPidControl", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "aribCaptionsPidControl" + } + }, + "AudioBufferModel": { + "target": "com.amazonaws.medialive#M2tsAudioBufferModel", + "traits": { + "smithy.api#documentation": "When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.", + "smithy.api#jsonName": "audioBufferModel" + } + }, + "AudioFramesPerPes": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "The number of audio frames to insert for each PES packet.", + "smithy.api#jsonName": "audioFramesPerPes" + } + }, + "AudioPids": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "audioPids" + } + }, + "AudioStreamType": { + "target": "com.amazonaws.medialive#M2tsAudioStreamType", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "audioStreamType" + } + }, + "Bitrate": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.", + "smithy.api#jsonName": "bitrate" + } + }, + "BufferModel": { + "target": "com.amazonaws.medialive#M2tsBufferModel", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "bufferModel" + } + }, + "CcDescriptor": { + "target": "com.amazonaws.medialive#M2tsCcDescriptor", + "traits": { + "smithy.api#documentation": "When set to enabled, generates captionServiceDescriptor in PMT.", + "smithy.api#jsonName": "ccDescriptor" + } + }, + "DvbNitSettings": { + "target": "com.amazonaws.medialive#DvbNitSettings", + "traits": { + "smithy.api#documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbNitSettings" + } + }, + "DvbSdtSettings": { + "target": "com.amazonaws.medialive#DvbSdtSettings", + "traits": { + "smithy.api#documentation": "Inserts DVB Service Description Table (SDT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbSdtSettings" + } + }, + "DvbSubPids": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "dvbSubPids" + } + }, + "DvbTdtSettings": { + "target": "com.amazonaws.medialive#DvbTdtSettings", + "traits": { + "smithy.api#documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbTdtSettings" + } + }, + "DvbTeletextPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "dvbTeletextPid" + } + }, + "Ebif": { + "target": "com.amazonaws.medialive#M2tsEbifControl", + "traits": { + "smithy.api#documentation": "If set to passthrough, passes any EBIF data from the input source to this output.", + "smithy.api#jsonName": "ebif" + } + }, + "EbpAudioInterval": { + "target": "com.amazonaws.medialive#M2tsAudioInterval", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "ebpAudioInterval" + } + }, + "EbpLookaheadMs": { + "target": "com.amazonaws.medialive#__integerMin0Max10000", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "ebpLookaheadMs" + } + }, + "EbpPlacement": { + "target": "com.amazonaws.medialive#M2tsEbpPlacement", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "ebpPlacement" + } + }, + "EcmPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "This field is unused and deprecated.", + "smithy.api#jsonName": "ecmPid" + } + }, + "EsRateInPes": { + "target": "com.amazonaws.medialive#M2tsEsRateInPes", + "traits": { + "smithy.api#documentation": "Include or exclude the ES Rate field in the PES header.", + "smithy.api#jsonName": "esRateInPes" + } + }, + "EtvPlatformPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "etvPlatformPid" + } + }, + "EtvSignalPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "etvSignalPid" + } + }, + "FragmentTime": { + "target": "com.amazonaws.medialive#__doubleMin0", + "traits": { + "smithy.api#documentation": "The length in seconds of each fragment. Only used with EBP markers.", + "smithy.api#jsonName": "fragmentTime" + } + }, + "Klv": { + "target": "com.amazonaws.medialive#M2tsKlv", + "traits": { + "smithy.api#documentation": "If set to passthrough, passes any KLV data from the input source to this output.", + "smithy.api#jsonName": "klv" + } + }, + "KlvDataPids": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "klvDataPids" + } + }, + "NielsenId3Behavior": { + "target": "com.amazonaws.medialive#M2tsNielsenId3Behavior", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "nielsenId3Behavior" + } + }, + "NullPacketBitrate": { + "target": "com.amazonaws.medialive#__doubleMin0", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "nullPacketBitrate" + } + }, + "PatInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max1000", + "traits": { + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.", + "smithy.api#jsonName": "patInterval" + } + }, + "PcrControl": { + "target": "com.amazonaws.medialive#M2tsPcrControl", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "pcrControl" + } + }, + "PcrPeriod": { + "target": "com.amazonaws.medialive#__integerMin0Max500", + "traits": { + "smithy.api#documentation": "Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.", + "smithy.api#jsonName": "pcrPeriod" + } + }, + "PcrPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "pcrPid" + } + }, + "PmtInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max1000", + "traits": { + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.", + "smithy.api#jsonName": "pmtInterval" + } + }, + "PmtPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "pmtPid" + } + }, + "ProgramNum": { + "target": "com.amazonaws.medialive#__integerMin0Max65535", + "traits": { + "smithy.api#documentation": "The value of the program number field in the Program Map Table.", + "smithy.api#jsonName": "programNum" + } + }, + "RateMode": { + "target": "com.amazonaws.medialive#M2tsRateMode", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "rateMode" + } + }, + "Scte27Pids": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "scte27Pids" + } + }, + "Scte35Control": { + "target": "com.amazonaws.medialive#M2tsScte35Control", + "traits": { + "smithy.api#documentation": "Optionally pass SCTE-35 signals from the input source to this output.", + "smithy.api#jsonName": "scte35Control" + } + }, + "Scte35Pid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "scte35Pid" + } + }, + "SegmentationMarkers": { + "target": "com.amazonaws.medialive#M2tsSegmentationMarkers", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "segmentationMarkers" + } + }, + "SegmentationStyle": { + "target": "com.amazonaws.medialive#M2tsSegmentationStyle", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "segmentationStyle" + } + }, + "SegmentationTime": { + "target": "com.amazonaws.medialive#__doubleMin1", + "traits": { + "smithy.api#documentation": "The length in seconds of each segment. Required unless markers is set to _none_.", + "smithy.api#jsonName": "segmentationTime" + } + }, + "TimedMetadataBehavior": { + "target": "com.amazonaws.medialive#M2tsTimedMetadataBehavior", + "traits": { + "smithy.api#documentation": "When set to passthrough, timed metadata will be passed through from input to output.", + "smithy.api#jsonName": "timedMetadataBehavior" + } + }, + "TimedMetadataPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "timedMetadataPid" + } + }, + "TransportStreamId": { + "target": "com.amazonaws.medialive#__integerMin0Max65535", + "traits": { + "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", + "smithy.api#jsonName": "transportStreamId" + } + }, + "VideoPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "videoPid" + } + }, + "Scte35PrerollPullupMilliseconds": { + "target": "com.amazonaws.medialive#__doubleMin0Max5000", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "scte35PrerollPullupMilliseconds" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Settings" + } + }, + "com.amazonaws.medialive#M2tsTimedMetadataBehavior": { + "type": "enum", + "members": { + "NO_PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_PASSTHROUGH" + } + }, + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } + } + }, + "traits": { + "smithy.api#documentation": "M2ts Timed Metadata Behavior" + } + }, + "com.amazonaws.medialive#M3u8KlvBehavior": { + "type": "enum", + "members": { + "NO_PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_PASSTHROUGH" + } + }, + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } + } + }, + "traits": { + "smithy.api#documentation": "M3u8 Klv Behavior" + } + }, + "com.amazonaws.medialive#M3u8NielsenId3Behavior": { + "type": "enum", + "members": { + "NO_PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_PASSTHROUGH" + } + }, + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } + } + }, + "traits": { + "smithy.api#documentation": "M3u8 Nielsen Id3 Behavior" + } + }, + "com.amazonaws.medialive#M3u8PcrControl": { + "type": "enum", + "members": { + "CONFIGURED_PCR_PERIOD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFIGURED_PCR_PERIOD" + } + }, + "PCR_EVERY_PES_PACKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PCR_EVERY_PES_PACKET" + } + } + }, + "traits": { + "smithy.api#documentation": "M3u8 Pcr Control" + } + }, + "com.amazonaws.medialive#M3u8Scte35Behavior": { + "type": "enum", + "members": { + "NO_PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_PASSTHROUGH" + } + }, + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } + } + }, + "traits": { + "smithy.api#documentation": "M3u8 Scte35 Behavior" + } + }, + "com.amazonaws.medialive#M3u8Settings": { + "type": "structure", + "members": { + "AudioFramesPerPes": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "The number of audio frames to insert for each PES packet.", + "smithy.api#jsonName": "audioFramesPerPes" + } + }, + "AudioPids": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "audioPids" + } + }, + "EcmPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "This parameter is unused and deprecated.", + "smithy.api#jsonName": "ecmPid" + } + }, + "NielsenId3Behavior": { + "target": "com.amazonaws.medialive#M3u8NielsenId3Behavior", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "nielsenId3Behavior" + } + }, + "PatInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max1000", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "patInterval" + } + }, + "PcrControl": { + "target": "com.amazonaws.medialive#M3u8PcrControl", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "pcrControl" + } + }, + "PcrPeriod": { + "target": "com.amazonaws.medialive#__integerMin0Max500", + "traits": { + "smithy.api#documentation": "Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.", + "smithy.api#jsonName": "pcrPeriod" + } + }, + "PcrPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "pcrPid" + } + }, + "PmtInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max1000", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "pmtInterval" + } + }, + "PmtPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.", + "smithy.api#jsonName": "pmtPid" + } + }, + "ProgramNum": { + "target": "com.amazonaws.medialive#__integerMin0Max65535", + "traits": { + "smithy.api#documentation": "The value of the program number field in the Program Map Table.", + "smithy.api#jsonName": "programNum" + } + }, + "Scte35Behavior": { + "target": "com.amazonaws.medialive#M3u8Scte35Behavior", + "traits": { + "smithy.api#documentation": "If set to passthrough, passes any SCTE-35 signals from the input source to this output.", + "smithy.api#jsonName": "scte35Behavior" + } + }, + "Scte35Pid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.", + "smithy.api#jsonName": "scte35Pid" + } + }, + "TimedMetadataBehavior": { + "target": "com.amazonaws.medialive#M3u8TimedMetadataBehavior", + "traits": { + "smithy.api#documentation": "When set to passthrough, timed metadata is passed through from input to output.", + "smithy.api#jsonName": "timedMetadataBehavior" + } + }, + "TimedMetadataPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "timedMetadataPid" + } + }, + "TransportStreamId": { + "target": "com.amazonaws.medialive#__integerMin0Max65535", + "traits": { + "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", + "smithy.api#jsonName": "transportStreamId" + } + }, + "VideoPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.", + "smithy.api#jsonName": "videoPid" + } + }, + "KlvBehavior": { + "target": "com.amazonaws.medialive#M3u8KlvBehavior", + "traits": { + "smithy.api#documentation": "If set to passthrough, passes any KLV data from the input source to this output.", + "smithy.api#jsonName": "klvBehavior" + } + }, + "KlvDataPids": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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).", + "smithy.api#jsonName": "klvDataPids" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings information for the .m3u8 container" + } + }, + "com.amazonaws.medialive#M3u8TimedMetadataBehavior": { + "type": "enum", + "members": { + "NO_PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_PASSTHROUGH" + } + }, + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } + } + }, + "traits": { + "smithy.api#documentation": "M3u8 Timed Metadata Behavior" + } + }, + "com.amazonaws.medialive#MaintenanceCreateSettings": { + "type": "structure", + "members": { + "MaintenanceDay": { + "target": "com.amazonaws.medialive#MaintenanceDay", + "traits": { + "smithy.api#documentation": "Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows.", + "smithy.api#jsonName": "maintenanceDay" + } + }, + "MaintenanceStartTime": { + "target": "com.amazonaws.medialive#__stringPattern010920300", + "traits": { + "smithy.api#documentation": "Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows.", + "smithy.api#jsonName": "maintenanceStartTime" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for MaintenanceCreateSettings" + } + }, + "com.amazonaws.medialive#MaintenanceDay": { + "type": "enum", + "members": { + "MONDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONDAY" + } + }, + "TUESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TUESDAY" + } + }, + "WEDNESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEDNESDAY" + } + }, + "THURSDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THURSDAY" + } + }, + "FRIDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRIDAY" + } + }, + "SATURDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SATURDAY" + } + }, + "SUNDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUNDAY" + } + } + }, + "traits": { + "smithy.api#documentation": "The currently selected maintenance day." + } + }, + "com.amazonaws.medialive#MaintenanceStatus": { + "type": "structure", + "members": { + "MaintenanceDay": { + "target": "com.amazonaws.medialive#MaintenanceDay", + "traits": { + "smithy.api#documentation": "The currently selected maintenance day.", + "smithy.api#jsonName": "maintenanceDay" + } + }, + "MaintenanceDeadline": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Maintenance is required by the displayed date and time. Date and time is in ISO.", + "smithy.api#jsonName": "maintenanceDeadline" + } + }, + "MaintenanceScheduledDate": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The currently scheduled maintenance date and time. Date and time is in ISO.", + "smithy.api#jsonName": "maintenanceScheduledDate" + } + }, + "MaintenanceStartTime": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The currently selected maintenance start time. Time is in UTC.", + "smithy.api#jsonName": "maintenanceStartTime" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for MaintenanceStatus" + } + }, + "com.amazonaws.medialive#MaintenanceUpdateSettings": { + "type": "structure", + "members": { + "MaintenanceDay": { + "target": "com.amazonaws.medialive#MaintenanceDay", + "traits": { + "smithy.api#documentation": "Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows.", + "smithy.api#jsonName": "maintenanceDay" + } + }, + "MaintenanceScheduledDate": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Choose a specific date for maintenance to occur. The chosen date is used for the next maintenance window only.", + "smithy.api#jsonName": "maintenanceScheduledDate" + } + }, + "MaintenanceStartTime": { + "target": "com.amazonaws.medialive#__stringPattern010920300", + "traits": { + "smithy.api#documentation": "Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows.", + "smithy.api#jsonName": "maintenanceStartTime" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for MaintenanceUpdateSettings" + } + }, + "com.amazonaws.medialive#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Placeholder documentation for MaxResults", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.medialive#MediaConnectFlow": { + "type": "structure", + "members": { + "FlowArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ARN of the MediaConnect Flow being used as a source.", + "smithy.api#jsonName": "flowArn" + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for a MediaConnect Flow." + } + }, + "com.amazonaws.medialive#MediaConnectFlowRequest": { + "type": "structure", + "members": { + "FlowArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ARN of the MediaConnect Flow that you want to use as a source.", + "smithy.api#jsonName": "flowArn" + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for a MediaConnect Flow." + } + }, + "com.amazonaws.medialive#MediaLive": { + "type": "service", + "version": "2017-10-14", + "operations": [ + { + "target": "com.amazonaws.medialive#AcceptInputDeviceTransfer" + }, + { + "target": "com.amazonaws.medialive#BatchDelete" + }, + { + "target": "com.amazonaws.medialive#BatchStart" + }, + { + "target": "com.amazonaws.medialive#BatchStop" + }, + { + "target": "com.amazonaws.medialive#BatchUpdateSchedule" + }, + { + "target": "com.amazonaws.medialive#CancelInputDeviceTransfer" + }, + { + "target": "com.amazonaws.medialive#ClaimDevice" + }, + { + "target": "com.amazonaws.medialive#CreateChannel" + }, + { + "target": "com.amazonaws.medialive#CreateCloudWatchAlarmTemplate" + }, + { + "target": "com.amazonaws.medialive#CreateCloudWatchAlarmTemplateGroup" + }, + { + "target": "com.amazonaws.medialive#CreateEventBridgeRuleTemplate" + }, + { + "target": "com.amazonaws.medialive#CreateEventBridgeRuleTemplateGroup" + }, + { + "target": "com.amazonaws.medialive#CreateInput" + }, + { + "target": "com.amazonaws.medialive#CreateInputSecurityGroup" + }, + { + "target": "com.amazonaws.medialive#CreateMultiplex" + }, + { + "target": "com.amazonaws.medialive#CreateMultiplexProgram" + }, + { + "target": "com.amazonaws.medialive#CreatePartnerInput" + }, + { + "target": "com.amazonaws.medialive#CreateSignalMap" + }, + { + "target": "com.amazonaws.medialive#CreateTags" + }, + { + "target": "com.amazonaws.medialive#DeleteChannel" + }, + { + "target": "com.amazonaws.medialive#DeleteCloudWatchAlarmTemplate" + }, + { + "target": "com.amazonaws.medialive#DeleteCloudWatchAlarmTemplateGroup" + }, + { + "target": "com.amazonaws.medialive#DeleteEventBridgeRuleTemplate" + }, + { + "target": "com.amazonaws.medialive#DeleteEventBridgeRuleTemplateGroup" + }, + { + "target": "com.amazonaws.medialive#DeleteInput" + }, + { + "target": "com.amazonaws.medialive#DeleteInputSecurityGroup" + }, + { + "target": "com.amazonaws.medialive#DeleteMultiplex" + }, + { + "target": "com.amazonaws.medialive#DeleteMultiplexProgram" + }, + { + "target": "com.amazonaws.medialive#DeleteReservation" + }, + { + "target": "com.amazonaws.medialive#DeleteSchedule" + }, + { + "target": "com.amazonaws.medialive#DeleteSignalMap" + }, + { + "target": "com.amazonaws.medialive#DeleteTags" + }, + { + "target": "com.amazonaws.medialive#DescribeAccountConfiguration" + }, + { + "target": "com.amazonaws.medialive#DescribeChannel" + }, + { + "target": "com.amazonaws.medialive#DescribeInput" + }, + { + "target": "com.amazonaws.medialive#DescribeInputDevice" + }, + { + "target": "com.amazonaws.medialive#DescribeInputDeviceThumbnail" + }, + { + "target": "com.amazonaws.medialive#DescribeInputSecurityGroup" + }, + { + "target": "com.amazonaws.medialive#DescribeMultiplex" + }, + { + "target": "com.amazonaws.medialive#DescribeMultiplexProgram" + }, + { + "target": "com.amazonaws.medialive#DescribeOffering" + }, + { + "target": "com.amazonaws.medialive#DescribeReservation" + }, + { + "target": "com.amazonaws.medialive#DescribeSchedule" + }, + { + "target": "com.amazonaws.medialive#DescribeThumbnails" + }, + { + "target": "com.amazonaws.medialive#GetCloudWatchAlarmTemplate" + }, + { + "target": "com.amazonaws.medialive#GetCloudWatchAlarmTemplateGroup" + }, + { + "target": "com.amazonaws.medialive#GetEventBridgeRuleTemplate" + }, + { + "target": "com.amazonaws.medialive#GetEventBridgeRuleTemplateGroup" + }, + { + "target": "com.amazonaws.medialive#GetSignalMap" + }, + { + "target": "com.amazonaws.medialive#ListChannels" + }, + { + "target": "com.amazonaws.medialive#ListCloudWatchAlarmTemplateGroups" + }, + { + "target": "com.amazonaws.medialive#ListCloudWatchAlarmTemplates" + }, + { + "target": "com.amazonaws.medialive#ListEventBridgeRuleTemplateGroups" + }, + { + "target": "com.amazonaws.medialive#ListEventBridgeRuleTemplates" + }, + { + "target": "com.amazonaws.medialive#ListInputDevices" + }, + { + "target": "com.amazonaws.medialive#ListInputDeviceTransfers" + }, + { + "target": "com.amazonaws.medialive#ListInputs" + }, + { + "target": "com.amazonaws.medialive#ListInputSecurityGroups" + }, + { + "target": "com.amazonaws.medialive#ListMultiplexes" + }, + { + "target": "com.amazonaws.medialive#ListMultiplexPrograms" + }, + { + "target": "com.amazonaws.medialive#ListOfferings" + }, + { + "target": "com.amazonaws.medialive#ListReservations" + }, + { + "target": "com.amazonaws.medialive#ListSignalMaps" + }, + { + "target": "com.amazonaws.medialive#ListTagsForResource" + }, + { + "target": "com.amazonaws.medialive#PurchaseOffering" + }, + { + "target": "com.amazonaws.medialive#RebootInputDevice" + }, + { + "target": "com.amazonaws.medialive#RejectInputDeviceTransfer" + }, + { + "target": "com.amazonaws.medialive#RestartChannelPipelines" + }, + { + "target": "com.amazonaws.medialive#StartChannel" + }, + { + "target": "com.amazonaws.medialive#StartDeleteMonitorDeployment" + }, + { + "target": "com.amazonaws.medialive#StartInputDevice" + }, + { + "target": "com.amazonaws.medialive#StartInputDeviceMaintenanceWindow" + }, + { + "target": "com.amazonaws.medialive#StartMonitorDeployment" + }, + { + "target": "com.amazonaws.medialive#StartMultiplex" + }, + { + "target": "com.amazonaws.medialive#StartUpdateSignalMap" + }, + { + "target": "com.amazonaws.medialive#StopChannel" + }, + { + "target": "com.amazonaws.medialive#StopInputDevice" + }, + { + "target": "com.amazonaws.medialive#StopMultiplex" + }, + { + "target": "com.amazonaws.medialive#TransferInputDevice" + }, + { + "target": "com.amazonaws.medialive#UpdateAccountConfiguration" + }, + { + "target": "com.amazonaws.medialive#UpdateChannel" + }, + { + "target": "com.amazonaws.medialive#UpdateChannelClass" + }, + { + "target": "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplate" + }, + { + "target": "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplateGroup" + }, + { + "target": "com.amazonaws.medialive#UpdateEventBridgeRuleTemplate" + }, + { + "target": "com.amazonaws.medialive#UpdateEventBridgeRuleTemplateGroup" + }, + { + "target": "com.amazonaws.medialive#UpdateInput" + }, + { + "target": "com.amazonaws.medialive#UpdateInputDevice" + }, + { + "target": "com.amazonaws.medialive#UpdateInputSecurityGroup" + }, + { + "target": "com.amazonaws.medialive#UpdateMultiplex" + }, + { + "target": "com.amazonaws.medialive#UpdateMultiplexProgram" + }, + { + "target": "com.amazonaws.medialive#UpdateReservation" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "MediaLive", + "arnNamespace": "medialive", + "cloudFormationName": "MediaLive", + "cloudTrailEventSource": "medialive.amazonaws.com", + "endpointPrefix": "medialive" + }, + "aws.auth#sigv4": { + "name": "medialive" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "API for AWS Elemental MediaLive", + "smithy.api#title": "AWS Elemental MediaLive", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" } ] } @@ -18116,3027 +21373,4816 @@ } } }, - "com.amazonaws.medialive#MediaPackageGroupSettings": { + "com.amazonaws.medialive#MediaPackageGroupSettings": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.medialive#OutputLocationRef", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "MediaPackage channel destination.", + "smithy.api#jsonName": "destination", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Media Package Group Settings" + } + }, + "com.amazonaws.medialive#MediaPackageOutputDestinationSettings": { + "type": "structure", + "members": { + "ChannelId": { + "target": "com.amazonaws.medialive#__stringMin1", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "channelId" + } + } + }, + "traits": { + "smithy.api#documentation": "MediaPackage Output Destination Settings" + } + }, + "com.amazonaws.medialive#MediaPackageOutputSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Media Package Output Settings" + } + }, + "com.amazonaws.medialive#MediaResource": { + "type": "structure", + "members": { + "Destinations": { + "target": "com.amazonaws.medialive#__listOfMediaResourceNeighbor", + "traits": { + "smithy.api#jsonName": "destinations" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max256", + "traits": { + "smithy.api#documentation": "The logical name of an AWS media resource.", + "smithy.api#jsonName": "name" + } + }, + "Sources": { + "target": "com.amazonaws.medialive#__listOfMediaResourceNeighbor", + "traits": { + "smithy.api#jsonName": "sources" + } + } + }, + "traits": { + "smithy.api#documentation": "An AWS resource used in media workflows." + } + }, + "com.amazonaws.medialive#MediaResourceMap": { + "type": "map", + "key": { + "target": "com.amazonaws.medialive#__string" + }, + "value": { + "target": "com.amazonaws.medialive#MediaResource" + }, + "traits": { + "smithy.api#documentation": "A map representing an AWS media workflow as a graph." + } + }, + "com.amazonaws.medialive#MediaResourceNeighbor": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__stringMin1Max2048PatternArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of a resource used in AWS media workflows.", + "smithy.api#jsonName": "arn", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max256", + "traits": { + "smithy.api#documentation": "The logical name of an AWS media resource.", + "smithy.api#jsonName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "A direct source or destination neighbor to an AWS media resource." + } + }, + "com.amazonaws.medialive#MonitorDeployment": { + "type": "structure", + "members": { + "DetailsUri": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", + "traits": { + "smithy.api#documentation": "URI associated with a signal map's monitor deployment.", + "smithy.api#jsonName": "detailsUri" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", + "traits": { + "smithy.api#documentation": "Error message associated with a failed monitor deployment of a signal map.", + "smithy.api#jsonName": "errorMessage" + } + }, + "Status": { + "target": "com.amazonaws.medialive#SignalMapMonitorDeploymentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the latest monitor deployment of a signal map." + } + }, + "com.amazonaws.medialive#MotionGraphicsActivateScheduleActionSettings": { + "type": "structure", + "members": { + "Duration": { + "target": "com.amazonaws.medialive#__longMin0Max86400000", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "duration" + } + }, + "PasswordParam": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Key used to extract the password from EC2 Parameter store", + "smithy.api#jsonName": "passwordParam" + } + }, + "Url": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "URI of the HTML5 content to be rendered into the live stream.", + "smithy.api#jsonName": "url" + } + }, + "Username": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Documentation update needed", + "smithy.api#jsonName": "username" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings to specify the rendering of motion graphics into the video stream." + } + }, + "com.amazonaws.medialive#MotionGraphicsConfiguration": { + "type": "structure", + "members": { + "MotionGraphicsInsertion": { + "target": "com.amazonaws.medialive#MotionGraphicsInsertion", + "traits": { + "smithy.api#jsonName": "motionGraphicsInsertion" + } + }, + "MotionGraphicsSettings": { + "target": "com.amazonaws.medialive#MotionGraphicsSettings", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Motion Graphics Settings", + "smithy.api#jsonName": "motionGraphicsSettings", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Motion Graphics Configuration" + } + }, + "com.amazonaws.medialive#MotionGraphicsDeactivateScheduleActionSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Settings to specify the ending of rendering motion graphics into the video stream." + } + }, + "com.amazonaws.medialive#MotionGraphicsInsertion": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "Motion Graphics Insertion" + } + }, + "com.amazonaws.medialive#MotionGraphicsSettings": { + "type": "structure", + "members": { + "HtmlMotionGraphicsSettings": { + "target": "com.amazonaws.medialive#HtmlMotionGraphicsSettings", + "traits": { + "smithy.api#jsonName": "htmlMotionGraphicsSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Motion Graphics Settings" + } + }, + "com.amazonaws.medialive#Mp2CodingMode": { + "type": "enum", + "members": { + "CODING_MODE_1_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODING_MODE_1_0" + } + }, + "CODING_MODE_2_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODING_MODE_2_0" + } + } + }, + "traits": { + "smithy.api#documentation": "Mp2 Coding Mode" + } + }, + "com.amazonaws.medialive#Mp2Settings": { + "type": "structure", + "members": { + "Bitrate": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "Average bitrate in bits/second.", + "smithy.api#jsonName": "bitrate" + } + }, + "CodingMode": { + "target": "com.amazonaws.medialive#Mp2CodingMode", + "traits": { + "smithy.api#documentation": "The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).", + "smithy.api#jsonName": "codingMode" + } + }, + "SampleRate": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "Sample rate in Hz.", + "smithy.api#jsonName": "sampleRate" + } + } + }, + "traits": { + "smithy.api#documentation": "Mp2 Settings" + } + }, + "com.amazonaws.medialive#Mpeg2AdaptiveQuantization": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OFF" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Adaptive Quantization" + } + }, + "com.amazonaws.medialive#Mpeg2ColorMetadata": { + "type": "enum", + "members": { + "IGNORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORE" + } + }, + "INSERT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSERT" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Color Metadata" + } + }, + "com.amazonaws.medialive#Mpeg2ColorSpace": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Color Space" + } + }, + "com.amazonaws.medialive#Mpeg2DisplayRatio": { + "type": "enum", + "members": { + "DISPLAYRATIO16X9": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISPLAYRATIO16X9" + } + }, + "DISPLAYRATIO4X3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISPLAYRATIO4X3" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Display Ratio" + } + }, + "com.amazonaws.medialive#Mpeg2FilterSettings": { + "type": "structure", + "members": { + "TemporalFilterSettings": { + "target": "com.amazonaws.medialive#TemporalFilterSettings", + "traits": { + "smithy.api#jsonName": "temporalFilterSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Filter Settings" + } + }, + "com.amazonaws.medialive#Mpeg2GopSizeUnits": { + "type": "enum", + "members": { + "FRAMES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRAMES" + } + }, + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECONDS" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Gop Size Units" + } + }, + "com.amazonaws.medialive#Mpeg2ScanType": { + "type": "enum", + "members": { + "INTERLACED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERLACED" + } + }, + "PROGRESSIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRESSIVE" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Scan Type" + } + }, + "com.amazonaws.medialive#Mpeg2Settings": { + "type": "structure", + "members": { + "AdaptiveQuantization": { + "target": "com.amazonaws.medialive#Mpeg2AdaptiveQuantization", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "adaptiveQuantization" + } + }, + "AfdSignaling": { + "target": "com.amazonaws.medialive#AfdSignaling", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "afdSignaling" + } + }, + "ColorMetadata": { + "target": "com.amazonaws.medialive#Mpeg2ColorMetadata", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "colorMetadata" + } + }, + "ColorSpace": { + "target": "com.amazonaws.medialive#Mpeg2ColorSpace", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "colorSpace" + } + }, + "DisplayAspectRatio": { + "target": "com.amazonaws.medialive#Mpeg2DisplayRatio", + "traits": { + "smithy.api#documentation": "Sets the pixel aspect ratio for the encode.", + "smithy.api#jsonName": "displayAspectRatio" + } + }, + "FilterSettings": { + "target": "com.amazonaws.medialive#Mpeg2FilterSettings", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "filterSettings" + } + }, + "FixedAfd": { + "target": "com.amazonaws.medialive#FixedAfd", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "fixedAfd" + } + }, + "FramerateDenominator": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "description\": \"The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.", + "smithy.api#jsonName": "framerateDenominator", + "smithy.api#required": {} + } + }, + "FramerateNumerator": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.", + "smithy.api#jsonName": "framerateNumerator", + "smithy.api#required": {} + } + }, + "GopClosedCadence": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "MPEG2: default is open GOP.", + "smithy.api#jsonName": "gopClosedCadence" + } + }, + "GopNumBFrames": { + "target": "com.amazonaws.medialive#__integerMin0Max7", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "gopNumBFrames" + } + }, + "GopSize": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "gopSize" + } + }, + "GopSizeUnits": { + "target": "com.amazonaws.medialive#Mpeg2GopSizeUnits", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "gopSizeUnits" + } + }, + "ScanType": { + "target": "com.amazonaws.medialive#Mpeg2ScanType", + "traits": { + "smithy.api#documentation": "Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).", + "smithy.api#jsonName": "scanType" + } + }, + "SubgopLength": { + "target": "com.amazonaws.medialive#Mpeg2SubGopLength", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "subgopLength" + } + }, + "TimecodeInsertion": { + "target": "com.amazonaws.medialive#Mpeg2TimecodeInsertionBehavior", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "timecodeInsertion" + } + }, + "TimecodeBurninSettings": { + "target": "com.amazonaws.medialive#TimecodeBurninSettings", + "traits": { + "smithy.api#documentation": "Timecode burn-in settings", + "smithy.api#jsonName": "timecodeBurninSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Settings" + } + }, + "com.amazonaws.medialive#Mpeg2SubGopLength": { + "type": "enum", + "members": { + "DYNAMIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMIC" + } + }, + "FIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Sub Gop Length" + } + }, + "com.amazonaws.medialive#Mpeg2TimecodeInsertionBehavior": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "GOP_TIMECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOP_TIMECODE" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Timecode Insertion Behavior" + } + }, + "com.amazonaws.medialive#MsSmoothGroupSettings": { + "type": "structure", + "members": { + "AcquisitionPointId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.", + "smithy.api#jsonName": "acquisitionPointId" + } + }, + "AudioOnlyTimecodeControl": { + "target": "com.amazonaws.medialive#SmoothGroupAudioOnlyTimecodeControl", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "audioOnlyTimecodeControl" + } + }, + "CertificateMode": { + "target": "com.amazonaws.medialive#SmoothGroupCertificateMode", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "certificateMode" + } + }, + "ConnectionRetryInterval": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "connectionRetryInterval" + } + }, + "Destination": { + "target": "com.amazonaws.medialive#OutputLocationRef", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Smooth Streaming publish point on an IIS server. Elemental Live acts as a \"Push\" encoder to IIS.", + "smithy.api#jsonName": "destination", + "smithy.api#required": {} + } + }, + "EventId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "MS Smooth event ID to be sent to the IIS server.\n\nShould only be specified if eventIdMode is set to useConfigured.", + "smithy.api#jsonName": "eventId" + } + }, + "EventIdMode": { + "target": "com.amazonaws.medialive#SmoothGroupEventIdMode", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "eventIdMode" + } + }, + "EventStopBehavior": { + "target": "com.amazonaws.medialive#SmoothGroupEventStopBehavior", + "traits": { + "smithy.api#documentation": "When set to sendEos, send EOS signal to IIS server when stopping the event", + "smithy.api#jsonName": "eventStopBehavior" + } + }, + "FilecacheDuration": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", + "smithy.api#jsonName": "filecacheDuration" + } + }, + "FragmentLength": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#documentation": "Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.", + "smithy.api#jsonName": "fragmentLength" + } + }, + "InputLossAction": { + "target": "com.amazonaws.medialive#InputLossActionForMsSmoothOut", + "traits": { + "smithy.api#documentation": "Parameter that control output group behavior on input loss.", + "smithy.api#jsonName": "inputLossAction" + } + }, + "NumRetries": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Number of retry attempts.", + "smithy.api#jsonName": "numRetries" + } + }, + "RestartDelay": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.", + "smithy.api#jsonName": "restartDelay" + } + }, + "SegmentationMode": { + "target": "com.amazonaws.medialive#SmoothGroupSegmentationMode", + "traits": { + "smithy.api#documentation": "useInputSegmentation has been deprecated. The configured segment size is always used.", + "smithy.api#jsonName": "segmentationMode" + } + }, + "SendDelayMs": { + "target": "com.amazonaws.medialive#__integerMin0Max10000", + "traits": { + "smithy.api#documentation": "Number of milliseconds to delay the output from the second pipeline.", + "smithy.api#jsonName": "sendDelayMs" + } + }, + "SparseTrackType": { + "target": "com.amazonaws.medialive#SmoothGroupSparseTrackType", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "sparseTrackType" + } + }, + "StreamManifestBehavior": { + "target": "com.amazonaws.medialive#SmoothGroupStreamManifestBehavior", + "traits": { + "smithy.api#documentation": "When set to send, send stream manifest so publishing point doesn't start until all streams start.", + "smithy.api#jsonName": "streamManifestBehavior" + } + }, + "TimestampOffset": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.", + "smithy.api#jsonName": "timestampOffset" + } + }, + "TimestampOffsetMode": { + "target": "com.amazonaws.medialive#SmoothGroupTimestampOffsetMode", + "traits": { + "smithy.api#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", + "smithy.api#jsonName": "timestampOffsetMode" + } + } + }, + "traits": { + "smithy.api#documentation": "Ms Smooth Group Settings" + } + }, + "com.amazonaws.medialive#MsSmoothH265PackagingType": { + "type": "enum", + "members": { + "HEV1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEV1" + } + }, + "HVC1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HVC1" + } + } + }, + "traits": { + "smithy.api#documentation": "Ms Smooth H265 Packaging Type" + } + }, + "com.amazonaws.medialive#MsSmoothOutputSettings": { + "type": "structure", + "members": { + "H265PackagingType": { + "target": "com.amazonaws.medialive#MsSmoothH265PackagingType", + "traits": { + "smithy.api#documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1.", + "smithy.api#jsonName": "h265PackagingType" + } + }, + "NameModifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type.", + "smithy.api#jsonName": "nameModifier" + } + } + }, + "traits": { + "smithy.api#documentation": "Ms Smooth Output Settings" + } + }, + "com.amazonaws.medialive#Multiplex": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique arn of the multiplex.", + "smithy.api#jsonName": "arn" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "A list of availability zones for the multiplex.", + "smithy.api#jsonName": "availabilityZones" + } + }, + "Destinations": { + "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", + "traits": { + "smithy.api#documentation": "A list of the multiplex output destinations.", + "smithy.api#jsonName": "destinations" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique id of the multiplex.", + "smithy.api#jsonName": "id" + } + }, + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexSettings", + "traits": { + "smithy.api#documentation": "Configuration for a multiplex event.", + "smithy.api#jsonName": "multiplexSettings" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the multiplex.", + "smithy.api#jsonName": "name" + } + }, + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" + } + }, + "ProgramCount": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The number of programs in the multiplex.", + "smithy.api#jsonName": "programCount" + } + }, + "State": { + "target": "com.amazonaws.medialive#MultiplexState", + "traits": { + "smithy.api#documentation": "The current state of the multiplex.", + "smithy.api#jsonName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "The multiplex object." + } + }, + "com.amazonaws.medialive#MultiplexGroupSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Multiplex Group Settings" + } + }, + "com.amazonaws.medialive#MultiplexMediaConnectOutputDestinationSettings": { + "type": "structure", + "members": { + "EntitlementArn": { + "target": "com.amazonaws.medialive#__stringMin1", + "traits": { + "smithy.api#documentation": "The MediaConnect entitlement ARN available as a Flow source.", + "smithy.api#jsonName": "entitlementArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Multiplex MediaConnect output destination settings." + } + }, + "com.amazonaws.medialive#MultiplexOutputDestination": { + "type": "structure", + "members": { + "MediaConnectSettings": { + "target": "com.amazonaws.medialive#MultiplexMediaConnectOutputDestinationSettings", + "traits": { + "smithy.api#documentation": "Multiplex MediaConnect output destination settings.", + "smithy.api#jsonName": "mediaConnectSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Multiplex output destination settings" + } + }, + "com.amazonaws.medialive#MultiplexOutputSettings": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.medialive#OutputLocationRef", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Destination is a Multiplex.", + "smithy.api#jsonName": "destination", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Multiplex Output Settings" + } + }, + "com.amazonaws.medialive#MultiplexProgram": { + "type": "structure", + "members": { + "ChannelId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The MediaLive channel associated with the program.", + "smithy.api#jsonName": "channelId" + } + }, + "MultiplexProgramSettings": { + "target": "com.amazonaws.medialive#MultiplexProgramSettings", + "traits": { + "smithy.api#documentation": "The settings for this multiplex program.", + "smithy.api#jsonName": "multiplexProgramSettings" + } + }, + "PacketIdentifiersMap": { + "target": "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap", + "traits": { + "smithy.api#documentation": "The packet identifier map for this multiplex program.", + "smithy.api#jsonName": "packetIdentifiersMap" + } + }, + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfMultiplexProgramPipelineDetail", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "pipelineDetails" + } + }, + "ProgramName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the multiplex program.", + "smithy.api#jsonName": "programName" + } + } + }, + "traits": { + "smithy.api#documentation": "The multiplex program object." + } + }, + "com.amazonaws.medialive#MultiplexProgramChannelDestinationSettings": { + "type": "structure", + "members": { + "MultiplexId": { + "target": "com.amazonaws.medialive#__stringMin1", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "multiplexId" + } + }, + "ProgramName": { + "target": "com.amazonaws.medialive#__stringMin1", + "traits": { + "smithy.api#documentation": "The program name of the Multiplex program that the encoder is providing output to.", + "smithy.api#jsonName": "programName" + } + } + }, + "traits": { + "smithy.api#documentation": "Multiplex Program Input Destination Settings for outputting a Channel to a Multiplex" + } + }, + "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap": { + "type": "structure", + "members": { + "AudioPids": { + "target": "com.amazonaws.medialive#__listOf__integer", + "traits": { + "smithy.api#jsonName": "audioPids" + } + }, + "DvbSubPids": { + "target": "com.amazonaws.medialive#__listOf__integer", + "traits": { + "smithy.api#jsonName": "dvbSubPids" + } + }, + "DvbTeletextPid": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#jsonName": "dvbTeletextPid" + } + }, + "EtvPlatformPid": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#jsonName": "etvPlatformPid" + } + }, + "EtvSignalPid": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#jsonName": "etvSignalPid" + } + }, + "KlvDataPids": { + "target": "com.amazonaws.medialive#__listOf__integer", + "traits": { + "smithy.api#jsonName": "klvDataPids" + } + }, + "PcrPid": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#jsonName": "pcrPid" + } + }, + "PmtPid": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#jsonName": "pmtPid" + } + }, + "PrivateMetadataPid": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#jsonName": "privateMetadataPid" + } + }, + "Scte27Pids": { + "target": "com.amazonaws.medialive#__listOf__integer", + "traits": { + "smithy.api#jsonName": "scte27Pids" + } + }, + "Scte35Pid": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#jsonName": "scte35Pid" + } + }, + "TimedMetadataPid": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#jsonName": "timedMetadataPid" + } + }, + "VideoPid": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#jsonName": "videoPid" + } + } + }, + "traits": { + "smithy.api#documentation": "Packet identifiers map for a given Multiplex program." + } + }, + "com.amazonaws.medialive#MultiplexProgramPipelineDetail": { + "type": "structure", + "members": { + "ActiveChannelPipeline": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.", + "smithy.api#jsonName": "activeChannelPipeline" + } + }, + "PipelineId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Identifies a specific pipeline in the multiplex.", + "smithy.api#jsonName": "pipelineId" + } + } + }, + "traits": { + "smithy.api#documentation": "The current source for one of the pipelines in the multiplex." + } + }, + "com.amazonaws.medialive#MultiplexProgramServiceDescriptor": { + "type": "structure", + "members": { + "ProviderName": { + "target": "com.amazonaws.medialive#__stringMax256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the provider.", + "smithy.api#jsonName": "providerName", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.medialive#__stringMax256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the service.", + "smithy.api#jsonName": "serviceName", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Transport stream service descriptor configuration for the Multiplex program." + } + }, + "com.amazonaws.medialive#MultiplexProgramSettings": { + "type": "structure", + "members": { + "PreferredChannelPipeline": { + "target": "com.amazonaws.medialive#PreferredChannelPipeline", + "traits": { + "smithy.api#documentation": "Indicates which pipeline is preferred by the multiplex for program ingest.", + "smithy.api#jsonName": "preferredChannelPipeline" + } + }, + "ProgramNumber": { + "target": "com.amazonaws.medialive#__integerMin0Max65535", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Unique program number.", + "smithy.api#jsonName": "programNumber", + "smithy.api#required": {} + } + }, + "ServiceDescriptor": { + "target": "com.amazonaws.medialive#MultiplexProgramServiceDescriptor", + "traits": { + "smithy.api#documentation": "Transport stream service descriptor configuration for the Multiplex program.", + "smithy.api#jsonName": "serviceDescriptor" + } + }, + "VideoSettings": { + "target": "com.amazonaws.medialive#MultiplexVideoSettings", + "traits": { + "smithy.api#documentation": "Program video settings configuration.", + "smithy.api#jsonName": "videoSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Multiplex Program settings configuration." + } + }, + "com.amazonaws.medialive#MultiplexProgramSummary": { + "type": "structure", + "members": { + "ChannelId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The MediaLive Channel associated with the program.", + "smithy.api#jsonName": "channelId" + } + }, + "ProgramName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the multiplex program.", + "smithy.api#jsonName": "programName" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for MultiplexProgramSummary" + } + }, + "com.amazonaws.medialive#MultiplexSettings": { + "type": "structure", + "members": { + "MaximumVideoBufferDelayMilliseconds": { + "target": "com.amazonaws.medialive#__integerMin800Max3000", + "traits": { + "smithy.api#documentation": "Maximum video buffer delay in milliseconds.", + "smithy.api#jsonName": "maximumVideoBufferDelayMilliseconds" + } + }, + "TransportStreamBitrate": { + "target": "com.amazonaws.medialive#__integerMin1000000Max100000000", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Transport stream bit rate.", + "smithy.api#jsonName": "transportStreamBitrate", + "smithy.api#required": {} + } + }, + "TransportStreamId": { + "target": "com.amazonaws.medialive#__integerMin0Max65535", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Transport stream ID.", + "smithy.api#jsonName": "transportStreamId", + "smithy.api#required": {} + } + }, + "TransportStreamReservedBitrate": { + "target": "com.amazonaws.medialive#__integerMin0Max100000000", + "traits": { + "smithy.api#documentation": "Transport stream reserved bit rate.", + "smithy.api#jsonName": "transportStreamReservedBitrate" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configuration for a Multiplex event" + } + }, + "com.amazonaws.medialive#MultiplexSettingsSummary": { + "type": "structure", + "members": { + "TransportStreamBitrate": { + "target": "com.amazonaws.medialive#__integerMin1000000Max100000000", + "traits": { + "smithy.api#documentation": "Transport stream bit rate.", + "smithy.api#jsonName": "transportStreamBitrate" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary configuration for a Multiplex event." + } + }, + "com.amazonaws.medialive#MultiplexState": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "IDLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDLE" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "RECOVERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECOVERING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#documentation": "The current state of the multiplex." + } + }, + "com.amazonaws.medialive#MultiplexStatmuxVideoSettings": { + "type": "structure", + "members": { + "MaximumBitrate": { + "target": "com.amazonaws.medialive#__integerMin100000Max100000000", + "traits": { + "smithy.api#documentation": "Maximum statmux bitrate.", + "smithy.api#jsonName": "maximumBitrate" + } + }, + "MinimumBitrate": { + "target": "com.amazonaws.medialive#__integerMin100000Max100000000", + "traits": { + "smithy.api#documentation": "Minimum statmux bitrate.", + "smithy.api#jsonName": "minimumBitrate" + } + }, + "Priority": { + "target": "com.amazonaws.medialive#__integerMinNegative5Max5", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "priority" + } + } + }, + "traits": { + "smithy.api#documentation": "Statmux rate control settings" + } + }, + "com.amazonaws.medialive#MultiplexSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique arn of the multiplex.", + "smithy.api#jsonName": "arn" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "A list of availability zones for the multiplex.", + "smithy.api#jsonName": "availabilityZones" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique id of the multiplex.", + "smithy.api#jsonName": "id" + } + }, + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexSettingsSummary", + "traits": { + "smithy.api#documentation": "Configuration for a multiplex event.", + "smithy.api#jsonName": "multiplexSettings" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the multiplex.", + "smithy.api#jsonName": "name" + } + }, + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" + } + }, + "ProgramCount": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The number of programs in the multiplex.", + "smithy.api#jsonName": "programCount" + } + }, + "State": { + "target": "com.amazonaws.medialive#MultiplexState", + "traits": { + "smithy.api#documentation": "The current state of the multiplex.", + "smithy.api#jsonName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for MultiplexSummary" + } + }, + "com.amazonaws.medialive#MultiplexVideoSettings": { + "type": "structure", + "members": { + "ConstantBitrate": { + "target": "com.amazonaws.medialive#__integerMin100000Max100000000", + "traits": { + "smithy.api#documentation": "The constant bitrate configuration for the video encode.\nWhen this field is defined, StatmuxSettings must be undefined.", + "smithy.api#jsonName": "constantBitrate" + } + }, + "StatmuxSettings": { + "target": "com.amazonaws.medialive#MultiplexStatmuxVideoSettings", + "traits": { + "smithy.api#documentation": "Statmux rate control settings.\nWhen this field is defined, ConstantBitrate must be undefined.", + "smithy.api#jsonName": "statmuxSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "The video configuration for each program in a multiplex." + } + }, + "com.amazonaws.medialive#NetworkInputServerValidation": { + "type": "enum", + "members": { + "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME" + } + }, + "CHECK_CRYPTOGRAPHY_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHECK_CRYPTOGRAPHY_ONLY" + } + } + }, + "traits": { + "smithy.api#documentation": "Network Input Server Validation" + } + }, + "com.amazonaws.medialive#NetworkInputSettings": { + "type": "structure", + "members": { + "HlsInputSettings": { + "target": "com.amazonaws.medialive#HlsInputSettings", + "traits": { + "smithy.api#documentation": "Specifies HLS input settings when the uri is for a HLS manifest.", + "smithy.api#jsonName": "hlsInputSettings" + } + }, + "ServerValidation": { + "target": "com.amazonaws.medialive#NetworkInputServerValidation", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "serverValidation" + } + } + }, + "traits": { + "smithy.api#documentation": "Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection." + } + }, + "com.amazonaws.medialive#NielsenCBET": { + "type": "structure", + "members": { + "CbetCheckDigitString": { + "target": "com.amazonaws.medialive#__stringMin2Max2", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Enter the CBET check digits to use in the watermark.", + "smithy.api#jsonName": "cbetCheckDigitString", + "smithy.api#required": {} + } + }, + "CbetStepaside": { + "target": "com.amazonaws.medialive#NielsenWatermarksCbetStepaside", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Determines the method of CBET insertion mode when prior encoding is detected on the same layer.", + "smithy.api#jsonName": "cbetStepaside", + "smithy.api#required": {} + } + }, + "Csid": { + "target": "com.amazonaws.medialive#__stringMin1Max7", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Enter the CBET Source ID (CSID) to use in the watermark", + "smithy.api#jsonName": "csid", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Nielsen CBET" + } + }, + "com.amazonaws.medialive#NielsenConfiguration": { + "type": "structure", + "members": { + "DistributorId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Enter the Distributor ID assigned to your organization by Nielsen.", + "smithy.api#jsonName": "distributorId" + } + }, + "NielsenPcmToId3Tagging": { + "target": "com.amazonaws.medialive#NielsenPcmToId3TaggingState", + "traits": { + "smithy.api#documentation": "Enables Nielsen PCM to ID3 tagging", + "smithy.api#jsonName": "nielsenPcmToId3Tagging" + } + } + }, + "traits": { + "smithy.api#documentation": "Nielsen Configuration" + } + }, + "com.amazonaws.medialive#NielsenNaesIiNw": { + "type": "structure", + "members": { + "CheckDigitString": { + "target": "com.amazonaws.medialive#__stringMin2Max2", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Enter the check digit string for the watermark", + "smithy.api#jsonName": "checkDigitString", + "smithy.api#required": {} + } + }, + "Sid": { + "target": "com.amazonaws.medialive#__doubleMin1Max65535", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Enter the Nielsen Source ID (SID) to include in the watermark", + "smithy.api#jsonName": "sid", + "smithy.api#required": {} + } + }, + "Timezone": { + "target": "com.amazonaws.medialive#NielsenWatermarkTimezones", + "traits": { + "smithy.api#documentation": "Choose the timezone for the time stamps in the watermark. If not provided,\nthe timestamps will be in Coordinated Universal Time (UTC)", + "smithy.api#jsonName": "timezone" + } + } + }, + "traits": { + "smithy.api#documentation": "Nielsen Naes Ii Nw" + } + }, + "com.amazonaws.medialive#NielsenPcmToId3TaggingState": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "State of Nielsen PCM to ID3 tagging" + } + }, + "com.amazonaws.medialive#NielsenWatermarkTimezones": { + "type": "enum", + "members": { + "AMERICA_PUERTO_RICO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMERICA_PUERTO_RICO" + } + }, + "US_ALASKA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_ALASKA" + } + }, + "US_ARIZONA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_ARIZONA" + } + }, + "US_CENTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_CENTRAL" + } + }, + "US_EASTERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_EASTERN" + } + }, + "US_HAWAII": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_HAWAII" + } + }, + "US_MOUNTAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_MOUNTAIN" + } + }, + "US_PACIFIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_PACIFIC" + } + }, + "US_SAMOA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_SAMOA" + } + }, + "UTC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UTC" + } + } + }, + "traits": { + "smithy.api#documentation": "Nielsen Watermark Timezones" + } + }, + "com.amazonaws.medialive#NielsenWatermarksCbetStepaside": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "Nielsen Watermarks Cbet Stepaside" + } + }, + "com.amazonaws.medialive#NielsenWatermarksDistributionTypes": { + "type": "enum", + "members": { + "FINAL_DISTRIBUTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINAL_DISTRIBUTOR" + } + }, + "PROGRAM_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_CONTENT" + } + } + }, + "traits": { + "smithy.api#documentation": "Nielsen Watermarks Distribution Types" + } + }, + "com.amazonaws.medialive#NielsenWatermarksSettings": { + "type": "structure", + "members": { + "NielsenCbetSettings": { + "target": "com.amazonaws.medialive#NielsenCBET", + "traits": { + "smithy.api#documentation": "Complete these fields only if you want to insert watermarks of type Nielsen CBET", + "smithy.api#jsonName": "nielsenCbetSettings" + } + }, + "NielsenDistributionType": { + "target": "com.amazonaws.medialive#NielsenWatermarksDistributionTypes", + "traits": { + "smithy.api#documentation": "Choose the distribution types that you want to assign to the watermarks:\n- PROGRAM_CONTENT\n- FINAL_DISTRIBUTOR", + "smithy.api#jsonName": "nielsenDistributionType" + } + }, + "NielsenNaesIiNwSettings": { + "target": "com.amazonaws.medialive#NielsenNaesIiNw", + "traits": { + "smithy.api#documentation": "Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW).", + "smithy.api#jsonName": "nielsenNaesIiNwSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Nielsen Watermarks Settings" + } + }, + "com.amazonaws.medialive#NotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for NotFoundException", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.medialive#Offering": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'", + "smithy.api#jsonName": "arn" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", + "smithy.api#jsonName": "currencyCode" + } + }, + "Duration": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "Lease duration, e.g. '12'", + "smithy.api#jsonName": "duration" + } + }, + "DurationUnits": { + "target": "com.amazonaws.medialive#OfferingDurationUnits", + "traits": { + "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", + "smithy.api#jsonName": "durationUnits" + } + }, + "FixedPrice": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", + "smithy.api#jsonName": "fixedPrice" + } + }, + "OfferingDescription": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", + "smithy.api#jsonName": "offeringDescription" + } + }, + "OfferingId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#jsonName": "offeringId" + } + }, + "OfferingType": { + "target": "com.amazonaws.medialive#OfferingType", + "traits": { + "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", + "smithy.api#jsonName": "offeringType" + } + }, + "Region": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", + "smithy.api#jsonName": "region" + } + }, + "ResourceSpecification": { + "target": "com.amazonaws.medialive#ReservationResourceSpecification", + "traits": { + "smithy.api#documentation": "Resource configuration details", + "smithy.api#jsonName": "resourceSpecification" + } + }, + "UsagePrice": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", + "smithy.api#jsonName": "usagePrice" + } + } + }, + "traits": { + "smithy.api#documentation": "Reserved resources available for purchase" + } + }, + "com.amazonaws.medialive#OfferingDurationUnits": { + "type": "enum", + "members": { + "MONTHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHS" + } + } + }, + "traits": { + "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'" + } + }, + "com.amazonaws.medialive#OfferingType": { + "type": "enum", + "members": { + "NO_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_UPFRONT" + } + } + }, + "traits": { + "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'" + } + }, + "com.amazonaws.medialive#Output": { + "type": "structure", + "members": { + "AudioDescriptionNames": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "The names of the AudioDescriptions used as audio sources for this output.", + "smithy.api#jsonName": "audioDescriptionNames" + } + }, + "CaptionDescriptionNames": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "The names of the CaptionDescriptions used as caption sources for this output.", + "smithy.api#jsonName": "captionDescriptionNames" + } + }, + "OutputName": { + "target": "com.amazonaws.medialive#__stringMin1Max255", + "traits": { + "smithy.api#documentation": "The name used to identify an output.", + "smithy.api#jsonName": "outputName" + } + }, + "OutputSettings": { + "target": "com.amazonaws.medialive#OutputSettings", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Output type-specific settings.", + "smithy.api#jsonName": "outputSettings", + "smithy.api#required": {} + } + }, + "VideoDescriptionName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the VideoDescription used as the source for this output.", + "smithy.api#jsonName": "videoDescriptionName" + } + } + }, + "traits": { + "smithy.api#documentation": "Output settings. There can be multiple outputs within a group." + } + }, + "com.amazonaws.medialive#OutputDestination": { "type": "structure", "members": { - "Destination": { - "target": "com.amazonaws.medialive#OutputLocationRef", + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "User-specified id. This is used in an output group or an output.", + "smithy.api#jsonName": "id" + } + }, + "MediaPackageSettings": { + "target": "com.amazonaws.medialive#__listOfMediaPackageOutputDestinationSettings", + "traits": { + "smithy.api#documentation": "Destination settings for a MediaPackage output; one destination for both encoders.", + "smithy.api#jsonName": "mediaPackageSettings" + } + }, + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexProgramChannelDestinationSettings", + "traits": { + "smithy.api#documentation": "Destination settings for a Multiplex output; one destination for both encoders.", + "smithy.api#jsonName": "multiplexSettings" + } + }, + "Settings": { + "target": "com.amazonaws.medialive#__listOfOutputDestinationSettings", + "traits": { + "smithy.api#documentation": "Destination settings for a standard output; one destination for each redundant encoder.", + "smithy.api#jsonName": "settings" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for OutputDestination" + } + }, + "com.amazonaws.medialive#OutputDestinationSettings": { + "type": "structure", + "members": { + "PasswordParam": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "key used to extract the password from EC2 Parameter store", + "smithy.api#jsonName": "passwordParam" + } + }, + "StreamName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Stream name for RTMP destinations (URLs of type rtmp://)", + "smithy.api#jsonName": "streamName" + } + }, + "Url": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "A URL specifying a destination", + "smithy.api#jsonName": "url" + } + }, + "Username": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "username for destination", + "smithy.api#jsonName": "username" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for OutputDestinationSettings" + } + }, + "com.amazonaws.medialive#OutputGroup": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.medialive#__stringMax32", + "traits": { + "smithy.api#documentation": "Custom output group name optionally defined by the user.", + "smithy.api#jsonName": "name" + } + }, + "OutputGroupSettings": { + "target": "com.amazonaws.medialive#OutputGroupSettings", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Settings associated with the output group.", + "smithy.api#jsonName": "outputGroupSettings", + "smithy.api#required": {} + } + }, + "Outputs": { + "target": "com.amazonaws.medialive#__listOfOutput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "outputs", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Output groups for this Live Event. Output groups contain information about where streams should be distributed." + } + }, + "com.amazonaws.medialive#OutputGroupSettings": { + "type": "structure", + "members": { + "ArchiveGroupSettings": { + "target": "com.amazonaws.medialive#ArchiveGroupSettings", + "traits": { + "smithy.api#jsonName": "archiveGroupSettings" + } + }, + "FrameCaptureGroupSettings": { + "target": "com.amazonaws.medialive#FrameCaptureGroupSettings", + "traits": { + "smithy.api#jsonName": "frameCaptureGroupSettings" + } + }, + "HlsGroupSettings": { + "target": "com.amazonaws.medialive#HlsGroupSettings", + "traits": { + "smithy.api#jsonName": "hlsGroupSettings" + } + }, + "MediaPackageGroupSettings": { + "target": "com.amazonaws.medialive#MediaPackageGroupSettings", + "traits": { + "smithy.api#jsonName": "mediaPackageGroupSettings" + } + }, + "MsSmoothGroupSettings": { + "target": "com.amazonaws.medialive#MsSmoothGroupSettings", + "traits": { + "smithy.api#jsonName": "msSmoothGroupSettings" + } + }, + "MultiplexGroupSettings": { + "target": "com.amazonaws.medialive#MultiplexGroupSettings", + "traits": { + "smithy.api#jsonName": "multiplexGroupSettings" + } + }, + "RtmpGroupSettings": { + "target": "com.amazonaws.medialive#RtmpGroupSettings", + "traits": { + "smithy.api#jsonName": "rtmpGroupSettings" + } + }, + "UdpGroupSettings": { + "target": "com.amazonaws.medialive#UdpGroupSettings", + "traits": { + "smithy.api#jsonName": "udpGroupSettings" + } + }, + "CmafIngestGroupSettings": { + "target": "com.amazonaws.medialive#CmafIngestGroupSettings", + "traits": { + "smithy.api#jsonName": "cmafIngestGroupSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Output Group Settings" + } + }, + "com.amazonaws.medialive#OutputLocationRef": { + "type": "structure", + "members": { + "DestinationRefId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#jsonName": "destinationRefId" + } + } + }, + "traits": { + "smithy.api#documentation": "Reference to an OutputDestination ID defined in the channel" + } + }, + "com.amazonaws.medialive#OutputLockingSettings": { + "type": "structure", + "members": { + "EpochLockingSettings": { + "target": "com.amazonaws.medialive#EpochLockingSettings", + "traits": { + "smithy.api#jsonName": "epochLockingSettings" + } + }, + "PipelineLockingSettings": { + "target": "com.amazonaws.medialive#PipelineLockingSettings", + "traits": { + "smithy.api#jsonName": "pipelineLockingSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Output Locking Settings" + } + }, + "com.amazonaws.medialive#OutputSettings": { + "type": "structure", + "members": { + "ArchiveOutputSettings": { + "target": "com.amazonaws.medialive#ArchiveOutputSettings", + "traits": { + "smithy.api#jsonName": "archiveOutputSettings" + } + }, + "FrameCaptureOutputSettings": { + "target": "com.amazonaws.medialive#FrameCaptureOutputSettings", + "traits": { + "smithy.api#jsonName": "frameCaptureOutputSettings" + } + }, + "HlsOutputSettings": { + "target": "com.amazonaws.medialive#HlsOutputSettings", + "traits": { + "smithy.api#jsonName": "hlsOutputSettings" + } + }, + "MediaPackageOutputSettings": { + "target": "com.amazonaws.medialive#MediaPackageOutputSettings", + "traits": { + "smithy.api#jsonName": "mediaPackageOutputSettings" + } + }, + "MsSmoothOutputSettings": { + "target": "com.amazonaws.medialive#MsSmoothOutputSettings", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "MediaPackage channel destination.", - "smithy.api#jsonName": "destination", - "smithy.api#required": {} + "smithy.api#jsonName": "msSmoothOutputSettings" + } + }, + "MultiplexOutputSettings": { + "target": "com.amazonaws.medialive#MultiplexOutputSettings", + "traits": { + "smithy.api#jsonName": "multiplexOutputSettings" + } + }, + "RtmpOutputSettings": { + "target": "com.amazonaws.medialive#RtmpOutputSettings", + "traits": { + "smithy.api#jsonName": "rtmpOutputSettings" + } + }, + "UdpOutputSettings": { + "target": "com.amazonaws.medialive#UdpOutputSettings", + "traits": { + "smithy.api#jsonName": "udpOutputSettings" + } + }, + "CmafIngestOutputSettings": { + "target": "com.amazonaws.medialive#CmafIngestOutputSettings", + "traits": { + "smithy.api#jsonName": "cmafIngestOutputSettings" } } }, "traits": { - "smithy.api#documentation": "Media Package Group Settings" + "smithy.api#documentation": "Output Settings" } }, - "com.amazonaws.medialive#MediaPackageOutputDestinationSettings": { + "com.amazonaws.medialive#PassThroughSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Pass Through Settings" + } + }, + "com.amazonaws.medialive#PauseStateScheduleActionSettings": { "type": "structure", "members": { - "ChannelId": { - "target": "com.amazonaws.medialive#__stringMin1", + "Pipelines": { + "target": "com.amazonaws.medialive#__listOfPipelinePauseStateSettings", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "channelId" + "smithy.api#jsonName": "pipelines" } } }, "traits": { - "smithy.api#documentation": "MediaPackage Output Destination Settings" - } - }, - "com.amazonaws.medialive#MediaPackageOutputSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Media Package Output Settings" + "smithy.api#documentation": "Settings for the action to set pause state of a channel." } }, - "com.amazonaws.medialive#MotionGraphicsActivateScheduleActionSettings": { + "com.amazonaws.medialive#PipelineDetail": { "type": "structure", "members": { - "Duration": { - "target": "com.amazonaws.medialive#__longMin0Max86400000", + "ActiveInputAttachmentName": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "duration" + "smithy.api#documentation": "The name of the active input attachment currently being ingested by this pipeline.", + "smithy.api#jsonName": "activeInputAttachmentName" } }, - "PasswordParam": { + "ActiveInputSwitchActionName": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Key used to extract the password from EC2 Parameter store", - "smithy.api#jsonName": "passwordParam" + "smithy.api#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.", + "smithy.api#jsonName": "activeInputSwitchActionName" } }, - "Url": { + "ActiveMotionGraphicsActionName": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "URI of the HTML5 content to be rendered into the live stream.", - "smithy.api#jsonName": "url" + "smithy.api#documentation": "The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline.", + "smithy.api#jsonName": "activeMotionGraphicsActionName" } }, - "Username": { + "ActiveMotionGraphicsUri": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Documentation update needed", - "smithy.api#jsonName": "username" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings to specify the rendering of motion graphics into the video stream." - } - }, - "com.amazonaws.medialive#MotionGraphicsConfiguration": { - "type": "structure", - "members": { - "MotionGraphicsInsertion": { - "target": "com.amazonaws.medialive#MotionGraphicsInsertion", - "traits": { - "smithy.api#jsonName": "motionGraphicsInsertion" + "smithy.api#documentation": "The current URI being used for HTML5 motion graphics for this pipeline.", + "smithy.api#jsonName": "activeMotionGraphicsUri" } }, - "MotionGraphicsSettings": { - "target": "com.amazonaws.medialive#MotionGraphicsSettings", + "PipelineId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Motion Graphics Settings", - "smithy.api#jsonName": "motionGraphicsSettings", - "smithy.api#required": {} + "smithy.api#documentation": "Pipeline ID", + "smithy.api#jsonName": "pipelineId" } } }, "traits": { - "smithy.api#documentation": "Motion Graphics Configuration" - } - }, - "com.amazonaws.medialive#MotionGraphicsDeactivateScheduleActionSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Settings to specify the ending of rendering motion graphics into the video stream." + "smithy.api#documentation": "Runtime details of a pipeline when a channel is running." } }, - "com.amazonaws.medialive#MotionGraphicsInsertion": { + "com.amazonaws.medialive#PipelineId": { "type": "enum", "members": { - "DISABLED": { + "PIPELINE_0": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "PIPELINE_0" } }, - "ENABLED": { + "PIPELINE_1": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "PIPELINE_1" } } }, "traits": { - "smithy.api#documentation": "Motion Graphics Insertion" + "smithy.api#documentation": "Pipeline ID" } }, - "com.amazonaws.medialive#MotionGraphicsSettings": { + "com.amazonaws.medialive#PipelineLockingSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Pipeline Locking Settings" + } + }, + "com.amazonaws.medialive#PipelinePauseStateSettings": { "type": "structure", "members": { - "HtmlMotionGraphicsSettings": { - "target": "com.amazonaws.medialive#HtmlMotionGraphicsSettings", + "PipelineId": { + "target": "com.amazonaws.medialive#PipelineId", "traits": { - "smithy.api#jsonName": "htmlMotionGraphicsSettings" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Pipeline ID to pause (\"PIPELINE_0\" or \"PIPELINE_1\").", + "smithy.api#jsonName": "pipelineId", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Motion Graphics Settings" + "smithy.api#documentation": "Settings for pausing a pipeline." } }, - "com.amazonaws.medialive#Mp2CodingMode": { + "com.amazonaws.medialive#PreferredChannelPipeline": { "type": "enum", "members": { - "CODING_MODE_1_0": { + "CURRENTLY_ACTIVE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CODING_MODE_1_0" + "smithy.api#enumValue": "CURRENTLY_ACTIVE" } }, - "CODING_MODE_2_0": { + "PIPELINE_0": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CODING_MODE_2_0" + "smithy.api#enumValue": "PIPELINE_0" + } + }, + "PIPELINE_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIPELINE_1" } } }, "traits": { - "smithy.api#documentation": "Mp2 Coding Mode" + "smithy.api#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." } }, - "com.amazonaws.medialive#Mp2Settings": { - "type": "structure", - "members": { - "Bitrate": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "Average bitrate in bits/second.", - "smithy.api#jsonName": "bitrate" - } + "com.amazonaws.medialive#PurchaseOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#PurchaseOfferingRequest" + }, + "output": { + "target": "com.amazonaws.medialive#PurchaseOfferingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "CodingMode": { - "target": "com.amazonaws.medialive#Mp2CodingMode", - "traits": { - "smithy.api#documentation": "The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).", - "smithy.api#jsonName": "codingMode" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "SampleRate": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "Sample rate in Hz.", - "smithy.api#jsonName": "sampleRate" - } + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" } - }, + ], "traits": { - "smithy.api#documentation": "Mp2 Settings" + "smithy.api#documentation": "Purchase an offering and create a reservation.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/offerings/{OfferingId}/purchase", + "code": 201 + } } }, - "com.amazonaws.medialive#Mpeg2AdaptiveQuantization": { - "type": "enum", + "com.amazonaws.medialive#PurchaseOfferingRequest": { + "type": "structure", "members": { - "AUTO": { - "target": "smithy.api#Unit", + "Count": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#enumValue": "AUTO" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Number of resources", + "smithy.api#jsonName": "count", + "smithy.api#required": {} } }, - "HIGH": { - "target": "smithy.api#Unit", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "HIGH" + "smithy.api#documentation": "Name for the new reservation", + "smithy.api#jsonName": "name" } }, - "LOW": { - "target": "smithy.api#Unit", + "OfferingId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "LOW" + "smithy.api#documentation": "Offering to purchase, e.g. '87654321'", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "MEDIUM": { - "target": "smithy.api#Unit", + "RenewalSettings": { + "target": "com.amazonaws.medialive#RenewalSettings", "traits": { - "smithy.api#enumValue": "MEDIUM" + "smithy.api#documentation": "Renewal settings for the reservation", + "smithy.api#jsonName": "renewalSettings" } }, - "OFF": { - "target": "smithy.api#Unit", + "RequestId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "OFF" + "smithy.api#documentation": "Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "requestId" } - } - }, - "traits": { - "smithy.api#documentation": "Mpeg2 Adaptive Quantization" - } - }, - "com.amazonaws.medialive#Mpeg2ColorMetadata": { - "type": "enum", - "members": { - "IGNORE": { - "target": "smithy.api#Unit", + }, + "Start": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "IGNORE" + "smithy.api#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.", + "smithy.api#jsonName": "start" } }, - "INSERT": { - "target": "smithy.api#Unit", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#enumValue": "INSERT" + "smithy.api#documentation": "A collection of key-value pairs", + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "Mpeg2 Color Metadata" + "smithy.api#documentation": "Placeholder documentation for PurchaseOfferingRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#Mpeg2ColorSpace": { - "type": "enum", + "com.amazonaws.medialive#PurchaseOfferingResponse": { + "type": "structure", "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "PASSTHROUGH": { - "target": "smithy.api#Unit", + "Reservation": { + "target": "com.amazonaws.medialive#Reservation", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#jsonName": "reservation" } } }, "traits": { - "smithy.api#documentation": "Mpeg2 Color Space" + "smithy.api#documentation": "Placeholder documentation for PurchaseOfferingResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#Mpeg2DisplayRatio": { - "type": "enum", - "members": { - "DISPLAYRATIO16X9": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISPLAYRATIO16X9" - } - }, - "DISPLAYRATIO4X3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISPLAYRATIO4X3" - } - } - }, + "com.amazonaws.medialive#RawSettings": { + "type": "structure", + "members": {}, "traits": { - "smithy.api#documentation": "Mpeg2 Display Ratio" + "smithy.api#documentation": "Raw Settings" } }, - "com.amazonaws.medialive#Mpeg2FilterSettings": { - "type": "structure", - "members": { - "TemporalFilterSettings": { - "target": "com.amazonaws.medialive#TemporalFilterSettings", - "traits": { - "smithy.api#jsonName": "temporalFilterSettings" - } - } + "com.amazonaws.medialive#RebootInputDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#RebootInputDeviceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#RebootInputDeviceResponse" }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], "traits": { - "smithy.api#documentation": "Mpeg2 Filter Settings" + "smithy.api#documentation": "Send a reboot command to the specified input device. The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/reboot", + "code": 200 + } } }, - "com.amazonaws.medialive#Mpeg2GopSizeUnits": { + "com.amazonaws.medialive#RebootInputDeviceForce": { "type": "enum", "members": { - "FRAMES": { + "NO": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FRAMES" + "smithy.api#enumValue": "NO" } }, - "SECONDS": { + "YES": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SECONDS" + "smithy.api#enumValue": "YES" } } }, "traits": { - "smithy.api#documentation": "Mpeg2 Gop Size Units" + "smithy.api#documentation": "Whether or not to force reboot the input device." } }, - "com.amazonaws.medialive#Mpeg2ScanType": { - "type": "enum", + "com.amazonaws.medialive#RebootInputDeviceRequest": { + "type": "structure", "members": { - "INTERLACED": { - "target": "smithy.api#Unit", + "Force": { + "target": "com.amazonaws.medialive#RebootInputDeviceForce", "traits": { - "smithy.api#enumValue": "INTERLACED" + "smithy.api#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.", + "smithy.api#jsonName": "force" } }, - "PROGRESSIVE": { - "target": "smithy.api#Unit", + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "PROGRESSIVE" + "smithy.api#documentation": "The unique ID of the input device to reboot. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Mpeg2 Scan Type" + "smithy.api#documentation": "A request to reboot an AWS Elemental device.", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#Mpeg2Settings": { + "com.amazonaws.medialive#RebootInputDeviceResponse": { "type": "structure", - "members": { - "AdaptiveQuantization": { - "target": "com.amazonaws.medialive#Mpeg2AdaptiveQuantization", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "adaptiveQuantization" - } - }, - "AfdSignaling": { - "target": "com.amazonaws.medialive#AfdSignaling", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "afdSignaling" - } - }, - "ColorMetadata": { - "target": "com.amazonaws.medialive#Mpeg2ColorMetadata", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "colorMetadata" - } - }, - "ColorSpace": { - "target": "com.amazonaws.medialive#Mpeg2ColorSpace", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "colorSpace" - } - }, - "DisplayAspectRatio": { - "target": "com.amazonaws.medialive#Mpeg2DisplayRatio", - "traits": { - "smithy.api#documentation": "Sets the pixel aspect ratio for the encode.", - "smithy.api#jsonName": "displayAspectRatio" - } - }, - "FilterSettings": { - "target": "com.amazonaws.medialive#Mpeg2FilterSettings", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "filterSettings" - } - }, - "FixedAfd": { - "target": "com.amazonaws.medialive#FixedAfd", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "fixedAfd" - } - }, - "FramerateDenominator": { - "target": "com.amazonaws.medialive#__integerMin1", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "description\": \"The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.", - "smithy.api#jsonName": "framerateDenominator", - "smithy.api#required": {} - } - }, - "FramerateNumerator": { - "target": "com.amazonaws.medialive#__integerMin1", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.", - "smithy.api#jsonName": "framerateNumerator", - "smithy.api#required": {} - } + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for RebootInputDeviceResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#Rec601Settings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Rec601 Settings" + } + }, + "com.amazonaws.medialive#Rec709Settings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Rec709 Settings" + } + }, + "com.amazonaws.medialive#RejectInputDeviceTransfer": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#RejectInputDeviceTransferRequest" + }, + "output": { + "target": "com.amazonaws.medialive#RejectInputDeviceTransferResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "GopClosedCadence": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "MPEG2: default is open GOP.", - "smithy.api#jsonName": "gopClosedCadence" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "GopNumBFrames": { - "target": "com.amazonaws.medialive#__integerMin0Max7", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "gopNumBFrames" - } + { + "target": "com.amazonaws.medialive#ConflictException" }, - "GopSize": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "gopSize" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "GopSizeUnits": { - "target": "com.amazonaws.medialive#Mpeg2GopSizeUnits", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "gopSizeUnits" - } + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" }, - "ScanType": { - "target": "com.amazonaws.medialive#Mpeg2ScanType", - "traits": { - "smithy.api#documentation": "Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).", - "smithy.api#jsonName": "scanType" - } + { + "target": "com.amazonaws.medialive#InternalServerErrorException" }, - "SubgopLength": { - "target": "com.amazonaws.medialive#Mpeg2SubGopLength", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "subgopLength" - } + { + "target": "com.amazonaws.medialive#NotFoundException" }, - "TimecodeInsertion": { - "target": "com.amazonaws.medialive#Mpeg2TimecodeInsertionBehavior", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "timecodeInsertion" - } + { + "target": "com.amazonaws.medialive#TooManyRequestsException" }, - "TimecodeBurninSettings": { - "target": "com.amazonaws.medialive#TimecodeBurninSettings", + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Reject the transfer of the specified input device to your AWS account.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/reject", + "code": 200 + } + } + }, + "com.amazonaws.medialive#RejectInputDeviceTransferRequest": { + "type": "structure", + "members": { + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Timecode burn-in settings", - "smithy.api#jsonName": "timecodeBurninSettings" + "smithy.api#documentation": "The unique ID of the input device to reject. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Mpeg2 Settings" + "smithy.api#documentation": "Placeholder documentation for RejectInputDeviceTransferRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#Mpeg2SubGopLength": { - "type": "enum", + "com.amazonaws.medialive#RejectInputDeviceTransferResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for RejectInputDeviceTransferResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#RemixSettings": { + "type": "structure", "members": { - "DYNAMIC": { - "target": "smithy.api#Unit", + "ChannelMappings": { + "target": "com.amazonaws.medialive#__listOfAudioChannelMapping", "traits": { - "smithy.api#enumValue": "DYNAMIC" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Mapping of input channels to output channels, with appropriate gain adjustments.", + "smithy.api#jsonName": "channelMappings", + "smithy.api#required": {} } }, - "FIXED": { - "target": "smithy.api#Unit", + "ChannelsIn": { + "target": "com.amazonaws.medialive#__integerMin1Max16", "traits": { - "smithy.api#enumValue": "FIXED" + "smithy.api#documentation": "Number of input channels to be used.", + "smithy.api#jsonName": "channelsIn" + } + }, + "ChannelsOut": { + "target": "com.amazonaws.medialive#__integerMin1Max8", + "traits": { + "smithy.api#documentation": "Number of output channels to be produced.\nValid values: 1, 2, 4, 6, 8", + "smithy.api#jsonName": "channelsOut" } } }, "traits": { - "smithy.api#documentation": "Mpeg2 Sub Gop Length" + "smithy.api#documentation": "Remix Settings" } }, - "com.amazonaws.medialive#Mpeg2TimecodeInsertionBehavior": { - "type": "enum", + "com.amazonaws.medialive#RenewalSettings": { + "type": "structure", "members": { - "DISABLED": { - "target": "smithy.api#Unit", + "AutomaticRenewal": { + "target": "com.amazonaws.medialive#ReservationAutomaticRenewal", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#documentation": "Automatic renewal status for the reservation", + "smithy.api#jsonName": "automaticRenewal" } }, - "GOP_TIMECODE": { - "target": "smithy.api#Unit", + "RenewalCount": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#enumValue": "GOP_TIMECODE" + "smithy.api#documentation": "Count for the reservation renewal", + "smithy.api#jsonName": "renewalCount" } } }, "traits": { - "smithy.api#documentation": "Mpeg2 Timecode Insertion Behavior" + "smithy.api#documentation": "The Renewal settings for Reservations" } }, - "com.amazonaws.medialive#MsSmoothGroupSettings": { + "com.amazonaws.medialive#Reservation": { "type": "structure", "members": { - "AcquisitionPointId": { + "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.", - "smithy.api#jsonName": "acquisitionPointId" + "smithy.api#documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'", + "smithy.api#jsonName": "arn" } }, - "AudioOnlyTimecodeControl": { - "target": "com.amazonaws.medialive#SmoothGroupAudioOnlyTimecodeControl", + "Count": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "audioOnlyTimecodeControl" + "smithy.api#documentation": "Number of reserved resources", + "smithy.api#jsonName": "count" } }, - "CertificateMode": { - "target": "com.amazonaws.medialive#SmoothGroupCertificateMode", + "CurrencyCode": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "certificateMode" + "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", + "smithy.api#jsonName": "currencyCode" } }, - "ConnectionRetryInterval": { - "target": "com.amazonaws.medialive#__integerMin0", + "Duration": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "connectionRetryInterval" + "smithy.api#documentation": "Lease duration, e.g. '12'", + "smithy.api#jsonName": "duration" } }, - "Destination": { - "target": "com.amazonaws.medialive#OutputLocationRef", + "DurationUnits": { + "target": "com.amazonaws.medialive#OfferingDurationUnits", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Smooth Streaming publish point on an IIS server. Elemental Live acts as a \"Push\" encoder to IIS.", - "smithy.api#jsonName": "destination", - "smithy.api#required": {} + "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", + "smithy.api#jsonName": "durationUnits" } }, - "EventId": { + "End": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "MS Smooth event ID to be sent to the IIS server.\n\nShould only be specified if eventIdMode is set to useConfigured.", - "smithy.api#jsonName": "eventId" + "smithy.api#documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'", + "smithy.api#jsonName": "end" } }, - "EventIdMode": { - "target": "com.amazonaws.medialive#SmoothGroupEventIdMode", + "FixedPrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "eventIdMode" + "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", + "smithy.api#jsonName": "fixedPrice" } }, - "EventStopBehavior": { - "target": "com.amazonaws.medialive#SmoothGroupEventStopBehavior", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "When set to sendEos, send EOS signal to IIS server when stopping the event", - "smithy.api#jsonName": "eventStopBehavior" + "smithy.api#documentation": "User specified reservation name", + "smithy.api#jsonName": "name" } }, - "FilecacheDuration": { - "target": "com.amazonaws.medialive#__integerMin0", + "OfferingDescription": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", - "smithy.api#jsonName": "filecacheDuration" + "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", + "smithy.api#jsonName": "offeringDescription" } }, - "FragmentLength": { - "target": "com.amazonaws.medialive#__integerMin1", + "OfferingId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.", - "smithy.api#jsonName": "fragmentLength" + "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#jsonName": "offeringId" } }, - "InputLossAction": { - "target": "com.amazonaws.medialive#InputLossActionForMsSmoothOut", + "OfferingType": { + "target": "com.amazonaws.medialive#OfferingType", "traits": { - "smithy.api#documentation": "Parameter that control output group behavior on input loss.", - "smithy.api#jsonName": "inputLossAction" + "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", + "smithy.api#jsonName": "offeringType" } }, - "NumRetries": { - "target": "com.amazonaws.medialive#__integerMin0", + "Region": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Number of retry attempts.", - "smithy.api#jsonName": "numRetries" + "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", + "smithy.api#jsonName": "region" } }, - "RestartDelay": { - "target": "com.amazonaws.medialive#__integerMin0", + "RenewalSettings": { + "target": "com.amazonaws.medialive#RenewalSettings", "traits": { - "smithy.api#documentation": "Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.", - "smithy.api#jsonName": "restartDelay" + "smithy.api#documentation": "Renewal settings for the reservation", + "smithy.api#jsonName": "renewalSettings" } }, - "SegmentationMode": { - "target": "com.amazonaws.medialive#SmoothGroupSegmentationMode", + "ReservationId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "useInputSegmentation has been deprecated. The configured segment size is always used.", - "smithy.api#jsonName": "segmentationMode" + "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", + "smithy.api#jsonName": "reservationId" } }, - "SendDelayMs": { - "target": "com.amazonaws.medialive#__integerMin0Max10000", + "ResourceSpecification": { + "target": "com.amazonaws.medialive#ReservationResourceSpecification", "traits": { - "smithy.api#documentation": "Number of milliseconds to delay the output from the second pipeline.", - "smithy.api#jsonName": "sendDelayMs" + "smithy.api#documentation": "Resource configuration details", + "smithy.api#jsonName": "resourceSpecification" } }, - "SparseTrackType": { - "target": "com.amazonaws.medialive#SmoothGroupSparseTrackType", + "Start": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "sparseTrackType" + "smithy.api#documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'", + "smithy.api#jsonName": "start" } }, - "StreamManifestBehavior": { - "target": "com.amazonaws.medialive#SmoothGroupStreamManifestBehavior", + "State": { + "target": "com.amazonaws.medialive#ReservationState", "traits": { - "smithy.api#documentation": "When set to send, send stream manifest so publishing point doesn't start until all streams start.", - "smithy.api#jsonName": "streamManifestBehavior" + "smithy.api#documentation": "Current state of reservation, e.g. 'ACTIVE'", + "smithy.api#jsonName": "state" } }, - "TimestampOffset": { - "target": "com.amazonaws.medialive#__string", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.", - "smithy.api#jsonName": "timestampOffset" + "smithy.api#documentation": "A collection of key-value pairs", + "smithy.api#jsonName": "tags" } }, - "TimestampOffsetMode": { - "target": "com.amazonaws.medialive#SmoothGroupTimestampOffsetMode", + "UsagePrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#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", - "smithy.api#jsonName": "timestampOffsetMode" + "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", + "smithy.api#jsonName": "usagePrice" } } }, "traits": { - "smithy.api#documentation": "Ms Smooth Group Settings" + "smithy.api#documentation": "Reserved resources available to use" } }, - "com.amazonaws.medialive#MsSmoothH265PackagingType": { + "com.amazonaws.medialive#ReservationAutomaticRenewal": { "type": "enum", "members": { - "HEV1": { + "DISABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HEV1" + "smithy.api#enumValue": "DISABLED" } }, - "HVC1": { + "ENABLED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HVC1" - } - } - }, - "traits": { - "smithy.api#documentation": "Ms Smooth H265 Packaging Type" - } - }, - "com.amazonaws.medialive#MsSmoothOutputSettings": { - "type": "structure", - "members": { - "H265PackagingType": { - "target": "com.amazonaws.medialive#MsSmoothH265PackagingType", - "traits": { - "smithy.api#documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1.", - "smithy.api#jsonName": "h265PackagingType" + "smithy.api#enumValue": "ENABLED" } }, - "NameModifier": { - "target": "com.amazonaws.medialive#__string", + "UNAVAILABLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type.", - "smithy.api#jsonName": "nameModifier" + "smithy.api#enumValue": "UNAVAILABLE" } } }, "traits": { - "smithy.api#documentation": "Ms Smooth Output Settings" + "smithy.api#documentation": "Automatic Renewal Status for Reservation" } }, - "com.amazonaws.medialive#Multiplex": { - "type": "structure", + "com.amazonaws.medialive#ReservationCodec": { + "type": "enum", "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique arn of the multiplex.", - "smithy.api#jsonName": "arn" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "A list of availability zones for the multiplex.", - "smithy.api#jsonName": "availabilityZones" - } - }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", + "MPEG2": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A list of the multiplex output destinations.", - "smithy.api#jsonName": "destinations" + "smithy.api#enumValue": "MPEG2" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "AVC": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique id of the multiplex.", - "smithy.api#jsonName": "id" + "smithy.api#enumValue": "AVC" } }, - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexSettings", + "HEVC": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Configuration for a multiplex event.", - "smithy.api#jsonName": "multiplexSettings" + "smithy.api#enumValue": "HEVC" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "AUDIO": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the multiplex.", - "smithy.api#jsonName": "name" + "smithy.api#enumValue": "AUDIO" } }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", + "LINK": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" + "smithy.api#enumValue": "LINK" } - }, - "ProgramCount": { - "target": "com.amazonaws.medialive#__integer", + } + }, + "traits": { + "smithy.api#documentation": "Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO'" + } + }, + "com.amazonaws.medialive#ReservationMaximumBitrate": { + "type": "enum", + "members": { + "MAX_10_MBPS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The number of programs in the multiplex.", - "smithy.api#jsonName": "programCount" + "smithy.api#enumValue": "MAX_10_MBPS" } }, - "State": { - "target": "com.amazonaws.medialive#MultiplexState", + "MAX_20_MBPS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The current state of the multiplex.", - "smithy.api#jsonName": "state" + "smithy.api#enumValue": "MAX_20_MBPS" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "MAX_50_MBPS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#enumValue": "MAX_50_MBPS" } } }, "traits": { - "smithy.api#documentation": "The multiplex object." - } - }, - "com.amazonaws.medialive#MultiplexGroupSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Multiplex Group Settings" + "smithy.api#documentation": "Maximum bitrate in megabits per second" } }, - "com.amazonaws.medialive#MultiplexMediaConnectOutputDestinationSettings": { - "type": "structure", + "com.amazonaws.medialive#ReservationMaximumFramerate": { + "type": "enum", "members": { - "EntitlementArn": { - "target": "com.amazonaws.medialive#__stringMin1", + "MAX_30_FPS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The MediaConnect entitlement ARN available as a Flow source.", - "smithy.api#jsonName": "entitlementArn" + "smithy.api#enumValue": "MAX_30_FPS" } - } - }, - "traits": { - "smithy.api#documentation": "Multiplex MediaConnect output destination settings." - } - }, - "com.amazonaws.medialive#MultiplexOutputDestination": { - "type": "structure", - "members": { - "MediaConnectSettings": { - "target": "com.amazonaws.medialive#MultiplexMediaConnectOutputDestinationSettings", + }, + "MAX_60_FPS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Multiplex MediaConnect output destination settings.", - "smithy.api#jsonName": "mediaConnectSettings" + "smithy.api#enumValue": "MAX_60_FPS" } } }, "traits": { - "smithy.api#documentation": "Multiplex output destination settings" + "smithy.api#documentation": "Maximum framerate in frames per second (Outputs only)" } }, - "com.amazonaws.medialive#MultiplexOutputSettings": { - "type": "structure", + "com.amazonaws.medialive#ReservationResolution": { + "type": "enum", "members": { - "Destination": { - "target": "com.amazonaws.medialive#OutputLocationRef", + "SD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Destination is a Multiplex.", - "smithy.api#jsonName": "destination", - "smithy.api#required": {} + "smithy.api#enumValue": "SD" + } + }, + "HD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HD" + } + }, + "FHD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FHD" + } + }, + "UHD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UHD" } } }, "traits": { - "smithy.api#documentation": "Multiplex Output Settings" + "smithy.api#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" } }, - "com.amazonaws.medialive#MultiplexProgram": { + "com.amazonaws.medialive#ReservationResourceSpecification": { "type": "structure", "members": { - "ChannelId": { - "target": "com.amazonaws.medialive#__string", + "ChannelClass": { + "target": "com.amazonaws.medialive#ChannelClass", "traits": { - "smithy.api#documentation": "The MediaLive channel associated with the program.", - "smithy.api#jsonName": "channelId" + "smithy.api#documentation": "Channel class, e.g. 'STANDARD'", + "smithy.api#jsonName": "channelClass" + } + }, + "Codec": { + "target": "com.amazonaws.medialive#ReservationCodec", + "traits": { + "smithy.api#documentation": "Codec, e.g. 'AVC'", + "smithy.api#jsonName": "codec" } }, - "MultiplexProgramSettings": { - "target": "com.amazonaws.medialive#MultiplexProgramSettings", + "MaximumBitrate": { + "target": "com.amazonaws.medialive#ReservationMaximumBitrate", "traits": { - "smithy.api#documentation": "The settings for this multiplex program.", - "smithy.api#jsonName": "multiplexProgramSettings" + "smithy.api#documentation": "Maximum bitrate, e.g. 'MAX_20_MBPS'", + "smithy.api#jsonName": "maximumBitrate" } }, - "PacketIdentifiersMap": { - "target": "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap", + "MaximumFramerate": { + "target": "com.amazonaws.medialive#ReservationMaximumFramerate", "traits": { - "smithy.api#documentation": "The packet identifier map for this multiplex program.", - "smithy.api#jsonName": "packetIdentifiersMap" + "smithy.api#documentation": "Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)", + "smithy.api#jsonName": "maximumFramerate" } }, - "PipelineDetails": { - "target": "com.amazonaws.medialive#__listOfMultiplexProgramPipelineDetail", + "Resolution": { + "target": "com.amazonaws.medialive#ReservationResolution", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "pipelineDetails" + "smithy.api#documentation": "Resolution, e.g. 'HD'", + "smithy.api#jsonName": "resolution" } }, - "ProgramName": { - "target": "com.amazonaws.medialive#__string", + "ResourceType": { + "target": "com.amazonaws.medialive#ReservationResourceType", "traits": { - "smithy.api#documentation": "The name of the multiplex program.", - "smithy.api#jsonName": "programName" + "smithy.api#documentation": "Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'", + "smithy.api#jsonName": "resourceType" } - } - }, - "traits": { - "smithy.api#documentation": "The multiplex program object." - } - }, - "com.amazonaws.medialive#MultiplexProgramChannelDestinationSettings": { - "type": "structure", - "members": { - "MultiplexId": { - "target": "com.amazonaws.medialive#__stringMin1", + }, + "SpecialFeature": { + "target": "com.amazonaws.medialive#ReservationSpecialFeature", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "multiplexId" + "smithy.api#documentation": "Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)", + "smithy.api#jsonName": "specialFeature" } }, - "ProgramName": { - "target": "com.amazonaws.medialive#__stringMin1", + "VideoQuality": { + "target": "com.amazonaws.medialive#ReservationVideoQuality", "traits": { - "smithy.api#documentation": "The program name of the Multiplex program that the encoder is providing output to.", - "smithy.api#jsonName": "programName" + "smithy.api#documentation": "Video quality, e.g. 'STANDARD' (Outputs only)", + "smithy.api#jsonName": "videoQuality" } } }, "traits": { - "smithy.api#documentation": "Multiplex Program Input Destination Settings for outputting a Channel to a Multiplex" + "smithy.api#documentation": "Resource configuration (codec, resolution, bitrate, ...)" } }, - "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap": { - "type": "structure", + "com.amazonaws.medialive#ReservationResourceType": { + "type": "enum", "members": { - "AudioPids": { - "target": "com.amazonaws.medialive#__listOf__integer", - "traits": { - "smithy.api#jsonName": "audioPids" - } - }, - "DvbSubPids": { - "target": "com.amazonaws.medialive#__listOf__integer", + "INPUT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "dvbSubPids" + "smithy.api#enumValue": "INPUT" } }, - "DvbTeletextPid": { - "target": "com.amazonaws.medialive#__integer", + "OUTPUT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "dvbTeletextPid" + "smithy.api#enumValue": "OUTPUT" } }, - "EtvPlatformPid": { - "target": "com.amazonaws.medialive#__integer", + "MULTIPLEX": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "etvPlatformPid" + "smithy.api#enumValue": "MULTIPLEX" } }, - "EtvSignalPid": { - "target": "com.amazonaws.medialive#__integer", + "CHANNEL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "etvSignalPid" + "smithy.api#enumValue": "CHANNEL" } - }, - "KlvDataPids": { - "target": "com.amazonaws.medialive#__listOf__integer", + } + }, + "traits": { + "smithy.api#documentation": "Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'" + } + }, + "com.amazonaws.medialive#ReservationSpecialFeature": { + "type": "enum", + "members": { + "ADVANCED_AUDIO": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "klvDataPids" + "smithy.api#enumValue": "ADVANCED_AUDIO" } }, - "PcrPid": { - "target": "com.amazonaws.medialive#__integer", + "AUDIO_NORMALIZATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "pcrPid" + "smithy.api#enumValue": "AUDIO_NORMALIZATION" } }, - "PmtPid": { - "target": "com.amazonaws.medialive#__integer", + "MGHD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "pmtPid" + "smithy.api#enumValue": "MGHD" } }, - "PrivateMetadataPid": { - "target": "com.amazonaws.medialive#__integer", + "MGUHD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "privateMetadataPid" + "smithy.api#enumValue": "MGUHD" } - }, - "Scte27Pids": { - "target": "com.amazonaws.medialive#__listOf__integer", + } + }, + "traits": { + "smithy.api#documentation": "Special features, 'ADVANCED_AUDIO' 'AUDIO_NORMALIZATION' 'MGHD' or 'MGUHD'" + } + }, + "com.amazonaws.medialive#ReservationState": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "scte27Pids" + "smithy.api#enumValue": "ACTIVE" } }, - "Scte35Pid": { - "target": "com.amazonaws.medialive#__integer", + "EXPIRED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "scte35Pid" + "smithy.api#enumValue": "EXPIRED" } }, - "TimedMetadataPid": { - "target": "com.amazonaws.medialive#__integer", + "CANCELED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "timedMetadataPid" + "smithy.api#enumValue": "CANCELED" } }, - "VideoPid": { - "target": "com.amazonaws.medialive#__integer", + "DELETED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "videoPid" + "smithy.api#enumValue": "DELETED" } } }, "traits": { - "smithy.api#documentation": "Packet identifiers map for a given Multiplex program." + "smithy.api#documentation": "Current reservation state" } }, - "com.amazonaws.medialive#MultiplexProgramPipelineDetail": { - "type": "structure", + "com.amazonaws.medialive#ReservationVideoQuality": { + "type": "enum", "members": { - "ActiveChannelPipeline": { - "target": "com.amazonaws.medialive#__string", + "STANDARD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.", - "smithy.api#jsonName": "activeChannelPipeline" + "smithy.api#enumValue": "STANDARD" } }, - "PipelineId": { - "target": "com.amazonaws.medialive#__string", + "ENHANCED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Identifies a specific pipeline in the multiplex.", - "smithy.api#jsonName": "pipelineId" + "smithy.api#enumValue": "ENHANCED" + } + }, + "PREMIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREMIUM" } } }, "traits": { - "smithy.api#documentation": "The current source for one of the pipelines in the multiplex." + "smithy.api#documentation": "Video quality, e.g. 'STANDARD' (Outputs only)" } }, - "com.amazonaws.medialive#MultiplexProgramServiceDescriptor": { + "com.amazonaws.medialive#RestartChannelPipelines": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#RestartChannelPipelinesRequest" + }, + "output": { + "target": "com.amazonaws.medialive#RestartChannelPipelinesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Restart pipelines in one channel that is currently running.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/channels/{ChannelId}/restartChannelPipelines", + "code": 200 + } + } + }, + "com.amazonaws.medialive#RestartChannelPipelinesRequest": { "type": "structure", "members": { - "ProviderName": { - "target": "com.amazonaws.medialive#__stringMax256", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the provider.", - "smithy.api#jsonName": "providerName", - "smithy.api#required": {} - } - }, - "ServiceName": { - "target": "com.amazonaws.medialive#__stringMax256", + "ChannelId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the service.", - "smithy.api#jsonName": "serviceName", + "smithy.api#documentation": "ID of channel", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "PipelineIds": { + "target": "com.amazonaws.medialive#__listOfChannelPipelineIdToRestart", + "traits": { + "smithy.api#documentation": "An array of pipelines to restart in this channel. Format PIPELINE_0 or PIPELINE_1.", + "smithy.api#jsonName": "pipelineIds" + } } }, "traits": { - "smithy.api#documentation": "Transport stream service descriptor configuration for the Multiplex program." + "smithy.api#documentation": "Pipelines to restart.", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#MultiplexProgramSettings": { + "com.amazonaws.medialive#RestartChannelPipelinesResponse": { "type": "structure", "members": { - "PreferredChannelPipeline": { - "target": "com.amazonaws.medialive#PreferredChannelPipeline", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Indicates which pipeline is preferred by the multiplex for program ingest.", - "smithy.api#jsonName": "preferredChannelPipeline" + "smithy.api#documentation": "The unique arn of the channel.", + "smithy.api#jsonName": "arn" } }, - "ProgramNumber": { - "target": "com.amazonaws.medialive#__integerMin0Max65535", + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Unique program number.", - "smithy.api#jsonName": "programNumber", - "smithy.api#required": {} + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" } }, - "ServiceDescriptor": { - "target": "com.amazonaws.medialive#MultiplexProgramServiceDescriptor", + "ChannelClass": { + "target": "com.amazonaws.medialive#ChannelClass", "traits": { - "smithy.api#documentation": "Transport stream service descriptor configuration for the Multiplex program.", - "smithy.api#jsonName": "serviceDescriptor" + "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", + "smithy.api#jsonName": "channelClass" } }, - "VideoSettings": { - "target": "com.amazonaws.medialive#MultiplexVideoSettings", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfOutputDestination", "traits": { - "smithy.api#documentation": "Program video settings configuration.", - "smithy.api#jsonName": "videoSettings" + "smithy.api#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.", + "smithy.api#jsonName": "destinations" } - } - }, - "traits": { - "smithy.api#documentation": "Multiplex Program settings configuration." - } - }, - "com.amazonaws.medialive#MultiplexProgramSummary": { - "type": "structure", - "members": { - "ChannelId": { - "target": "com.amazonaws.medialive#__string", + }, + "EgressEndpoints": { + "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", "traits": { - "smithy.api#documentation": "The MediaLive Channel associated with the program.", - "smithy.api#jsonName": "channelId" + "smithy.api#documentation": "The endpoints where outgoing connections initiate from", + "smithy.api#jsonName": "egressEndpoints" } }, - "ProgramName": { + "EncoderSettings": { + "target": "com.amazonaws.medialive#EncoderSettings", + "traits": { + "smithy.api#jsonName": "encoderSettings" + } + }, + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The name of the multiplex program.", - "smithy.api#jsonName": "programName" + "smithy.api#documentation": "The unique id of the channel.", + "smithy.api#jsonName": "id" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for MultiplexProgramSummary" - } - }, - "com.amazonaws.medialive#MultiplexSettings": { - "type": "structure", - "members": { - "MaximumVideoBufferDelayMilliseconds": { - "target": "com.amazonaws.medialive#__integerMin800Max3000", + }, + "InputAttachments": { + "target": "com.amazonaws.medialive#__listOfInputAttachment", "traits": { - "smithy.api#documentation": "Maximum video buffer delay in milliseconds.", - "smithy.api#jsonName": "maximumVideoBufferDelayMilliseconds" + "smithy.api#documentation": "List of input attachments for channel.", + "smithy.api#jsonName": "inputAttachments" } }, - "TransportStreamBitrate": { - "target": "com.amazonaws.medialive#__integerMin1000000Max100000000", + "InputSpecification": { + "target": "com.amazonaws.medialive#InputSpecification", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Transport stream bit rate.", - "smithy.api#jsonName": "transportStreamBitrate", - "smithy.api#required": {} + "smithy.api#documentation": "Specification of network and file inputs for this channel", + "smithy.api#jsonName": "inputSpecification" } }, - "TransportStreamId": { - "target": "com.amazonaws.medialive#__integerMin0Max65535", + "LogLevel": { + "target": "com.amazonaws.medialive#LogLevel", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Transport stream ID.", - "smithy.api#jsonName": "transportStreamId", - "smithy.api#required": {} + "smithy.api#documentation": "The log level being written to CloudWatch Logs.", + "smithy.api#jsonName": "logLevel" } }, - "TransportStreamReservedBitrate": { - "target": "com.amazonaws.medialive#__integerMin0Max100000000", + "Maintenance": { + "target": "com.amazonaws.medialive#MaintenanceStatus", "traits": { - "smithy.api#documentation": "Transport stream reserved bit rate.", - "smithy.api#jsonName": "transportStreamReservedBitrate" + "smithy.api#documentation": "Maintenance settings for this channel.", + "smithy.api#jsonName": "maintenance" } - } - }, - "traits": { - "smithy.api#documentation": "Contains configuration for a Multiplex event" - } - }, - "com.amazonaws.medialive#MultiplexSettingsSummary": { - "type": "structure", - "members": { - "TransportStreamBitrate": { - "target": "com.amazonaws.medialive#__integerMin1000000Max100000000", + }, + "MaintenanceStatus": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Transport stream bit rate.", - "smithy.api#jsonName": "transportStreamBitrate" + "smithy.api#documentation": "The time in milliseconds by when the PVRE restart must occur.", + "smithy.api#jsonName": "maintenanceStatus" } - } - }, - "traits": { - "smithy.api#documentation": "Contains summary configuration for a Multiplex event." - } - }, - "com.amazonaws.medialive#MultiplexState": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", + }, + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "CREATING" + "smithy.api#documentation": "The name of the channel. (user-mutable)", + "smithy.api#jsonName": "name" } }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfPipelineDetail", "traits": { - "smithy.api#enumValue": "CREATE_FAILED" + "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", + "smithy.api#jsonName": "pipelineDetails" } }, - "IDLE": { - "target": "smithy.api#Unit", + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#enumValue": "IDLE" + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" } }, - "STARTING": { - "target": "smithy.api#Unit", + "RoleArn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "STARTING" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", + "smithy.api#jsonName": "roleArn" } }, - "RUNNING": { - "target": "smithy.api#Unit", + "State": { + "target": "com.amazonaws.medialive#ChannelState", "traits": { - "smithy.api#enumValue": "RUNNING" + "smithy.api#jsonName": "state" } }, - "RECOVERING": { - "target": "smithy.api#Unit", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#enumValue": "RECOVERING" + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" } }, - "STOPPING": { + "Vpc": { + "target": "com.amazonaws.medialive#VpcOutputSettingsDescription", + "traits": { + "smithy.api#documentation": "Settings for VPC output", + "smithy.api#jsonName": "vpc" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for RestartChannelPipelinesResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#RtmpAdMarkers": { + "type": "enum", + "members": { + "ON_CUE_POINT_SCTE35": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "STOPPING" + "smithy.api#enumValue": "ON_CUE_POINT_SCTE35" } - }, - "DELETING": { + } + }, + "traits": { + "smithy.api#documentation": "Rtmp Ad Markers" + } + }, + "com.amazonaws.medialive#RtmpCacheFullBehavior": { + "type": "enum", + "members": { + "DISCONNECT_IMMEDIATELY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DELETING" + "smithy.api#enumValue": "DISCONNECT_IMMEDIATELY" } }, - "DELETED": { + "WAIT_FOR_SERVER": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DELETED" + "smithy.api#enumValue": "WAIT_FOR_SERVER" } } }, "traits": { - "smithy.api#documentation": "The current state of the multiplex." + "smithy.api#documentation": "Rtmp Cache Full Behavior" } }, - "com.amazonaws.medialive#MultiplexStatmuxVideoSettings": { - "type": "structure", + "com.amazonaws.medialive#RtmpCaptionData": { + "type": "enum", "members": { - "MaximumBitrate": { - "target": "com.amazonaws.medialive#__integerMin100000Max100000000", + "ALL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Maximum statmux bitrate.", - "smithy.api#jsonName": "maximumBitrate" + "smithy.api#enumValue": "ALL" } }, - "MinimumBitrate": { - "target": "com.amazonaws.medialive#__integerMin100000Max100000000", + "FIELD1_608": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Minimum statmux bitrate.", - "smithy.api#jsonName": "minimumBitrate" + "smithy.api#enumValue": "FIELD1_608" } }, - "Priority": { - "target": "com.amazonaws.medialive#__integerMinNegative5Max5", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "priority" + "FIELD1_AND_FIELD2_608": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD1_AND_FIELD2_608" } } }, "traits": { - "smithy.api#documentation": "Statmux rate control settings" + "smithy.api#documentation": "Rtmp Caption Data" } }, - "com.amazonaws.medialive#MultiplexSummary": { + "com.amazonaws.medialive#RtmpCaptionInfoDestinationSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Rtmp Caption Info Destination Settings" + } + }, + "com.amazonaws.medialive#RtmpGroupSettings": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique arn of the multiplex.", - "smithy.api#jsonName": "arn" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "A list of availability zones for the multiplex.", - "smithy.api#jsonName": "availabilityZones" - } - }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "AdMarkers": { + "target": "com.amazonaws.medialive#__listOfRtmpAdMarkers", "traits": { - "smithy.api#documentation": "The unique id of the multiplex.", - "smithy.api#jsonName": "id" + "smithy.api#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.", + "smithy.api#jsonName": "adMarkers" } }, - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexSettingsSummary", + "AuthenticationScheme": { + "target": "com.amazonaws.medialive#AuthenticationScheme", "traits": { - "smithy.api#documentation": "Configuration for a multiplex event.", - "smithy.api#jsonName": "multiplexSettings" + "smithy.api#documentation": "Authentication scheme to use when connecting with CDN", + "smithy.api#jsonName": "authenticationScheme" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "CacheFullBehavior": { + "target": "com.amazonaws.medialive#RtmpCacheFullBehavior", "traits": { - "smithy.api#documentation": "The name of the multiplex.", - "smithy.api#jsonName": "name" + "smithy.api#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.", + "smithy.api#jsonName": "cacheFullBehavior" } }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", + "CacheLength": { + "target": "com.amazonaws.medialive#__integerMin30", "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" + "smithy.api#documentation": "Cache length, in seconds, is used to calculate buffer size.", + "smithy.api#jsonName": "cacheLength" } }, - "ProgramCount": { - "target": "com.amazonaws.medialive#__integer", + "CaptionData": { + "target": "com.amazonaws.medialive#RtmpCaptionData", "traits": { - "smithy.api#documentation": "The number of programs in the multiplex.", - "smithy.api#jsonName": "programCount" + "smithy.api#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.", + "smithy.api#jsonName": "captionData" } }, - "State": { - "target": "com.amazonaws.medialive#MultiplexState", + "InputLossAction": { + "target": "com.amazonaws.medialive#InputLossActionForRtmpOut", "traits": { - "smithy.api#documentation": "The current state of the multiplex.", - "smithy.api#jsonName": "state" + "smithy.api#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.", + "smithy.api#jsonName": "inputLossAction" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", - "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for MultiplexSummary" - } - }, - "com.amazonaws.medialive#MultiplexVideoSettings": { - "type": "structure", - "members": { - "ConstantBitrate": { - "target": "com.amazonaws.medialive#__integerMin100000Max100000000", + "RestartDelay": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "The constant bitrate configuration for the video encode.\nWhen this field is defined, StatmuxSettings must be undefined.", - "smithy.api#jsonName": "constantBitrate" + "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", + "smithy.api#jsonName": "restartDelay" } }, - "StatmuxSettings": { - "target": "com.amazonaws.medialive#MultiplexStatmuxVideoSettings", + "IncludeFillerNalUnits": { + "target": "com.amazonaws.medialive#IncludeFillerNalUnits", "traits": { - "smithy.api#documentation": "Statmux rate control settings.\nWhen this field is defined, ConstantBitrate must be undefined.", - "smithy.api#jsonName": "statmuxSettings" + "smithy.api#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.", + "smithy.api#jsonName": "includeFillerNalUnits" } } }, "traits": { - "smithy.api#documentation": "The video configuration for each program in a multiplex." + "smithy.api#documentation": "Rtmp Group Settings" } }, - "com.amazonaws.medialive#NetworkInputServerValidation": { + "com.amazonaws.medialive#RtmpOutputCertificateMode": { "type": "enum", "members": { - "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME": { + "SELF_SIGNED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME" + "smithy.api#enumValue": "SELF_SIGNED" } }, - "CHECK_CRYPTOGRAPHY_ONLY": { + "VERIFY_AUTHENTICITY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CHECK_CRYPTOGRAPHY_ONLY" + "smithy.api#enumValue": "VERIFY_AUTHENTICITY" } } }, "traits": { - "smithy.api#documentation": "Network Input Server Validation" + "smithy.api#documentation": "Rtmp Output Certificate Mode" } }, - "com.amazonaws.medialive#NetworkInputSettings": { + "com.amazonaws.medialive#RtmpOutputSettings": { "type": "structure", "members": { - "HlsInputSettings": { - "target": "com.amazonaws.medialive#HlsInputSettings", + "CertificateMode": { + "target": "com.amazonaws.medialive#RtmpOutputCertificateMode", "traits": { - "smithy.api#documentation": "Specifies HLS input settings when the uri is for a HLS manifest.", - "smithy.api#jsonName": "hlsInputSettings" + "smithy.api#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.", + "smithy.api#jsonName": "certificateMode" } }, - "ServerValidation": { - "target": "com.amazonaws.medialive#NetworkInputServerValidation", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "serverValidation" - } - } - }, - "traits": { - "smithy.api#documentation": "Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection." - } - }, - "com.amazonaws.medialive#NielsenCBET": { - "type": "structure", - "members": { - "CbetCheckDigitString": { - "target": "com.amazonaws.medialive#__stringMin2Max2", + "ConnectionRetryInterval": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Enter the CBET check digits to use in the watermark.", - "smithy.api#jsonName": "cbetCheckDigitString", - "smithy.api#required": {} + "smithy.api#documentation": "Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.", + "smithy.api#jsonName": "connectionRetryInterval" } }, - "CbetStepaside": { - "target": "com.amazonaws.medialive#NielsenWatermarksCbetStepaside", + "Destination": { + "target": "com.amazonaws.medialive#OutputLocationRef", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Determines the method of CBET insertion mode when prior encoding is detected on the same layer.", - "smithy.api#jsonName": "cbetStepaside", + "smithy.api#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.", + "smithy.api#jsonName": "destination", "smithy.api#required": {} } }, - "Csid": { - "target": "com.amazonaws.medialive#__stringMin1Max7", + "NumRetries": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Enter the CBET Source ID (CSID) to use in the watermark", - "smithy.api#jsonName": "csid", - "smithy.api#required": {} + "smithy.api#documentation": "Number of retry attempts.", + "smithy.api#jsonName": "numRetries" } } }, "traits": { - "smithy.api#documentation": "Nielsen CBET" + "smithy.api#documentation": "Rtmp Output Settings" } }, - "com.amazonaws.medialive#NielsenConfiguration": { - "type": "structure", + "com.amazonaws.medialive#S3CannedAcl": { + "type": "enum", "members": { - "DistributorId": { - "target": "com.amazonaws.medialive#__string", + "AUTHENTICATED_READ": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Enter the Distributor ID assigned to your organization by Nielsen.", - "smithy.api#jsonName": "distributorId" + "smithy.api#enumValue": "AUTHENTICATED_READ" } }, - "NielsenPcmToId3Tagging": { - "target": "com.amazonaws.medialive#NielsenPcmToId3TaggingState", + "BUCKET_OWNER_FULL_CONTROL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Enables Nielsen PCM to ID3 tagging", - "smithy.api#jsonName": "nielsenPcmToId3Tagging" + "smithy.api#enumValue": "BUCKET_OWNER_FULL_CONTROL" + } + }, + "BUCKET_OWNER_READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUCKET_OWNER_READ" + } + }, + "PUBLIC_READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLIC_READ" } } }, "traits": { - "smithy.api#documentation": "Nielsen Configuration" + "smithy.api#documentation": "S3 Canned Acl" } }, - "com.amazonaws.medialive#NielsenNaesIiNw": { + "com.amazonaws.medialive#ScheduleAction": { "type": "structure", "members": { - "CheckDigitString": { - "target": "com.amazonaws.medialive#__stringMin2Max2", + "ActionName": { + "target": "com.amazonaws.medialive#__string", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Enter the check digit string for the watermark", - "smithy.api#jsonName": "checkDigitString", + "smithy.api#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.", + "smithy.api#jsonName": "actionName", "smithy.api#required": {} } }, - "Sid": { - "target": "com.amazonaws.medialive#__doubleMin1Max65535", + "ScheduleActionSettings": { + "target": "com.amazonaws.medialive#ScheduleActionSettings", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Enter the Nielsen Source ID (SID) to include in the watermark", - "smithy.api#jsonName": "sid", + "smithy.api#documentation": "Settings for this schedule action.", + "smithy.api#jsonName": "scheduleActionSettings", "smithy.api#required": {} } }, - "Timezone": { - "target": "com.amazonaws.medialive#NielsenWatermarkTimezones", - "traits": { - "smithy.api#documentation": "Choose the timezone for the time stamps in the watermark. If not provided,\nthe timestamps will be in Coordinated Universal Time (UTC)", - "smithy.api#jsonName": "timezone" - } - } - }, - "traits": { - "smithy.api#documentation": "Nielsen Naes Ii Nw" - } - }, - "com.amazonaws.medialive#NielsenPcmToId3TaggingState": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "ENABLED": { - "target": "smithy.api#Unit", + "ScheduleActionStartSettings": { + "target": "com.amazonaws.medialive#ScheduleActionStartSettings", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time for the action to start in the channel.", + "smithy.api#jsonName": "scheduleActionStartSettings", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "State of Nielsen PCM to ID3 tagging" + "smithy.api#documentation": "Contains information on a single schedule action." } }, - "com.amazonaws.medialive#NielsenWatermarkTimezones": { - "type": "enum", + "com.amazonaws.medialive#ScheduleActionSettings": { + "type": "structure", "members": { - "AMERICA_PUERTO_RICO": { - "target": "smithy.api#Unit", + "HlsId3SegmentTaggingSettings": { + "target": "com.amazonaws.medialive#HlsId3SegmentTaggingScheduleActionSettings", "traits": { - "smithy.api#enumValue": "AMERICA_PUERTO_RICO" + "smithy.api#documentation": "Action to insert HLS ID3 segment tagging", + "smithy.api#jsonName": "hlsId3SegmentTaggingSettings" } }, - "US_ALASKA": { - "target": "smithy.api#Unit", + "HlsTimedMetadataSettings": { + "target": "com.amazonaws.medialive#HlsTimedMetadataScheduleActionSettings", "traits": { - "smithy.api#enumValue": "US_ALASKA" + "smithy.api#documentation": "Action to insert HLS metadata", + "smithy.api#jsonName": "hlsTimedMetadataSettings" } }, - "US_ARIZONA": { - "target": "smithy.api#Unit", + "InputPrepareSettings": { + "target": "com.amazonaws.medialive#InputPrepareScheduleActionSettings", "traits": { - "smithy.api#enumValue": "US_ARIZONA" + "smithy.api#documentation": "Action to prepare an input for a future immediate input switch", + "smithy.api#jsonName": "inputPrepareSettings" } }, - "US_CENTRAL": { - "target": "smithy.api#Unit", + "InputSwitchSettings": { + "target": "com.amazonaws.medialive#InputSwitchScheduleActionSettings", "traits": { - "smithy.api#enumValue": "US_CENTRAL" + "smithy.api#documentation": "Action to switch the input", + "smithy.api#jsonName": "inputSwitchSettings" } }, - "US_EASTERN": { - "target": "smithy.api#Unit", + "MotionGraphicsImageActivateSettings": { + "target": "com.amazonaws.medialive#MotionGraphicsActivateScheduleActionSettings", "traits": { - "smithy.api#enumValue": "US_EASTERN" + "smithy.api#documentation": "Action to activate a motion graphics image overlay", + "smithy.api#jsonName": "motionGraphicsImageActivateSettings" } }, - "US_HAWAII": { - "target": "smithy.api#Unit", + "MotionGraphicsImageDeactivateSettings": { + "target": "com.amazonaws.medialive#MotionGraphicsDeactivateScheduleActionSettings", "traits": { - "smithy.api#enumValue": "US_HAWAII" + "smithy.api#documentation": "Action to deactivate a motion graphics image overlay", + "smithy.api#jsonName": "motionGraphicsImageDeactivateSettings" } }, - "US_MOUNTAIN": { - "target": "smithy.api#Unit", + "PauseStateSettings": { + "target": "com.amazonaws.medialive#PauseStateScheduleActionSettings", "traits": { - "smithy.api#enumValue": "US_MOUNTAIN" + "smithy.api#documentation": "Action to pause or unpause one or both channel pipelines", + "smithy.api#jsonName": "pauseStateSettings" } }, - "US_PACIFIC": { - "target": "smithy.api#Unit", + "Scte35InputSettings": { + "target": "com.amazonaws.medialive#Scte35InputScheduleActionSettings", "traits": { - "smithy.api#enumValue": "US_PACIFIC" + "smithy.api#documentation": "Action to specify scte35 input", + "smithy.api#jsonName": "scte35InputSettings" } }, - "US_SAMOA": { - "target": "smithy.api#Unit", + "Scte35ReturnToNetworkSettings": { + "target": "com.amazonaws.medialive#Scte35ReturnToNetworkScheduleActionSettings", "traits": { - "smithy.api#enumValue": "US_SAMOA" + "smithy.api#documentation": "Action to insert SCTE-35 return_to_network message", + "smithy.api#jsonName": "scte35ReturnToNetworkSettings" } }, - "UTC": { - "target": "smithy.api#Unit", + "Scte35SpliceInsertSettings": { + "target": "com.amazonaws.medialive#Scte35SpliceInsertScheduleActionSettings", "traits": { - "smithy.api#enumValue": "UTC" + "smithy.api#documentation": "Action to insert SCTE-35 splice_insert message", + "smithy.api#jsonName": "scte35SpliceInsertSettings" } - } - }, - "traits": { - "smithy.api#documentation": "Nielsen Watermark Timezones" - } - }, - "com.amazonaws.medialive#NielsenWatermarksCbetStepaside": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", + }, + "Scte35TimeSignalSettings": { + "target": "com.amazonaws.medialive#Scte35TimeSignalScheduleActionSettings", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#documentation": "Action to insert SCTE-35 time_signal message", + "smithy.api#jsonName": "scte35TimeSignalSettings" } }, - "ENABLED": { - "target": "smithy.api#Unit", + "StaticImageActivateSettings": { + "target": "com.amazonaws.medialive#StaticImageActivateScheduleActionSettings", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#documentation": "Action to activate a static image overlay", + "smithy.api#jsonName": "staticImageActivateSettings" } - } - }, - "traits": { - "smithy.api#documentation": "Nielsen Watermarks Cbet Stepaside" - } - }, - "com.amazonaws.medialive#NielsenWatermarksDistributionTypes": { - "type": "enum", - "members": { - "FINAL_DISTRIBUTOR": { - "target": "smithy.api#Unit", + }, + "StaticImageDeactivateSettings": { + "target": "com.amazonaws.medialive#StaticImageDeactivateScheduleActionSettings", "traits": { - "smithy.api#enumValue": "FINAL_DISTRIBUTOR" + "smithy.api#documentation": "Action to deactivate a static image overlay", + "smithy.api#jsonName": "staticImageDeactivateSettings" } }, - "PROGRAM_CONTENT": { - "target": "smithy.api#Unit", + "StaticImageOutputActivateSettings": { + "target": "com.amazonaws.medialive#StaticImageOutputActivateScheduleActionSettings", "traits": { - "smithy.api#enumValue": "PROGRAM_CONTENT" + "smithy.api#documentation": "Action to activate a static image overlay in one or more specified outputs", + "smithy.api#jsonName": "staticImageOutputActivateSettings" + } + }, + "StaticImageOutputDeactivateSettings": { + "target": "com.amazonaws.medialive#StaticImageOutputDeactivateScheduleActionSettings", + "traits": { + "smithy.api#documentation": "Action to deactivate a static image overlay in one or more specified outputs", + "smithy.api#jsonName": "staticImageOutputDeactivateSettings" } } }, "traits": { - "smithy.api#documentation": "Nielsen Watermarks Distribution Types" + "smithy.api#documentation": "Holds the settings for a single schedule action." } }, - "com.amazonaws.medialive#NielsenWatermarksSettings": { + "com.amazonaws.medialive#ScheduleActionStartSettings": { "type": "structure", "members": { - "NielsenCbetSettings": { - "target": "com.amazonaws.medialive#NielsenCBET", + "FixedModeScheduleActionStartSettings": { + "target": "com.amazonaws.medialive#FixedModeScheduleActionStartSettings", "traits": { - "smithy.api#documentation": "Complete these fields only if you want to insert watermarks of type Nielsen CBET", - "smithy.api#jsonName": "nielsenCbetSettings" + "smithy.api#documentation": "Option for specifying the start time for an action.", + "smithy.api#jsonName": "fixedModeScheduleActionStartSettings" } }, - "NielsenDistributionType": { - "target": "com.amazonaws.medialive#NielsenWatermarksDistributionTypes", + "FollowModeScheduleActionStartSettings": { + "target": "com.amazonaws.medialive#FollowModeScheduleActionStartSettings", "traits": { - "smithy.api#documentation": "Choose the distribution types that you want to assign to the watermarks:\n- PROGRAM_CONTENT\n- FINAL_DISTRIBUTOR", - "smithy.api#jsonName": "nielsenDistributionType" + "smithy.api#documentation": "Option for specifying an action as relative to another action.", + "smithy.api#jsonName": "followModeScheduleActionStartSettings" } }, - "NielsenNaesIiNwSettings": { - "target": "com.amazonaws.medialive#NielsenNaesIiNw", + "ImmediateModeScheduleActionStartSettings": { + "target": "com.amazonaws.medialive#ImmediateModeScheduleActionStartSettings", "traits": { - "smithy.api#documentation": "Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW).", - "smithy.api#jsonName": "nielsenNaesIiNwSettings" + "smithy.api#documentation": "Option for specifying an action that should be applied immediately.", + "smithy.api#jsonName": "immediateModeScheduleActionStartSettings" } } }, "traits": { - "smithy.api#documentation": "Nielsen Watermarks Settings" + "smithy.api#documentation": "Settings to specify when an action should occur. Only one of the options must be selected." } }, - "com.amazonaws.medialive#NotFoundException": { - "type": "structure", + "com.amazonaws.medialive#Scte20Convert608To708": { + "type": "enum", "members": { - "Message": { - "target": "com.amazonaws.medialive#__string", + "DISABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "message" + "smithy.api#enumValue": "DISABLED" + } + }, + "UPCONVERT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPCONVERT" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for NotFoundException", - "smithy.api#error": "client", - "smithy.api#httpError": 404 + "smithy.api#documentation": "Scte20 Convert608 To708" } }, - "com.amazonaws.medialive#Offering": { + "com.amazonaws.medialive#Scte20PlusEmbeddedDestinationSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Scte20 Plus Embedded Destination Settings" + } + }, + "com.amazonaws.medialive#Scte20SourceSettings": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'", - "smithy.api#jsonName": "arn" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", - "smithy.api#jsonName": "currencyCode" - } - }, - "Duration": { - "target": "com.amazonaws.medialive#__integer", - "traits": { - "smithy.api#documentation": "Lease duration, e.g. '12'", - "smithy.api#jsonName": "duration" - } - }, - "DurationUnits": { - "target": "com.amazonaws.medialive#OfferingDurationUnits", - "traits": { - "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", - "smithy.api#jsonName": "durationUnits" - } - }, - "FixedPrice": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", - "smithy.api#jsonName": "fixedPrice" - } - }, - "OfferingDescription": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", - "smithy.api#jsonName": "offeringDescription" - } - }, - "OfferingId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", - "smithy.api#jsonName": "offeringId" - } - }, - "OfferingType": { - "target": "com.amazonaws.medialive#OfferingType", - "traits": { - "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", - "smithy.api#jsonName": "offeringType" - } - }, - "Region": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", - "smithy.api#jsonName": "region" - } - }, - "ResourceSpecification": { - "target": "com.amazonaws.medialive#ReservationResourceSpecification", + "Convert608To708": { + "target": "com.amazonaws.medialive#Scte20Convert608To708", "traits": { - "smithy.api#documentation": "Resource configuration details", - "smithy.api#jsonName": "resourceSpecification" + "smithy.api#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.", + "smithy.api#jsonName": "convert608To708" } }, - "UsagePrice": { - "target": "com.amazonaws.medialive#__double", + "Source608ChannelNumber": { + "target": "com.amazonaws.medialive#__integerMin1Max4", "traits": { - "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", - "smithy.api#jsonName": "usagePrice" + "smithy.api#documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.", + "smithy.api#jsonName": "source608ChannelNumber" } } }, "traits": { - "smithy.api#documentation": "Reserved resources available for purchase" + "smithy.api#documentation": "Scte20 Source Settings" } }, - "com.amazonaws.medialive#OfferingDurationUnits": { - "type": "enum", - "members": { - "MONTHS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONTHS" - } - } - }, + "com.amazonaws.medialive#Scte27DestinationSettings": { + "type": "structure", + "members": {}, "traits": { - "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'" + "smithy.api#documentation": "Scte27 Destination Settings" } }, - "com.amazonaws.medialive#OfferingType": { + "com.amazonaws.medialive#Scte27OcrLanguage": { "type": "enum", "members": { - "NO_UPFRONT": { + "DEU": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NO_UPFRONT" + "smithy.api#enumValue": "DEU" } - } - }, - "traits": { - "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'" - } - }, - "com.amazonaws.medialive#Output": { - "type": "structure", - "members": { - "AudioDescriptionNames": { - "target": "com.amazonaws.medialive#__listOf__string", + }, + "ENG": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The names of the AudioDescriptions used as audio sources for this output.", - "smithy.api#jsonName": "audioDescriptionNames" + "smithy.api#enumValue": "ENG" } }, - "CaptionDescriptionNames": { - "target": "com.amazonaws.medialive#__listOf__string", + "FRA": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The names of the CaptionDescriptions used as caption sources for this output.", - "smithy.api#jsonName": "captionDescriptionNames" + "smithy.api#enumValue": "FRA" } }, - "OutputName": { - "target": "com.amazonaws.medialive#__stringMin1Max255", + "NLD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name used to identify an output.", - "smithy.api#jsonName": "outputName" + "smithy.api#enumValue": "NLD" } }, - "OutputSettings": { - "target": "com.amazonaws.medialive#OutputSettings", + "POR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Output type-specific settings.", - "smithy.api#jsonName": "outputSettings", - "smithy.api#required": {} + "smithy.api#enumValue": "POR" } }, - "VideoDescriptionName": { - "target": "com.amazonaws.medialive#__string", + "SPA": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the VideoDescription used as the source for this output.", - "smithy.api#jsonName": "videoDescriptionName" + "smithy.api#enumValue": "SPA" } } }, "traits": { - "smithy.api#documentation": "Output settings. There can be multiple outputs within a group." + "smithy.api#documentation": "Scte27 Ocr Language" } }, - "com.amazonaws.medialive#OutputDestination": { + "com.amazonaws.medialive#Scte27SourceSettings": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "User-specified id. This is used in an output group or an output.", - "smithy.api#jsonName": "id" - } - }, - "MediaPackageSettings": { - "target": "com.amazonaws.medialive#__listOfMediaPackageOutputDestinationSettings", - "traits": { - "smithy.api#documentation": "Destination settings for a MediaPackage output; one destination for both encoders.", - "smithy.api#jsonName": "mediaPackageSettings" - } - }, - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexProgramChannelDestinationSettings", + "OcrLanguage": { + "target": "com.amazonaws.medialive#Scte27OcrLanguage", "traits": { - "smithy.api#documentation": "Destination settings for a Multiplex output; one destination for both encoders.", - "smithy.api#jsonName": "multiplexSettings" + "smithy.api#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.", + "smithy.api#jsonName": "ocrLanguage" } }, - "Settings": { - "target": "com.amazonaws.medialive#__listOfOutputDestinationSettings", + "Pid": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Destination settings for a standard output; one destination for each redundant encoder.", - "smithy.api#jsonName": "settings" + "smithy.api#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.", + "smithy.api#jsonName": "pid" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for OutputDestination" + "smithy.api#documentation": "Scte27 Source Settings" } }, - "com.amazonaws.medialive#OutputDestinationSettings": { - "type": "structure", + "com.amazonaws.medialive#Scte35AposNoRegionalBlackoutBehavior": { + "type": "enum", "members": { - "PasswordParam": { - "target": "com.amazonaws.medialive#__string", + "FOLLOW": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "key used to extract the password from EC2 Parameter store", - "smithy.api#jsonName": "passwordParam" + "smithy.api#enumValue": "FOLLOW" } }, - "StreamName": { - "target": "com.amazonaws.medialive#__string", + "IGNORE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Stream name for RTMP destinations (URLs of type rtmp://)", - "smithy.api#jsonName": "streamName" + "smithy.api#enumValue": "IGNORE" } - }, - "Url": { - "target": "com.amazonaws.medialive#__string", + } + }, + "traits": { + "smithy.api#documentation": "Scte35 Apos No Regional Blackout Behavior" + } + }, + "com.amazonaws.medialive#Scte35AposWebDeliveryAllowedBehavior": { + "type": "enum", + "members": { + "FOLLOW": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A URL specifying a destination", - "smithy.api#jsonName": "url" + "smithy.api#enumValue": "FOLLOW" } }, - "Username": { - "target": "com.amazonaws.medialive#__string", + "IGNORE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "username for destination", - "smithy.api#jsonName": "username" + "smithy.api#enumValue": "IGNORE" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for OutputDestinationSettings" + "smithy.api#documentation": "Scte35 Apos Web Delivery Allowed Behavior" } }, - "com.amazonaws.medialive#OutputGroup": { - "type": "structure", + "com.amazonaws.medialive#Scte35ArchiveAllowedFlag": { + "type": "enum", "members": { - "Name": { - "target": "com.amazonaws.medialive#__stringMax32", - "traits": { - "smithy.api#documentation": "Custom output group name optionally defined by the user.", - "smithy.api#jsonName": "name" - } - }, - "OutputGroupSettings": { - "target": "com.amazonaws.medialive#OutputGroupSettings", + "ARCHIVE_NOT_ALLOWED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Settings associated with the output group.", - "smithy.api#jsonName": "outputGroupSettings", - "smithy.api#required": {} + "smithy.api#enumValue": "ARCHIVE_NOT_ALLOWED" } }, - "Outputs": { - "target": "com.amazonaws.medialive#__listOfOutput", + "ARCHIVE_ALLOWED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#jsonName": "outputs", - "smithy.api#required": {} + "smithy.api#enumValue": "ARCHIVE_ALLOWED" } } }, "traits": { - "smithy.api#documentation": "Output groups for this Live Event. Output groups contain information about where streams should be distributed." + "smithy.api#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." } }, - "com.amazonaws.medialive#OutputGroupSettings": { + "com.amazonaws.medialive#Scte35DeliveryRestrictions": { "type": "structure", "members": { - "ArchiveGroupSettings": { - "target": "com.amazonaws.medialive#ArchiveGroupSettings", - "traits": { - "smithy.api#jsonName": "archiveGroupSettings" - } - }, - "FrameCaptureGroupSettings": { - "target": "com.amazonaws.medialive#FrameCaptureGroupSettings", - "traits": { - "smithy.api#jsonName": "frameCaptureGroupSettings" - } - }, - "HlsGroupSettings": { - "target": "com.amazonaws.medialive#HlsGroupSettings", - "traits": { - "smithy.api#jsonName": "hlsGroupSettings" - } - }, - "MediaPackageGroupSettings": { - "target": "com.amazonaws.medialive#MediaPackageGroupSettings", - "traits": { - "smithy.api#jsonName": "mediaPackageGroupSettings" - } - }, - "MsSmoothGroupSettings": { - "target": "com.amazonaws.medialive#MsSmoothGroupSettings", - "traits": { - "smithy.api#jsonName": "msSmoothGroupSettings" - } - }, - "MultiplexGroupSettings": { - "target": "com.amazonaws.medialive#MultiplexGroupSettings", + "ArchiveAllowedFlag": { + "target": "com.amazonaws.medialive#Scte35ArchiveAllowedFlag", "traits": { - "smithy.api#jsonName": "multiplexGroupSettings" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Corresponds to SCTE-35 archive_allowed_flag.", + "smithy.api#jsonName": "archiveAllowedFlag", + "smithy.api#required": {} } }, - "RtmpGroupSettings": { - "target": "com.amazonaws.medialive#RtmpGroupSettings", + "DeviceRestrictions": { + "target": "com.amazonaws.medialive#Scte35DeviceRestrictions", "traits": { - "smithy.api#jsonName": "rtmpGroupSettings" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Corresponds to SCTE-35 device_restrictions parameter.", + "smithy.api#jsonName": "deviceRestrictions", + "smithy.api#required": {} } }, - "UdpGroupSettings": { - "target": "com.amazonaws.medialive#UdpGroupSettings", + "NoRegionalBlackoutFlag": { + "target": "com.amazonaws.medialive#Scte35NoRegionalBlackoutFlag", "traits": { - "smithy.api#jsonName": "udpGroupSettings" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Corresponds to SCTE-35 no_regional_blackout_flag parameter.", + "smithy.api#jsonName": "noRegionalBlackoutFlag", + "smithy.api#required": {} } }, - "CmafIngestGroupSettings": { - "target": "com.amazonaws.medialive#CmafIngestGroupSettings", + "WebDeliveryAllowedFlag": { + "target": "com.amazonaws.medialive#Scte35WebDeliveryAllowedFlag", "traits": { - "smithy.api#jsonName": "cmafIngestGroupSettings" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Corresponds to SCTE-35 web_delivery_allowed_flag parameter.", + "smithy.api#jsonName": "webDeliveryAllowedFlag", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Output Group Settings" + "smithy.api#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." } }, - "com.amazonaws.medialive#OutputLocationRef": { + "com.amazonaws.medialive#Scte35Descriptor": { "type": "structure", "members": { - "DestinationRefId": { - "target": "com.amazonaws.medialive#__string", + "Scte35DescriptorSettings": { + "target": "com.amazonaws.medialive#Scte35DescriptorSettings", "traits": { - "smithy.api#jsonName": "destinationRefId" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "SCTE-35 Descriptor Settings.", + "smithy.api#jsonName": "scte35DescriptorSettings", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Reference to an OutputDestination ID defined in the channel" + "smithy.api#documentation": "Holds one set of SCTE-35 Descriptor Settings." } }, - "com.amazonaws.medialive#OutputLockingSettings": { + "com.amazonaws.medialive#Scte35DescriptorSettings": { "type": "structure", "members": { - "EpochLockingSettings": { - "target": "com.amazonaws.medialive#EpochLockingSettings", - "traits": { - "smithy.api#jsonName": "epochLockingSettings" - } - }, - "PipelineLockingSettings": { - "target": "com.amazonaws.medialive#PipelineLockingSettings", + "SegmentationDescriptorScte35DescriptorSettings": { + "target": "com.amazonaws.medialive#Scte35SegmentationDescriptor", "traits": { - "smithy.api#jsonName": "pipelineLockingSettings" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "SCTE-35 Segmentation Descriptor.", + "smithy.api#jsonName": "segmentationDescriptorScte35DescriptorSettings", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Output Locking Settings" + "smithy.api#documentation": "SCTE-35 Descriptor settings." } }, - "com.amazonaws.medialive#OutputSettings": { - "type": "structure", + "com.amazonaws.medialive#Scte35DeviceRestrictions": { + "type": "enum", "members": { - "ArchiveOutputSettings": { - "target": "com.amazonaws.medialive#ArchiveOutputSettings", - "traits": { - "smithy.api#jsonName": "archiveOutputSettings" - } - }, - "FrameCaptureOutputSettings": { - "target": "com.amazonaws.medialive#FrameCaptureOutputSettings", - "traits": { - "smithy.api#jsonName": "frameCaptureOutputSettings" - } - }, - "HlsOutputSettings": { - "target": "com.amazonaws.medialive#HlsOutputSettings", - "traits": { - "smithy.api#jsonName": "hlsOutputSettings" - } - }, - "MediaPackageOutputSettings": { - "target": "com.amazonaws.medialive#MediaPackageOutputSettings", - "traits": { - "smithy.api#jsonName": "mediaPackageOutputSettings" - } - }, - "MsSmoothOutputSettings": { - "target": "com.amazonaws.medialive#MsSmoothOutputSettings", - "traits": { - "smithy.api#jsonName": "msSmoothOutputSettings" - } - }, - "MultiplexOutputSettings": { - "target": "com.amazonaws.medialive#MultiplexOutputSettings", + "NONE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "multiplexOutputSettings" + "smithy.api#enumValue": "NONE" } }, - "RtmpOutputSettings": { - "target": "com.amazonaws.medialive#RtmpOutputSettings", + "RESTRICT_GROUP0": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "rtmpOutputSettings" + "smithy.api#enumValue": "RESTRICT_GROUP0" } }, - "UdpOutputSettings": { - "target": "com.amazonaws.medialive#UdpOutputSettings", + "RESTRICT_GROUP1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "udpOutputSettings" + "smithy.api#enumValue": "RESTRICT_GROUP1" } }, - "CmafIngestOutputSettings": { - "target": "com.amazonaws.medialive#CmafIngestOutputSettings", + "RESTRICT_GROUP2": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "cmafIngestOutputSettings" + "smithy.api#enumValue": "RESTRICT_GROUP2" } } }, "traits": { - "smithy.api#documentation": "Output Settings" - } - }, - "com.amazonaws.medialive#PassThroughSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Pass Through Settings" + "smithy.api#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." } }, - "com.amazonaws.medialive#PauseStateScheduleActionSettings": { - "type": "structure", + "com.amazonaws.medialive#Scte35InputMode": { + "type": "enum", "members": { - "Pipelines": { - "target": "com.amazonaws.medialive#__listOfPipelinePauseStateSettings", + "FIXED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "pipelines" + "smithy.api#enumValue": "FIXED" + } + }, + "FOLLOW_ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FOLLOW_ACTIVE" } } }, "traits": { - "smithy.api#documentation": "Settings for the action to set pause state of a channel." + "smithy.api#documentation": "Whether the SCTE-35 input should be the active input or a fixed input." } }, - "com.amazonaws.medialive#PipelineDetail": { + "com.amazonaws.medialive#Scte35InputScheduleActionSettings": { "type": "structure", "members": { - "ActiveInputAttachmentName": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The name of the active input attachment currently being ingested by this pipeline.", - "smithy.api#jsonName": "activeInputAttachmentName" - } - }, - "ActiveInputSwitchActionName": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "activeInputSwitchActionName" - } - }, - "ActiveMotionGraphicsActionName": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline.", - "smithy.api#jsonName": "activeMotionGraphicsActionName" - } - }, - "ActiveMotionGraphicsUri": { + "InputAttachmentNameReference": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The current URI being used for HTML5 motion graphics for this pipeline.", - "smithy.api#jsonName": "activeMotionGraphicsUri" + "smithy.api#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.)\"", + "smithy.api#jsonName": "inputAttachmentNameReference" } }, - "PipelineId": { - "target": "com.amazonaws.medialive#__string", + "Mode": { + "target": "com.amazonaws.medialive#Scte35InputMode", "traits": { - "smithy.api#documentation": "Pipeline ID", - "smithy.api#jsonName": "pipelineId" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Whether the SCTE-35 input should be the active input or a fixed input.", + "smithy.api#jsonName": "mode", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Runtime details of a pipeline when a channel is running." + "smithy.api#documentation": "Scte35Input Schedule Action Settings" } }, - "com.amazonaws.medialive#PipelineId": { + "com.amazonaws.medialive#Scte35NoRegionalBlackoutFlag": { "type": "enum", "members": { - "PIPELINE_0": { + "REGIONAL_BLACKOUT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PIPELINE_0" + "smithy.api#enumValue": "REGIONAL_BLACKOUT" } }, - "PIPELINE_1": { + "NO_REGIONAL_BLACKOUT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PIPELINE_1" + "smithy.api#enumValue": "NO_REGIONAL_BLACKOUT" } } }, "traits": { - "smithy.api#documentation": "Pipeline ID" - } - }, - "com.amazonaws.medialive#PipelineLockingSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Pipeline Locking Settings" + "smithy.api#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." } }, - "com.amazonaws.medialive#PipelinePauseStateSettings": { + "com.amazonaws.medialive#Scte35ReturnToNetworkScheduleActionSettings": { "type": "structure", "members": { - "PipelineId": { - "target": "com.amazonaws.medialive#PipelineId", + "SpliceEventId": { + "target": "com.amazonaws.medialive#__longMin0Max4294967295", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Pipeline ID to pause (\"PIPELINE_0\" or \"PIPELINE_1\").", - "smithy.api#jsonName": "pipelineId", + "smithy.api#documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.", + "smithy.api#jsonName": "spliceEventId", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Settings for pausing a pipeline." + "smithy.api#documentation": "Settings for a SCTE-35 return_to_network message." } }, - "com.amazonaws.medialive#PreferredChannelPipeline": { + "com.amazonaws.medialive#Scte35SegmentationCancelIndicator": { "type": "enum", "members": { - "CURRENTLY_ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CURRENTLY_ACTIVE" - } - }, - "PIPELINE_0": { + "SEGMENTATION_EVENT_NOT_CANCELED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PIPELINE_0" + "smithy.api#enumValue": "SEGMENTATION_EVENT_NOT_CANCELED" } }, - "PIPELINE_1": { + "SEGMENTATION_EVENT_CANCELED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PIPELINE_1" + "smithy.api#enumValue": "SEGMENTATION_EVENT_CANCELED" } } }, "traits": { - "smithy.api#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." - } - }, - "com.amazonaws.medialive#PurchaseOffering": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#PurchaseOfferingRequest" - }, - "output": { - "target": "com.amazonaws.medialive#PurchaseOfferingResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ConflictException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#NotFoundException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "Purchase an offering and create a reservation.", - "smithy.api#http": { - "method": "POST", - "uri": "/prod/offerings/{OfferingId}/purchase", - "code": 201 - } + "smithy.api#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." } }, - "com.amazonaws.medialive#PurchaseOfferingRequest": { + "com.amazonaws.medialive#Scte35SegmentationDescriptor": { "type": "structure", "members": { - "Count": { - "target": "com.amazonaws.medialive#__integerMin1", + "DeliveryRestrictions": { + "target": "com.amazonaws.medialive#Scte35DeliveryRestrictions", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Number of resources", - "smithy.api#jsonName": "count", - "smithy.api#required": {} + "smithy.api#documentation": "Holds the four SCTE-35 delivery restriction parameters.", + "smithy.api#jsonName": "deliveryRestrictions" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "SegmentNum": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Name for the new reservation", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.", + "smithy.api#jsonName": "segmentNum" } }, - "OfferingId": { - "target": "com.amazonaws.medialive#__string", + "SegmentationCancelIndicator": { + "target": "com.amazonaws.medialive#Scte35SegmentationCancelIndicator", "traits": { - "smithy.api#documentation": "Offering to purchase, e.g. '87654321'", - "smithy.api#httpLabel": {}, + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_event_cancel_indicator.", + "smithy.api#jsonName": "segmentationCancelIndicator", "smithy.api#required": {} } }, - "RenewalSettings": { - "target": "com.amazonaws.medialive#RenewalSettings", + "SegmentationDuration": { + "target": "com.amazonaws.medialive#__longMin0Max1099511627775", "traits": { - "smithy.api#documentation": "Renewal settings for the reservation", - "smithy.api#jsonName": "renewalSettings" + "smithy.api#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.", + "smithy.api#jsonName": "segmentationDuration" } }, - "RequestId": { - "target": "com.amazonaws.medialive#__string", + "SegmentationEventId": { + "target": "com.amazonaws.medialive#__longMin0Max4294967295", "traits": { - "smithy.api#documentation": "Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "requestId" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_event_id.", + "smithy.api#jsonName": "segmentationEventId", + "smithy.api#required": {} } }, - "Start": { - "target": "com.amazonaws.medialive#__string", + "SegmentationTypeId": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "start" + "smithy.api#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\").", + "smithy.api#jsonName": "segmentationTypeId" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "SegmentationUpid": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "A collection of key-value pairs", - "smithy.api#jsonName": "tags" + "smithy.api#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.", + "smithy.api#jsonName": "segmentationUpid" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for PurchaseOfferingRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#PurchaseOfferingResponse": { - "type": "structure", - "members": { - "Reservation": { - "target": "com.amazonaws.medialive#Reservation", + }, + "SegmentationUpidType": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#jsonName": "reservation" + "smithy.api#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\").", + "smithy.api#jsonName": "segmentationUpidType" } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for PurchaseOfferingResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#RawSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Raw Settings" - } - }, - "com.amazonaws.medialive#RebootInputDevice": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#RebootInputDeviceRequest" - }, - "output": { - "target": "com.amazonaws.medialive#RebootInputDeviceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#NotFoundException" }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" + "SegmentsExpected": { + "target": "com.amazonaws.medialive#__integerMin0Max255", + "traits": { + "smithy.api#documentation": "Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.", + "smithy.api#jsonName": "segmentsExpected" + } }, - { - "target": "com.amazonaws.medialive#UnprocessableEntityException" - } - ], - "traits": { - "smithy.api#documentation": "Send a reboot command to the specified input device. The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected.", - "smithy.api#http": { - "method": "POST", - "uri": "/prod/inputDevices/{InputDeviceId}/reboot", - "code": 200 - } - } - }, - "com.amazonaws.medialive#RebootInputDeviceForce": { - "type": "enum", - "members": { - "NO": { - "target": "smithy.api#Unit", + "SubSegmentNum": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#enumValue": "NO" + "smithy.api#documentation": "Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.", + "smithy.api#jsonName": "subSegmentNum" } }, - "YES": { - "target": "smithy.api#Unit", + "SubSegmentsExpected": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#enumValue": "YES" + "smithy.api#documentation": "Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.", + "smithy.api#jsonName": "subSegmentsExpected" } } }, "traits": { - "smithy.api#documentation": "Whether or not to force reboot the input device." + "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_descriptor." } }, - "com.amazonaws.medialive#RebootInputDeviceRequest": { + "com.amazonaws.medialive#Scte35SpliceInsert": { "type": "structure", "members": { - "Force": { - "target": "com.amazonaws.medialive#RebootInputDeviceForce", + "AdAvailOffset": { + "target": "com.amazonaws.medialive#__integerMinNegative1000Max1000", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "force" + "smithy.api#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.", + "smithy.api#jsonName": "adAvailOffset" } }, - "InputDeviceId": { - "target": "com.amazonaws.medialive#__string", + "NoRegionalBlackoutFlag": { + "target": "com.amazonaws.medialive#Scte35SpliceInsertNoRegionalBlackoutBehavior", "traits": { - "smithy.api#documentation": "The unique ID of the input device to reboot. For example, hd-123456789abcdef.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates", + "smithy.api#jsonName": "noRegionalBlackoutFlag" + } + }, + "WebDeliveryAllowedFlag": { + "target": "com.amazonaws.medialive#Scte35SpliceInsertWebDeliveryAllowedBehavior", + "traits": { + "smithy.api#documentation": "When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates", + "smithy.api#jsonName": "webDeliveryAllowedFlag" } } }, "traits": { - "smithy.api#documentation": "A request to reboot an AWS Elemental device.", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#RebootInputDeviceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Placeholder documentation for RebootInputDeviceResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#Rec601Settings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Rec601 Settings" - } - }, - "com.amazonaws.medialive#Rec709Settings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Rec709 Settings" + "smithy.api#documentation": "Typical configuration that applies breaks on splice inserts in addition to time signal placement opportunities, breaks, and advertisements." } }, - "com.amazonaws.medialive#RejectInputDeviceTransfer": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#RejectInputDeviceTransferRequest" - }, - "output": { - "target": "com.amazonaws.medialive#RejectInputDeviceTransferResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ConflictException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#NotFoundException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - }, - { - "target": "com.amazonaws.medialive#UnprocessableEntityException" + "com.amazonaws.medialive#Scte35SpliceInsertNoRegionalBlackoutBehavior": { + "type": "enum", + "members": { + "FOLLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FOLLOW" + } + }, + "IGNORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORE" + } } - ], + }, "traits": { - "smithy.api#documentation": "Reject the transfer of the specified input device to your AWS account.", - "smithy.api#http": { - "method": "POST", - "uri": "/prod/inputDevices/{InputDeviceId}/reject", - "code": 200 - } + "smithy.api#documentation": "Scte35 Splice Insert No Regional Blackout Behavior" } }, - "com.amazonaws.medialive#RejectInputDeviceTransferRequest": { + "com.amazonaws.medialive#Scte35SpliceInsertScheduleActionSettings": { "type": "structure", "members": { - "InputDeviceId": { - "target": "com.amazonaws.medialive#__string", + "Duration": { + "target": "com.amazonaws.medialive#__longMin0Max8589934591", "traits": { - "smithy.api#documentation": "The unique ID of the input device to reject. For example, hd-123456789abcdef.", - "smithy.api#httpLabel": {}, + "smithy.api#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.", + "smithy.api#jsonName": "duration" + } + }, + "SpliceEventId": { + "target": "com.amazonaws.medialive#__longMin0Max4294967295", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.", + "smithy.api#jsonName": "spliceEventId", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for RejectInputDeviceTransferRequest", - "smithy.api#input": {} + "smithy.api#documentation": "Settings for a SCTE-35 splice_insert message." } }, - "com.amazonaws.medialive#RejectInputDeviceTransferResponse": { - "type": "structure", - "members": {}, + "com.amazonaws.medialive#Scte35SpliceInsertWebDeliveryAllowedBehavior": { + "type": "enum", + "members": { + "FOLLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FOLLOW" + } + }, + "IGNORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORE" + } + } + }, "traits": { - "smithy.api#documentation": "Placeholder documentation for RejectInputDeviceTransferResponse", - "smithy.api#output": {} + "smithy.api#documentation": "Scte35 Splice Insert Web Delivery Allowed Behavior" } }, - "com.amazonaws.medialive#RemixSettings": { + "com.amazonaws.medialive#Scte35TimeSignalApos": { "type": "structure", "members": { - "ChannelMappings": { - "target": "com.amazonaws.medialive#__listOfAudioChannelMapping", + "AdAvailOffset": { + "target": "com.amazonaws.medialive#__integerMinNegative1000Max1000", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Mapping of input channels to output channels, with appropriate gain adjustments.", - "smithy.api#jsonName": "channelMappings", - "smithy.api#required": {} + "smithy.api#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.", + "smithy.api#jsonName": "adAvailOffset" } }, - "ChannelsIn": { - "target": "com.amazonaws.medialive#__integerMin1Max16", + "NoRegionalBlackoutFlag": { + "target": "com.amazonaws.medialive#Scte35AposNoRegionalBlackoutBehavior", "traits": { - "smithy.api#documentation": "Number of input channels to be used.", - "smithy.api#jsonName": "channelsIn" + "smithy.api#documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates", + "smithy.api#jsonName": "noRegionalBlackoutFlag" } }, - "ChannelsOut": { - "target": "com.amazonaws.medialive#__integerMin1Max8", + "WebDeliveryAllowedFlag": { + "target": "com.amazonaws.medialive#Scte35AposWebDeliveryAllowedBehavior", "traits": { - "smithy.api#documentation": "Number of output channels to be produced.\nValid values: 1, 2, 4, 6, 8", - "smithy.api#jsonName": "channelsOut" + "smithy.api#documentation": "When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates", + "smithy.api#jsonName": "webDeliveryAllowedFlag" } } }, "traits": { - "smithy.api#documentation": "Remix Settings" + "smithy.api#documentation": "Atypical configuration that applies segment breaks only on SCTE-35 time signal placement opportunities and breaks." } }, - "com.amazonaws.medialive#RenewalSettings": { + "com.amazonaws.medialive#Scte35TimeSignalScheduleActionSettings": { "type": "structure", "members": { - "AutomaticRenewal": { - "target": "com.amazonaws.medialive#ReservationAutomaticRenewal", + "Scte35Descriptors": { + "target": "com.amazonaws.medialive#__listOfScte35Descriptor", "traits": { - "smithy.api#documentation": "Automatic renewal status for the reservation", - "smithy.api#jsonName": "automaticRenewal" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.", + "smithy.api#jsonName": "scte35Descriptors", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for a SCTE-35 time_signal." + } + }, + "com.amazonaws.medialive#Scte35Type": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" } }, - "RenewalCount": { - "target": "com.amazonaws.medialive#__integerMin1", + "SCTE_35_WITHOUT_SEGMENTATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Count for the reservation renewal", - "smithy.api#jsonName": "renewalCount" + "smithy.api#enumValue": "SCTE_35_WITHOUT_SEGMENTATION" } } }, "traits": { - "smithy.api#documentation": "The Renewal settings for Reservations" + "smithy.api#documentation": "Scte35 Type" } }, - "com.amazonaws.medialive#Reservation": { - "type": "structure", + "com.amazonaws.medialive#Scte35WebDeliveryAllowedFlag": { + "type": "enum", "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", + "WEB_DELIVERY_NOT_ALLOWED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'", - "smithy.api#jsonName": "arn" + "smithy.api#enumValue": "WEB_DELIVERY_NOT_ALLOWED" } }, - "Count": { - "target": "com.amazonaws.medialive#__integer", + "WEB_DELIVERY_ALLOWED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Number of reserved resources", - "smithy.api#jsonName": "count" + "smithy.api#enumValue": "WEB_DELIVERY_ALLOWED" } - }, - "CurrencyCode": { - "target": "com.amazonaws.medialive#__string", + } + }, + "traits": { + "smithy.api#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." + } + }, + "com.amazonaws.medialive#SignalMapMonitorDeploymentStatus": { + "type": "enum", + "members": { + "NOT_DEPLOYED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", - "smithy.api#jsonName": "currencyCode" + "smithy.api#enumValue": "NOT_DEPLOYED" } }, - "Duration": { - "target": "com.amazonaws.medialive#__integer", + "DRY_RUN_DEPLOYMENT_COMPLETE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Lease duration, e.g. '12'", - "smithy.api#jsonName": "duration" + "smithy.api#enumValue": "DRY_RUN_DEPLOYMENT_COMPLETE" } }, - "DurationUnits": { - "target": "com.amazonaws.medialive#OfferingDurationUnits", + "DRY_RUN_DEPLOYMENT_FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", - "smithy.api#jsonName": "durationUnits" + "smithy.api#enumValue": "DRY_RUN_DEPLOYMENT_FAILED" } }, - "End": { - "target": "com.amazonaws.medialive#__string", + "DRY_RUN_DEPLOYMENT_IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'", - "smithy.api#jsonName": "end" + "smithy.api#enumValue": "DRY_RUN_DEPLOYMENT_IN_PROGRESS" } }, - "FixedPrice": { - "target": "com.amazonaws.medialive#__double", + "DEPLOYMENT_COMPLETE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", - "smithy.api#jsonName": "fixedPrice" + "smithy.api#enumValue": "DEPLOYMENT_COMPLETE" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "DEPLOYMENT_FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "User specified reservation name", - "smithy.api#jsonName": "name" + "smithy.api#enumValue": "DEPLOYMENT_FAILED" } }, - "OfferingDescription": { - "target": "com.amazonaws.medialive#__string", + "DEPLOYMENT_IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", - "smithy.api#jsonName": "offeringDescription" + "smithy.api#enumValue": "DEPLOYMENT_IN_PROGRESS" } }, - "OfferingId": { - "target": "com.amazonaws.medialive#__string", + "DELETE_COMPLETE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", - "smithy.api#jsonName": "offeringId" + "smithy.api#enumValue": "DELETE_COMPLETE" } }, - "OfferingType": { - "target": "com.amazonaws.medialive#OfferingType", + "DELETE_FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", - "smithy.api#jsonName": "offeringType" + "smithy.api#enumValue": "DELETE_FAILED" } }, - "Region": { - "target": "com.amazonaws.medialive#__string", + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", - "smithy.api#jsonName": "region" + "smithy.api#enumValue": "DELETE_IN_PROGRESS" } - }, - "RenewalSettings": { - "target": "com.amazonaws.medialive#RenewalSettings", + } + }, + "traits": { + "smithy.api#documentation": "A signal map's monitor deployment status." + } + }, + "com.amazonaws.medialive#SignalMapStatus": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Renewal settings for the reservation", - "smithy.api#jsonName": "renewalSettings" + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } }, - "ReservationId": { - "target": "com.amazonaws.medialive#__string", + "CREATE_COMPLETE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", - "smithy.api#jsonName": "reservationId" + "smithy.api#enumValue": "CREATE_COMPLETE" } }, - "ResourceSpecification": { - "target": "com.amazonaws.medialive#ReservationResourceSpecification", + "CREATE_FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Resource configuration details", - "smithy.api#jsonName": "resourceSpecification" + "smithy.api#enumValue": "CREATE_FAILED" } }, - "Start": { - "target": "com.amazonaws.medialive#__string", + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'", - "smithy.api#jsonName": "start" + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" } }, - "State": { - "target": "com.amazonaws.medialive#ReservationState", + "UPDATE_COMPLETE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Current state of reservation, e.g. 'ACTIVE'", - "smithy.api#jsonName": "state" + "smithy.api#enumValue": "UPDATE_COMPLETE" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "UPDATE_REVERTED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A collection of key-value pairs", - "smithy.api#jsonName": "tags" + "smithy.api#enumValue": "UPDATE_REVERTED" } }, - "UsagePrice": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", - "smithy.api#jsonName": "usagePrice" - } - } - }, - "traits": { - "smithy.api#documentation": "Reserved resources available to use" - } - }, - "com.amazonaws.medialive#ReservationAutomaticRenewal": { - "type": "enum", - "members": { - "DISABLED": { + "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "UPDATE_FAILED" } }, - "ENABLED": { + "READY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "READY" } }, - "UNAVAILABLE": { + "NOT_READY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "UNAVAILABLE" + "smithy.api#enumValue": "NOT_READY" } } }, "traits": { - "smithy.api#documentation": "Automatic Renewal Status for Reservation" + "smithy.api#documentation": "A signal map's current status which is dependent on its lifecycle actions or associated jobs." } }, - "com.amazonaws.medialive#ReservationCodec": { - "type": "enum", + "com.amazonaws.medialive#SignalMapSummary": { + "type": "structure", "members": { - "MPEG2": { - "target": "smithy.api#Unit", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveSignalMap", "traits": { - "smithy.api#enumValue": "MPEG2" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A signal map's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn", + "smithy.api#required": {} } }, - "AVC": { - "target": "smithy.api#Unit", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "AVC" + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "createdAt", + "smithy.api#required": {} } }, - "HEVC": { - "target": "smithy.api#Unit", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#enumValue": "HEVC" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "AUDIO": { - "target": "smithy.api#Unit", + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#enumValue": "AUDIO" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A signal map's id.", + "smithy.api#jsonName": "id", + "smithy.api#required": {} } }, - "LINK": { - "target": "smithy.api#Unit", + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "LINK" + "smithy.api#jsonName": "modifiedAt" + } + }, + "MonitorDeploymentStatus": { + "target": "com.amazonaws.medialive#SignalMapMonitorDeploymentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "monitorDeploymentStatus", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.medialive#SignalMapStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO'" + "smithy.api#documentation": "Placeholder documentation for SignalMapSummary" } }, - "com.amazonaws.medialive#ReservationMaximumBitrate": { + "com.amazonaws.medialive#SmoothGroupAudioOnlyTimecodeControl": { "type": "enum", "members": { - "MAX_10_MBPS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_10_MBPS" - } - }, - "MAX_20_MBPS": { + "PASSTHROUGH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MAX_20_MBPS" + "smithy.api#enumValue": "PASSTHROUGH" } }, - "MAX_50_MBPS": { + "USE_CONFIGURED_CLOCK": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MAX_50_MBPS" + "smithy.api#enumValue": "USE_CONFIGURED_CLOCK" } } }, "traits": { - "smithy.api#documentation": "Maximum bitrate in megabits per second" + "smithy.api#documentation": "Smooth Group Audio Only Timecode Control" } }, - "com.amazonaws.medialive#ReservationMaximumFramerate": { + "com.amazonaws.medialive#SmoothGroupCertificateMode": { "type": "enum", "members": { - "MAX_30_FPS": { + "SELF_SIGNED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MAX_30_FPS" + "smithy.api#enumValue": "SELF_SIGNED" } }, - "MAX_60_FPS": { + "VERIFY_AUTHENTICITY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MAX_60_FPS" + "smithy.api#enumValue": "VERIFY_AUTHENTICITY" } } }, "traits": { - "smithy.api#documentation": "Maximum framerate in frames per second (Outputs only)" + "smithy.api#documentation": "Smooth Group Certificate Mode" } }, - "com.amazonaws.medialive#ReservationResolution": { + "com.amazonaws.medialive#SmoothGroupEventIdMode": { "type": "enum", "members": { - "SD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SD" - } - }, - "HD": { + "NO_EVENT_ID": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "HD" + "smithy.api#enumValue": "NO_EVENT_ID" } }, - "FHD": { + "USE_CONFIGURED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FHD" + "smithy.api#enumValue": "USE_CONFIGURED" } }, - "UHD": { + "USE_TIMESTAMP": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "UHD" + "smithy.api#enumValue": "USE_TIMESTAMP" } } }, "traits": { - "smithy.api#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" + "smithy.api#documentation": "Smooth Group Event Id Mode" } }, - "com.amazonaws.medialive#ReservationResourceSpecification": { - "type": "structure", + "com.amazonaws.medialive#SmoothGroupEventStopBehavior": { + "type": "enum", "members": { - "ChannelClass": { - "target": "com.amazonaws.medialive#ChannelClass", - "traits": { - "smithy.api#documentation": "Channel class, e.g. 'STANDARD'", - "smithy.api#jsonName": "channelClass" - } - }, - "Codec": { - "target": "com.amazonaws.medialive#ReservationCodec", - "traits": { - "smithy.api#documentation": "Codec, e.g. 'AVC'", - "smithy.api#jsonName": "codec" - } - }, - "MaximumBitrate": { - "target": "com.amazonaws.medialive#ReservationMaximumBitrate", - "traits": { - "smithy.api#documentation": "Maximum bitrate, e.g. 'MAX_20_MBPS'", - "smithy.api#jsonName": "maximumBitrate" - } - }, - "MaximumFramerate": { - "target": "com.amazonaws.medialive#ReservationMaximumFramerate", - "traits": { - "smithy.api#documentation": "Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)", - "smithy.api#jsonName": "maximumFramerate" - } - }, - "Resolution": { - "target": "com.amazonaws.medialive#ReservationResolution", + "NONE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Resolution, e.g. 'HD'", - "smithy.api#jsonName": "resolution" + "smithy.api#enumValue": "NONE" } }, - "ResourceType": { - "target": "com.amazonaws.medialive#ReservationResourceType", + "SEND_EOS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'", - "smithy.api#jsonName": "resourceType" + "smithy.api#enumValue": "SEND_EOS" } - }, - "SpecialFeature": { - "target": "com.amazonaws.medialive#ReservationSpecialFeature", + } + }, + "traits": { + "smithy.api#documentation": "Smooth Group Event Stop Behavior" + } + }, + "com.amazonaws.medialive#SmoothGroupSegmentationMode": { + "type": "enum", + "members": { + "USE_INPUT_SEGMENTATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)", - "smithy.api#jsonName": "specialFeature" + "smithy.api#enumValue": "USE_INPUT_SEGMENTATION" } }, - "VideoQuality": { - "target": "com.amazonaws.medialive#ReservationVideoQuality", + "USE_SEGMENT_DURATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Video quality, e.g. 'STANDARD' (Outputs only)", - "smithy.api#jsonName": "videoQuality" + "smithy.api#enumValue": "USE_SEGMENT_DURATION" } } }, "traits": { - "smithy.api#documentation": "Resource configuration (codec, resolution, bitrate, ...)" + "smithy.api#documentation": "Smooth Group Segmentation Mode" } }, - "com.amazonaws.medialive#ReservationResourceType": { + "com.amazonaws.medialive#SmoothGroupSparseTrackType": { "type": "enum", "members": { - "INPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INPUT" - } - }, - "OUTPUT": { + "NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "OUTPUT" + "smithy.api#enumValue": "NONE" } }, - "MULTIPLEX": { + "SCTE_35": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MULTIPLEX" + "smithy.api#enumValue": "SCTE_35" } }, - "CHANNEL": { + "SCTE_35_WITHOUT_SEGMENTATION": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CHANNEL" + "smithy.api#enumValue": "SCTE_35_WITHOUT_SEGMENTATION" } } }, "traits": { - "smithy.api#documentation": "Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'" + "smithy.api#documentation": "Smooth Group Sparse Track Type" } }, - "com.amazonaws.medialive#ReservationSpecialFeature": { + "com.amazonaws.medialive#SmoothGroupStreamManifestBehavior": { "type": "enum", "members": { - "ADVANCED_AUDIO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADVANCED_AUDIO" - } - }, - "AUDIO_NORMALIZATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUDIO_NORMALIZATION" - } - }, - "MGHD": { + "DO_NOT_SEND": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MGHD" + "smithy.api#enumValue": "DO_NOT_SEND" } }, - "MGUHD": { + "SEND": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MGUHD" + "smithy.api#enumValue": "SEND" } } }, "traits": { - "smithy.api#documentation": "Special features, 'ADVANCED_AUDIO' 'AUDIO_NORMALIZATION' 'MGHD' or 'MGUHD'" + "smithy.api#documentation": "Smooth Group Stream Manifest Behavior" } }, - "com.amazonaws.medialive#ReservationState": { + "com.amazonaws.medialive#SmoothGroupTimestampOffsetMode": { "type": "enum", "members": { - "ACTIVE": { + "USE_CONFIGURED_OFFSET": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ACTIVE" + "smithy.api#enumValue": "USE_CONFIGURED_OFFSET" } }, - "EXPIRED": { + "USE_EVENT_START_DATE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EXPIRED" + "smithy.api#enumValue": "USE_EVENT_START_DATE" } - }, - "CANCELED": { + } + }, + "traits": { + "smithy.api#documentation": "Smooth Group Timestamp Offset Mode" + } + }, + "com.amazonaws.medialive#Smpte2038DataPreference": { + "type": "enum", + "members": { + "IGNORE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CANCELED" + "smithy.api#enumValue": "IGNORE" } }, - "DELETED": { + "PREFER": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DELETED" + "smithy.api#enumValue": "PREFER" } } }, "traits": { - "smithy.api#documentation": "Current reservation state" + "smithy.api#documentation": "Smpte2038 Data Preference" } }, - "com.amazonaws.medialive#ReservationVideoQuality": { - "type": "enum", + "com.amazonaws.medialive#SmpteTtDestinationSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Smpte Tt Destination Settings" + } + }, + "com.amazonaws.medialive#StandardHlsSettings": { + "type": "structure", "members": { - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STANDARD" - } - }, - "ENHANCED": { - "target": "smithy.api#Unit", + "AudioRenditionSets": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "ENHANCED" + "smithy.api#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 ','.", + "smithy.api#jsonName": "audioRenditionSets" } }, - "PREMIUM": { - "target": "smithy.api#Unit", + "M3u8Settings": { + "target": "com.amazonaws.medialive#M3u8Settings", "traits": { - "smithy.api#enumValue": "PREMIUM" + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "m3u8Settings", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Video quality, e.g. 'STANDARD' (Outputs only)" + "smithy.api#documentation": "Standard Hls Settings" } }, - "com.amazonaws.medialive#RestartChannelPipelines": { + "com.amazonaws.medialive#StartChannel": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#RestartChannelPipelinesRequest" + "target": "com.amazonaws.medialive#StartChannelRequest" }, "output": { - "target": "com.amazonaws.medialive#RestartChannelPipelinesResponse" + "target": "com.amazonaws.medialive#StartChannelResponse" }, "errors": [ { @@ -21165,39 +26211,32 @@ } ], "traits": { - "smithy.api#documentation": "Restart pipelines in one channel that is currently running.", + "smithy.api#documentation": "Starts an existing channel", "smithy.api#http": { "method": "POST", - "uri": "/prod/channels/{ChannelId}/restartChannelPipelines", + "uri": "/prod/channels/{ChannelId}/start", "code": 200 } } }, - "com.amazonaws.medialive#RestartChannelPipelinesRequest": { + "com.amazonaws.medialive#StartChannelRequest": { "type": "structure", "members": { "ChannelId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "ID of channel", + "smithy.api#documentation": "A request to start a channel", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "PipelineIds": { - "target": "com.amazonaws.medialive#__listOfChannelPipelineIdToRestart", - "traits": { - "smithy.api#documentation": "An array of pipelines to restart in this channel. Format PIPELINE_0 or PIPELINE_1.", - "smithy.api#jsonName": "pipelineIds" - } } }, "traits": { - "smithy.api#documentation": "Pipelines to restart.", + "smithy.api#documentation": "Placeholder documentation for StartChannelRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#RestartChannelPipelinesResponse": { + "com.amazonaws.medialive#StartChannelResponse": { "type": "structure", "members": { "Arn": { @@ -21276,13 +26315,6 @@ "smithy.api#jsonName": "maintenance" } }, - "MaintenanceStatus": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The time in milliseconds by when the PVRE restart must occur.", - "smithy.api#jsonName": "maintenanceStatus" - } - }, "Name": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -21311,1320 +26343,1155 @@ "smithy.api#jsonName": "roleArn" } }, - "State": { - "target": "com.amazonaws.medialive#ChannelState", - "traits": { - "smithy.api#jsonName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", - "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" - } - }, - "Vpc": { - "target": "com.amazonaws.medialive#VpcOutputSettingsDescription", - "traits": { - "smithy.api#documentation": "Settings for VPC output", - "smithy.api#jsonName": "vpc" - } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for RestartChannelPipelinesResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#RtmpAdMarkers": { - "type": "enum", - "members": { - "ON_CUE_POINT_SCTE35": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ON_CUE_POINT_SCTE35" - } - } - }, - "traits": { - "smithy.api#documentation": "Rtmp Ad Markers" - } - }, - "com.amazonaws.medialive#RtmpCacheFullBehavior": { - "type": "enum", - "members": { - "DISCONNECT_IMMEDIATELY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISCONNECT_IMMEDIATELY" - } - }, - "WAIT_FOR_SERVER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WAIT_FOR_SERVER" - } - } - }, - "traits": { - "smithy.api#documentation": "Rtmp Cache Full Behavior" - } - }, - "com.amazonaws.medialive#RtmpCaptionData": { - "type": "enum", - "members": { - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - }, - "FIELD1_608": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIELD1_608" - } - }, - "FIELD1_AND_FIELD2_608": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIELD1_AND_FIELD2_608" - } - } - }, - "traits": { - "smithy.api#documentation": "Rtmp Caption Data" - } - }, - "com.amazonaws.medialive#RtmpCaptionInfoDestinationSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Rtmp Caption Info Destination Settings" - } - }, - "com.amazonaws.medialive#RtmpGroupSettings": { - "type": "structure", - "members": { - "AdMarkers": { - "target": "com.amazonaws.medialive#__listOfRtmpAdMarkers", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "adMarkers" - } - }, - "AuthenticationScheme": { - "target": "com.amazonaws.medialive#AuthenticationScheme", - "traits": { - "smithy.api#documentation": "Authentication scheme to use when connecting with CDN", - "smithy.api#jsonName": "authenticationScheme" - } - }, - "CacheFullBehavior": { - "target": "com.amazonaws.medialive#RtmpCacheFullBehavior", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "cacheFullBehavior" - } - }, - "CacheLength": { - "target": "com.amazonaws.medialive#__integerMin30", - "traits": { - "smithy.api#documentation": "Cache length, in seconds, is used to calculate buffer size.", - "smithy.api#jsonName": "cacheLength" - } - }, - "CaptionData": { - "target": "com.amazonaws.medialive#RtmpCaptionData", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "captionData" - } - }, - "InputLossAction": { - "target": "com.amazonaws.medialive#InputLossActionForRtmpOut", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "inputLossAction" - } - }, - "RestartDelay": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", - "smithy.api#jsonName": "restartDelay" - } - }, - "IncludeFillerNalUnits": { - "target": "com.amazonaws.medialive#IncludeFillerNalUnits", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "includeFillerNalUnits" - } - } - }, - "traits": { - "smithy.api#documentation": "Rtmp Group Settings" - } - }, - "com.amazonaws.medialive#RtmpOutputCertificateMode": { - "type": "enum", - "members": { - "SELF_SIGNED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SELF_SIGNED" - } - }, - "VERIFY_AUTHENTICITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERIFY_AUTHENTICITY" - } - } - }, - "traits": { - "smithy.api#documentation": "Rtmp Output Certificate Mode" - } - }, - "com.amazonaws.medialive#RtmpOutputSettings": { - "type": "structure", - "members": { - "CertificateMode": { - "target": "com.amazonaws.medialive#RtmpOutputCertificateMode", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "certificateMode" - } - }, - "ConnectionRetryInterval": { - "target": "com.amazonaws.medialive#__integerMin1", + "State": { + "target": "com.amazonaws.medialive#ChannelState", "traits": { - "smithy.api#documentation": "Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.", - "smithy.api#jsonName": "connectionRetryInterval" + "smithy.api#jsonName": "state" } }, - "Destination": { - "target": "com.amazonaws.medialive#OutputLocationRef", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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.", - "smithy.api#jsonName": "destination", - "smithy.api#required": {} + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" } }, - "NumRetries": { - "target": "com.amazonaws.medialive#__integerMin0", + "Vpc": { + "target": "com.amazonaws.medialive#VpcOutputSettingsDescription", "traits": { - "smithy.api#documentation": "Number of retry attempts.", - "smithy.api#jsonName": "numRetries" + "smithy.api#documentation": "Settings for VPC output", + "smithy.api#jsonName": "vpc" } } }, "traits": { - "smithy.api#documentation": "Rtmp Output Settings" + "smithy.api#documentation": "Placeholder documentation for StartChannelResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#S3CannedAcl": { - "type": "enum", - "members": { - "AUTHENTICATED_READ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTHENTICATED_READ" - } + "com.amazonaws.medialive#StartDeleteMonitorDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#StartDeleteMonitorDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.medialive#StartDeleteMonitorDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "BUCKET_OWNER_FULL_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BUCKET_OWNER_FULL_CONTROL" - } + { + "target": "com.amazonaws.medialive#ConflictException" }, - "BUCKET_OWNER_READ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BUCKET_OWNER_READ" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "PUBLIC_READ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUBLIC_READ" - } + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" } - }, + ], "traits": { - "smithy.api#documentation": "S3 Canned Acl" + "smithy.api#documentation": "Initiates a deployment to delete the monitor of the specified signal map.", + "smithy.api#http": { + "method": "DELETE", + "uri": "/prod/signal-maps/{Identifier}/monitor-deployment", + "code": 202 + } } }, - "com.amazonaws.medialive#ScheduleAction": { + "com.amazonaws.medialive#StartDeleteMonitorDeploymentRequest": { "type": "structure", "members": { - "ActionName": { + "Identifier": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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.", - "smithy.api#jsonName": "actionName", - "smithy.api#required": {} - } - }, - "ScheduleActionSettings": { - "target": "com.amazonaws.medialive#ScheduleActionSettings", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Settings for this schedule action.", - "smithy.api#jsonName": "scheduleActionSettings", - "smithy.api#required": {} - } - }, - "ScheduleActionStartSettings": { - "target": "com.amazonaws.medialive#ScheduleActionStartSettings", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time for the action to start in the channel.", - "smithy.api#jsonName": "scheduleActionStartSettings", + "smithy.api#documentation": "A signal map's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains information on a single schedule action." + "smithy.api#documentation": "Placeholder documentation for StartDeleteMonitorDeploymentRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#ScheduleActionSettings": { + "com.amazonaws.medialive#StartDeleteMonitorDeploymentResponse": { "type": "structure", "members": { - "HlsId3SegmentTaggingSettings": { - "target": "com.amazonaws.medialive#HlsId3SegmentTaggingScheduleActionSettings", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveSignalMap", "traits": { - "smithy.api#documentation": "Action to insert HLS ID3 segment tagging", - "smithy.api#jsonName": "hlsId3SegmentTaggingSettings" + "smithy.api#documentation": "A signal map's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" } }, - "HlsTimedMetadataSettings": { - "target": "com.amazonaws.medialive#HlsTimedMetadataScheduleActionSettings", + "CloudWatchAlarmTemplateGroupIds": { + "target": "com.amazonaws.medialive#__listOf__stringMin7Max11PatternAws097", "traits": { - "smithy.api#documentation": "Action to insert HLS metadata", - "smithy.api#jsonName": "hlsTimedMetadataSettings" + "smithy.api#jsonName": "cloudWatchAlarmTemplateGroupIds" } }, - "InputPrepareSettings": { - "target": "com.amazonaws.medialive#InputPrepareScheduleActionSettings", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "Action to prepare an input for a future immediate input switch", - "smithy.api#jsonName": "inputPrepareSettings" + "smithy.api#jsonName": "createdAt" } }, - "InputSwitchSettings": { - "target": "com.amazonaws.medialive#InputSwitchScheduleActionSettings", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#documentation": "Action to switch the input", - "smithy.api#jsonName": "inputSwitchSettings" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "MotionGraphicsImageActivateSettings": { - "target": "com.amazonaws.medialive#MotionGraphicsActivateScheduleActionSettings", + "DiscoveryEntryPointArn": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#documentation": "Action to activate a motion graphics image overlay", - "smithy.api#jsonName": "motionGraphicsImageActivateSettings" + "smithy.api#documentation": "A top-level supported AWS resource ARN to discovery a signal map from.", + "smithy.api#jsonName": "discoveryEntryPointArn" } }, - "MotionGraphicsImageDeactivateSettings": { - "target": "com.amazonaws.medialive#MotionGraphicsDeactivateScheduleActionSettings", + "ErrorMessage": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#documentation": "Action to deactivate a motion graphics image overlay", - "smithy.api#jsonName": "motionGraphicsImageDeactivateSettings" + "smithy.api#documentation": "Error message associated with a failed creation or failed update attempt of a signal map.", + "smithy.api#jsonName": "errorMessage" } }, - "PauseStateSettings": { - "target": "com.amazonaws.medialive#PauseStateScheduleActionSettings", + "EventBridgeRuleTemplateGroupIds": { + "target": "com.amazonaws.medialive#__listOf__stringMin7Max11PatternAws097", "traits": { - "smithy.api#documentation": "Action to pause or unpause one or both channel pipelines", - "smithy.api#jsonName": "pauseStateSettings" + "smithy.api#jsonName": "eventBridgeRuleTemplateGroupIds" } }, - "Scte35InputSettings": { - "target": "com.amazonaws.medialive#Scte35InputScheduleActionSettings", + "FailedMediaResourceMap": { + "target": "com.amazonaws.medialive#FailedMediaResourceMap", "traits": { - "smithy.api#documentation": "Action to specify scte35 input", - "smithy.api#jsonName": "scte35InputSettings" + "smithy.api#jsonName": "failedMediaResourceMap" } }, - "Scte35ReturnToNetworkSettings": { - "target": "com.amazonaws.medialive#Scte35ReturnToNetworkScheduleActionSettings", + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#documentation": "Action to insert SCTE-35 return_to_network message", - "smithy.api#jsonName": "scte35ReturnToNetworkSettings" + "smithy.api#documentation": "A signal map's id.", + "smithy.api#jsonName": "id" } }, - "Scte35SpliceInsertSettings": { - "target": "com.amazonaws.medialive#Scte35SpliceInsertScheduleActionSettings", + "LastDiscoveredAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "Action to insert SCTE-35 splice_insert message", - "smithy.api#jsonName": "scte35SpliceInsertSettings" + "smithy.api#jsonName": "lastDiscoveredAt" } }, - "Scte35TimeSignalSettings": { - "target": "com.amazonaws.medialive#Scte35TimeSignalScheduleActionSettings", + "LastSuccessfulMonitorDeployment": { + "target": "com.amazonaws.medialive#SuccessfulMonitorDeployment", "traits": { - "smithy.api#documentation": "Action to insert SCTE-35 time_signal message", - "smithy.api#jsonName": "scte35TimeSignalSettings" + "smithy.api#jsonName": "lastSuccessfulMonitorDeployment" } }, - "StaticImageActivateSettings": { - "target": "com.amazonaws.medialive#StaticImageActivateScheduleActionSettings", + "MediaResourceMap": { + "target": "com.amazonaws.medialive#MediaResourceMap", "traits": { - "smithy.api#documentation": "Action to activate a static image overlay", - "smithy.api#jsonName": "staticImageActivateSettings" + "smithy.api#jsonName": "mediaResourceMap" + } + }, + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "modifiedAt" + } + }, + "MonitorChangesPendingDeployment": { + "target": "com.amazonaws.medialive#__boolean", + "traits": { + "smithy.api#documentation": "If true, there are pending monitor changes for this signal map that can be deployed.", + "smithy.api#jsonName": "monitorChangesPendingDeployment" + } + }, + "MonitorDeployment": { + "target": "com.amazonaws.medialive#MonitorDeployment", + "traits": { + "smithy.api#jsonName": "monitorDeployment" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" } }, - "StaticImageDeactivateSettings": { - "target": "com.amazonaws.medialive#StaticImageDeactivateScheduleActionSettings", - "traits": { - "smithy.api#documentation": "Action to deactivate a static image overlay", - "smithy.api#jsonName": "staticImageDeactivateSettings" - } + "Status": { + "target": "com.amazonaws.medialive#SignalMapStatus", + "traits": { + "smithy.api#jsonName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for StartDeleteMonitorDeploymentResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#StartInputDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#StartInputDeviceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#StartInputDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Start an input device that is attached to a MediaConnect flow. (There is no need to start a device that is attached to a MediaLive input; MediaLive starts the device when the channel starts.)", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/start", + "code": 200 + } + } + }, + "com.amazonaws.medialive#StartInputDeviceMaintenanceWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowRequest" + }, + "output": { + "target": "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" }, - "StaticImageOutputActivateSettings": { - "target": "com.amazonaws.medialive#StaticImageOutputActivateScheduleActionSettings", - "traits": { - "smithy.api#documentation": "Action to activate a static image overlay in one or more specified outputs", - "smithy.api#jsonName": "staticImageOutputActivateSettings" - } + { + "target": "com.amazonaws.medialive#TooManyRequestsException" }, - "StaticImageOutputDeactivateSettings": { - "target": "com.amazonaws.medialive#StaticImageOutputDeactivateScheduleActionSettings", - "traits": { - "smithy.api#documentation": "Action to deactivate a static image overlay in one or more specified outputs", - "smithy.api#jsonName": "staticImageOutputDeactivateSettings" - } + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" } - }, + ], "traits": { - "smithy.api#documentation": "Holds the settings for a single schedule action." + "smithy.api#documentation": "Start a maintenance window for the specified input device. Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/startInputDeviceMaintenanceWindow", + "code": 200 + } } }, - "com.amazonaws.medialive#ScheduleActionStartSettings": { + "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowRequest": { "type": "structure", "members": { - "FixedModeScheduleActionStartSettings": { - "target": "com.amazonaws.medialive#FixedModeScheduleActionStartSettings", - "traits": { - "smithy.api#documentation": "Option for specifying the start time for an action.", - "smithy.api#jsonName": "fixedModeScheduleActionStartSettings" - } - }, - "FollowModeScheduleActionStartSettings": { - "target": "com.amazonaws.medialive#FollowModeScheduleActionStartSettings", - "traits": { - "smithy.api#documentation": "Option for specifying an action as relative to another action.", - "smithy.api#jsonName": "followModeScheduleActionStartSettings" - } - }, - "ImmediateModeScheduleActionStartSettings": { - "target": "com.amazonaws.medialive#ImmediateModeScheduleActionStartSettings", + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Option for specifying an action that should be applied immediately.", - "smithy.api#jsonName": "immediateModeScheduleActionStartSettings" + "smithy.api#documentation": "The unique ID of the input device to start a maintenance window for. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Settings to specify when an action should occur. Only one of the options must be selected." + "smithy.api#documentation": "Placeholder documentation for StartInputDeviceMaintenanceWindowRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#Scte20Convert608To708": { - "type": "enum", + "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for StartInputDeviceMaintenanceWindowResponse", + "smithy.api#output": {} + } + }, + "com.amazonaws.medialive#StartInputDeviceRequest": { + "type": "structure", "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "UPCONVERT": { - "target": "smithy.api#Unit", + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "UPCONVERT" + "smithy.api#documentation": "The unique ID of the input device to start. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Scte20 Convert608 To708" + "smithy.api#documentation": "Placeholder documentation for StartInputDeviceRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#Scte20PlusEmbeddedDestinationSettings": { + "com.amazonaws.medialive#StartInputDeviceResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Scte20 Plus Embedded Destination Settings" + "smithy.api#documentation": "Placeholder documentation for StartInputDeviceResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#Scte20SourceSettings": { + "com.amazonaws.medialive#StartMonitorDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#StartMonitorDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.medialive#StartMonitorDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Initiates a deployment to deploy the latest monitor of the specified signal map.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/signal-maps/{Identifier}/monitor-deployment", + "code": 202 + } + } + }, + "com.amazonaws.medialive#StartMonitorDeploymentRequest": { "type": "structure", "members": { - "Convert608To708": { - "target": "com.amazonaws.medialive#Scte20Convert608To708", + "DryRun": { + "target": "com.amazonaws.medialive#__boolean", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "convert608To708" + "smithy.api#jsonName": "dryRun" } }, - "Source608ChannelNumber": { - "target": "com.amazonaws.medialive#__integerMin1Max4", + "Identifier": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.", - "smithy.api#jsonName": "source608ChannelNumber" + "smithy.api#documentation": "A signal map's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Scte20 Source Settings" + "smithy.api#documentation": "Placeholder documentation for StartMonitorDeploymentRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#Scte27DestinationSettings": { + "com.amazonaws.medialive#StartMonitorDeploymentResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Scte27 Destination Settings" - } - }, - "com.amazonaws.medialive#Scte27OcrLanguage": { - "type": "enum", "members": { - "DEU": { - "target": "smithy.api#Unit", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveSignalMap", "traits": { - "smithy.api#enumValue": "DEU" + "smithy.api#documentation": "A signal map's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" } }, - "ENG": { - "target": "smithy.api#Unit", + "CloudWatchAlarmTemplateGroupIds": { + "target": "com.amazonaws.medialive#__listOf__stringMin7Max11PatternAws097", "traits": { - "smithy.api#enumValue": "ENG" + "smithy.api#jsonName": "cloudWatchAlarmTemplateGroupIds" } }, - "FRA": { - "target": "smithy.api#Unit", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "FRA" + "smithy.api#jsonName": "createdAt" } }, - "NLD": { - "target": "smithy.api#Unit", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#enumValue": "NLD" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "POR": { - "target": "smithy.api#Unit", + "DiscoveryEntryPointArn": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#enumValue": "POR" + "smithy.api#documentation": "A top-level supported AWS resource ARN to discovery a signal map from.", + "smithy.api#jsonName": "discoveryEntryPointArn" } }, - "SPA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPA" - } - } - }, - "traits": { - "smithy.api#documentation": "Scte27 Ocr Language" - } - }, - "com.amazonaws.medialive#Scte27SourceSettings": { - "type": "structure", - "members": { - "OcrLanguage": { - "target": "com.amazonaws.medialive#Scte27OcrLanguage", + "ErrorMessage": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "ocrLanguage" + "smithy.api#documentation": "Error message associated with a failed creation or failed update attempt of a signal map.", + "smithy.api#jsonName": "errorMessage" } }, - "Pid": { - "target": "com.amazonaws.medialive#__integerMin1", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "pid" - } - } - }, - "traits": { - "smithy.api#documentation": "Scte27 Source Settings" - } - }, - "com.amazonaws.medialive#Scte35AposNoRegionalBlackoutBehavior": { - "type": "enum", - "members": { - "FOLLOW": { - "target": "smithy.api#Unit", + "EventBridgeRuleTemplateGroupIds": { + "target": "com.amazonaws.medialive#__listOf__stringMin7Max11PatternAws097", "traits": { - "smithy.api#enumValue": "FOLLOW" + "smithy.api#jsonName": "eventBridgeRuleTemplateGroupIds" } }, - "IGNORE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IGNORE" - } - } - }, - "traits": { - "smithy.api#documentation": "Scte35 Apos No Regional Blackout Behavior" - } - }, - "com.amazonaws.medialive#Scte35AposWebDeliveryAllowedBehavior": { - "type": "enum", - "members": { - "FOLLOW": { - "target": "smithy.api#Unit", + "FailedMediaResourceMap": { + "target": "com.amazonaws.medialive#FailedMediaResourceMap", "traits": { - "smithy.api#enumValue": "FOLLOW" + "smithy.api#jsonName": "failedMediaResourceMap" } }, - "IGNORE": { - "target": "smithy.api#Unit", + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#enumValue": "IGNORE" + "smithy.api#documentation": "A signal map's id.", + "smithy.api#jsonName": "id" } - } - }, - "traits": { - "smithy.api#documentation": "Scte35 Apos Web Delivery Allowed Behavior" - } - }, - "com.amazonaws.medialive#Scte35ArchiveAllowedFlag": { - "type": "enum", - "members": { - "ARCHIVE_NOT_ALLOWED": { - "target": "smithy.api#Unit", + }, + "LastDiscoveredAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "ARCHIVE_NOT_ALLOWED" + "smithy.api#jsonName": "lastDiscoveredAt" } }, - "ARCHIVE_ALLOWED": { - "target": "smithy.api#Unit", + "LastSuccessfulMonitorDeployment": { + "target": "com.amazonaws.medialive#SuccessfulMonitorDeployment", "traits": { - "smithy.api#enumValue": "ARCHIVE_ALLOWED" + "smithy.api#jsonName": "lastSuccessfulMonitorDeployment" } - } - }, - "traits": { - "smithy.api#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." - } - }, - "com.amazonaws.medialive#Scte35DeliveryRestrictions": { - "type": "structure", - "members": { - "ArchiveAllowedFlag": { - "target": "com.amazonaws.medialive#Scte35ArchiveAllowedFlag", + }, + "MediaResourceMap": { + "target": "com.amazonaws.medialive#MediaResourceMap", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Corresponds to SCTE-35 archive_allowed_flag.", - "smithy.api#jsonName": "archiveAllowedFlag", - "smithy.api#required": {} + "smithy.api#jsonName": "mediaResourceMap" } }, - "DeviceRestrictions": { - "target": "com.amazonaws.medialive#Scte35DeviceRestrictions", + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Corresponds to SCTE-35 device_restrictions parameter.", - "smithy.api#jsonName": "deviceRestrictions", - "smithy.api#required": {} + "smithy.api#jsonName": "modifiedAt" } }, - "NoRegionalBlackoutFlag": { - "target": "com.amazonaws.medialive#Scte35NoRegionalBlackoutFlag", + "MonitorChangesPendingDeployment": { + "target": "com.amazonaws.medialive#__boolean", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Corresponds to SCTE-35 no_regional_blackout_flag parameter.", - "smithy.api#jsonName": "noRegionalBlackoutFlag", - "smithy.api#required": {} + "smithy.api#documentation": "If true, there are pending monitor changes for this signal map that can be deployed.", + "smithy.api#jsonName": "monitorChangesPendingDeployment" } }, - "WebDeliveryAllowedFlag": { - "target": "com.amazonaws.medialive#Scte35WebDeliveryAllowedFlag", + "MonitorDeployment": { + "target": "com.amazonaws.medialive#MonitorDeployment", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Corresponds to SCTE-35 web_delivery_allowed_flag parameter.", - "smithy.api#jsonName": "webDeliveryAllowedFlag", - "smithy.api#required": {} + "smithy.api#jsonName": "monitorDeployment" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.medialive#SignalMapStatus", + "traits": { + "smithy.api#jsonName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#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." + "smithy.api#documentation": "Placeholder documentation for StartMonitorDeploymentResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#Scte35Descriptor": { - "type": "structure", - "members": { - "Scte35DescriptorSettings": { - "target": "com.amazonaws.medialive#Scte35DescriptorSettings", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "SCTE-35 Descriptor Settings.", - "smithy.api#jsonName": "scte35DescriptorSettings", - "smithy.api#required": {} - } - } + "com.amazonaws.medialive#StartMultiplex": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#StartMultiplexRequest" + }, + "output": { + "target": "com.amazonaws.medialive#StartMultiplexResponse" }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], "traits": { - "smithy.api#documentation": "Holds one set of SCTE-35 Descriptor Settings." + "smithy.api#documentation": "Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/multiplexes/{MultiplexId}/start", + "code": 202 + } } }, - "com.amazonaws.medialive#Scte35DescriptorSettings": { + "com.amazonaws.medialive#StartMultiplexRequest": { "type": "structure", "members": { - "SegmentationDescriptorScte35DescriptorSettings": { - "target": "com.amazonaws.medialive#Scte35SegmentationDescriptor", + "MultiplexId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "SCTE-35 Segmentation Descriptor.", - "smithy.api#jsonName": "segmentationDescriptorScte35DescriptorSettings", + "smithy.api#documentation": "The ID of the multiplex.", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "SCTE-35 Descriptor settings." + "smithy.api#documentation": "Placeholder documentation for StartMultiplexRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#Scte35DeviceRestrictions": { - "type": "enum", + "com.amazonaws.medialive#StartMultiplexResponse": { + "type": "structure", "members": { - "NONE": { - "target": "smithy.api#Unit", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#documentation": "The unique arn of the multiplex.", + "smithy.api#jsonName": "arn" } }, - "RESTRICT_GROUP0": { - "target": "smithy.api#Unit", + "AvailabilityZones": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#enumValue": "RESTRICT_GROUP0" + "smithy.api#documentation": "A list of availability zones for the multiplex.", + "smithy.api#jsonName": "availabilityZones" } }, - "RESTRICT_GROUP1": { - "target": "smithy.api#Unit", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", "traits": { - "smithy.api#enumValue": "RESTRICT_GROUP1" + "smithy.api#documentation": "A list of the multiplex output destinations.", + "smithy.api#jsonName": "destinations" } }, - "RESTRICT_GROUP2": { - "target": "smithy.api#Unit", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "RESTRICT_GROUP2" + "smithy.api#documentation": "The unique id of the multiplex.", + "smithy.api#jsonName": "id" } - } - }, - "traits": { - "smithy.api#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." - } - }, - "com.amazonaws.medialive#Scte35InputMode": { - "type": "enum", - "members": { - "FIXED": { - "target": "smithy.api#Unit", + }, + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexSettings", "traits": { - "smithy.api#enumValue": "FIXED" + "smithy.api#documentation": "Configuration for a multiplex event.", + "smithy.api#jsonName": "multiplexSettings" } }, - "FOLLOW_ACTIVE": { - "target": "smithy.api#Unit", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "FOLLOW_ACTIVE" + "smithy.api#documentation": "The name of the multiplex.", + "smithy.api#jsonName": "name" } - } - }, - "traits": { - "smithy.api#documentation": "Whether the SCTE-35 input should be the active input or a fixed input." - } - }, - "com.amazonaws.medialive#Scte35InputScheduleActionSettings": { - "type": "structure", - "members": { - "InputAttachmentNameReference": { - "target": "com.amazonaws.medialive#__string", + }, + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#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.)\"", - "smithy.api#jsonName": "inputAttachmentNameReference" + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" } }, - "Mode": { - "target": "com.amazonaws.medialive#Scte35InputMode", + "ProgramCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Whether the SCTE-35 input should be the active input or a fixed input.", - "smithy.api#jsonName": "mode", - "smithy.api#required": {} + "smithy.api#documentation": "The number of programs in the multiplex.", + "smithy.api#jsonName": "programCount" } - } - }, - "traits": { - "smithy.api#documentation": "Scte35Input Schedule Action Settings" - } - }, - "com.amazonaws.medialive#Scte35NoRegionalBlackoutFlag": { - "type": "enum", - "members": { - "REGIONAL_BLACKOUT": { - "target": "smithy.api#Unit", + }, + "State": { + "target": "com.amazonaws.medialive#MultiplexState", "traits": { - "smithy.api#enumValue": "REGIONAL_BLACKOUT" + "smithy.api#documentation": "The current state of the multiplex.", + "smithy.api#jsonName": "state" } }, - "NO_REGIONAL_BLACKOUT": { - "target": "smithy.api#Unit", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#enumValue": "NO_REGIONAL_BLACKOUT" + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#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." + "smithy.api#documentation": "Placeholder documentation for StartMultiplexResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#Scte35ReturnToNetworkScheduleActionSettings": { + "com.amazonaws.medialive#StartTimecode": { "type": "structure", "members": { - "SpliceEventId": { - "target": "com.amazonaws.medialive#__longMin0Max4294967295", + "Timecode": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.", - "smithy.api#jsonName": "spliceEventId", - "smithy.api#required": {} + "smithy.api#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.", + "smithy.api#jsonName": "timecode" } } }, "traits": { - "smithy.api#documentation": "Settings for a SCTE-35 return_to_network message." + "smithy.api#documentation": "Settings to identify the start of the clip." + } + }, + "com.amazonaws.medialive#StartUpdateSignalMap": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#StartUpdateSignalMapRequest" + }, + "output": { + "target": "com.amazonaws.medialive#StartUpdateSignalMapResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Initiates an update for the specified signal map. Will discover a new signal map if a changed discoveryEntryPointArn is provided.", + "smithy.api#http": { + "method": "PATCH", + "uri": "/prod/signal-maps/{Identifier}", + "code": 202 + } } }, - "com.amazonaws.medialive#Scte35SegmentationCancelIndicator": { - "type": "enum", + "com.amazonaws.medialive#StartUpdateSignalMapRequest": { + "type": "structure", "members": { - "SEGMENTATION_EVENT_NOT_CANCELED": { - "target": "smithy.api#Unit", + "CloudWatchAlarmTemplateGroupIdentifiers": { + "target": "com.amazonaws.medialive#__listOf__stringPatternS", "traits": { - "smithy.api#enumValue": "SEGMENTATION_EVENT_NOT_CANCELED" + "smithy.api#jsonName": "cloudWatchAlarmTemplateGroupIdentifiers" } }, - "SEGMENTATION_EVENT_CANCELED": { - "target": "smithy.api#Unit", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#enumValue": "SEGMENTATION_EVENT_CANCELED" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } + }, + "DiscoveryEntryPointArn": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", + "traits": { + "smithy.api#documentation": "A top-level supported AWS resource ARN to discovery a signal map from.", + "smithy.api#jsonName": "discoveryEntryPointArn" + } + }, + "EventBridgeRuleTemplateGroupIdentifiers": { + "target": "com.amazonaws.medialive#__listOf__stringPatternS", + "traits": { + "smithy.api#jsonName": "eventBridgeRuleTemplateGroupIdentifiers" + } + }, + "ForceRediscovery": { + "target": "com.amazonaws.medialive#__boolean", + "traits": { + "smithy.api#documentation": "If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.", + "smithy.api#jsonName": "forceRediscovery" + } + }, + "Identifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "A signal map's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" } } }, "traits": { - "smithy.api#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." + "smithy.api#documentation": "Placeholder documentation for StartUpdateSignalMapRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#Scte35SegmentationDescriptor": { + "com.amazonaws.medialive#StartUpdateSignalMapResponse": { "type": "structure", "members": { - "DeliveryRestrictions": { - "target": "com.amazonaws.medialive#Scte35DeliveryRestrictions", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveSignalMap", "traits": { - "smithy.api#documentation": "Holds the four SCTE-35 delivery restriction parameters.", - "smithy.api#jsonName": "deliveryRestrictions" + "smithy.api#documentation": "A signal map's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" } }, - "SegmentNum": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "CloudWatchAlarmTemplateGroupIds": { + "target": "com.amazonaws.medialive#__listOf__stringMin7Max11PatternAws097", "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.", - "smithy.api#jsonName": "segmentNum" + "smithy.api#jsonName": "cloudWatchAlarmTemplateGroupIds" } }, - "SegmentationCancelIndicator": { - "target": "com.amazonaws.medialive#Scte35SegmentationCancelIndicator", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_event_cancel_indicator.", - "smithy.api#jsonName": "segmentationCancelIndicator", - "smithy.api#required": {} + "smithy.api#jsonName": "createdAt" } }, - "SegmentationDuration": { - "target": "com.amazonaws.medialive#__longMin0Max1099511627775", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "segmentationDuration" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "SegmentationEventId": { - "target": "com.amazonaws.medialive#__longMin0Max4294967295", + "DiscoveryEntryPointArn": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_event_id.", - "smithy.api#jsonName": "segmentationEventId", - "smithy.api#required": {} + "smithy.api#documentation": "A top-level supported AWS resource ARN to discovery a signal map from.", + "smithy.api#jsonName": "discoveryEntryPointArn" } }, - "SegmentationTypeId": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "ErrorMessage": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", "traits": { - "smithy.api#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\").", - "smithy.api#jsonName": "segmentationTypeId" + "smithy.api#documentation": "Error message associated with a failed creation or failed update attempt of a signal map.", + "smithy.api#jsonName": "errorMessage" } }, - "SegmentationUpid": { - "target": "com.amazonaws.medialive#__string", + "EventBridgeRuleTemplateGroupIds": { + "target": "com.amazonaws.medialive#__listOf__stringMin7Max11PatternAws097", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "segmentationUpid" + "smithy.api#jsonName": "eventBridgeRuleTemplateGroupIds" } }, - "SegmentationUpidType": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "FailedMediaResourceMap": { + "target": "com.amazonaws.medialive#FailedMediaResourceMap", "traits": { - "smithy.api#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\").", - "smithy.api#jsonName": "segmentationUpidType" + "smithy.api#jsonName": "failedMediaResourceMap" } }, - "SegmentsExpected": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.", - "smithy.api#jsonName": "segmentsExpected" + "smithy.api#documentation": "A signal map's id.", + "smithy.api#jsonName": "id" } }, - "SubSegmentNum": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "LastDiscoveredAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.", - "smithy.api#jsonName": "subSegmentNum" + "smithy.api#jsonName": "lastDiscoveredAt" } }, - "SubSegmentsExpected": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "LastSuccessfulMonitorDeployment": { + "target": "com.amazonaws.medialive#SuccessfulMonitorDeployment", "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.", - "smithy.api#jsonName": "subSegmentsExpected" + "smithy.api#jsonName": "lastSuccessfulMonitorDeployment" } - } - }, - "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_descriptor." - } - }, - "com.amazonaws.medialive#Scte35SpliceInsert": { - "type": "structure", - "members": { - "AdAvailOffset": { - "target": "com.amazonaws.medialive#__integerMinNegative1000Max1000", + }, + "MediaResourceMap": { + "target": "com.amazonaws.medialive#MediaResourceMap", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "adAvailOffset" + "smithy.api#jsonName": "mediaResourceMap" } }, - "NoRegionalBlackoutFlag": { - "target": "com.amazonaws.medialive#Scte35SpliceInsertNoRegionalBlackoutBehavior", + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates", - "smithy.api#jsonName": "noRegionalBlackoutFlag" + "smithy.api#jsonName": "modifiedAt" } }, - "WebDeliveryAllowedFlag": { - "target": "com.amazonaws.medialive#Scte35SpliceInsertWebDeliveryAllowedBehavior", + "MonitorChangesPendingDeployment": { + "target": "com.amazonaws.medialive#__boolean", "traits": { - "smithy.api#documentation": "When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates", - "smithy.api#jsonName": "webDeliveryAllowedFlag" + "smithy.api#documentation": "If true, there are pending monitor changes for this signal map that can be deployed.", + "smithy.api#jsonName": "monitorChangesPendingDeployment" } - } - }, - "traits": { - "smithy.api#documentation": "Typical configuration that applies breaks on splice inserts in addition to time signal placement opportunities, breaks, and advertisements." - } - }, - "com.amazonaws.medialive#Scte35SpliceInsertNoRegionalBlackoutBehavior": { - "type": "enum", - "members": { - "FOLLOW": { - "target": "smithy.api#Unit", + }, + "MonitorDeployment": { + "target": "com.amazonaws.medialive#MonitorDeployment", "traits": { - "smithy.api#enumValue": "FOLLOW" + "smithy.api#jsonName": "monitorDeployment" } }, - "IGNORE": { - "target": "smithy.api#Unit", + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#enumValue": "IGNORE" + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" } - } - }, - "traits": { - "smithy.api#documentation": "Scte35 Splice Insert No Regional Blackout Behavior" - } - }, - "com.amazonaws.medialive#Scte35SpliceInsertScheduleActionSettings": { - "type": "structure", - "members": { - "Duration": { - "target": "com.amazonaws.medialive#__longMin0Max8589934591", + }, + "Status": { + "target": "com.amazonaws.medialive#SignalMapStatus", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "duration" + "smithy.api#jsonName": "status" } }, - "SpliceEventId": { - "target": "com.amazonaws.medialive#__longMin0Max4294967295", + "Tags": { + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.", - "smithy.api#jsonName": "spliceEventId", - "smithy.api#required": {} + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "Settings for a SCTE-35 splice_insert message." + "smithy.api#documentation": "Placeholder documentation for StartUpdateSignalMapResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#Scte35SpliceInsertWebDeliveryAllowedBehavior": { - "type": "enum", + "com.amazonaws.medialive#StaticImageActivateScheduleActionSettings": { + "type": "structure", "members": { - "FOLLOW": { - "target": "smithy.api#Unit", + "Duration": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "FOLLOW" + "smithy.api#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.", + "smithy.api#jsonName": "duration" } }, - "IGNORE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IGNORE" - } - } - }, - "traits": { - "smithy.api#documentation": "Scte35 Splice Insert Web Delivery Allowed Behavior" - } - }, - "com.amazonaws.medialive#Scte35TimeSignalApos": { - "type": "structure", - "members": { - "AdAvailOffset": { - "target": "com.amazonaws.medialive#__integerMinNegative1000Max1000", + "FadeIn": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "adAvailOffset" + "smithy.api#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).", + "smithy.api#jsonName": "fadeIn" } }, - "NoRegionalBlackoutFlag": { - "target": "com.amazonaws.medialive#Scte35AposNoRegionalBlackoutBehavior", + "FadeOut": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates", - "smithy.api#jsonName": "noRegionalBlackoutFlag" + "smithy.api#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).", + "smithy.api#jsonName": "fadeOut" } }, - "WebDeliveryAllowedFlag": { - "target": "com.amazonaws.medialive#Scte35AposWebDeliveryAllowedBehavior", + "Height": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates", - "smithy.api#jsonName": "webDeliveryAllowedFlag" + "smithy.api#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.", + "smithy.api#jsonName": "height" } - } - }, - "traits": { - "smithy.api#documentation": "Atypical configuration that applies segment breaks only on SCTE-35 time signal placement opportunities and breaks." - } - }, - "com.amazonaws.medialive#Scte35TimeSignalScheduleActionSettings": { - "type": "structure", - "members": { - "Scte35Descriptors": { - "target": "com.amazonaws.medialive#__listOfScte35Descriptor", + }, + "Image": { + "target": "com.amazonaws.medialive#InputLocation", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.", - "smithy.api#jsonName": "scte35Descriptors", + "smithy.api#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.", + "smithy.api#jsonName": "image", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "Settings for a SCTE-35 time_signal." - } - }, - "com.amazonaws.medialive#Scte35Type": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } }, - "SCTE_35_WITHOUT_SEGMENTATION": { - "target": "smithy.api#Unit", + "ImageX": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "SCTE_35_WITHOUT_SEGMENTATION" + "smithy.api#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.", + "smithy.api#jsonName": "imageX" } - } - }, - "traits": { - "smithy.api#documentation": "Scte35 Type" - } - }, - "com.amazonaws.medialive#Scte35WebDeliveryAllowedFlag": { - "type": "enum", - "members": { - "WEB_DELIVERY_NOT_ALLOWED": { - "target": "smithy.api#Unit", + }, + "ImageY": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "WEB_DELIVERY_NOT_ALLOWED" + "smithy.api#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.", + "smithy.api#jsonName": "imageY" } }, - "WEB_DELIVERY_ALLOWED": { - "target": "smithy.api#Unit", + "Layer": { + "target": "com.amazonaws.medialive#__integerMin0Max7", "traits": { - "smithy.api#enumValue": "WEB_DELIVERY_ALLOWED" + "smithy.api#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.", + "smithy.api#jsonName": "layer" } - } - }, - "traits": { - "smithy.api#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." - } - }, - "com.amazonaws.medialive#SmoothGroupAudioOnlyTimecodeControl": { - "type": "enum", - "members": { - "PASSTHROUGH": { - "target": "smithy.api#Unit", + }, + "Opacity": { + "target": "com.amazonaws.medialive#__integerMin0Max100", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.", + "smithy.api#jsonName": "opacity" } }, - "USE_CONFIGURED_CLOCK": { - "target": "smithy.api#Unit", + "Width": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#enumValue": "USE_CONFIGURED_CLOCK" + "smithy.api#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.", + "smithy.api#jsonName": "width" } } }, "traits": { - "smithy.api#documentation": "Smooth Group Audio Only Timecode Control" + "smithy.api#documentation": "Settings for the action to activate a static image." } }, - "com.amazonaws.medialive#SmoothGroupCertificateMode": { - "type": "enum", + "com.amazonaws.medialive#StaticImageDeactivateScheduleActionSettings": { + "type": "structure", "members": { - "SELF_SIGNED": { - "target": "smithy.api#Unit", + "FadeOut": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "SELF_SIGNED" + "smithy.api#documentation": "The time in milliseconds for the image to fade out. Default is 0 (no fade-out).", + "smithy.api#jsonName": "fadeOut" } }, - "VERIFY_AUTHENTICITY": { - "target": "smithy.api#Unit", + "Layer": { + "target": "com.amazonaws.medialive#__integerMin0Max7", "traits": { - "smithy.api#enumValue": "VERIFY_AUTHENTICITY" + "smithy.api#documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0.", + "smithy.api#jsonName": "layer" } } }, "traits": { - "smithy.api#documentation": "Smooth Group Certificate Mode" + "smithy.api#documentation": "Settings for the action to deactivate the image in a specific layer." } }, - "com.amazonaws.medialive#SmoothGroupEventIdMode": { - "type": "enum", + "com.amazonaws.medialive#StaticImageOutputActivateScheduleActionSettings": { + "type": "structure", "members": { - "NO_EVENT_ID": { - "target": "smithy.api#Unit", + "Duration": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "NO_EVENT_ID" + "smithy.api#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.", + "smithy.api#jsonName": "duration" } }, - "USE_CONFIGURED": { - "target": "smithy.api#Unit", + "FadeIn": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "USE_CONFIGURED" + "smithy.api#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).", + "smithy.api#jsonName": "fadeIn" } }, - "USE_TIMESTAMP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USE_TIMESTAMP" - } - } - }, - "traits": { - "smithy.api#documentation": "Smooth Group Event Id Mode" - } - }, - "com.amazonaws.medialive#SmoothGroupEventStopBehavior": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", + "FadeOut": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#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).", + "smithy.api#jsonName": "fadeOut" } }, - "SEND_EOS": { - "target": "smithy.api#Unit", + "Height": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#enumValue": "SEND_EOS" + "smithy.api#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.", + "smithy.api#jsonName": "height" } - } - }, - "traits": { - "smithy.api#documentation": "Smooth Group Event Stop Behavior" - } - }, - "com.amazonaws.medialive#SmoothGroupSegmentationMode": { - "type": "enum", - "members": { - "USE_INPUT_SEGMENTATION": { - "target": "smithy.api#Unit", + }, + "Image": { + "target": "com.amazonaws.medialive#InputLocation", "traits": { - "smithy.api#enumValue": "USE_INPUT_SEGMENTATION" + "smithy.api#clientOptional": {}, + "smithy.api#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.", + "smithy.api#jsonName": "image", + "smithy.api#required": {} } }, - "USE_SEGMENT_DURATION": { - "target": "smithy.api#Unit", + "ImageX": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "USE_SEGMENT_DURATION" + "smithy.api#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.", + "smithy.api#jsonName": "imageX" } - } - }, - "traits": { - "smithy.api#documentation": "Smooth Group Segmentation Mode" - } - }, - "com.amazonaws.medialive#SmoothGroupSparseTrackType": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", + }, + "ImageY": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#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.", + "smithy.api#jsonName": "imageY" } }, - "SCTE_35": { - "target": "smithy.api#Unit", + "Layer": { + "target": "com.amazonaws.medialive#__integerMin0Max7", "traits": { - "smithy.api#enumValue": "SCTE_35" + "smithy.api#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.", + "smithy.api#jsonName": "layer" } }, - "SCTE_35_WITHOUT_SEGMENTATION": { - "target": "smithy.api#Unit", + "Opacity": { + "target": "com.amazonaws.medialive#__integerMin0Max100", "traits": { - "smithy.api#enumValue": "SCTE_35_WITHOUT_SEGMENTATION" + "smithy.api#documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.", + "smithy.api#jsonName": "opacity" } - } - }, - "traits": { - "smithy.api#documentation": "Smooth Group Sparse Track Type" - } - }, - "com.amazonaws.medialive#SmoothGroupStreamManifestBehavior": { - "type": "enum", - "members": { - "DO_NOT_SEND": { - "target": "smithy.api#Unit", + }, + "OutputNames": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#enumValue": "DO_NOT_SEND" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name(s) of the output(s) the activation should apply to.", + "smithy.api#jsonName": "outputNames", + "smithy.api#required": {} } }, - "SEND": { - "target": "smithy.api#Unit", + "Width": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#enumValue": "SEND" + "smithy.api#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.", + "smithy.api#jsonName": "width" } } }, "traits": { - "smithy.api#documentation": "Smooth Group Stream Manifest Behavior" + "smithy.api#documentation": "Settings for the action to activate a static image." } }, - "com.amazonaws.medialive#SmoothGroupTimestampOffsetMode": { - "type": "enum", + "com.amazonaws.medialive#StaticImageOutputDeactivateScheduleActionSettings": { + "type": "structure", "members": { - "USE_CONFIGURED_OFFSET": { - "target": "smithy.api#Unit", + "FadeOut": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "USE_CONFIGURED_OFFSET" + "smithy.api#documentation": "The time in milliseconds for the image to fade out. Default is 0 (no fade-out).", + "smithy.api#jsonName": "fadeOut" } }, - "USE_EVENT_START_DATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USE_EVENT_START_DATE" - } - } - }, - "traits": { - "smithy.api#documentation": "Smooth Group Timestamp Offset Mode" - } - }, - "com.amazonaws.medialive#Smpte2038DataPreference": { - "type": "enum", - "members": { - "IGNORE": { - "target": "smithy.api#Unit", + "Layer": { + "target": "com.amazonaws.medialive#__integerMin0Max7", "traits": { - "smithy.api#enumValue": "IGNORE" + "smithy.api#documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0.", + "smithy.api#jsonName": "layer" } }, - "PREFER": { - "target": "smithy.api#Unit", + "OutputNames": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#enumValue": "PREFER" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name(s) of the output(s) the deactivation should apply to.", + "smithy.api#jsonName": "outputNames", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Smpte2038 Data Preference" - } - }, - "com.amazonaws.medialive#SmpteTtDestinationSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Smpte Tt Destination Settings" + "smithy.api#documentation": "Settings for the action to deactivate the image in a specific layer." } }, - "com.amazonaws.medialive#StandardHlsSettings": { + "com.amazonaws.medialive#StaticKeySettings": { "type": "structure", "members": { - "AudioRenditionSets": { - "target": "com.amazonaws.medialive#__string", + "KeyProviderServer": { + "target": "com.amazonaws.medialive#InputLocation", "traits": { - "smithy.api#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 ','.", - "smithy.api#jsonName": "audioRenditionSets" + "smithy.api#documentation": "The URL of the license server used for protecting content.", + "smithy.api#jsonName": "keyProviderServer" } }, - "M3u8Settings": { - "target": "com.amazonaws.medialive#M3u8Settings", + "StaticKeyValue": { + "target": "com.amazonaws.medialive#__stringMin32Max32", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#jsonName": "m3u8Settings", + "smithy.api#documentation": "Static key value as a 32 character hexadecimal string.", + "smithy.api#jsonName": "staticKeyValue", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Standard Hls Settings" + "smithy.api#documentation": "Static Key Settings" } }, - "com.amazonaws.medialive#StartChannel": { + "com.amazonaws.medialive#StopChannel": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#StartChannelRequest" + "target": "com.amazonaws.medialive#StopChannelRequest" }, "output": { - "target": "com.amazonaws.medialive#StartChannelResponse" + "target": "com.amazonaws.medialive#StopChannelResponse" }, "errors": [ { @@ -22653,32 +27520,32 @@ } ], "traits": { - "smithy.api#documentation": "Starts an existing channel", + "smithy.api#documentation": "Stops a running channel", "smithy.api#http": { "method": "POST", - "uri": "/prod/channels/{ChannelId}/start", + "uri": "/prod/channels/{ChannelId}/stop", "code": 200 } } }, - "com.amazonaws.medialive#StartChannelRequest": { + "com.amazonaws.medialive#StopChannelRequest": { "type": "structure", "members": { "ChannelId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "A request to start a channel", + "smithy.api#documentation": "A request to stop a running channel", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for StartChannelRequest", + "smithy.api#documentation": "Placeholder documentation for StopChannelRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#StartChannelResponse": { + "com.amazonaws.medialive#StopChannelResponse": { "type": "structure", "members": { "Arn": { @@ -22807,60 +27674,17 @@ } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for StartChannelResponse", + "smithy.api#documentation": "Placeholder documentation for StopChannelResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#StartInputDevice": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#StartInputDeviceRequest" - }, - "output": { - "target": "com.amazonaws.medialive#StartInputDeviceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#NotFoundException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - }, - { - "target": "com.amazonaws.medialive#UnprocessableEntityException" - } - ], - "traits": { - "smithy.api#documentation": "Start an input device that is attached to a MediaConnect flow. (There is no need to start a device that is attached to a MediaLive input; MediaLive starts the device when the channel starts.)", - "smithy.api#http": { - "method": "POST", - "uri": "/prod/inputDevices/{InputDeviceId}/start", - "code": 200 - } - } - }, - "com.amazonaws.medialive#StartInputDeviceMaintenanceWindow": { + "com.amazonaws.medialive#StopInputDevice": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowRequest" + "target": "com.amazonaws.medialive#StopInputDeviceRequest" }, "output": { - "target": "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowResponse" + "target": "com.amazonaws.medialive#StopInputDeviceResponse" }, "errors": [ { @@ -22889,71 +27713,46 @@ } ], "traits": { - "smithy.api#documentation": "Start a maintenance window for the specified input device. Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance.", + "smithy.api#documentation": "Stop an input device that is attached to a MediaConnect flow. (There is no need to stop a device that is attached to a MediaLive input; MediaLive automatically stops the device when the channel stops.)", "smithy.api#http": { "method": "POST", - "uri": "/prod/inputDevices/{InputDeviceId}/startInputDeviceMaintenanceWindow", + "uri": "/prod/inputDevices/{InputDeviceId}/stop", "code": 200 } } }, - "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowRequest": { - "type": "structure", - "members": { - "InputDeviceId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique ID of the input device to start a maintenance window for. For example, hd-123456789abcdef.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for StartInputDeviceMaintenanceWindowRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Placeholder documentation for StartInputDeviceMaintenanceWindowResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#StartInputDeviceRequest": { + "com.amazonaws.medialive#StopInputDeviceRequest": { "type": "structure", "members": { "InputDeviceId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique ID of the input device to start. For example, hd-123456789abcdef.", + "smithy.api#documentation": "The unique ID of the input device to stop. For example, hd-123456789abcdef.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for StartInputDeviceRequest", + "smithy.api#documentation": "Placeholder documentation for StopInputDeviceRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#StartInputDeviceResponse": { + "com.amazonaws.medialive#StopInputDeviceResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Placeholder documentation for StartInputDeviceResponse", + "smithy.api#documentation": "Placeholder documentation for StopInputDeviceResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#StartMultiplex": { + "com.amazonaws.medialive#StopMultiplex": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#StartMultiplexRequest" + "target": "com.amazonaws.medialive#StopMultiplexRequest" }, "output": { - "target": "com.amazonaws.medialive#StartMultiplexResponse" + "target": "com.amazonaws.medialive#StopMultiplexResponse" }, "errors": [ { @@ -22982,15 +27781,15 @@ } ], "traits": { - "smithy.api#documentation": "Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.", + "smithy.api#documentation": "Stops a running multiplex. If the multiplex isn't running, this action has no effect.", "smithy.api#http": { "method": "POST", - "uri": "/prod/multiplexes/{MultiplexId}/start", + "uri": "/prod/multiplexes/{MultiplexId}/stop", "code": 202 } } }, - "com.amazonaws.medialive#StartMultiplexRequest": { + "com.amazonaws.medialive#StopMultiplexRequest": { "type": "structure", "members": { "MultiplexId": { @@ -23003,11 +27802,11 @@ } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for StartMultiplexRequest", + "smithy.api#documentation": "Placeholder documentation for StopMultiplexRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#StartMultiplexResponse": { + "com.amazonaws.medialive#StopMultiplexResponse": { "type": "structure", "members": { "Arn": { @@ -23082,539 +27881,583 @@ } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for StartMultiplexResponse", + "smithy.api#documentation": "Placeholder documentation for StopMultiplexResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#StartTimecode": { + "com.amazonaws.medialive#StopTimecode": { "type": "structure", "members": { + "LastFrameClippingBehavior": { + "target": "com.amazonaws.medialive#LastFrameClippingBehavior", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "lastFrameClippingBehavior" + } + }, "Timecode": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", + "smithy.api#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.", "smithy.api#jsonName": "timecode" } } }, "traits": { - "smithy.api#documentation": "Settings to identify the start of the clip." + "smithy.api#documentation": "Settings to identify the end of the clip." } }, - "com.amazonaws.medialive#StaticImageActivateScheduleActionSettings": { + "com.amazonaws.medialive#SuccessfulMonitorDeployment": { + "type": "structure", + "members": { + "DetailsUri": { + "target": "com.amazonaws.medialive#__stringMin1Max2048", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "URI associated with a signal map's monitor deployment.", + "smithy.api#jsonName": "detailsUri", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.medialive#SignalMapMonitorDeploymentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the latest successful monitor deployment of a signal map." + } + }, + "com.amazonaws.medialive#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.medialive#__string" + }, + "value": { + "target": "com.amazonaws.medialive#__string" + }, + "traits": { + "smithy.api#documentation": "Represents the tags associated with a resource." + } + }, + "com.amazonaws.medialive#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.medialive#__string" + }, + "value": { + "target": "com.amazonaws.medialive#__string" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for Tags" + } + }, + "com.amazonaws.medialive#TeletextDestinationSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Teletext Destination Settings" + } + }, + "com.amazonaws.medialive#TeletextSourceSettings": { + "type": "structure", + "members": { + "OutputRectangle": { + "target": "com.amazonaws.medialive#CaptionRectangle", + "traits": { + "smithy.api#documentation": "Optionally defines a region where TTML style captions will be displayed", + "smithy.api#jsonName": "outputRectangle" + } + }, + "PageNumber": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "pageNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "Teletext Source Settings" + } + }, + "com.amazonaws.medialive#TemporalFilterPostFilterSharpening": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "Temporal Filter Post Filter Sharpening" + } + }, + "com.amazonaws.medialive#TemporalFilterSettings": { "type": "structure", "members": { - "Duration": { - "target": "com.amazonaws.medialive#__integerMin0", + "PostFilterSharpening": { + "target": "com.amazonaws.medialive#TemporalFilterPostFilterSharpening", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "postFilterSharpening" + } + }, + "Strength": { + "target": "com.amazonaws.medialive#TemporalFilterStrength", + "traits": { + "smithy.api#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.", + "smithy.api#jsonName": "strength" + } + } + }, + "traits": { + "smithy.api#documentation": "Temporal Filter Settings" + } + }, + "com.amazonaws.medialive#TemporalFilterStrength": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "duration" + "smithy.api#enumValue": "AUTO" } }, - "FadeIn": { - "target": "com.amazonaws.medialive#__integerMin0", + "STRENGTH_1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "fadeIn" + "smithy.api#enumValue": "STRENGTH_1" } }, - "FadeOut": { - "target": "com.amazonaws.medialive#__integerMin0", + "STRENGTH_2": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "fadeOut" + "smithy.api#enumValue": "STRENGTH_2" } }, - "Height": { - "target": "com.amazonaws.medialive#__integerMin1", + "STRENGTH_3": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "height" + "smithy.api#enumValue": "STRENGTH_3" } }, - "Image": { - "target": "com.amazonaws.medialive#InputLocation", + "STRENGTH_4": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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.", - "smithy.api#jsonName": "image", - "smithy.api#required": {} + "smithy.api#enumValue": "STRENGTH_4" } }, - "ImageX": { - "target": "com.amazonaws.medialive#__integerMin0", + "STRENGTH_5": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "imageX" + "smithy.api#enumValue": "STRENGTH_5" } }, - "ImageY": { - "target": "com.amazonaws.medialive#__integerMin0", + "STRENGTH_6": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "imageY" + "smithy.api#enumValue": "STRENGTH_6" } }, - "Layer": { - "target": "com.amazonaws.medialive#__integerMin0Max7", + "STRENGTH_7": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "layer" + "smithy.api#enumValue": "STRENGTH_7" } }, - "Opacity": { - "target": "com.amazonaws.medialive#__integerMin0Max100", + "STRENGTH_8": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.", - "smithy.api#jsonName": "opacity" + "smithy.api#enumValue": "STRENGTH_8" } }, - "Width": { - "target": "com.amazonaws.medialive#__integerMin1", + "STRENGTH_9": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "width" + "smithy.api#enumValue": "STRENGTH_9" } - } - }, - "traits": { - "smithy.api#documentation": "Settings for the action to activate a static image." - } - }, - "com.amazonaws.medialive#StaticImageDeactivateScheduleActionSettings": { - "type": "structure", - "members": { - "FadeOut": { - "target": "com.amazonaws.medialive#__integerMin0", + }, + "STRENGTH_10": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The time in milliseconds for the image to fade out. Default is 0 (no fade-out).", - "smithy.api#jsonName": "fadeOut" + "smithy.api#enumValue": "STRENGTH_10" } }, - "Layer": { - "target": "com.amazonaws.medialive#__integerMin0Max7", + "STRENGTH_11": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0.", - "smithy.api#jsonName": "layer" + "smithy.api#enumValue": "STRENGTH_11" } - } - }, - "traits": { - "smithy.api#documentation": "Settings for the action to deactivate the image in a specific layer." - } - }, - "com.amazonaws.medialive#StaticImageOutputActivateScheduleActionSettings": { - "type": "structure", - "members": { - "Duration": { - "target": "com.amazonaws.medialive#__integerMin0", + }, + "STRENGTH_12": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "duration" + "smithy.api#enumValue": "STRENGTH_12" } }, - "FadeIn": { - "target": "com.amazonaws.medialive#__integerMin0", + "STRENGTH_13": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "fadeIn" + "smithy.api#enumValue": "STRENGTH_13" } }, - "FadeOut": { - "target": "com.amazonaws.medialive#__integerMin0", + "STRENGTH_14": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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).", - "smithy.api#jsonName": "fadeOut" + "smithy.api#enumValue": "STRENGTH_14" } }, - "Height": { - "target": "com.amazonaws.medialive#__integerMin1", + "STRENGTH_15": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "height" + "smithy.api#enumValue": "STRENGTH_15" } }, - "Image": { - "target": "com.amazonaws.medialive#InputLocation", + "STRENGTH_16": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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.", - "smithy.api#jsonName": "image", - "smithy.api#required": {} + "smithy.api#enumValue": "STRENGTH_16" } - }, - "ImageX": { - "target": "com.amazonaws.medialive#__integerMin0", + } + }, + "traits": { + "smithy.api#documentation": "Temporal Filter Strength" + } + }, + "com.amazonaws.medialive#Thumbnail": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "imageX" + "smithy.api#documentation": "The binary data for the latest thumbnail.", + "smithy.api#jsonName": "body" } }, - "ImageY": { - "target": "com.amazonaws.medialive#__integerMin0", + "ContentType": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "imageY" + "smithy.api#documentation": "The content type for the latest thumbnail.", + "smithy.api#jsonName": "contentType" } }, - "Layer": { - "target": "com.amazonaws.medialive#__integerMin0Max7", + "ThumbnailType": { + "target": "com.amazonaws.medialive#ThumbnailType", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "layer" + "smithy.api#documentation": "Thumbnail Type", + "smithy.api#jsonName": "thumbnailType" } }, - "Opacity": { - "target": "com.amazonaws.medialive#__integerMin0Max100", + "TimeStamp": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.", - "smithy.api#jsonName": "opacity" + "smithy.api#documentation": "Time stamp for the latest thumbnail.", + "smithy.api#jsonName": "timeStamp" } - }, - "OutputNames": { - "target": "com.amazonaws.medialive#__listOf__string", + } + }, + "traits": { + "smithy.api#documentation": "Details of a single thumbnail" + } + }, + "com.amazonaws.medialive#ThumbnailConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.medialive#ThumbnailState", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name(s) of the output(s) the activation should apply to.", - "smithy.api#jsonName": "outputNames", + "smithy.api#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.", + "smithy.api#jsonName": "state", "smithy.api#required": {} } - }, - "Width": { - "target": "com.amazonaws.medialive#__integerMin1", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "width" - } } }, "traits": { - "smithy.api#documentation": "Settings for the action to activate a static image." + "smithy.api#documentation": "Thumbnail Configuration" } }, - "com.amazonaws.medialive#StaticImageOutputDeactivateScheduleActionSettings": { + "com.amazonaws.medialive#ThumbnailDetail": { "type": "structure", "members": { - "FadeOut": { - "target": "com.amazonaws.medialive#__integerMin0", + "PipelineId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The time in milliseconds for the image to fade out. Default is 0 (no fade-out).", - "smithy.api#jsonName": "fadeOut" + "smithy.api#documentation": "Pipeline ID", + "smithy.api#jsonName": "pipelineId" } }, - "Layer": { - "target": "com.amazonaws.medialive#__integerMin0Max7", + "Thumbnails": { + "target": "com.amazonaws.medialive#__listOfThumbnail", "traits": { - "smithy.api#documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0.", - "smithy.api#jsonName": "layer" + "smithy.api#documentation": "thumbnails of a single pipeline", + "smithy.api#jsonName": "thumbnails" } - }, - "OutputNames": { - "target": "com.amazonaws.medialive#__listOf__string", + } + }, + "traits": { + "smithy.api#documentation": "Thumbnail details for one pipeline of a running channel." + } + }, + "com.amazonaws.medialive#ThumbnailState": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name(s) of the output(s) the deactivation should apply to.", - "smithy.api#jsonName": "outputNames", - "smithy.api#required": {} + "smithy.api#enumValue": "AUTO" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" } } }, "traits": { - "smithy.api#documentation": "Settings for the action to deactivate the image in a specific layer." + "smithy.api#documentation": "Thumbnail State" } }, - "com.amazonaws.medialive#StaticKeySettings": { - "type": "structure", + "com.amazonaws.medialive#ThumbnailType": { + "type": "enum", "members": { - "KeyProviderServer": { - "target": "com.amazonaws.medialive#InputLocation", + "UNSPECIFIED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The URL of the license server used for protecting content.", - "smithy.api#jsonName": "keyProviderServer" + "smithy.api#enumValue": "UNSPECIFIED" } }, - "StaticKeyValue": { - "target": "com.amazonaws.medialive#__stringMin32Max32", + "CURRENT_ACTIVE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Static key value as a 32 character hexadecimal string.", - "smithy.api#jsonName": "staticKeyValue", - "smithy.api#required": {} + "smithy.api#enumValue": "CURRENT_ACTIVE" } } }, "traits": { - "smithy.api#documentation": "Static Key Settings" + "smithy.api#documentation": "Thumbnail type." } }, - "com.amazonaws.medialive#StopChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#StopChannelRequest" - }, - "output": { - "target": "com.amazonaws.medialive#StopChannelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ConflictException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "com.amazonaws.medialive#TimecodeBurninFontSize": { + "type": "enum", + "members": { + "EXTRA_SMALL_10": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTRA_SMALL_10" + } }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" + "LARGE_48": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LARGE_48" + } }, - { - "target": "com.amazonaws.medialive#NotFoundException" + "MEDIUM_32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM_32" + } }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "Stops a running channel", - "smithy.api#http": { - "method": "POST", - "uri": "/prod/channels/{ChannelId}/stop", - "code": 200 - } - } - }, - "com.amazonaws.medialive#StopChannelRequest": { - "type": "structure", - "members": { - "ChannelId": { - "target": "com.amazonaws.medialive#__string", + "SMALL_16": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A request to stop a running channel", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "SMALL_16" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for StopChannelRequest", - "smithy.api#input": {} + "smithy.api#documentation": "Timecode Burnin Font Size" } }, - "com.amazonaws.medialive#StopChannelResponse": { - "type": "structure", + "com.amazonaws.medialive#TimecodeBurninPosition": { + "type": "enum", "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique arn of the channel.", - "smithy.api#jsonName": "arn" - } - }, - "CdiInputSpecification": { - "target": "com.amazonaws.medialive#CdiInputSpecification", + "BOTTOM_CENTER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specification of CDI inputs for this channel", - "smithy.api#jsonName": "cdiInputSpecification" + "smithy.api#enumValue": "BOTTOM_CENTER" } }, - "ChannelClass": { - "target": "com.amazonaws.medialive#ChannelClass", + "BOTTOM_LEFT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", - "smithy.api#jsonName": "channelClass" + "smithy.api#enumValue": "BOTTOM_LEFT" } }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfOutputDestination", + "BOTTOM_RIGHT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "destinations" + "smithy.api#enumValue": "BOTTOM_RIGHT" } }, - "EgressEndpoints": { - "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", + "MIDDLE_CENTER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The endpoints where outgoing connections initiate from", - "smithy.api#jsonName": "egressEndpoints" + "smithy.api#enumValue": "MIDDLE_CENTER" } }, - "EncoderSettings": { - "target": "com.amazonaws.medialive#EncoderSettings", + "MIDDLE_LEFT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "encoderSettings" + "smithy.api#enumValue": "MIDDLE_LEFT" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "MIDDLE_RIGHT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique id of the channel.", - "smithy.api#jsonName": "id" + "smithy.api#enumValue": "MIDDLE_RIGHT" } }, - "InputAttachments": { - "target": "com.amazonaws.medialive#__listOfInputAttachment", + "TOP_CENTER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "List of input attachments for channel.", - "smithy.api#jsonName": "inputAttachments" + "smithy.api#enumValue": "TOP_CENTER" } }, - "InputSpecification": { - "target": "com.amazonaws.medialive#InputSpecification", + "TOP_LEFT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specification of network and file inputs for this channel", - "smithy.api#jsonName": "inputSpecification" + "smithy.api#enumValue": "TOP_LEFT" } }, - "LogLevel": { - "target": "com.amazonaws.medialive#LogLevel", + "TOP_RIGHT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The log level being written to CloudWatch Logs.", - "smithy.api#jsonName": "logLevel" + "smithy.api#enumValue": "TOP_RIGHT" } - }, - "Maintenance": { - "target": "com.amazonaws.medialive#MaintenanceStatus", + } + }, + "traits": { + "smithy.api#documentation": "Timecode Burnin Position" + } + }, + "com.amazonaws.medialive#TimecodeBurninSettings": { + "type": "structure", + "members": { + "FontSize": { + "target": "com.amazonaws.medialive#TimecodeBurninFontSize", "traits": { - "smithy.api#documentation": "Maintenance settings for this channel.", - "smithy.api#jsonName": "maintenance" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Choose a timecode burn-in font size", + "smithy.api#jsonName": "fontSize", + "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "Position": { + "target": "com.amazonaws.medialive#TimecodeBurninPosition", "traits": { - "smithy.api#documentation": "The name of the channel. (user-mutable)", - "smithy.api#jsonName": "name" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Choose a timecode burn-in output position", + "smithy.api#jsonName": "position", + "smithy.api#required": {} } }, - "PipelineDetails": { - "target": "com.amazonaws.medialive#__listOfPipelineDetail", + "Prefix": { + "target": "com.amazonaws.medialive#__stringMax255", "traits": { - "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", - "smithy.api#jsonName": "pipelineDetails" + "smithy.api#documentation": "Create a timecode burn-in prefix (optional)", + "smithy.api#jsonName": "prefix" } - }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", + } + }, + "traits": { + "smithy.api#documentation": "Timecode Burnin Settings" + } + }, + "com.amazonaws.medialive#TimecodeConfig": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.medialive#TimecodeConfigSource", "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" + "smithy.api#clientOptional": {}, + "smithy.api#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.", + "smithy.api#jsonName": "source", + "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", + "SyncThreshold": { + "target": "com.amazonaws.medialive#__integerMin1Max1000000", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", - "smithy.api#jsonName": "roleArn" + "smithy.api#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.", + "smithy.api#jsonName": "syncThreshold" } - }, - "State": { - "target": "com.amazonaws.medialive#ChannelState", + } + }, + "traits": { + "smithy.api#documentation": "Timecode Config" + } + }, + "com.amazonaws.medialive#TimecodeConfigSource": { + "type": "enum", + "members": { + "EMBEDDED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#jsonName": "state" + "smithy.api#enumValue": "EMBEDDED" } - }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + }, + "SYSTEMCLOCK": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#enumValue": "SYSTEMCLOCK" } }, - "Vpc": { - "target": "com.amazonaws.medialive#VpcOutputSettingsDescription", + "ZEROBASED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Settings for VPC output", - "smithy.api#jsonName": "vpc" + "smithy.api#enumValue": "ZEROBASED" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for StopChannelResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#StopInputDevice": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#StopInputDeviceRequest" - }, - "output": { - "target": "com.amazonaws.medialive#StopInputDeviceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ForbiddenException" - }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" - }, - { - "target": "com.amazonaws.medialive#NotFoundException" - }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" - }, - { - "target": "com.amazonaws.medialive#UnprocessableEntityException" - } - ], - "traits": { - "smithy.api#documentation": "Stop an input device that is attached to a MediaConnect flow. (There is no need to stop a device that is attached to a MediaLive input; MediaLive automatically stops the device when the channel stops.)", - "smithy.api#http": { - "method": "POST", - "uri": "/prod/inputDevices/{InputDeviceId}/stop", - "code": 200 - } + "smithy.api#documentation": "Timecode Config Source" } }, - "com.amazonaws.medialive#StopInputDeviceRequest": { + "com.amazonaws.medialive#TooManyRequestsException": { "type": "structure", "members": { - "InputDeviceId": { + "Message": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique ID of the input device to stop. For example, hd-123456789abcdef.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#jsonName": "message" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for StopInputDeviceRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#StopInputDeviceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Placeholder documentation for StopInputDeviceResponse", - "smithy.api#output": {} + "smithy.api#documentation": "Placeholder documentation for TooManyRequestsException", + "smithy.api#error": "client", + "smithy.api#httpError": 429 } }, - "com.amazonaws.medialive#StopMultiplex": { + "com.amazonaws.medialive#TransferInputDevice": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#StopMultiplexRequest" + "target": "com.amazonaws.medialive#TransferInputDeviceRequest" }, "output": { - "target": "com.amazonaws.medialive#StopMultiplexResponse" + "target": "com.amazonaws.medialive#TransferInputDeviceResponse" }, "errors": [ { @@ -23640,654 +28483,576 @@ }, { "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" } ], "traits": { - "smithy.api#documentation": "Stops a running multiplex. If the multiplex isn't running, this action has no effect.", + "smithy.api#documentation": "Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.", "smithy.api#http": { "method": "POST", - "uri": "/prod/multiplexes/{MultiplexId}/stop", - "code": 202 + "uri": "/prod/inputDevices/{InputDeviceId}/transfer", + "code": 200 } } }, - "com.amazonaws.medialive#StopMultiplexRequest": { + "com.amazonaws.medialive#TransferInputDeviceRequest": { "type": "structure", "members": { - "MultiplexId": { + "InputDeviceId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ID of the multiplex.", + "smithy.api#documentation": "The unique ID of this input device. For example, hd-123456789abcdef.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for StopMultiplexRequest", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#StopMultiplexResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique arn of the multiplex.", - "smithy.api#jsonName": "arn" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "A list of availability zones for the multiplex.", - "smithy.api#jsonName": "availabilityZones" - } - }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", - "traits": { - "smithy.api#documentation": "A list of the multiplex output destinations.", - "smithy.api#jsonName": "destinations" - } }, - "Id": { + "TargetCustomerId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique id of the multiplex.", - "smithy.api#jsonName": "id" - } - }, - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexSettings", - "traits": { - "smithy.api#documentation": "Configuration for a multiplex event.", - "smithy.api#jsonName": "multiplexSettings" + "smithy.api#documentation": "The AWS account ID (12 digits) for the recipient of the device transfer.", + "smithy.api#jsonName": "targetCustomerId" } }, - "Name": { + "TargetRegion": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The name of the multiplex.", - "smithy.api#jsonName": "name" - } - }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", - "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" - } - }, - "ProgramCount": { - "target": "com.amazonaws.medialive#__integer", - "traits": { - "smithy.api#documentation": "The number of programs in the multiplex.", - "smithy.api#jsonName": "programCount" - } - }, - "State": { - "target": "com.amazonaws.medialive#MultiplexState", - "traits": { - "smithy.api#documentation": "The current state of the multiplex.", - "smithy.api#jsonName": "state" + "smithy.api#documentation": "The target AWS region to transfer the device.", + "smithy.api#jsonName": "targetRegion" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "TransferMessage": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "An optional message for the recipient. Maximum 280 characters.", + "smithy.api#jsonName": "transferMessage" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for StopMultiplexResponse", + "smithy.api#documentation": "A request to transfer an input device.", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#TransferInputDeviceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for TransferInputDeviceResponse", "smithy.api#output": {} } }, - "com.amazonaws.medialive#StopTimecode": { + "com.amazonaws.medialive#TransferringInputDeviceSummary": { "type": "structure", "members": { - "LastFrameClippingBehavior": { - "target": "com.amazonaws.medialive#LastFrameClippingBehavior", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "lastFrameClippingBehavior" + "smithy.api#documentation": "The unique ID of the input device.", + "smithy.api#jsonName": "id" } }, - "Timecode": { + "Message": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "timecode" + "smithy.api#documentation": "The optional message that the sender has attached to the transfer.", + "smithy.api#jsonName": "message" + } + }, + "TargetCustomerId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The AWS account ID for the recipient of the input device transfer.", + "smithy.api#jsonName": "targetCustomerId" + } + }, + "TransferType": { + "target": "com.amazonaws.medialive#InputDeviceTransferType", + "traits": { + "smithy.api#documentation": "The type (direction) of the input device transfer.", + "smithy.api#jsonName": "transferType" } } }, "traits": { - "smithy.api#documentation": "Settings to identify the end of the clip." - } - }, - "com.amazonaws.medialive#Tags": { - "type": "map", - "key": { - "target": "com.amazonaws.medialive#__string" - }, - "value": { - "target": "com.amazonaws.medialive#__string" - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for Tags" - } - }, - "com.amazonaws.medialive#TeletextDestinationSettings": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Teletext Destination Settings" + "smithy.api#documentation": "Details about the input device that is being transferred." } }, - "com.amazonaws.medialive#TeletextSourceSettings": { + "com.amazonaws.medialive#TtmlDestinationSettings": { "type": "structure", "members": { - "OutputRectangle": { - "target": "com.amazonaws.medialive#CaptionRectangle", - "traits": { - "smithy.api#documentation": "Optionally defines a region where TTML style captions will be displayed", - "smithy.api#jsonName": "outputRectangle" - } - }, - "PageNumber": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "pageNumber" + "StyleControl": { + "target": "com.amazonaws.medialive#TtmlDestinationStyleControl", + "traits": { + "smithy.api#documentation": "This field is not currently supported and will not affect the output styling. Leave the default value.", + "smithy.api#jsonName": "styleControl" } } }, "traits": { - "smithy.api#documentation": "Teletext Source Settings" + "smithy.api#documentation": "Ttml Destination Settings" } }, - "com.amazonaws.medialive#TemporalFilterPostFilterSharpening": { + "com.amazonaws.medialive#TtmlDestinationStyleControl": { "type": "enum", "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "DISABLED": { + "PASSTHROUGH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "PASSTHROUGH" } }, - "ENABLED": { + "USE_CONFIGURED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "USE_CONFIGURED" } } }, "traits": { - "smithy.api#documentation": "Temporal Filter Post Filter Sharpening" + "smithy.api#documentation": "Ttml Destination Style Control" } }, - "com.amazonaws.medialive#TemporalFilterSettings": { + "com.amazonaws.medialive#UdpContainerSettings": { "type": "structure", "members": { - "PostFilterSharpening": { - "target": "com.amazonaws.medialive#TemporalFilterPostFilterSharpening", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "postFilterSharpening" - } - }, - "Strength": { - "target": "com.amazonaws.medialive#TemporalFilterStrength", + "M2tsSettings": { + "target": "com.amazonaws.medialive#M2tsSettings", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "strength" + "smithy.api#jsonName": "m2tsSettings" } } }, "traits": { - "smithy.api#documentation": "Temporal Filter Settings" + "smithy.api#documentation": "Udp Container Settings" } }, - "com.amazonaws.medialive#TemporalFilterStrength": { - "type": "enum", + "com.amazonaws.medialive#UdpGroupSettings": { + "type": "structure", "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "STRENGTH_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRENGTH_1" - } - }, - "STRENGTH_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRENGTH_2" - } - }, - "STRENGTH_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRENGTH_3" - } - }, - "STRENGTH_4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRENGTH_4" - } - }, - "STRENGTH_5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRENGTH_5" - } - }, - "STRENGTH_6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRENGTH_6" - } - }, - "STRENGTH_7": { - "target": "smithy.api#Unit", + "InputLossAction": { + "target": "com.amazonaws.medialive#InputLossActionForUdpOut", "traits": { - "smithy.api#enumValue": "STRENGTH_7" + "smithy.api#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.", + "smithy.api#jsonName": "inputLossAction" } }, - "STRENGTH_8": { - "target": "smithy.api#Unit", + "TimedMetadataId3Frame": { + "target": "com.amazonaws.medialive#UdpTimedMetadataId3Frame", "traits": { - "smithy.api#enumValue": "STRENGTH_8" + "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", + "smithy.api#jsonName": "timedMetadataId3Frame" } }, - "STRENGTH_9": { - "target": "smithy.api#Unit", + "TimedMetadataId3Period": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#enumValue": "STRENGTH_9" + "smithy.api#documentation": "Timed Metadata interval in seconds.", + "smithy.api#jsonName": "timedMetadataId3Period" } - }, - "STRENGTH_10": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#documentation": "Udp Group Settings" + } + }, + "com.amazonaws.medialive#UdpOutputSettings": { + "type": "structure", + "members": { + "BufferMsec": { + "target": "com.amazonaws.medialive#__integerMin0Max10000", "traits": { - "smithy.api#enumValue": "STRENGTH_10" + "smithy.api#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.", + "smithy.api#jsonName": "bufferMsec" } }, - "STRENGTH_11": { - "target": "smithy.api#Unit", + "ContainerSettings": { + "target": "com.amazonaws.medialive#UdpContainerSettings", "traits": { - "smithy.api#enumValue": "STRENGTH_11" + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "containerSettings", + "smithy.api#required": {} } }, - "STRENGTH_12": { - "target": "smithy.api#Unit", + "Destination": { + "target": "com.amazonaws.medialive#OutputLocationRef", "traits": { - "smithy.api#enumValue": "STRENGTH_12" + "smithy.api#clientOptional": {}, + "smithy.api#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).", + "smithy.api#jsonName": "destination", + "smithy.api#required": {} } }, - "STRENGTH_13": { - "target": "smithy.api#Unit", + "FecOutputSettings": { + "target": "com.amazonaws.medialive#FecOutputSettings", "traits": { - "smithy.api#enumValue": "STRENGTH_13" + "smithy.api#documentation": "Settings for enabling and adjusting Forward Error Correction on UDP outputs.", + "smithy.api#jsonName": "fecOutputSettings" } - }, - "STRENGTH_14": { + } + }, + "traits": { + "smithy.api#documentation": "Udp Output Settings" + } + }, + "com.amazonaws.medialive#UdpTimedMetadataId3Frame": { + "type": "enum", + "members": { + "NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "STRENGTH_14" + "smithy.api#enumValue": "NONE" } }, - "STRENGTH_15": { + "PRIV": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "STRENGTH_15" + "smithy.api#enumValue": "PRIV" } }, - "STRENGTH_16": { + "TDRL": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "STRENGTH_16" + "smithy.api#enumValue": "TDRL" } } }, "traits": { - "smithy.api#documentation": "Temporal Filter Strength" + "smithy.api#documentation": "Udp Timed Metadata Id3 Frame" } }, - "com.amazonaws.medialive#Thumbnail": { + "com.amazonaws.medialive#UnprocessableEntityException": { "type": "structure", "members": { - "Body": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The binary data for the latest thumbnail.", - "smithy.api#jsonName": "body" - } - }, - "ContentType": { + "Message": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The content type for the latest thumbnail.", - "smithy.api#jsonName": "contentType" - } - }, - "ThumbnailType": { - "target": "com.amazonaws.medialive#ThumbnailType", - "traits": { - "smithy.api#documentation": "Thumbnail Type", - "smithy.api#jsonName": "thumbnailType" + "smithy.api#documentation": "The error message.", + "smithy.api#jsonName": "message" } }, - "TimeStamp": { - "target": "com.amazonaws.medialive#__timestampIso8601", + "ValidationErrors": { + "target": "com.amazonaws.medialive#__listOfValidationError", "traits": { - "smithy.api#documentation": "Time stamp for the latest thumbnail.", - "smithy.api#jsonName": "timeStamp" + "smithy.api#documentation": "A collection of validation error responses.", + "smithy.api#jsonName": "validationErrors" } } }, "traits": { - "smithy.api#documentation": "Details of a single thumbnail" + "smithy.api#documentation": "Placeholder documentation for UnprocessableEntityException", + "smithy.api#error": "client", + "smithy.api#httpError": 422 } }, - "com.amazonaws.medialive#ThumbnailConfiguration": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.medialive#ThumbnailState", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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.", - "smithy.api#jsonName": "state", - "smithy.api#required": {} - } - } + "com.amazonaws.medialive#UpdateAccountConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#UpdateAccountConfigurationRequest" }, - "traits": { - "smithy.api#documentation": "Thumbnail Configuration" - } - }, - "com.amazonaws.medialive#ThumbnailDetail": { - "type": "structure", - "members": { - "PipelineId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Pipeline ID", - "smithy.api#jsonName": "pipelineId" - } + "output": { + "target": "com.amazonaws.medialive#UpdateAccountConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" }, - "Thumbnails": { - "target": "com.amazonaws.medialive#__listOfThumbnail", - "traits": { - "smithy.api#documentation": "thumbnails of a single pipeline", - "smithy.api#jsonName": "thumbnails" - } + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" } - }, + ], "traits": { - "smithy.api#documentation": "Thumbnail details for one pipeline of a running channel." + "smithy.api#documentation": "Update account configuration", + "smithy.api#http": { + "method": "PUT", + "uri": "/prod/accountConfiguration", + "code": 200 + } } }, - "com.amazonaws.medialive#ThumbnailState": { - "type": "enum", + "com.amazonaws.medialive#UpdateAccountConfigurationRequest": { + "type": "structure", "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", + "AccountConfiguration": { + "target": "com.amazonaws.medialive#AccountConfiguration", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#jsonName": "accountConfiguration" } } }, "traits": { - "smithy.api#documentation": "Thumbnail State" + "smithy.api#documentation": "List of account configuration parameters to update.", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#ThumbnailType": { - "type": "enum", + "com.amazonaws.medialive#UpdateAccountConfigurationResponse": { + "type": "structure", "members": { - "UNSPECIFIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNSPECIFIED" - } - }, - "CURRENT_ACTIVE": { - "target": "smithy.api#Unit", + "AccountConfiguration": { + "target": "com.amazonaws.medialive#AccountConfiguration", "traits": { - "smithy.api#enumValue": "CURRENT_ACTIVE" + "smithy.api#jsonName": "accountConfiguration" } } }, "traits": { - "smithy.api#documentation": "Thumbnail type." + "smithy.api#documentation": "Placeholder documentation for UpdateAccountConfigurationResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#TimecodeBurninFontSize": { - "type": "enum", - "members": { - "EXTRA_SMALL_10": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXTRA_SMALL_10" - } + "com.amazonaws.medialive#UpdateChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#UpdateChannelRequest" + }, + "output": { + "target": "com.amazonaws.medialive#UpdateChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "LARGE_48": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LARGE_48" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "MEDIUM_32": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM_32" - } + { + "target": "com.amazonaws.medialive#ConflictException" }, - "SMALL_16": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMALL_16" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" } - }, + ], "traits": { - "smithy.api#documentation": "Timecode Burnin Font Size" + "smithy.api#documentation": "Updates a channel.", + "smithy.api#http": { + "method": "PUT", + "uri": "/prod/channels/{ChannelId}", + "code": 200 + } } }, - "com.amazonaws.medialive#TimecodeBurninPosition": { - "type": "enum", - "members": { - "BOTTOM_CENTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTOM_CENTER" - } + "com.amazonaws.medialive#UpdateChannelClass": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#UpdateChannelClassRequest" + }, + "output": { + "target": "com.amazonaws.medialive#UpdateChannelClassResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "BOTTOM_LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTOM_LEFT" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "BOTTOM_RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTOM_RIGHT" - } + { + "target": "com.amazonaws.medialive#ConflictException" }, - "MIDDLE_CENTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIDDLE_CENTER" - } + { + "target": "com.amazonaws.medialive#ForbiddenException" }, - "MIDDLE_LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIDDLE_LEFT" - } + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" }, - "MIDDLE_RIGHT": { - "target": "smithy.api#Unit", + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Changes the class of the channel.", + "smithy.api#http": { + "method": "PUT", + "uri": "/prod/channels/{ChannelId}/channelClass", + "code": 200 + } + } + }, + "com.amazonaws.medialive#UpdateChannelClassRequest": { + "type": "structure", + "members": { + "ChannelClass": { + "target": "com.amazonaws.medialive#ChannelClass", "traits": { - "smithy.api#enumValue": "MIDDLE_RIGHT" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The channel class that you wish to update this channel to use.", + "smithy.api#jsonName": "channelClass", + "smithy.api#required": {} } }, - "TOP_CENTER": { - "target": "smithy.api#Unit", + "ChannelId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "TOP_CENTER" + "smithy.api#documentation": "Channel Id of the channel whose class should be updated.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "TOP_LEFT": { - "target": "smithy.api#Unit", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfOutputDestination", "traits": { - "smithy.api#enumValue": "TOP_LEFT" + "smithy.api#documentation": "A list of output destinations for this channel.", + "smithy.api#jsonName": "destinations" } - }, - "TOP_RIGHT": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#documentation": "Channel class that the channel should be updated to.", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#UpdateChannelClassResponse": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.medialive#Channel", "traits": { - "smithy.api#enumValue": "TOP_RIGHT" + "smithy.api#jsonName": "channel" } } }, "traits": { - "smithy.api#documentation": "Timecode Burnin Position" + "smithy.api#documentation": "Placeholder documentation for UpdateChannelClassResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#TimecodeBurninSettings": { + "com.amazonaws.medialive#UpdateChannelRequest": { "type": "structure", "members": { - "FontSize": { - "target": "com.amazonaws.medialive#TimecodeBurninFontSize", + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Choose a timecode burn-in font size", - "smithy.api#jsonName": "fontSize", + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" + } + }, + "ChannelId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "channel ID", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Position": { - "target": "com.amazonaws.medialive#TimecodeBurninPosition", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfOutputDestination", + "traits": { + "smithy.api#documentation": "A list of output destinations for this channel.", + "smithy.api#jsonName": "destinations" + } + }, + "EncoderSettings": { + "target": "com.amazonaws.medialive#EncoderSettings", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Choose a timecode burn-in output position", - "smithy.api#jsonName": "position", - "smithy.api#required": {} + "smithy.api#documentation": "The encoder settings for this channel.", + "smithy.api#jsonName": "encoderSettings" } }, - "Prefix": { - "target": "com.amazonaws.medialive#__stringMax255", + "InputAttachments": { + "target": "com.amazonaws.medialive#__listOfInputAttachment", "traits": { - "smithy.api#documentation": "Create a timecode burn-in prefix (optional)", - "smithy.api#jsonName": "prefix" + "smithy.api#jsonName": "inputAttachments" } - } - }, - "traits": { - "smithy.api#documentation": "Timecode Burnin Settings" - } - }, - "com.amazonaws.medialive#TimecodeConfig": { - "type": "structure", - "members": { - "Source": { - "target": "com.amazonaws.medialive#TimecodeConfigSource", + }, + "InputSpecification": { + "target": "com.amazonaws.medialive#InputSpecification", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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.", - "smithy.api#jsonName": "source", - "smithy.api#required": {} + "smithy.api#documentation": "Specification of network and file inputs for this channel", + "smithy.api#jsonName": "inputSpecification" } }, - "SyncThreshold": { - "target": "com.amazonaws.medialive#__integerMin1Max1000000", + "LogLevel": { + "target": "com.amazonaws.medialive#LogLevel", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "syncThreshold" + "smithy.api#documentation": "The log level to write to CloudWatch Logs.", + "smithy.api#jsonName": "logLevel" } - } - }, - "traits": { - "smithy.api#documentation": "Timecode Config" - } - }, - "com.amazonaws.medialive#TimecodeConfigSource": { - "type": "enum", - "members": { - "EMBEDDED": { - "target": "smithy.api#Unit", + }, + "Maintenance": { + "target": "com.amazonaws.medialive#MaintenanceUpdateSettings", "traits": { - "smithy.api#enumValue": "EMBEDDED" + "smithy.api#documentation": "Maintenance settings for this channel.", + "smithy.api#jsonName": "maintenance" } }, - "SYSTEMCLOCK": { - "target": "smithy.api#Unit", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "SYSTEMCLOCK" + "smithy.api#documentation": "The name of the channel.", + "smithy.api#jsonName": "name" } }, - "ZEROBASED": { - "target": "smithy.api#Unit", + "RoleArn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#enumValue": "ZEROBASED" + "smithy.api#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.", + "smithy.api#jsonName": "roleArn" } } }, "traits": { - "smithy.api#documentation": "Timecode Config Source" + "smithy.api#documentation": "A request to update a channel.", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#TooManyRequestsException": { + "com.amazonaws.medialive#UpdateChannelResponse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.medialive#__string", + "Channel": { + "target": "com.amazonaws.medialive#Channel", "traits": { - "smithy.api#jsonName": "message" + "smithy.api#jsonName": "channel" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for TooManyRequestsException", - "smithy.api#error": "client", - "smithy.api#httpError": 429 + "smithy.api#documentation": "Placeholder documentation for UpdateChannelResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#TransferInputDevice": { + "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#TransferInputDeviceRequest" + "target": "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplateRequest" }, "output": { - "target": "com.amazonaws.medialive#TransferInputDeviceResponse" + "target": "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplateResponse" }, "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, { "target": "com.amazonaws.medialive#BadRequestException" }, @@ -24297,9 +29062,6 @@ { "target": "com.amazonaws.medialive#ForbiddenException" }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" - }, { "target": "com.amazonaws.medialive#InternalServerErrorException" }, @@ -24308,351 +29070,397 @@ }, { "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified cloudwatch alarm template.", + "smithy.api#http": { + "method": "PATCH", + "uri": "/prod/cloudwatch-alarm-templates/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplateGroupRequest" + }, + "output": { + "target": "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplateGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadRequestException" }, { - "target": "com.amazonaws.medialive#UnprocessableEntityException" + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.", + "smithy.api#documentation": "Updates the specified cloudwatch alarm template group.", "smithy.api#http": { - "method": "POST", - "uri": "/prod/inputDevices/{InputDeviceId}/transfer", + "method": "PATCH", + "uri": "/prod/cloudwatch-alarm-template-groups/{Identifier}", "code": 200 } } }, - "com.amazonaws.medialive#TransferInputDeviceRequest": { + "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplateGroupRequest": { "type": "structure", "members": { - "InputDeviceId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique ID of this input device. For example, hd-123456789abcdef.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TargetCustomerId": { - "target": "com.amazonaws.medialive#__string", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#documentation": "The AWS account ID (12 digits) for the recipient of the device transfer.", - "smithy.api#jsonName": "targetCustomerId" - } - }, - "TargetRegion": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The target AWS region to transfer the device.", - "smithy.api#jsonName": "targetRegion" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "TransferMessage": { + "Identifier": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "An optional message for the recipient. Maximum 280 characters.", - "smithy.api#jsonName": "transferMessage" + "smithy.api#documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A request to transfer an input device.", + "smithy.api#documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateGroupRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#TransferInputDeviceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Placeholder documentation for TransferInputDeviceResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#TransferringInputDeviceSummary": { + "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplateGroupResponse": { "type": "structure", "members": { + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup", + "traits": { + "smithy.api#documentation": "A cloudwatch alarm template group's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" + } + }, + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "createdAt" + } + }, + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } + }, "Id": { - "target": "com.amazonaws.medialive#__string", + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#documentation": "The unique ID of the input device.", + "smithy.api#documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`", "smithy.api#jsonName": "id" } }, - "Message": { - "target": "com.amazonaws.medialive#__string", + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "The optional message that the sender has attached to the transfer.", - "smithy.api#jsonName": "message" + "smithy.api#jsonName": "modifiedAt" } }, - "TargetCustomerId": { - "target": "com.amazonaws.medialive#__string", + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#documentation": "The AWS account ID for the recipient of the input device transfer.", - "smithy.api#jsonName": "targetCustomerId" + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" } }, - "TransferType": { - "target": "com.amazonaws.medialive#InputDeviceTransferType", + "Tags": { + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#documentation": "The type (direction) of the input device transfer.", - "smithy.api#jsonName": "transferType" + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "Details about the input device that is being transferred." + "smithy.api#documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateGroupResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#TtmlDestinationSettings": { + "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplateRequest": { "type": "structure", "members": { - "StyleControl": { - "target": "com.amazonaws.medialive#TtmlDestinationStyleControl", + "ComparisonOperator": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateComparisonOperator", "traits": { - "smithy.api#documentation": "This field is not currently supported and will not affect the output styling. Leave the default value.", - "smithy.api#jsonName": "styleControl" + "smithy.api#jsonName": "comparisonOperator" } - } - }, - "traits": { - "smithy.api#documentation": "Ttml Destination Settings" - } - }, - "com.amazonaws.medialive#TtmlDestinationStyleControl": { - "type": "enum", - "members": { - "PASSTHROUGH": { - "target": "smithy.api#Unit", + }, + "DatapointsToAlarm": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm.", + "smithy.api#jsonName": "datapointsToAlarm" + } + }, + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } + }, + "EvaluationPeriods": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#documentation": "The number of periods over which data is compared to the specified threshold.", + "smithy.api#jsonName": "evaluationPeriods" + } + }, + "GroupIdentifier": { + "target": "com.amazonaws.medialive#__stringPatternS", + "traits": { + "smithy.api#documentation": "A cloudwatch alarm template group's identifier. Can be either be its id or current name.", + "smithy.api#jsonName": "groupIdentifier" + } + }, + "Identifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "A cloudwatch alarm template's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.medialive#__stringMax64", + "traits": { + "smithy.api#documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType.", + "smithy.api#jsonName": "metricName" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" + } + }, + "Period": { + "target": "com.amazonaws.medialive#__integerMin10Max86400", + "traits": { + "smithy.api#documentation": "The period, in seconds, over which the specified statistic is applied.", + "smithy.api#jsonName": "period" + } + }, + "Statistic": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateStatistic", + "traits": { + "smithy.api#jsonName": "statistic" + } + }, + "TargetResourceType": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTargetResourceType", + "traits": { + "smithy.api#jsonName": "targetResourceType" + } + }, + "Threshold": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#enumValue": "PASSTHROUGH" + "smithy.api#documentation": "The threshold value to compare with the specified statistic.", + "smithy.api#jsonName": "threshold" } }, - "USE_CONFIGURED": { - "target": "smithy.api#Unit", + "TreatMissingData": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTreatMissingData", "traits": { - "smithy.api#enumValue": "USE_CONFIGURED" + "smithy.api#jsonName": "treatMissingData" } } }, "traits": { - "smithy.api#documentation": "Ttml Destination Style Control" + "smithy.api#documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateRequest", + "smithy.api#input": {} } }, - "com.amazonaws.medialive#UdpContainerSettings": { + "com.amazonaws.medialive#UpdateCloudWatchAlarmTemplateResponse": { "type": "structure", "members": { - "M2tsSettings": { - "target": "com.amazonaws.medialive#M2tsSettings", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveCloudwatchAlarmTemplate", "traits": { - "smithy.api#jsonName": "m2tsSettings" + "smithy.api#documentation": "A cloudwatch alarm template's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" } - } - }, - "traits": { - "smithy.api#documentation": "Udp Container Settings" - } - }, - "com.amazonaws.medialive#UdpGroupSettings": { - "type": "structure", - "members": { - "InputLossAction": { - "target": "com.amazonaws.medialive#InputLossActionForUdpOut", + }, + "ComparisonOperator": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateComparisonOperator", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "inputLossAction" + "smithy.api#jsonName": "comparisonOperator" } }, - "TimedMetadataId3Frame": { - "target": "com.amazonaws.medialive#UdpTimedMetadataId3Frame", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", - "smithy.api#jsonName": "timedMetadataId3Frame" + "smithy.api#jsonName": "createdAt" } }, - "TimedMetadataId3Period": { - "target": "com.amazonaws.medialive#__integerMin0", + "DatapointsToAlarm": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Timed Metadata interval in seconds.", - "smithy.api#jsonName": "timedMetadataId3Period" + "smithy.api#documentation": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm.", + "smithy.api#jsonName": "datapointsToAlarm" } - } - }, - "traits": { - "smithy.api#documentation": "Udp Group Settings" - } - }, - "com.amazonaws.medialive#UdpOutputSettings": { - "type": "structure", - "members": { - "BufferMsec": { - "target": "com.amazonaws.medialive#__integerMin0Max10000", + }, + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "bufferMsec" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "ContainerSettings": { - "target": "com.amazonaws.medialive#UdpContainerSettings", + "EvaluationPeriods": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#jsonName": "containerSettings", - "smithy.api#required": {} + "smithy.api#documentation": "The number of periods over which data is compared to the specified threshold.", + "smithy.api#jsonName": "evaluationPeriods" } }, - "Destination": { - "target": "com.amazonaws.medialive#OutputLocationRef", + "GroupId": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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).", - "smithy.api#jsonName": "destination", - "smithy.api#required": {} + "smithy.api#documentation": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "groupId" } }, - "FecOutputSettings": { - "target": "com.amazonaws.medialive#FecOutputSettings", + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#documentation": "Settings for enabling and adjusting Forward Error Correction on UDP outputs.", - "smithy.api#jsonName": "fecOutputSettings" + "smithy.api#documentation": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`", + "smithy.api#jsonName": "id" } - } - }, - "traits": { - "smithy.api#documentation": "Udp Output Settings" - } - }, - "com.amazonaws.medialive#UdpTimedMetadataId3Frame": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", + }, + "MetricName": { + "target": "com.amazonaws.medialive#__stringMax64", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#documentation": "The name of the metric associated with the alarm. Must be compatible with targetResourceType.", + "smithy.api#jsonName": "metricName" } }, - "PRIV": { - "target": "smithy.api#Unit", + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#enumValue": "PRIV" + "smithy.api#jsonName": "modifiedAt" } }, - "TDRL": { - "target": "smithy.api#Unit", + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#enumValue": "TDRL" + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" } - } - }, - "traits": { - "smithy.api#documentation": "Udp Timed Metadata Id3 Frame" - } - }, - "com.amazonaws.medialive#UnprocessableEntityException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.medialive#__string", + }, + "Period": { + "target": "com.amazonaws.medialive#__integerMin10Max86400", "traits": { - "smithy.api#documentation": "The error message.", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "The period, in seconds, over which the specified statistic is applied.", + "smithy.api#jsonName": "period" } }, - "ValidationErrors": { - "target": "com.amazonaws.medialive#__listOfValidationError", + "Statistic": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateStatistic", "traits": { - "smithy.api#documentation": "A collection of validation error responses.", - "smithy.api#jsonName": "validationErrors" + "smithy.api#jsonName": "statistic" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" + } + }, + "TargetResourceType": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTargetResourceType", + "traits": { + "smithy.api#jsonName": "targetResourceType" + } + }, + "Threshold": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "The threshold value to compare with the specified statistic.", + "smithy.api#jsonName": "threshold" + } + }, + "TreatMissingData": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateTreatMissingData", + "traits": { + "smithy.api#jsonName": "treatMissingData" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for UnprocessableEntityException", - "smithy.api#error": "client", - "smithy.api#httpError": 422 + "smithy.api#documentation": "Placeholder documentation for UpdateCloudWatchAlarmTemplateResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#UpdateAccountConfiguration": { + "com.amazonaws.medialive#UpdateEventBridgeRuleTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#UpdateAccountConfigurationRequest" + "target": "com.amazonaws.medialive#UpdateEventBridgeRuleTemplateRequest" }, "output": { - "target": "com.amazonaws.medialive#UpdateAccountConfigurationResponse" + "target": "com.amazonaws.medialive#UpdateEventBridgeRuleTemplateResponse" }, "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, { "target": "com.amazonaws.medialive#BadRequestException" }, { - "target": "com.amazonaws.medialive#ForbiddenException" + "target": "com.amazonaws.medialive#ConflictException" }, { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "target": "com.amazonaws.medialive#ForbiddenException" }, { "target": "com.amazonaws.medialive#InternalServerErrorException" }, { - "target": "com.amazonaws.medialive#TooManyRequestsException" + "target": "com.amazonaws.medialive#NotFoundException" }, { - "target": "com.amazonaws.medialive#UnprocessableEntityException" + "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Update account configuration", + "smithy.api#documentation": "Updates the specified eventbridge rule template.", "smithy.api#http": { - "method": "PUT", - "uri": "/prod/accountConfiguration", + "method": "PATCH", + "uri": "/prod/eventbridge-rule-templates/{Identifier}", "code": 200 } } }, - "com.amazonaws.medialive#UpdateAccountConfigurationRequest": { - "type": "structure", - "members": { - "AccountConfiguration": { - "target": "com.amazonaws.medialive#AccountConfiguration", - "traits": { - "smithy.api#jsonName": "accountConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "List of account configuration parameters to update.", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#UpdateAccountConfigurationResponse": { - "type": "structure", - "members": { - "AccountConfiguration": { - "target": "com.amazonaws.medialive#AccountConfiguration", - "traits": { - "smithy.api#jsonName": "accountConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for UpdateAccountConfigurationResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#UpdateChannel": { + "com.amazonaws.medialive#UpdateEventBridgeRuleTemplateGroup": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#UpdateChannelRequest" + "target": "com.amazonaws.medialive#UpdateEventBridgeRuleTemplateGroupRequest" }, "output": { - "target": "com.amazonaws.medialive#UpdateChannelResponse" + "target": "com.amazonaws.medialive#UpdateEventBridgeRuleTemplateGroupResponse" }, "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, { "target": "com.amazonaws.medialive#BadRequestException" }, @@ -24663,209 +29471,224 @@ "target": "com.amazonaws.medialive#ForbiddenException" }, { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "target": "com.amazonaws.medialive#InternalServerErrorException" }, { - "target": "com.amazonaws.medialive#InternalServerErrorException" + "target": "com.amazonaws.medialive#NotFoundException" }, { - "target": "com.amazonaws.medialive#UnprocessableEntityException" + "target": "com.amazonaws.medialive#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Updates a channel.", + "smithy.api#documentation": "Updates the specified eventbridge rule template group.", "smithy.api#http": { - "method": "PUT", - "uri": "/prod/channels/{ChannelId}", + "method": "PATCH", + "uri": "/prod/eventbridge-rule-template-groups/{Identifier}", "code": 200 } } }, - "com.amazonaws.medialive#UpdateChannelClass": { - "type": "operation", - "input": { - "target": "com.amazonaws.medialive#UpdateChannelClassRequest" - }, - "output": { - "target": "com.amazonaws.medialive#UpdateChannelClassResponse" - }, - "errors": [ - { - "target": "com.amazonaws.medialive#BadGatewayException" - }, - { - "target": "com.amazonaws.medialive#BadRequestException" - }, - { - "target": "com.amazonaws.medialive#ConflictException" + "com.amazonaws.medialive#UpdateEventBridgeRuleTemplateGroupRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } }, - { - "target": "com.amazonaws.medialive#ForbiddenException" + "Identifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateGroupRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#UpdateEventBridgeRuleTemplateGroupResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveEventbridgeRuleTemplateGroup", + "traits": { + "smithy.api#documentation": "An eventbridge rule template group's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" + } }, - { - "target": "com.amazonaws.medialive#GatewayTimeoutException" + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "createdAt" + } }, - { - "target": "com.amazonaws.medialive#InternalServerErrorException" + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", + "traits": { + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" + } }, - { - "target": "com.amazonaws.medialive#NotFoundException" + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", + "traits": { + "smithy.api#documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "id" + } }, - { - "target": "com.amazonaws.medialive#TooManyRequestsException" + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", + "traits": { + "smithy.api#jsonName": "modifiedAt" + } }, - { - "target": "com.amazonaws.medialive#UnprocessableEntityException" + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", + "traits": { + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#TagMap", + "traits": { + "smithy.api#jsonName": "tags" + } } - ], + }, "traits": { - "smithy.api#documentation": "Changes the class of the channel.", - "smithy.api#http": { - "method": "PUT", - "uri": "/prod/channels/{ChannelId}/channelClass", - "code": 200 - } + "smithy.api#documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateGroupResponse", + "smithy.api#output": {} } }, - "com.amazonaws.medialive#UpdateChannelClassRequest": { + "com.amazonaws.medialive#UpdateEventBridgeRuleTemplateRequest": { "type": "structure", "members": { - "ChannelClass": { - "target": "com.amazonaws.medialive#ChannelClass", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The channel class that you wish to update this channel to use.", - "smithy.api#jsonName": "channelClass", - "smithy.api#required": {} + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "ChannelId": { + "EventTargets": { + "target": "com.amazonaws.medialive#__listOfEventBridgeRuleTemplateTarget", + "traits": { + "smithy.api#jsonName": "eventTargets" + } + }, + "EventType": { + "target": "com.amazonaws.medialive#EventBridgeRuleTemplateEventType", + "traits": { + "smithy.api#jsonName": "eventType" + } + }, + "GroupIdentifier": { + "target": "com.amazonaws.medialive#__stringPatternS", + "traits": { + "smithy.api#documentation": "An eventbridge rule template group's identifier. Can be either be its id or current name.", + "smithy.api#jsonName": "groupIdentifier" + } + }, + "Identifier": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Channel Id of the channel whose class should be updated.", + "smithy.api#documentation": "An eventbridge rule template's identifier. Can be either be its id or current name.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfOutputDestination", + "Name": { + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#documentation": "A list of output destinations for this channel.", - "smithy.api#jsonName": "destinations" + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "smithy.api#jsonName": "name" } } }, "traits": { - "smithy.api#documentation": "Channel class that the channel should be updated to.", + "smithy.api#documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateRequest", "smithy.api#input": {} } }, - "com.amazonaws.medialive#UpdateChannelClassResponse": { - "type": "structure", - "members": { - "Channel": { - "target": "com.amazonaws.medialive#Channel", - "traits": { - "smithy.api#jsonName": "channel" - } - } - }, - "traits": { - "smithy.api#documentation": "Placeholder documentation for UpdateChannelClassResponse", - "smithy.api#output": {} - } - }, - "com.amazonaws.medialive#UpdateChannelRequest": { + "com.amazonaws.medialive#UpdateEventBridgeRuleTemplateResponse": { "type": "structure", "members": { - "CdiInputSpecification": { - "target": "com.amazonaws.medialive#CdiInputSpecification", + "Arn": { + "target": "com.amazonaws.medialive#__stringPatternArnMedialiveEventbridgeRuleTemplate", "traits": { - "smithy.api#documentation": "Specification of CDI inputs for this channel", - "smithy.api#jsonName": "cdiInputSpecification" + "smithy.api#documentation": "An eventbridge rule template's ARN (Amazon Resource Name)", + "smithy.api#jsonName": "arn" } }, - "ChannelId": { - "target": "com.amazonaws.medialive#__string", + "CreatedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "channel ID", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#jsonName": "createdAt" } }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfOutputDestination", + "Description": { + "target": "com.amazonaws.medialive#__stringMin0Max1024", "traits": { - "smithy.api#documentation": "A list of output destinations for this channel.", - "smithy.api#jsonName": "destinations" + "smithy.api#documentation": "A resource's optional description.", + "smithy.api#jsonName": "description" } }, - "EncoderSettings": { - "target": "com.amazonaws.medialive#EncoderSettings", + "EventTargets": { + "target": "com.amazonaws.medialive#__listOfEventBridgeRuleTemplateTarget", "traits": { - "smithy.api#documentation": "The encoder settings for this channel.", - "smithy.api#jsonName": "encoderSettings" + "smithy.api#jsonName": "eventTargets" } }, - "InputAttachments": { - "target": "com.amazonaws.medialive#__listOfInputAttachment", + "EventType": { + "target": "com.amazonaws.medialive#EventBridgeRuleTemplateEventType", "traits": { - "smithy.api#jsonName": "inputAttachments" + "smithy.api#jsonName": "eventType" } }, - "InputSpecification": { - "target": "com.amazonaws.medialive#InputSpecification", + "GroupId": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#documentation": "Specification of network and file inputs for this channel", - "smithy.api#jsonName": "inputSpecification" + "smithy.api#documentation": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`", + "smithy.api#jsonName": "groupId" } }, - "LogLevel": { - "target": "com.amazonaws.medialive#LogLevel", + "Id": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097", "traits": { - "smithy.api#documentation": "The log level to write to CloudWatch Logs.", - "smithy.api#jsonName": "logLevel" + "smithy.api#documentation": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`", + "smithy.api#jsonName": "id" } }, - "Maintenance": { - "target": "com.amazonaws.medialive#MaintenanceUpdateSettings", + "ModifiedAt": { + "target": "com.amazonaws.medialive#__timestampIso8601", "traits": { - "smithy.api#documentation": "Maintenance settings for this channel.", - "smithy.api#jsonName": "maintenance" + "smithy.api#jsonName": "modifiedAt" } }, "Name": { - "target": "com.amazonaws.medialive#__string", + "target": "com.amazonaws.medialive#__stringMin1Max255PatternS", "traits": { - "smithy.api#documentation": "The name of the channel.", + "smithy.api#documentation": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", "smithy.api#jsonName": "name" } }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#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.", - "smithy.api#jsonName": "roleArn" - } - } - }, - "traits": { - "smithy.api#documentation": "A request to update a channel.", - "smithy.api#input": {} - } - }, - "com.amazonaws.medialive#UpdateChannelResponse": { - "type": "structure", - "members": { - "Channel": { - "target": "com.amazonaws.medialive#Channel", + "Tags": { + "target": "com.amazonaws.medialive#TagMap", "traits": { - "smithy.api#jsonName": "channel" + "smithy.api#jsonName": "tags" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for UpdateChannelResponse", + "smithy.api#documentation": "Placeholder documentation for UpdateEventBridgeRuleTemplateResponse", "smithy.api#output": {} } }, @@ -26057,6 +30880,12 @@ "smithy.api#documentation": "Webvtt Destination Style Control" } }, + "com.amazonaws.medialive#__boolean": { + "type": "boolean", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __boolean" + } + }, "com.amazonaws.medialive#__double": { "type": "double", "traits": { @@ -26111,6 +30940,15 @@ "smithy.api#documentation": "Placeholder documentation for __integer" } }, + "com.amazonaws.medialive#__integerMax5": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __integerMax5", + "smithy.api#range": { + "max": 5 + } + } + }, "com.amazonaws.medialive#__integerMin0": { "type": "integer", "traits": { @@ -26387,6 +31225,16 @@ } } }, + "com.amazonaws.medialive#__integerMin10Max86400": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __integerMin10Max86400", + "smithy.api#range": { + "min": 10, + "max": 86400 + } + } + }, "com.amazonaws.medialive#__integerMin1Max10": { "type": "integer", "traits": { @@ -26753,6 +31601,24 @@ "smithy.api#documentation": "Placeholder documentation for __listOfChannelSummary" } }, + "com.amazonaws.medialive#__listOfCloudWatchAlarmTemplateGroupSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateGroupSummary" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfCloudWatchAlarmTemplateGroupSummary" + } + }, + "com.amazonaws.medialive#__listOfCloudWatchAlarmTemplateSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#CloudWatchAlarmTemplateSummary" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfCloudWatchAlarmTemplateSummary" + } + }, "com.amazonaws.medialive#__listOfColorCorrection": { "type": "list", "member": { @@ -26780,6 +31646,33 @@ "smithy.api#documentation": "Placeholder documentation for __listOfDashRoleCaption" } }, + "com.amazonaws.medialive#__listOfEventBridgeRuleTemplateGroupSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#EventBridgeRuleTemplateGroupSummary" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfEventBridgeRuleTemplateGroupSummary" + } + }, + "com.amazonaws.medialive#__listOfEventBridgeRuleTemplateSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#EventBridgeRuleTemplateSummary" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfEventBridgeRuleTemplateSummary" + } + }, + "com.amazonaws.medialive#__listOfEventBridgeRuleTemplateTarget": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#EventBridgeRuleTemplateTarget" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfEventBridgeRuleTemplateTarget" + } + }, "com.amazonaws.medialive#__listOfFailoverCondition": { "type": "list", "member": { @@ -26960,6 +31853,15 @@ "smithy.api#documentation": "Placeholder documentation for __listOfMediaPackageOutputDestinationSettings" } }, + "com.amazonaws.medialive#__listOfMediaResourceNeighbor": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#MediaResourceNeighbor" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfMediaResourceNeighbor" + } + }, "com.amazonaws.medialive#__listOfMultiplexOutputDestination": { "type": "list", "member": { @@ -27095,6 +31997,15 @@ "smithy.api#documentation": "Placeholder documentation for __listOfScte35Descriptor" } }, + "com.amazonaws.medialive#__listOfSignalMapSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#SignalMapSummary" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfSignalMapSummary" + } + }, "com.amazonaws.medialive#__listOfThumbnail": { "type": "list", "member": { @@ -27158,6 +32069,24 @@ "smithy.api#documentation": "Placeholder documentation for __listOf__string" } }, + "com.amazonaws.medialive#__listOf__stringMin7Max11PatternAws097": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#__stringMin7Max11PatternAws097" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOf__stringMin7Max11PatternAws097" + } + }, + "com.amazonaws.medialive#__listOf__stringPatternS": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#__stringPatternS" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOf__stringPatternS" + } + }, "com.amazonaws.medialive#__long": { "type": "long", "traits": { @@ -27260,6 +32189,26 @@ } } }, + "com.amazonaws.medialive#__stringMax64": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringMax64", + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.medialive#__stringMin0Max1024": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringMin0Max1024", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.medialive#__stringMin1": { "type": "string", "traits": { @@ -27269,6 +32218,27 @@ } } }, + "com.amazonaws.medialive#__stringMin1Max2048": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringMin1Max2048", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.medialive#__stringMin1Max2048PatternArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringMin1Max2048PatternArn", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn.+$" + } + }, "com.amazonaws.medialive#__stringMin1Max255": { "type": "string", "traits": { @@ -27279,6 +32249,17 @@ } } }, + "com.amazonaws.medialive#__stringMin1Max255PatternS": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringMin1Max255PatternS", + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[^\\s]+$" + } + }, "com.amazonaws.medialive#__stringMin1Max256": { "type": "string", "traits": { @@ -27359,6 +32340,17 @@ } } }, + "com.amazonaws.medialive#__stringMin7Max11PatternAws097": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringMin7Max11PatternAws097", + "smithy.api#length": { + "min": 7, + "max": 11 + }, + "smithy.api#pattern": "^(aws-)?[0-9]{7}$" + } + }, "com.amazonaws.medialive#__stringPattern010920300": { "type": "string", "traits": { @@ -27366,6 +32358,48 @@ "smithy.api#pattern": "^([0,1]?[0-9]|2[0-3]):00$" } }, + "com.amazonaws.medialive#__stringPatternArnMedialiveCloudwatchAlarmTemplate": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringPatternArnMedialiveCloudwatchAlarmTemplate", + "smithy.api#pattern": "^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$" + } + }, + "com.amazonaws.medialive#__stringPatternArnMedialiveCloudwatchAlarmTemplateGroup": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringPatternArnMedialiveCloudwatchAlarmTemplateGroup", + "smithy.api#pattern": "^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$" + } + }, + "com.amazonaws.medialive#__stringPatternArnMedialiveEventbridgeRuleTemplate": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringPatternArnMedialiveEventbridgeRuleTemplate", + "smithy.api#pattern": "^arn:.+:medialive:.+:eventbridge-rule-template:.+$" + } + }, + "com.amazonaws.medialive#__stringPatternArnMedialiveEventbridgeRuleTemplateGroup": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringPatternArnMedialiveEventbridgeRuleTemplateGroup", + "smithy.api#pattern": "^arn:.+:medialive:.+:eventbridge-rule-template-group:.+$" + } + }, + "com.amazonaws.medialive#__stringPatternArnMedialiveSignalMap": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringPatternArnMedialiveSignalMap", + "smithy.api#pattern": "^arn:.+:medialive:.+:signal-map:.+$" + } + }, + "com.amazonaws.medialive#__stringPatternS": { + "type": "string", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __stringPatternS", + "smithy.api#pattern": "^[^\\s]+$" + } + }, "com.amazonaws.medialive#__timestamp": { "type": "timestamp", "traits": { diff --git a/codegen/sdk-codegen/aws-models/mediapackagev2.2022-12-25.json b/codegen/sdk-codegen/aws-models/mediapackagev2.2022-12-25.json index 41742ebb22a..96dbab3844e 100644 --- a/codegen/sdk-codegen/aws-models/mediapackagev2.2022-12-25.json +++ b/codegen/sdk-codegen/aws-models/mediapackagev2.2022-12-25.json @@ -14,6 +14,23 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.mediapackagev2#AdMarkerDash": { + "type": "enum", + "members": { + "BINARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BINARY" + } + }, + "XML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XML" + } + } + } + }, "com.amazonaws.mediapackagev2#AdMarkerHls": { "type": "enum", "members": { @@ -691,6 +708,99 @@ "smithy.api#output": {} } }, + "com.amazonaws.mediapackagev2#CreateDashManifestConfiguration": { + "type": "structure", + "members": { + "ManifestName": { + "target": "com.amazonaws.mediapackagev2#ManifestName", + "traits": { + "smithy.api#documentation": "A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.
", + "smithy.api#required": {} + } + }, + "ManifestWindowSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total duration (in seconds) of the manifest's content.
", + "smithy.api#range": { + "min": 30 + } + } + }, + "FilterConfiguration": { + "target": "com.amazonaws.mediapackagev2#FilterConfiguration" + }, + "MinUpdatePeriodSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
", + "smithy.api#range": { + "min": 1, + "max": 3600 + } + } + }, + "MinBufferTimeSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Minimum amount of content (in seconds) that a player must keep available in the buffer.
", + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "SuggestedPresentationDelaySeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The amount of time (in seconds) that the player should be from the end of the manifest.
", + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "SegmentTemplateFormat": { + "target": "com.amazonaws.mediapackagev2#DashSegmentTemplateFormat", + "traits": { + "smithy.api#documentation": "Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.
Value description:
\n\n NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
The SCTE configuration.
" + } + }, + "DrmSignaling": { + "target": "com.amazonaws.mediapackagev2#DashDrmSignaling", + "traits": { + "smithy.api#documentation": "Determines how the DASH manifest signals the DRM content.
" + } + }, + "UtcTiming": { + "target": "com.amazonaws.mediapackagev2#DashUtcTiming", + "traits": { + "smithy.api#documentation": "Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Create a DASH manifest configuration.
" + } + }, + "com.amazonaws.mediapackagev2#CreateDashManifests": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#CreateDashManifestConfiguration" + } + }, "com.amazonaws.mediapackagev2#CreateHlsManifestConfiguration": { "type": "structure", "members": { @@ -1019,7 +1129,7 @@ "ChannelGroupName": "exampleChannelGroup", "ChannelName": "exampleChannel", "OriginEndpointName": "exampleOriginEndpointCMAF", - "ContainerType": "TS", + "ContainerType": "CMAF", "StartoverWindowSeconds": 300, "Segment": { "SegmentDurationSeconds": 6, @@ -1092,6 +1202,41 @@ "ProgramDateTimeIntervalSeconds": 60 } ], + "DashManifests": [ + { + "ManifestName": "exampleDashManifest1", + "ManifestWindowSeconds": 300, + "MinUpdatePeriodSeconds": 5, + "MinBufferTimeSeconds": 30, + "SuggestedPresentationDelaySeconds": 2, + "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", + "PeriodTriggers": [ + "AVAILS" + ], + "ScteDash": { + "AdMarkerDash": "XML" + }, + "DrmSignaling": "INDIVIDUAL" + }, + { + "ManifestName": "exampleDashManifest2", + "ManifestWindowSeconds": 60, + "MinUpdatePeriodSeconds": 3, + "MinBufferTimeSeconds": 9, + "SuggestedPresentationDelaySeconds": 12, + "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", + "PeriodTriggers": [ + "AVAILS", + "DRM_KEY_ROTATION", + "SOURCE_CHANGES", + "SOURCE_DISRUPTIONS" + ], + "ScteDash": { + "AdMarkerDash": "XML" + }, + "DrmSignaling": "INDIVIDUAL" + } + ], "Tags": { "key1": "value1", "key2": "value2" @@ -1104,7 +1249,7 @@ "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointCMAF", "CreatedAt": "2022-10-18T09:36:00.00Z", "ModifiedAt": "2022-10-18T09:36:00.00Z", - "ContainerType": "TS", + "ContainerType": "CMAF", "StartoverWindowSeconds": 300, "Segment": { "SegmentDurationSeconds": 6, @@ -1181,6 +1326,43 @@ "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleLLManifest2.m3u8" } ], + "DashManifests": [ + { + "ManifestName": "exampleDashManifest1", + "ManifestWindowSeconds": 300, + "MinUpdatePeriodSeconds": 5, + "MinBufferTimeSeconds": 30, + "SuggestedPresentationDelaySeconds": 2, + "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", + "PeriodTriggers": [ + "AVAILS" + ], + "ScteDash": { + "AdMarkerDash": "XML" + }, + "DrmSignaling": "INDIVIDUAL", + "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest1.mpd" + }, + { + "ManifestName": "exampleDashManifest2", + "ManifestWindowSeconds": 60, + "MinUpdatePeriodSeconds": 3, + "MinBufferTimeSeconds": 9, + "SuggestedPresentationDelaySeconds": 12, + "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", + "PeriodTriggers": [ + "AVAILS", + "DRM_KEY_ROTATION", + "SOURCE_CHANGES", + "SOURCE_DISRUPTIONS" + ], + "ScteDash": { + "AdMarkerDash": "XML" + }, + "DrmSignaling": "INDIVIDUAL", + "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest2.mpd" + } + ], "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", "Tags": { "key1": "value1", @@ -1273,6 +1455,13 @@ "smithy.api#documentation": "A low-latency HLS manifest configuration.
" } }, + "DashManifests": { + "target": "com.amazonaws.mediapackagev2#CreateDashManifests", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "A DASH manifest configuration.
" + } + }, "Tags": { "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { @@ -1368,6 +1557,12 @@ "smithy.api#documentation": "A low-latency HLS manifest configuration.
" } }, + "DashManifests": { + "target": "com.amazonaws.mediapackagev2#GetDashManifests", + "traits": { + "smithy.api#documentation": "A DASH manifest configuration.
" + } + }, "ETag": { "target": "com.amazonaws.mediapackagev2#EntityTag", "traits": { @@ -1387,6 +1582,134 @@ "smithy.api#output": {} } }, + "com.amazonaws.mediapackagev2#DashDrmSignaling": { + "type": "enum", + "members": { + "INDIVIDUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDIVIDUAL" + } + }, + "REFERENCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REFERENCED" + } + } + } + }, + "com.amazonaws.mediapackagev2#DashPeriodTrigger": { + "type": "enum", + "members": { + "AVAILS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILS" + } + }, + "DRM_KEY_ROTATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRM_KEY_ROTATION" + } + }, + "SOURCE_CHANGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_CHANGES" + } + }, + "SOURCE_DISRUPTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_DISRUPTIONS" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.mediapackagev2#DashPeriodTriggers": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#DashPeriodTrigger" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.mediapackagev2#DashSegmentTemplateFormat": { + "type": "enum", + "members": { + "NUMBER_WITH_TIMELINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER_WITH_TIMELINE" + } + } + } + }, + "com.amazonaws.mediapackagev2#DashUtcTiming": { + "type": "structure", + "members": { + "TimingMode": { + "target": "com.amazonaws.mediapackagev2#DashUtcTimingMode", + "traits": { + "smithy.api#documentation": "The UTC timing mode.
" + } + }, + "TimingSource": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.
", + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
" + } + }, + "com.amazonaws.mediapackagev2#DashUtcTimingMode": { + "type": "enum", + "members": { + "HTTP_HEAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_HEAD" + } + }, + "HTTP_ISO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_ISO" + } + }, + "HTTP_XSDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_XSDATE" + } + }, + "UTC_DIRECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UTC_DIRECT" + } + } + } + }, "com.amazonaws.mediapackagev2#DeleteChannel": { "type": "operation", "input": { @@ -2343,6 +2666,91 @@ "smithy.api#output": {} } }, + "com.amazonaws.mediapackagev2#GetDashManifestConfiguration": { + "type": "structure", + "members": { + "ManifestName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.
", + "smithy.api#required": {} + } + }, + "Url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The egress domain URL for stream delivery from MediaPackage.
", + "smithy.api#required": {} + } + }, + "ManifestWindowSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total duration (in seconds) of the manifest's content.
" + } + }, + "FilterConfiguration": { + "target": "com.amazonaws.mediapackagev2#FilterConfiguration" + }, + "MinUpdatePeriodSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
" + } + }, + "MinBufferTimeSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Minimum amount of content (in seconds) that a player must keep available in the buffer.
" + } + }, + "SuggestedPresentationDelaySeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The amount of time (in seconds) that the player should be from the end of the manifest.
" + } + }, + "SegmentTemplateFormat": { + "target": "com.amazonaws.mediapackagev2#DashSegmentTemplateFormat", + "traits": { + "smithy.api#documentation": "Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.
Value description:
\n\n NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
" + } + }, + "ScteDash": { + "target": "com.amazonaws.mediapackagev2#ScteDash", + "traits": { + "smithy.api#documentation": "The SCTE configuration.
" + } + }, + "DrmSignaling": { + "target": "com.amazonaws.mediapackagev2#DashDrmSignaling", + "traits": { + "smithy.api#documentation": "Determines how the DASH manifest signals the DRM content.
" + } + }, + "UtcTiming": { + "target": "com.amazonaws.mediapackagev2#DashUtcTiming", + "traits": { + "smithy.api#documentation": "Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Retrieve the DASH manifest configuration.
" + } + }, + "com.amazonaws.mediapackagev2#GetDashManifests": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#GetDashManifestConfiguration" + } + }, "com.amazonaws.mediapackagev2#GetHlsManifestConfiguration": { "type": "structure", "members": { @@ -2830,6 +3238,12 @@ "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The comma-separated list of tag key:value pairs assigned to the origin endpoint.
" } + }, + "DashManifests": { + "target": "com.amazonaws.mediapackagev2#GetDashManifests", + "traits": { + "smithy.api#documentation": "A DASH manifest configuration.
" + } } }, "traits": { @@ -3113,6 +3527,33 @@ "smithy.api#output": {} } }, + "com.amazonaws.mediapackagev2#ListDashManifestConfiguration": { + "type": "structure", + "members": { + "ManifestName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.
", + "smithy.api#required": {} + } + }, + "Url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The egress domain URL for stream delivery from MediaPackage.
" + } + } + }, + "traits": { + "smithy.api#documentation": "List the DASH manifest configuration.
" + } + }, + "com.amazonaws.mediapackagev2#ListDashManifests": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#ListDashManifestConfiguration" + } + }, "com.amazonaws.mediapackagev2#ListHlsManifestConfiguration": { "type": "structure", "members": { @@ -3257,7 +3698,7 @@ "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointCMAF", "CreatedAt": "2022-10-18T09:36:00.00Z", "ModifiedAt": "2022-10-18T09:36:00.00Z", - "ContainerType": "TS", + "ContainerType": "CMAF", "HlsManifests": [ { "ManifestName": "exampleManifest1", @@ -3281,6 +3722,16 @@ "ChildManifestName": "exampleLLManifest2", "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleLLManifest2.m3u8" } + ], + "DashManifests": [ + { + "ManifestName": "exampleDashManifest1", + "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest1.mpd" + }, + { + "ManifestName": "exampleDashManifest2", + "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest2.mpd" + } ] } ] @@ -3515,6 +3966,12 @@ "traits": { "smithy.api#documentation": "A low-latency HLS manifest configuration.
" } + }, + "DashManifests": { + "target": "com.amazonaws.mediapackagev2#ListDashManifests", + "traits": { + "smithy.api#documentation": "A DASH manifest configuration.
" + } } }, "traits": { @@ -3972,6 +4429,20 @@ "smithy.api#documentation": "The SCTE configuration.
" } }, + "com.amazonaws.mediapackagev2#ScteDash": { + "type": "structure", + "members": { + "AdMarkerDash": { + "target": "com.amazonaws.mediapackagev2#AdMarkerDash", + "traits": { + "smithy.api#documentation": "Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.
\nValue description:
\n\n Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.
\n XML - The SCTE marker is expressed fully in XML.
The SCTE configuration.
" + } + }, "com.amazonaws.mediapackagev2#ScteFilter": { "type": "enum", "members": { @@ -4987,6 +5458,13 @@ "smithy.api#documentation": "A low-latency HLS manifest configuration.
" } }, + "DashManifests": { + "target": "com.amazonaws.mediapackagev2#CreateDashManifests", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "A DASH manifest configuration.
" + } + }, "ETag": { "target": "com.amazonaws.mediapackagev2#EntityTag", "traits": { @@ -5097,6 +5575,12 @@ "smithy.api#documentation": "The comma-separated list of tag key:value pairs assigned to the origin endpoint.
", "smithy.api#jsonName": "tags" } + }, + "DashManifests": { + "target": "com.amazonaws.mediapackagev2#GetDashManifests", + "traits": { + "smithy.api#documentation": "A DASH manifest configuration.
" + } } }, "traits": { @@ -5202,6 +5686,12 @@ "smithy.api#enumValue": "NUM_MANIFESTS_HIGH" } }, + "MANIFEST_DRM_SYSTEMS_INCOMPATIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANIFEST_DRM_SYSTEMS_INCOMPATIBLE" + } + }, "DRM_SYSTEMS_ENCRYPTION_METHOD_INCOMPATIBLE": { "target": "smithy.api#Unit", "traits": { @@ -5345,6 +5835,48 @@ "traits": { "smithy.api#enumValue": "END_TIME_EARLIER_THAN_START_TIME" } + }, + "TS_CONTAINER_TYPE_WITH_DASH_MANIFEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TS_CONTAINER_TYPE_WITH_DASH_MANIFEST" + } + }, + "DIRECT_MODE_WITH_TIMING_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_MODE_WITH_TIMING_SOURCE" + } + }, + "NONE_MODE_WITH_TIMING_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE_MODE_WITH_TIMING_SOURCE" + } + }, + "TIMING_SOURCE_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMING_SOURCE_MISSING" + } + }, + "UPDATE_PERIOD_SMALLER_THAN_SEGMENT_DURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_PERIOD_SMALLER_THAN_SEGMENT_DURATION" + } + }, + "PERIOD_TRIGGERS_NONE_SPECIFIED_WITH_ADDITIONAL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERIOD_TRIGGERS_NONE_SPECIFIED_WITH_ADDITIONAL_VALUES" + } + }, + "DRM_SIGNALING_MISMATCH_SEGMENT_ENCRYPTION_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRM_SIGNALING_MISMATCH_SEGMENT_ENCRYPTION_STATUS" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json b/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json index 3d47857a4c8..bc6b33db5de 100644 --- a/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json +++ b/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json @@ -2633,6 +2633,13 @@ "smithy.api#documentation": "The configuration for HLS content.
" } }, + "InsertionMode": { + "target": "com.amazonaws.mediatailor#InsertionMode", + "traits": { + "smithy.api#default": "STITCHED_ONLY", + "smithy.api#documentation": "The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.
The VOD source's HTTP package configuration settings.
" } }, + "com.amazonaws.mediatailor#InsertionMode": { + "type": "enum", + "members": { + "STITCHED_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STITCHED_ONLY" + } + }, + "PLAYER_SELECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAYER_SELECT" + } + } + }, + "traits": { + "smithy.api#documentation": "Insertion Mode controls whether players can use stitched or guided ad insertion.
" + } + }, "com.amazonaws.mediatailor#KeyValuePair": { "type": "structure", "members": { @@ -4488,6 +4515,13 @@ "smithy.api#documentation": "The configuration for HLS content.
" } }, + "InsertionMode": { + "target": "com.amazonaws.mediatailor#InsertionMode", + "traits": { + "smithy.api#default": "STITCHED_ONLY", + "smithy.api#documentation": "The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.
The configuration for DASH content.
" } }, + "InsertionMode": { + "target": "com.amazonaws.mediatailor#InsertionMode", + "traits": { + "smithy.api#default": "STITCHED_ONLY", + "smithy.api#documentation": "The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.
The configuration for HLS content.
" } }, + "InsertionMode": { + "target": "com.amazonaws.mediatailor#InsertionMode", + "traits": { + "smithy.api#default": "STITCHED_ONLY", + "smithy.api#documentation": "The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.
The number of replicas in other AZs. Min =0, Max = 2, Default = 1.
" + "smithy.api#documentation": "The number of replicas in other AZs. Min =0, Max = 2, Default = 1.
\n\n Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.\n
\nThe number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.
" + "smithy.api#documentation": "The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.
\n\n Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.\n
\nThe number of replicas in other AZs. Min =0, Max = 2, Default =1
" + "smithy.api#documentation": "The number of replicas in other AZs. Min =0, Max = 2, Default =1
\n\n Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.\n
\nCreates a monitor between a source subnet and destination IP address. Within a monitor you'll create one or more probes that monitor network traffic between your source Amazon Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and sends metrics to Amazon CloudWatch.
", + "smithy.api#documentation": "Creates a monitor between a source subnet and destination IP address. Within a monitor you'll create one or more probes that monitor network traffic between your source Amazon Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and sends metrics to Amazon CloudWatch.
\nYou can also create a monitor with probes using this command. For each probe, you\n define the following:
\n\n source—The subnet IDs where the probes will be created.
\n destination— The target destination IP address for the\n probe.
\n destinationPort—Required only if the protocol is\n TCP.
\n protocol—The communication protocol between the source and\n destination. This will be either TCP or ICMP.
\n packetSize—The size of the packets. This must be a number between\n 56 and 8500.
(Optional) tags —Key-value pairs created and assigned to the\n probe.
The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60.
The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid\n values are either 30 or 60. 60 is the default if\n no period is chosen.
The number of seconds that metrics are aggregated by and sent to Amazon CloudWatch. This must be either 30 or 60.
The number of seconds that metrics are aggregated by and sent to Amazon CloudWatch.\n This will be either 30 or 60.
Create a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you'll incur billing charges for that probe.
", + "smithy.api#documentation": "Create a probe within a monitor. Once you create a probe, and it begins monitoring your\n network traffic, you'll incur billing charges for that probe. This action requires the\n monitorName parameter. Run ListMonitors to get a list of\n monitor names. Note the name of the monitorName you want to create the\n probe for.
The name of the monitor to associated with the probe. To get a list of available monitors, use ListMonitors.
The name of the monitor to associated with the probe.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -430,7 +430,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to delete a monitor" }, - "smithy.api#documentation": "Deletes a specified monitor.
", + "smithy.api#documentation": "Deletes a specified monitor.
\nThis action requires the monitorName parameter. Run\n ListMonitors to get a list of monitor names.
The name of the monitor to delete. Use the ListMonitors action to get a list of your current monitors.
The name of the monitor to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -493,7 +493,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to delete a probe" }, - "smithy.api#documentation": "Deletes the specified monitor. Once a probe is deleted you'll no longer incur any billing fees for that probe.
", + "smithy.api#documentation": "Deletes the specified probe. Once a probe is deleted you'll no longer incur any billing\n fees for that probe.
\nThis action requires both the monitorName and probeId\n parameters. Run ListMonitors to get a list of monitor names. Run\n GetMonitor to get a list of probes and probe IDs. You can only delete a\n single probe at a time using this action.
The name of the monitor to delete. For a list of the available monitors, use the ListMonitors action.
The name of the monitor to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -515,7 +515,7 @@ "probeId": { "target": "com.amazonaws.networkmonitor#ProbeId", "traits": { - "smithy.api#documentation": "The ID of the probe to delete. Run GetMonitor to get a lst of all probes and probe IDs associated with the monitor.
The ID of the probe to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -570,7 +570,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to get information about a monitor" }, - "smithy.api#documentation": "Returns details about a specific monitor.
", + "smithy.api#documentation": "Returns details about a specific monitor.
\nThis action requires the monitorName parameter. Run\n ListMonitors to get a list of monitor names.
The name of the monitor. To get a list of the current monitors and their names, use the ListMonitors action.
The name of the monitor.
", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.networkmonitor#MonitorState", "traits": { - "smithy.api#documentation": "Returns a list of the state of each monitor.
", + "smithy.api#documentation": "Lists the status of the state of each monitor.
Returns the details about a probe. You'll need both the monitorName and probeId.
Returns the details about a probe. This action requires both the\n monitorName and probeId parameters. Run\n ListMonitors to get a list of monitor names. Run\n GetMonitor to get a list of probes and probe IDs.
Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring\n service that identifies if a network issues exists within the Amazon Web Services network\n or your own company network. Within Network Monitor you'll choose the source VPCs and\n subnets from the Amazon Web Services network in which you operate and then you'll choose\n the destination IP addresses from your on-premises network. From these sources and\n destinations, Network Monitor creates a monitor containing all the possible source and\n destination combinations, each of which is called a probe, within a single monitor.\n These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.
\nFor more information, see Using Amazon CloudWatch Network Monitor in the Amazon CloudWatch User Guide.
", + "smithy.api#documentation": "Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring\n service that identifies if a network issues exists within the Amazon Web Services network\n or your own company network. Within Network Monitor you'll choose the source VPCs and\n subnets from the Amazon Web Services network in which you operate and then you'll choose\n the destination IP addresses from your on-premises network. From these sources and\n destinations, Network Monitor creates a monitor containing all the possible source and\n destination combinations, each of which is called a probe, within a single monitor.\n These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.
\nBefore you begin, ensure the Amazon Web Services CLI is configured in the Amazon Web Services Account where you will create the Network Monitor resource. Network\n Monitor doesn’t support creation on cross-account resources, but you can create a\n Network Monitor in any subnet belonging to a VPC owned by your Account.
\nFor more information, see Using Amazon CloudWatch Network Monitor in the Amazon CloudWatch User Guide.
", "smithy.api#title": "Amazon CloudWatch Network Monitor", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1978,7 +1978,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes information about a monitor probe.
" + "smithy.api#documentation": "Describes information about a network monitor probe.
" } }, "com.amazonaws.networkmonitor#ProbeId": { @@ -2435,7 +2435,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to update a monitor" }, - "smithy.api#documentation": "Updates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds.
Updates the aggregationPeriod for a monitor. Monitors support an\n aggregationPeriod of either 30 or 60 seconds.\n This action requires the monitorName and probeId parameter.\n Run ListMonitors to get a list of monitor names.
The name of the monitor to update. Run ListMonitors to get a list of monitor names.
The name of the monitor to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2539,7 +2539,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to update a probe" }, - "smithy.api#documentation": "Updates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.
Updates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.
You can update the following para create a monitor with probes using this command. For\n each probe, you define the following:
\n\n state—The state of the probe.
\n destination— The target destination IP address for the\n probe.
\n destinationPort—Required only if the protocol is\n TCP.
\n protocol—The communication protocol between the source and\n destination. This will be either TCP or ICMP.
\n packetSize—The size of the packets. This must be a number between\n 56 and 8500.
(Optional) tags —Key-value pairs created and assigned to the\n probe.
Run GetMonitor to get a list of probes and probe IDs.
The ID of the probe to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } diff --git a/codegen/sdk-codegen/aws-models/omics.2022-11-28.json b/codegen/sdk-codegen/aws-models/omics.2022-11-28.json index 6db63d936bd..7214d5b5fa0 100644 --- a/codegen/sdk-codegen/aws-models/omics.2022-11-28.json +++ b/codegen/sdk-codegen/aws-models/omics.2022-11-28.json @@ -37,7 +37,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to abort multipart read set uploads", - "smithy.api#documentation": "\n Stops a multipart upload.\n
", + "smithy.api#documentation": "Stops a multipart upload.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -53,7 +53,7 @@ "sequenceStoreId": { "target": "com.amazonaws.omics#SequenceStoreId", "traits": { - "smithy.api#documentation": "\n The sequence store ID for the store involved in the multipart upload.\n
", + "smithy.api#documentation": "The sequence store ID for the store involved in the multipart upload.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -61,7 +61,7 @@ "uploadId": { "target": "com.amazonaws.omics#UploadId", "traits": { - "smithy.api#documentation": "\n The ID for the multipart upload. \n
", + "smithy.api#documentation": "The ID for the multipart upload.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1109,7 +1109,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to complete a multipart read set upload", - "smithy.api#documentation": "\n Concludes a multipart upload once you have uploaded all the components.\n
", + "smithy.api#documentation": "Concludes a multipart upload once you have uploaded all the components.
", "smithy.api#endpoint": { "hostPrefix": "storage-" }, @@ -1125,7 +1125,7 @@ "sequenceStoreId": { "target": "com.amazonaws.omics#SequenceStoreId", "traits": { - "smithy.api#documentation": "\n The sequence store ID for the store involved in the multipart upload.\n
", + "smithy.api#documentation": "The sequence store ID for the store involved in the multipart upload.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1133,7 +1133,7 @@ "uploadId": { "target": "com.amazonaws.omics#UploadId", "traits": { - "smithy.api#documentation": "\n The ID for the multipart upload. \n
", + "smithy.api#documentation": "The ID for the multipart upload.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1141,7 +1141,7 @@ "parts": { "target": "com.amazonaws.omics#CompleteReadSetUploadPartList", "traits": { - "smithy.api#documentation": "\n The individual uploads or parts of a multipart upload.\n
", + "smithy.api#documentation": "The individual uploads or parts of a multipart upload.
", "smithy.api#required": {} } } @@ -1156,7 +1156,7 @@ "readSetId": { "target": "com.amazonaws.omics#ReadSetId", "traits": { - "smithy.api#documentation": "\n The read set ID created for an uploaded read set. \n
", + "smithy.api#documentation": "The read set ID created for an uploaded read set.
", "smithy.api#required": {} } } @@ -1196,6 +1196,11 @@ "target": "smithy.api#String", "traits": { "smithy.api#documentation": "\n A unique identifier used to confirm that parts are being added to the correct upload.\n
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", "smithy.api#required": {} } } @@ -1563,7 +1568,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a multipart read set upload", - "smithy.api#documentation": "\n Begins a multipart read set upload. \n
", + "smithy.api#documentation": "Begins a multipart read set upload.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -1579,7 +1584,7 @@ "sequenceStoreId": { "target": "com.amazonaws.omics#SequenceStoreId", "traits": { - "smithy.api#documentation": "\n The sequence store ID for the store that is the destination of the multipart uploads.\n
", + "smithy.api#documentation": "The sequence store ID for the store that is the destination of the multipart uploads.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1587,59 +1592,59 @@ "clientToken": { "target": "com.amazonaws.omics#ClientToken", "traits": { - "smithy.api#documentation": "\n An idempotency token that can be used to avoid triggering multiple multipart uploads.\n
" + "smithy.api#documentation": "An idempotency token that can be used to avoid triggering multiple multipart uploads.
" } }, "sourceFileType": { "target": "com.amazonaws.omics#FileType", "traits": { - "smithy.api#documentation": "\n The type of file being uploaded.\n
", + "smithy.api#documentation": "The type of file being uploaded.
", "smithy.api#required": {} } }, "subjectId": { "target": "com.amazonaws.omics#SubjectId", "traits": { - "smithy.api#documentation": "\n The source's subject ID.\n
", + "smithy.api#documentation": "The source's subject ID.
", "smithy.api#required": {} } }, "sampleId": { "target": "com.amazonaws.omics#SampleId", "traits": { - "smithy.api#documentation": "\n The source's sample ID.\n
", + "smithy.api#documentation": "The source's sample ID.
", "smithy.api#required": {} } }, "generatedFrom": { "target": "com.amazonaws.omics#GeneratedFrom", "traits": { - "smithy.api#documentation": "\n Where the source originated.\n
" + "smithy.api#documentation": "Where the source originated.
" } }, "referenceArn": { "target": "com.amazonaws.omics#ReferenceArn", "traits": { - "smithy.api#documentation": "\n The ARN of the reference.\n
" + "smithy.api#documentation": "The ARN of the reference.
" } }, "name": { "target": "com.amazonaws.omics#ReadSetName", "traits": { - "smithy.api#documentation": "\n The name of the read set.\n
", + "smithy.api#documentation": "The name of the read set.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.omics#ReadSetDescription", "traits": { - "smithy.api#documentation": "\n The description of the read set.\n
" + "smithy.api#documentation": "The description of the read set.
" } }, "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "\n Any tags to add to the read set.\n
" + "smithy.api#documentation": "Any tags to add to the read set.
" } } }, @@ -1653,73 +1658,73 @@ "sequenceStoreId": { "target": "com.amazonaws.omics#SequenceStoreId", "traits": { - "smithy.api#documentation": "\n The sequence store ID for the store that the read set will be created in.\n
", + "smithy.api#documentation": "The sequence store ID for the store that the read set will be created in.
", "smithy.api#required": {} } }, "uploadId": { "target": "com.amazonaws.omics#UploadId", "traits": { - "smithy.api#documentation": "\n he ID for the initiated multipart upload.\n
", + "smithy.api#documentation": "The ID for the initiated multipart upload.
", "smithy.api#required": {} } }, "sourceFileType": { "target": "com.amazonaws.omics#FileType", "traits": { - "smithy.api#documentation": "\n The file type of the read set source.\n
", + "smithy.api#documentation": "The file type of the read set source.
", "smithy.api#required": {} } }, "subjectId": { "target": "com.amazonaws.omics#SubjectId", "traits": { - "smithy.api#documentation": "\n The source's subject ID.\n
", + "smithy.api#documentation": "The source's subject ID.
", "smithy.api#required": {} } }, "sampleId": { "target": "com.amazonaws.omics#SampleId", "traits": { - "smithy.api#documentation": "\n The source's sample ID.\n
", + "smithy.api#documentation": "The source's sample ID.
", "smithy.api#required": {} } }, "generatedFrom": { "target": "com.amazonaws.omics#GeneratedFrom", "traits": { - "smithy.api#documentation": "\n The source of the read set. \n
" + "smithy.api#documentation": "The source of the read set.
" } }, "referenceArn": { "target": "com.amazonaws.omics#ReferenceArn", "traits": { - "smithy.api#documentation": "\n The read set source's reference ARN.\n
", + "smithy.api#documentation": "The read set source's reference ARN.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.omics#ReadSetName", "traits": { - "smithy.api#documentation": "\n The name of the read set.\n
" + "smithy.api#documentation": "The name of the read set.
" } }, "description": { "target": "com.amazonaws.omics#ReadSetDescription", "traits": { - "smithy.api#documentation": "\n The description of the read set.\n
" + "smithy.api#documentation": "The description of the read set.
" } }, "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "\n The tags to add to the read set.\n
" + "smithy.api#documentation": "The tags to add to the read set.
" } }, "creationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "\n The creation time of the multipart upload.\n
", + "smithy.api#documentation": "The creation time of the multipart upload.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } @@ -1962,7 +1967,7 @@ "maxGpus": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The maximum GPUs that can be used by a run group. \n
", + "smithy.api#documentation": "The maximum GPUs that can be used by a run group.
", "smithy.api#range": { "min": 1, "max": 100000 @@ -2081,7 +2086,13 @@ "fallbackLocation": { "target": "com.amazonaws.omics#S3Destination", "traits": { - "smithy.api#documentation": "\n An S3 location that is used to store files that have failed a direct upload. \n
" + "smithy.api#documentation": "An S3 location that is used to store files that have failed a direct upload.
" + } + }, + "eTagAlgorithmFamily": { + "target": "com.amazonaws.omics#ETagAlgorithmFamily", + "traits": { + "smithy.api#documentation": "The ETag algorithm family to use for ingested read sets.
" } } }, @@ -2135,7 +2146,13 @@ "fallbackLocation": { "target": "com.amazonaws.omics#S3Destination", "traits": { - "smithy.api#documentation": "\n An S3 location that is used to store files that have failed a direct upload. \n
" + "smithy.api#documentation": "An S3 location that is used to store files that have failed a direct upload.
" + } + }, + "eTagAlgorithmFamily": { + "target": "com.amazonaws.omics#ETagAlgorithmFamily", + "traits": { + "smithy.api#documentation": "The algorithm family of the ETag.
" } } }, @@ -2483,7 +2500,7 @@ "accelerators": { "target": "com.amazonaws.omics#Accelerators", "traits": { - "smithy.api#documentation": "\n The computational accelerator specified to run the workflow. \n
" + "smithy.api#documentation": "The computational accelerator specified to run the workflow.
" } } }, @@ -3280,24 +3297,24 @@ "algorithm": { "target": "com.amazonaws.omics#ETagAlgorithm", "traits": { - "smithy.api#documentation": "\n The algorithm used to calculate the read set’s ETag(s).
" + "smithy.api#documentation": "The algorithm used to calculate the read set’s ETag(s).
" } }, "source1": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The ETag hash calculated on Source1 of the read set.\n
" + "smithy.api#documentation": "The ETag hash calculated on Source1 of the read set.
" } }, "source2": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The ETag hash calculated on Source2 of the read set.\n
" + "smithy.api#documentation": "The ETag hash calculated on Source2 of the read set.
" } } }, "traits": { - "smithy.api#documentation": "\n The entity tag (ETag) is a hash of the object representing its semantic content.\n
" + "smithy.api#documentation": "The entity tag (ETag) is a hash of the object representing its semantic content.
" } }, "com.amazonaws.omics#ETagAlgorithm": { @@ -3315,6 +3332,49 @@ { "value": "CRAM_MD5up", "name": "CRAM_MD5UP" + }, + { + "value": "FASTQ_SHA256up", + "name": "FASTQ_SHA256UP" + }, + { + "value": "BAM_SHA256up", + "name": "BAM_SHA256UP" + }, + { + "value": "CRAM_SHA256up", + "name": "CRAM_SHA256UP" + }, + { + "value": "FASTQ_SHA512up", + "name": "FASTQ_SHA512UP" + }, + { + "value": "BAM_SHA512up", + "name": "BAM_SHA512UP" + }, + { + "value": "CRAM_SHA512up", + "name": "CRAM_SHA512UP" + } + ] + } + }, + "com.amazonaws.omics#ETagAlgorithmFamily": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MD5up", + "name": "MD5UP" + }, + { + "value": "SHA256up", + "name": "SHA256UP" + }, + { + "value": "SHA512up", + "name": "SHA512UP" } ] } @@ -3543,6 +3603,12 @@ "max": 5497558138880 } } + }, + "s3Access": { + "target": "com.amazonaws.omics#ReadSetS3Access", + "traits": { + "smithy.api#documentation": "The S3 URI metadata of a sequence store.
" + } } }, "traits": { @@ -3871,7 +3937,7 @@ "annotationFields": { "target": "com.amazonaws.omics#AnnotationFieldMap", "traits": { - "smithy.api#documentation": "\n The annotation schema generated by the parsed annotation data.\n
" + "smithy.api#documentation": "The annotation schema generated by the parsed annotation data.
" } } }, @@ -5187,7 +5253,7 @@ "statusMessage": { "target": "com.amazonaws.omics#ReadSetStatusMessage", "traits": { - "smithy.api#documentation": "\n The status message for a read set. It provides more detail as to why the read set has a status. \n
" + "smithy.api#documentation": "The status message for a read set. It provides more detail as to why the read set has a status.
" } }, "creationType": { @@ -5199,7 +5265,7 @@ "etag": { "target": "com.amazonaws.omics#ETag", "traits": { - "smithy.api#documentation": "\n The entity tag (ETag) is a hash of the object meant to represent its semantic content.\n
" + "smithy.api#documentation": "The entity tag (ETag) is a hash of the object meant to represent its semantic content.
" } } }, @@ -6136,7 +6202,7 @@ "maxGpus": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The maximum GPUs that can be used by a run group. \n
", + "smithy.api#documentation": "The maximum GPUs that can be used by a run group.
", "smithy.api#range": { "min": 1, "max": 100000 @@ -6323,7 +6389,7 @@ "accelerators": { "target": "com.amazonaws.omics#Accelerators", "traits": { - "smithy.api#documentation": "\n The computational accelerator used to run the workflow. \n
" + "smithy.api#documentation": "The computational accelerator used to run the workflow.
" } }, "retentionMode": { @@ -6335,25 +6401,25 @@ "failureReason": { "target": "com.amazonaws.omics#RunFailureReason", "traits": { - "smithy.api#documentation": "\n The reason a run has failed. \n
" + "smithy.api#documentation": "The reason a run has failed.
" } }, "logLocation": { "target": "com.amazonaws.omics#RunLogLocation", "traits": { - "smithy.api#documentation": "\n The location of the run log. \n
" + "smithy.api#documentation": "The location of the run log.
" } }, "uuid": { "target": "com.amazonaws.omics#RunUuid", "traits": { - "smithy.api#documentation": "\n The universally unique identifier for a run. \n
" + "smithy.api#documentation": "The universally unique identifier for a run.
" } }, "runOutputUri": { "target": "com.amazonaws.omics#RunOutputUri", "traits": { - "smithy.api#documentation": "\n The destination for workflow outputs.\n
" + "smithy.api#documentation": "The destination for workflow outputs.
" } } }, @@ -6630,7 +6696,7 @@ "gpus": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The number of Graphics Processing Units (GPU) specified in the task. \n
", + "smithy.api#documentation": "The number of Graphics Processing Units (GPU) specified in the task.
", "smithy.api#range": { "min": 0 } @@ -6639,13 +6705,13 @@ "instanceType": { "target": "com.amazonaws.omics#TaskInstanceType", "traits": { - "smithy.api#documentation": "\n The instance type for a task. \n
" + "smithy.api#documentation": "The instance type for a task.
" } }, "failureReason": { "target": "com.amazonaws.omics#TaskFailureReason", "traits": { - "smithy.api#documentation": "\n The reason a task has failed. \n
" + "smithy.api#documentation": "The reason a task has failed.
" } } }, @@ -6757,7 +6823,19 @@ "fallbackLocation": { "target": "com.amazonaws.omics#S3Destination", "traits": { - "smithy.api#documentation": "\n An S3 location that is used to store files that have failed a direct upload.\n
" + "smithy.api#documentation": "An S3 location that is used to store files that have failed a direct upload.
" + } + }, + "s3Access": { + "target": "com.amazonaws.omics#SequenceStoreS3Access", + "traits": { + "smithy.api#documentation": "The S3 metadata of a sequence store, including the ARN and S3 URI of the S3 bucket.
" + } + }, + "eTagAlgorithmFamily": { + "target": "com.amazonaws.omics#ETagAlgorithmFamily", + "traits": { + "smithy.api#documentation": "The algorithm family of the ETag.
" } } }, @@ -7028,7 +7106,7 @@ "annotationFields": { "target": "com.amazonaws.omics#AnnotationFieldMap", "traits": { - "smithy.api#documentation": "\n The annotation schema generated by the parsed annotation data. \n
" + "smithy.api#documentation": "The annotation schema generated by the parsed annotation data.
" } } }, @@ -7493,13 +7571,13 @@ "metadata": { "target": "com.amazonaws.omics#WorkflowMetadata", "traits": { - "smithy.api#documentation": "\n Gets metadata for workflow. \n
" + "smithy.api#documentation": "Gets metadata for workflow.
" } }, "accelerators": { "target": "com.amazonaws.omics#Accelerators", "traits": { - "smithy.api#documentation": "\n The computational accelerator specified to run the workflow.
" + "smithy.api#documentation": "The computational accelerator specified to run the workflow.
" } } }, @@ -8323,7 +8401,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list multipart read set uploads", - "smithy.api#documentation": "\n Lists multipart read set uploads and for in progress uploads. Once the upload is completed, a read set is created and the upload will no longer be returned in the respone.\n
", + "smithy.api#documentation": "Lists multipart read set uploads and for in progress uploads. \n Once the upload is completed, a read set is created and the upload will no longer be returned in the response.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -8346,7 +8424,7 @@ "sequenceStoreId": { "target": "com.amazonaws.omics#SequenceStoreId", "traits": { - "smithy.api#documentation": "\n The Sequence Store ID used for the multipart uploads.\n
", + "smithy.api#documentation": "The Sequence Store ID used for the multipart uploads.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8354,7 +8432,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The maximum number of multipart uploads returned in a page.\n
", + "smithy.api#documentation": "The maximum number of multipart uploads returned in a page.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -8365,7 +8443,7 @@ "nextToken": { "target": "com.amazonaws.omics#NextToken", "traits": { - "smithy.api#documentation": "\n Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.\n
", + "smithy.api#documentation": "Next token returned in the response of a previous ListMultipartReadSetUploads call. \n Used to get the next page of results.
", "smithy.api#httpQuery": "nextToken" } } @@ -8380,13 +8458,13 @@ "nextToken": { "target": "com.amazonaws.omics#NextToken", "traits": { - "smithy.api#documentation": "\n Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.\n
" + "smithy.api#documentation": "Next token returned in the response of a previous ListMultipartReadSetUploads call. \n Used to get the next page of results.
" } }, "uploads": { "target": "com.amazonaws.omics#MultipartReadSetUploadList", "traits": { - "smithy.api#documentation": "\n An array of multipart uploads.\n
" + "smithy.api#documentation": "An array of multipart uploads.
" } } }, @@ -8751,7 +8829,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list read set upload parts", - "smithy.api#documentation": "\n This operation will list all parts in a requested multipart upload for a sequence store.\n
", + "smithy.api#documentation": "This operation will list all parts in a requested multipart upload for a sequence store.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -8774,7 +8852,7 @@ "sequenceStoreId": { "target": "com.amazonaws.omics#SequenceStoreId", "traits": { - "smithy.api#documentation": "\n The Sequence Store ID used for the multipart uploads.\n
", + "smithy.api#documentation": "The Sequence Store ID used for the multipart uploads.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8782,7 +8860,7 @@ "uploadId": { "target": "com.amazonaws.omics#UploadId", "traits": { - "smithy.api#documentation": "\n The ID for the initiated multipart upload. \n
", + "smithy.api#documentation": "The ID for the initiated multipart upload.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8790,14 +8868,14 @@ "partSource": { "target": "com.amazonaws.omics#ReadSetPartSource", "traits": { - "smithy.api#documentation": "\n The source file for the upload part.\n
", + "smithy.api#documentation": "The source file for the upload part.
", "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The maximum number of read set upload parts returned in a page.\n
", + "smithy.api#documentation": "The maximum number of read set upload parts returned in a page.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -8808,14 +8886,14 @@ "nextToken": { "target": "com.amazonaws.omics#NextToken", "traits": { - "smithy.api#documentation": "\n Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.\n
", + "smithy.api#documentation": "Next token returned in the response of a previous ListReadSetUploadPartsRequest call.\n Used to get the next page of results.
", "smithy.api#httpQuery": "nextToken" } }, "filter": { "target": "com.amazonaws.omics#ReadSetUploadPartListFilter", "traits": { - "smithy.api#documentation": "\n Attributes used to filter for a specific subset of read set part uploads.\n
" + "smithy.api#documentation": "Attributes used to filter for a specific subset of read set part uploads.
" } } }, @@ -8829,13 +8907,13 @@ "nextToken": { "target": "com.amazonaws.omics#NextToken", "traits": { - "smithy.api#documentation": "\n Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results.\n
" + "smithy.api#documentation": "Next token returned in the response of a previous ListReadSetUploadParts call.\n Used to get the next page of results.
" } }, "parts": { "target": "com.amazonaws.omics#ReadSetUploadPartList", "traits": { - "smithy.api#documentation": "\n An array of upload parts.\n
" + "smithy.api#documentation": "An array of upload parts.
" } } }, @@ -9574,7 +9652,7 @@ "status": { "target": "com.amazonaws.omics#RunStatus", "traits": { - "smithy.api#documentation": "\n The status of a run.\n
", + "smithy.api#documentation": "The status of a run.
", "smithy.api#httpQuery": "status" } } @@ -11685,7 +11763,7 @@ "etag": { "target": "com.amazonaws.omics#ETag", "traits": { - "smithy.api#documentation": "\n The entity tag (ETag) is a hash of the object representing its semantic content.\n
" + "smithy.api#documentation": "The entity tag (ETag) is a hash of the object representing its semantic content.
" } } }, @@ -11768,6 +11846,20 @@ "smithy.api#documentation": "Represents a resource that stores a single genomic sequence file" } }, + "com.amazonaws.omics#ReadSetS3Access": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.omics#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI for each read set file.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The S3 URI for each read set file.
" + } + }, "com.amazonaws.omics#ReadSetStatus": { "type": "string", "traits": { @@ -12846,18 +12938,18 @@ "engineLogStream": { "target": "com.amazonaws.omics#EngineLogStream", "traits": { - "smithy.api#documentation": "\n The log stream ARN for the engine log. \n
" + "smithy.api#documentation": "The log stream ARN for the engine log.
" } }, "runLogStream": { "target": "com.amazonaws.omics#RunLogStream", "traits": { - "smithy.api#documentation": "\n The log stream ARN for the run log. \n
" + "smithy.api#documentation": "The log stream ARN for the run log.
" } } }, "traits": { - "smithy.api#documentation": "\n The URI for the run log. \n
" + "smithy.api#documentation": "The URI for the run log.
" } }, "com.amazonaws.omics#RunLogStream": { @@ -13073,6 +13165,16 @@ "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" } }, + "com.amazonaws.omics#S3AccessPointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*$" + } + }, "com.amazonaws.omics#S3Destination": { "type": "string", "traits": { @@ -13265,6 +13367,12 @@ "traits": { "smithy.api#documentation": "\n An S3 location that is used to store files that have failed a direct upload. \n
" } + }, + "eTagAlgorithmFamily": { + "target": "com.amazonaws.omics#ETagAlgorithmFamily", + "traits": { + "smithy.api#documentation": "The algorithm family of the ETag.
" + } } }, "traits": { @@ -13413,6 +13521,26 @@ "smithy.api#documentation": "Represents a resource that stores genomic sequence data" } }, + "com.amazonaws.omics#SequenceStoreS3Access": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.omics#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI of the sequence store.
" + } + }, + "s3AccessPointArn": { + "target": "com.amazonaws.omics#S3AccessPointArn", + "traits": { + "smithy.api#documentation": "This is ARN of the access point associated with the S3 bucket storing read sets.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The S3 access metadata of the sequence store.
" + } + }, "com.amazonaws.omics#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -13700,7 +13828,7 @@ "annotationFields": { "target": "com.amazonaws.omics#AnnotationFieldMap", "traits": { - "smithy.api#documentation": "\n The annotation schema generated by the parsed annotation data. \n
" + "smithy.api#documentation": "The annotation schema generated by the parsed annotation data.
" } } }, @@ -14462,7 +14590,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "A storage capacity for the run in gigabytes.
", + "smithy.api#documentation": "A storage capacity for the run in gibibytes.
", "smithy.api#range": { "min": 0, "max": 100000 @@ -14536,13 +14664,13 @@ "uuid": { "target": "com.amazonaws.omics#RunUuid", "traits": { - "smithy.api#documentation": "\n The universally unique identifier for a run. \n
" + "smithy.api#documentation": "The universally unique identifier for a run.
" } }, "runOutputUri": { "target": "com.amazonaws.omics#RunOutputUri", "traits": { - "smithy.api#documentation": "\n The destination for workflow outputs.\n
" + "smithy.api#documentation": "The destination for workflow outputs.
" } } }, @@ -14624,7 +14752,7 @@ "annotationFields": { "target": "com.amazonaws.omics#AnnotationFieldMap", "traits": { - "smithy.api#documentation": "\n The annotation schema generated by the parsed annotation data. \n
" + "smithy.api#documentation": "The annotation schema generated by the parsed annotation data.
" } } }, @@ -15008,7 +15136,7 @@ "instanceType": { "target": "com.amazonaws.omics#TaskInstanceType", "traits": { - "smithy.api#documentation": "\n The instance type for a task. \n
" + "smithy.api#documentation": "The instance type for a task.
" } } }, @@ -15638,7 +15766,7 @@ "maxGpus": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The maximum GPUs that can be used by a run group. \n
", + "smithy.api#documentation": "The maximum GPUs that can be used by a run group.
", "smithy.api#range": { "min": 1, "max": 100000 @@ -15893,7 +16021,7 @@ "traits": { "aws.auth#unsignedPayload": {}, "aws.iam#actionPermissionDescription": "Grants permission to upload read set parts", - "smithy.api#documentation": "\n This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, the previously uploaded part will be overwritten. \n
", + "smithy.api#documentation": "This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, \n the previously uploaded part will be overwritten.
", "smithy.api#endpoint": { "hostPrefix": "storage-" }, @@ -15909,7 +16037,7 @@ "sequenceStoreId": { "target": "com.amazonaws.omics#SequenceStoreId", "traits": { - "smithy.api#documentation": "\n The Sequence Store ID used for the multipart upload.\n
", + "smithy.api#documentation": "The Sequence Store ID used for the multipart upload.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -15917,7 +16045,7 @@ "uploadId": { "target": "com.amazonaws.omics#UploadId", "traits": { - "smithy.api#documentation": "\n The ID for the initiated multipart upload.\n
", + "smithy.api#documentation": "The ID for the initiated multipart upload.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -15925,7 +16053,7 @@ "partSource": { "target": "com.amazonaws.omics#ReadSetPartSource", "traits": { - "smithy.api#documentation": "\n The source file for an upload part. \n
", + "smithy.api#documentation": "The source file for an upload part.
", "smithy.api#httpQuery": "partSource", "smithy.api#required": {} } @@ -15933,7 +16061,7 @@ "partNumber": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The number of the part being uploaded.\n
", + "smithy.api#documentation": "The number of the part being uploaded.
", "smithy.api#httpQuery": "partNumber", "smithy.api#range": { "min": 1, @@ -15945,7 +16073,7 @@ "payload": { "target": "com.amazonaws.omics#ReadSetPartStreamingBlob", "traits": { - "smithy.api#documentation": "\n The read set data to upload for a part.\n
", + "smithy.api#documentation": "The read set data to upload for a part.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -15961,7 +16089,7 @@ "checksum": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n An identifier used to confirm that parts are being added to the intended upload.\n
", + "smithy.api#documentation": "An identifier used to confirm that parts are being added to the intended upload.
", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/outposts.2019-12-03.json b/codegen/sdk-codegen/aws-models/outposts.2019-12-03.json index 51d6e51dce4..832f6d74d71 100644 --- a/codegen/sdk-codegen/aws-models/outposts.2019-12-03.json +++ b/codegen/sdk-codegen/aws-models/outposts.2019-12-03.json @@ -353,6 +353,71 @@ "target": "com.amazonaws.outposts#CIDR" } }, + "com.amazonaws.outposts#CancelCapacityTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#CancelCapacityTaskInput" + }, + "output": { + "target": "com.amazonaws.outposts#CancelCapacityTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#ConflictException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Cancels the capacity task.
", + "smithy.api#http": { + "method": "POST", + "uri": "/outposts/{OutpostIdentifier}/capacity/{CapacityTaskId}", + "code": 200 + } + } + }, + "com.amazonaws.outposts#CancelCapacityTaskInput": { + "type": "structure", + "members": { + "CapacityTaskId": { + "target": "com.amazonaws.outposts#CapacityTaskId", + "traits": { + "smithy.api#documentation": "ID of the capacity task that you want to cancel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "OutpostIdentifier": { + "target": "com.amazonaws.outposts#OutpostIdentifier", + "traits": { + "smithy.api#documentation": "ID or ARN of the Outpost associated with the capacity task that you want to cancel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.outposts#CancelCapacityTaskOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.outposts#CancelOrder": { "type": "operation", "input": { @@ -410,6 +475,154 @@ "smithy.api#output": {} } }, + "com.amazonaws.outposts#CapacityTaskFailure": { + "type": "structure", + "members": { + "Reason": { + "target": "com.amazonaws.outposts#CapacityTaskStatusReason", + "traits": { + "smithy.api#documentation": "The reason that the specified capacity task failed.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.outposts#CapacityTaskFailureType", + "traits": { + "smithy.api#documentation": "The type of failure.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The capacity tasks that failed.
" + } + }, + "com.amazonaws.outposts#CapacityTaskFailureType": { + "type": "enum", + "members": { + "UNSUPPORTED_CAPACITY_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_CAPACITY_CONFIGURATION" + } + } + } + }, + "com.amazonaws.outposts#CapacityTaskId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 21, + "max": 21 + }, + "smithy.api#pattern": "^cap-[a-f0-9]{17}$" + } + }, + "com.amazonaws.outposts#CapacityTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#CapacityTaskSummary" + } + }, + "com.amazonaws.outposts#CapacityTaskStatus": { + "type": "enum", + "members": { + "REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUESTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + } + } + }, + "com.amazonaws.outposts#CapacityTaskStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#CapacityTaskStatus" + } + }, + "com.amazonaws.outposts#CapacityTaskStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.outposts#CapacityTaskSummary": { + "type": "structure", + "members": { + "CapacityTaskId": { + "target": "com.amazonaws.outposts#CapacityTaskId", + "traits": { + "smithy.api#documentation": "The ID of the specified capacity task.
" + } + }, + "OutpostId": { + "target": "com.amazonaws.outposts#OutpostId", + "traits": { + "smithy.api#documentation": "The ID of the Outpost associated with the specified capacity task.
" + } + }, + "OrderId": { + "target": "com.amazonaws.outposts#OrderId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services Outposts order of the host associated with the capacity task.
" + } + }, + "CapacityTaskStatus": { + "target": "com.amazonaws.outposts#CapacityTaskStatus", + "traits": { + "smithy.api#documentation": "The status of the capacity task.
" + } + }, + "CreationDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "The date that the specified capacity task was created.
" + } + }, + "CompletionDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "The date that the specified capacity task successfully ran.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "The date that the specified capacity was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the capacity task.
" + } + }, "com.amazonaws.outposts#CatalogItem": { "type": "structure", "members": { @@ -1000,7 +1213,7 @@ "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { - "smithy.api#documentation": "The ID or the Amazon Resource Name (ARN) of the Outpost.
", + "smithy.api#documentation": "The ID or ARN of the Outpost.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1094,6 +1307,12 @@ "smithy.api#pattern": "^\\S[\\S ]*$" } }, + "com.amazonaws.outposts#DryRun": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.outposts#EC2Capacity": { "type": "structure", "members": { @@ -1169,6 +1388,130 @@ } } }, + "com.amazonaws.outposts#GetCapacityTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#GetCapacityTaskInput" + }, + "output": { + "target": "com.amazonaws.outposts#GetCapacityTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets details of the specified capacity task.
", + "smithy.api#http": { + "method": "GET", + "uri": "/outposts/{OutpostIdentifier}/capacity/{CapacityTaskId}", + "code": 200 + } + } + }, + "com.amazonaws.outposts#GetCapacityTaskInput": { + "type": "structure", + "members": { + "CapacityTaskId": { + "target": "com.amazonaws.outposts#CapacityTaskId", + "traits": { + "smithy.api#documentation": "ID of the capacity task.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "OutpostIdentifier": { + "target": "com.amazonaws.outposts#OutpostIdentifier", + "traits": { + "smithy.api#documentation": "ID or ARN of the Outpost associated with the specified capacity task.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.outposts#GetCapacityTaskOutput": { + "type": "structure", + "members": { + "CapacityTaskId": { + "target": "com.amazonaws.outposts#CapacityTaskId", + "traits": { + "smithy.api#documentation": "ID of the capacity task.
" + } + }, + "OutpostId": { + "target": "com.amazonaws.outposts#OutpostId", + "traits": { + "smithy.api#documentation": "ID of the Outpost associated with the specified capacity task.
" + } + }, + "OrderId": { + "target": "com.amazonaws.outposts#OrderId", + "traits": { + "smithy.api#documentation": "ID of the Amazon Web Services Outposts order associated with the specified capacity task.
" + } + }, + "RequestedInstancePools": { + "target": "com.amazonaws.outposts#RequestedInstancePools", + "traits": { + "smithy.api#documentation": "List of instance pools requested in the capacity task.
" + } + }, + "DryRun": { + "target": "com.amazonaws.outposts#DryRun", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Performs a dry run to determine if you are above or below instance capacity.
" + } + }, + "CapacityTaskStatus": { + "target": "com.amazonaws.outposts#CapacityTaskStatus", + "traits": { + "smithy.api#documentation": "Status of the capacity task.
\nA capacity task can have one of the following statuses:
\n\n REQUESTED - The capacity task was created and is awaiting the next step\n by Amazon Web Services Outposts.
\n IN_PROGRESS - The capacity task is running and cannot be\n cancelled.
\n WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You\n must stop the recommended EC2 running instances to free up capacity for the task to\n run.
Reason why the capacity task failed.
" + } + }, + "CreationDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "The date the capacity task was created.
" + } + }, + "CompletionDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "The date the capacity task ran successfully.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "The date the capacity task was last modified.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.outposts#GetCatalogItem": { "type": "operation", "input": { @@ -1386,7 +1729,7 @@ "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { - "smithy.api#documentation": "The ID or the Amazon Resource Name (ARN) of the Outpost.
", + "smithy.api#documentation": "The ID or ARN of the Outpost.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1439,15 +1782,116 @@ "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { - "smithy.api#documentation": "The ID or the Amazon Resource Name (ARN) of the Outpost.
", + "smithy.api#documentation": "The ID or ARN of the Outpost.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.outposts#MaxResults1000", + "traits": { + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.outposts#GetOutpostInstanceTypesOutput": { + "type": "structure", + "members": { + "InstanceTypes": { + "target": "com.amazonaws.outposts#InstanceTypeListDefinition" + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token" + }, + "OutpostId": { + "target": "com.amazonaws.outposts#OutpostId", + "traits": { + "smithy.api#documentation": "The ID of the Outpost.
" + } + }, + "OutpostArn": { + "target": "com.amazonaws.outposts#OutpostArn" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.outposts#GetOutpostOutput": { + "type": "structure", + "members": { + "Outpost": { + "target": "com.amazonaws.outposts#Outpost" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.outposts#GetOutpostSupportedInstanceTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#GetOutpostSupportedInstanceTypesInput" + }, + "output": { + "target": "com.amazonaws.outposts#GetOutpostSupportedInstanceTypesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the instance types that an\n Outpost can support in InstanceTypeCapacity. This will generally include instance types that\n are not currently configured and therefore cannot be launched with the current Outpost\n capacity configuration.
The ID or ARN of the Outpost.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.outposts#Token", + "OrderId": { + "target": "com.amazonaws.outposts#OrderId", "traits": { - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "The ID for the Amazon Web Services Outposts order.
", + "smithy.api#httpQuery": "OrderId", + "smithy.api#required": {} } }, "MaxResults": { @@ -1455,13 +1899,19 @@ "traits": { "smithy.api#httpQuery": "MaxResults" } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token", + "traits": { + "smithy.api#httpQuery": "NextToken" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.outposts#GetOutpostInstanceTypesOutput": { + "com.amazonaws.outposts#GetOutpostSupportedInstanceTypesOutput": { "type": "structure", "members": { "InstanceTypes": { @@ -1469,26 +1919,6 @@ }, "NextToken": { "target": "com.amazonaws.outposts#Token" - }, - "OutpostId": { - "target": "com.amazonaws.outposts#OutpostId", - "traits": { - "smithy.api#documentation": "The ID of the Outpost.
" - } - }, - "OutpostArn": { - "target": "com.amazonaws.outposts#OutpostArn" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.outposts#GetOutpostOutput": { - "type": "structure", - "members": { - "Outpost": { - "target": "com.amazonaws.outposts#Outpost" } }, "traits": { @@ -1672,6 +2102,39 @@ "smithy.api#documentation": "The instance type.
" } }, + "com.amazonaws.outposts#InstanceTypeCapacity": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.outposts#InstanceTypeName", + "traits": { + "smithy.api#documentation": "The instance type of the hosts.
", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.outposts#InstanceTypeCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of instances for the specified instance type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The instance type that you specify determines the combination of CPU, memory, storage, and\n networking capacity.
" + } + }, + "com.amazonaws.outposts#InstanceTypeCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 9999 + } + } + }, "com.amazonaws.outposts#InstanceTypeItem": { "type": "structure", "members": { @@ -1692,6 +2155,16 @@ "smithy.api#documentation": "Information about the instance types.
" } }, + "com.amazonaws.outposts#InstanceTypeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9\\-]+\\.[a-z0-9\\-]+$" + } + }, "com.amazonaws.outposts#InternalServerException": { "type": "structure", "members": { @@ -2026,6 +2499,94 @@ "smithy.api#output": {} } }, + "com.amazonaws.outposts#ListCapacityTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#ListCapacityTasksInput" + }, + "output": { + "target": "com.amazonaws.outposts#ListCapacityTasksOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the capacity tasks for your Amazon Web Services account.
\nUse filters to return specific results. If you specify multiple filters, the results include only the resources that match \n all of the specified filters. For a filter where you can specify multiple values, the results include \n items that match any of the values that you specify for the filter.
", + "smithy.api#http": { + "method": "GET", + "uri": "/capacity/tasks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityTasks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.outposts#ListCapacityTasksInput": { + "type": "structure", + "members": { + "OutpostIdentifierFilter": { + "target": "com.amazonaws.outposts#OutpostIdentifier", + "traits": { + "smithy.api#documentation": "Filters the results by an Outpost ID or an Outpost ARN.
", + "smithy.api#httpQuery": "OutpostIdentifierFilter" + } + }, + "MaxResults": { + "target": "com.amazonaws.outposts#MaxResults1000", + "traits": { + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "CapacityTaskStatusFilter": { + "target": "com.amazonaws.outposts#CapacityTaskStatusList", + "traits": { + "smithy.api#documentation": "A list of statuses. For example,\n REQUESTED or WAITING_FOR_EVACUATION.
Lists all the capacity tasks.
" + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.outposts#ListCatalogItems": { "type": "operation", "input": { @@ -2945,6 +3506,9 @@ "type": "service", "version": "2019-12-03", "operations": [ + { + "target": "com.amazonaws.outposts#CancelCapacityTask" + }, { "target": "com.amazonaws.outposts#CancelOrder" }, @@ -2963,6 +3527,9 @@ { "target": "com.amazonaws.outposts#DeleteSite" }, + { + "target": "com.amazonaws.outposts#GetCapacityTask" + }, { "target": "com.amazonaws.outposts#GetCatalogItem" }, @@ -2978,6 +3545,9 @@ { "target": "com.amazonaws.outposts#GetOutpostInstanceTypes" }, + { + "target": "com.amazonaws.outposts#GetOutpostSupportedInstanceTypes" + }, { "target": "com.amazonaws.outposts#GetSite" }, @@ -2987,6 +3557,9 @@ { "target": "com.amazonaws.outposts#ListAssets" }, + { + "target": "com.amazonaws.outposts#ListCapacityTasks" + }, { "target": "com.amazonaws.outposts#ListCatalogItems" }, @@ -3002,6 +3575,9 @@ { "target": "com.amazonaws.outposts#ListTagsForResource" }, + { + "target": "com.amazonaws.outposts#StartCapacityTask" + }, { "target": "com.amazonaws.outposts#StartConnection" }, @@ -4268,6 +4844,12 @@ "smithy.api#documentation": "Information about the physical and logistical details for racks at sites.\n For more information\n about hardware requirements for racks, see Network \n readiness checklist in the Amazon Web Services Outposts User Guide.\n
" } }, + "com.amazonaws.outposts#RequestedInstancePools": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#InstanceTypeCapacity" + } + }, "com.amazonaws.outposts#ResourceType": { "type": "enum", "members": { @@ -4334,6 +4916,12 @@ "traits": { "smithy.api#enumValue": "UPS" } + }, + "EXPEDITORS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPEDITORS" + } } } }, @@ -4480,6 +5068,146 @@ "smithy.api#pattern": "^OR-[A-Z0-9]{7}$" } }, + "com.amazonaws.outposts#StartCapacityTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#StartCapacityTaskInput" + }, + "output": { + "target": "com.amazonaws.outposts#StartCapacityTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#ConflictException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts the specified capacity task. You can have one active capacity task for an order.
", + "smithy.api#http": { + "method": "POST", + "uri": "/outposts/{OutpostIdentifier}/capacity", + "code": 200 + } + } + }, + "com.amazonaws.outposts#StartCapacityTaskInput": { + "type": "structure", + "members": { + "OutpostIdentifier": { + "target": "com.amazonaws.outposts#OutpostIdentifier", + "traits": { + "smithy.api#documentation": "The ID or ARN of the Outposts associated with the specified capacity task.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "OrderId": { + "target": "com.amazonaws.outposts#OrderId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services Outposts order associated with the specified capacity task.
", + "smithy.api#required": {} + } + }, + "InstancePools": { + "target": "com.amazonaws.outposts#RequestedInstancePools", + "traits": { + "smithy.api#documentation": "The instance pools specified in the capacity task.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.outposts#DryRun", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "You can request a dry run to determine if the instance type and instance size changes is above or below available instance\n capacity. Requesting a dry run does not make any changes to your plan.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.outposts#StartCapacityTaskOutput": { + "type": "structure", + "members": { + "CapacityTaskId": { + "target": "com.amazonaws.outposts#CapacityTaskId", + "traits": { + "smithy.api#documentation": "ID of the capacity task that you want to start.
" + } + }, + "OutpostId": { + "target": "com.amazonaws.outposts#OutpostId", + "traits": { + "smithy.api#documentation": "ID of the Outpost associated with the capacity task.
" + } + }, + "OrderId": { + "target": "com.amazonaws.outposts#OrderId", + "traits": { + "smithy.api#documentation": "ID of the Amazon Web Services Outposts order of the host associated with the capacity task.
" + } + }, + "RequestedInstancePools": { + "target": "com.amazonaws.outposts#RequestedInstancePools", + "traits": { + "smithy.api#documentation": "List of the instance pools requested in the specified capacity task.
" + } + }, + "DryRun": { + "target": "com.amazonaws.outposts#DryRun", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Results of the dry run showing if the specified capacity task is above or below the\n available instance capacity.
" + } + }, + "CapacityTaskStatus": { + "target": "com.amazonaws.outposts#CapacityTaskStatus", + "traits": { + "smithy.api#documentation": "Status of the specified capacity task.
" + } + }, + "Failed": { + "target": "com.amazonaws.outposts#CapacityTaskFailure", + "traits": { + "smithy.api#documentation": "Reason that the specified capacity task failed.
" + } + }, + "CreationDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "Date that the specified capacity task was created.
" + } + }, + "CompletionDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "Date that the specified capacity task ran successfully.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "Date that the specified capacity task was last modified.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.outposts#StartConnection": { "type": "operation", "input": { @@ -4892,7 +5620,7 @@ "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { - "smithy.api#documentation": "The ID or the Amazon Resource Name (ARN) of the Outpost.
", + "smithy.api#documentation": "The ID or ARN of the Outpost.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } diff --git a/codegen/sdk-codegen/aws-models/payment-cryptography.2021-09-14.json b/codegen/sdk-codegen/aws-models/payment-cryptography.2021-09-14.json index 4e9412269fa..0a26efe18c1 100644 --- a/codegen/sdk-codegen/aws-models/payment-cryptography.2021-09-14.json +++ b/codegen/sdk-codegen/aws-models/payment-cryptography.2021-09-14.json @@ -146,7 +146,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.
\nYou can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region.
\nTo change the key that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don't affect the underlying key. To get the alias that you created, call ListAliases.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nCreates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.
\nYou can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region.
\nTo change the key that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don't affect the underlying key. To get the alias that you created, call ListAliases.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nCreates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.
\nIn addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.
\nWhen you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that define the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.
Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n " + "smithy.api#documentation": "Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.
\nIn addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.
\nWhen you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that define the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.
Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n " } }, "com.amazonaws.paymentcryptography#CreateKeyInput": { @@ -286,7 +286,7 @@ "target": "com.amazonaws.paymentcryptography#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nAssigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nDeletes the alias, but doesn't affect the underlying key.
\nEach key can have multiple aliases. To get the aliases of all keys, use the ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nDeletes the alias, but doesn't affect the underlying key.
\nEach key can have multiple aliases. To get the aliases of all keys, use the UpdateAlias operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nDeletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.
\nKey deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period set using DeleteKeyInDays. The default waiting period is 7 days. During the waiting period, the KeyState is DELETE_PENDING. After the key is deleted, the KeyState is DELETE_COMPLETE.
You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling StopKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n RestoreKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nDeletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.
\nKey deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period set using DeleteKeyInDays. The default waiting period is 7 days. During the waiting period, the KeyState is DELETE_PENDING. After the key is deleted, the KeyState is DELETE_COMPLETE.
You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling StopKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n RestoreKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nExports a key from Amazon Web Services Payment Cryptography.
\nAmazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ExportKey you can export symmetric keys using either symmetric and asymmetric key exchange mechanisms. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanism. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK). After which you can export working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
\nThe TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
\nYou can also use ExportKey functionality to generate and export an IPEK (Initial Pin Encryption Key) from Amazon Web Services Payment Cryptography using either TR-31 or TR-34 export key exchange. IPEK is generated from BDK (Base Derivation Key) and ExportDukptInitialKey attribute KSN (KeySerialNumber). The generated IPEK does not persist within Amazon Web Services Payment Cryptography and has to be re-generated each time during export.
\n To export initial keys (KEK) or IPEK using TR-34\n
\nUsing this operation, you can export initial key using TR-34 asymmetric key exchange. You can only export KEK generated within Amazon Web Services Payment Cryptography. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export and KRD is the user receiving the key.
\nTo initiate TR-34 key export, the KRD must obtain an export token by calling GetParametersForExport. This operation also generates a key pair for the purpose of key export, signs the key and returns back the signing public key certificate (also known as KDH signing certificate) and root certificate chain. The KDH uses the private key to sign the the export payload and the signing public key certificate is provided to KRD to verify the signature. The KRD can import the root certificate into its Hardware Security Module (HSM), as required. The export token and the associated KDH signing certificate expires after 7 days.
\nNext the KRD generates a key pair for the the purpose of encrypting the KDH key and provides the public key cerificate (also known as KRD wrapping certificate) back to KDH. The KRD will also import the root cerificate chain into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey. The KDH, Amazon Web Services Payment Cryptography, will use the KRD wrapping cerificate to encrypt (wrap) the key under export and signs it with signing private key to generate a TR-34 WrappedKeyBlock. For more information on TR-34 key export, see section Exporting symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
\n\n ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
\n ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
\n KeyMaterial: Use Tr34KeyBlock parameters.
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KRD wrapping key certificate.
\n ExportToken: Obtained from KDH by calling GetParametersForImport.
\n WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KRD wrapping key Amazon Web Services Payment Cryptography uses for encryption of the TR-34 export payload. This certificate must be signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography.
When this operation is successful, Amazon Web Services Payment Cryptography returns the KEK or IPEK as a TR-34 WrappedKeyBlock.
\n\n To export initial keys (KEK) or IPEK using RSA Wrap and Unwrap\n
\nUsing this operation, you can export initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate export, generate an asymmetric key pair on the receiving HSM and obtain the public key certificate in PEM format (base64 encoded) for the purpose of wrapping and the root certifiate chain. Import the root certificate into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey.
Next call ExportKey and set the following parameters:
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed wrapping key certificate.
\n KeyMaterial: Set to KeyCryptogram.
\n WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) obtained by the receiving HSM and signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography. The receiving HSM uses its private key component to unwrap the WrappedKeyCryptogram.
When this operation is successful, Amazon Web Services Payment Cryptography returns the WrappedKeyCryptogram.
\n\n To export working keys or IPEK using TR-31\n
\nUsing this operation, you can export working keys or IPEK using TR-31 symmetric key exchange. In TR-31, you must use an initial key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey.
\nSet the following parameters:
\n\n ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
\n ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
\n KeyMaterial: Use Tr31KeyBlock parameters.
When this operation is successful, Amazon Web Services Payment Cryptography returns the working key or IPEK as a TR-31 WrappedKeyBlock.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nExports a key from Amazon Web Services Payment Cryptography.
\nAmazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ExportKey you can export symmetric keys using either symmetric and asymmetric key exchange mechanisms. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanism. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK). After which you can export working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
\nThe TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
\nYou can also use ExportKey functionality to generate and export an IPEK (Initial Pin Encryption Key) from Amazon Web Services Payment Cryptography using either TR-31 or TR-34 export key exchange. IPEK is generated from BDK (Base Derivation Key) and ExportDukptInitialKey attribute KSN (KeySerialNumber). The generated IPEK does not persist within Amazon Web Services Payment Cryptography and has to be re-generated each time during export.
For key exchange using TR-31 or TR-34 key blocks, you can also export optional blocks within the key block header which contain additional attribute information about the key. The KeyVersion within KeyBlockHeaders indicates the version of the key within the key block. Furthermore, KeyExportability within KeyBlockHeaders can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.
The OptionalBlocks contain the additional data related to the key. For information on data type that can be included within optional blocks, refer to ASC X9.143-2022.
Data included in key block headers is signed but transmitted in clear text. Sensitive or confidential information should not be included in optional blocks. Refer to ASC X9.143-2022 standard for information on allowed data type.
\n\n To export initial keys (KEK) or IPEK using TR-34\n
\nUsing this operation, you can export initial key using TR-34 asymmetric key exchange. You can only export KEK generated within Amazon Web Services Payment Cryptography. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export and KRD is the user receiving the key.
\nTo initiate TR-34 key export, the KRD must obtain an export token by calling GetParametersForExport. This operation also generates a key pair for the purpose of key export, signs the key and returns back the signing public key certificate (also known as KDH signing certificate) and root certificate chain. The KDH uses the private key to sign the the export payload and the signing public key certificate is provided to KRD to verify the signature. The KRD can import the root certificate into its Hardware Security Module (HSM), as required. The export token and the associated KDH signing certificate expires after 7 days.
\nNext the KRD generates a key pair for the the purpose of encrypting the KDH key and provides the public key cerificate (also known as KRD wrapping certificate) back to KDH. The KRD will also import the root cerificate chain into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey. The KDH, Amazon Web Services Payment Cryptography, will use the KRD wrapping cerificate to encrypt (wrap) the key under export and signs it with signing private key to generate a TR-34 WrappedKeyBlock. For more information on TR-34 key export, see section Exporting symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
\n\n ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
\n ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
\n KeyMaterial: Use Tr34KeyBlock parameters.
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KRD wrapping key certificate.
\n ExportToken: Obtained from KDH by calling GetParametersForImport.
\n WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KRD wrapping key Amazon Web Services Payment Cryptography uses for encryption of the TR-34 export payload. This certificate must be signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography.
When this operation is successful, Amazon Web Services Payment Cryptography returns the KEK or IPEK as a TR-34 WrappedKeyBlock.
\n\n To export initial keys (KEK) or IPEK using RSA Wrap and Unwrap\n
\nUsing this operation, you can export initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate export, generate an asymmetric key pair on the receiving HSM and obtain the public key certificate in PEM format (base64 encoded) for the purpose of wrapping and the root certifiate chain. Import the root certificate into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey.
Next call ExportKey and set the following parameters:
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed wrapping key certificate.
\n KeyMaterial: Set to KeyCryptogram.
\n WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) obtained by the receiving HSM and signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography. The receiving HSM uses its private key component to unwrap the WrappedKeyCryptogram.
When this operation is successful, Amazon Web Services Payment Cryptography returns the WrappedKeyCryptogram.
\n\n To export working keys or IPEK using TR-31\n
\nUsing this operation, you can export working keys or IPEK using TR-31 symmetric key exchange. In TR-31, you must use an initial key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey.
\nSet the following parameters:
\n\n ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
\n ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
\n KeyMaterial: Use Tr31KeyBlock parameters.
When this operation is successful, Amazon Web Services Payment Cryptography returns the working key or IPEK as a TR-31 WrappedKeyBlock.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nThe KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.
Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" + } } }, "traits": { @@ -664,7 +670,7 @@ "ExportToken": { "target": "com.amazonaws.paymentcryptography#ExportTokenId", "traits": { - "smithy.api#documentation": "The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account.
", + "smithy.api#documentation": "The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account.
", "smithy.api#required": {} } }, @@ -680,6 +686,12 @@ "traits": { "smithy.api#documentation": "A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
" } + }, + "KeyBlockHeaders": { + "target": "com.amazonaws.paymentcryptography#KeyBlockHeaders", + "traits": { + "smithy.api#documentation": "Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" + } } }, "traits": { @@ -716,7 +728,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Gets the Amazon Web Services Payment Cryptography key associated with the alias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nGets the Amazon Web Services Payment Cryptography key associated with the alias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nGets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", + "smithy.api#documentation": "Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", "smithy.api#readonly": {} } }, @@ -858,7 +870,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
\nThe signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nGets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
\nThe signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nGets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography.
\nThe wrapping key certificate wraps the key under import. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 7 days. You can use the same import token to import multiple keys into your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nGets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography.
\nThe wrapping key certificate wraps the key under import. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 7 days. You can use the same import token to import multiple keys into your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nImports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.
\nAmazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ImportKey you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms.
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
\nThe TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
\nYou can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
\n\n To import a public root key certificate\n
\nYou can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
\n\n To import a public root key certificate\n
\nUsing this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.
\nSet the following parameters:
\n\n KeyMaterial: RootCertificatePublicKey\n
\n KeyClass: PUBLIC_KEY\n
\n KeyModesOfUse: Verify\n
\n KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE\n
\n PublicKeyCertificate: The public key certificate in PEM format (base64 encoded) of the private root key under import.
\n To import a trusted public key certificate\n
\nThe root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:
\n\n KeyMaterial: TrustedCertificatePublicKey\n
\n CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.
\n KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.
\n PublicKeyCertificate: The trusted public key certificate in PEM format (base64 encoded) under import.
\n To import initial keys (KEK or ZMK or similar) using TR-34\n
\nUsing this operation, you can import initial key using TR-34 asymmetric key exchange. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During the key import process, KDH is the user who initiates the key import and KRD is Amazon Web Services Payment Cryptography who receives the key.
\nTo initiate TR-34 key import, the KDH must obtain an import token by calling GetParametersForImport. This operation generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate (also known as KRD wrapping certificate) and the root certificate chain. The KDH must trust and install the KRD wrapping certificate on its HSM and use it to encrypt (wrap) the KDH key during TR-34 WrappedKeyBlock generation. The import token and associated KRD wrapping certificate expires after 7 days.
\nNext the KDH generates a key pair for the purpose of signing the encrypted KDH key and provides the public certificate of the signing key to Amazon Web Services Payment Cryptography. The KDH will also need to import the root certificate chain of the KDH signing certificate by calling ImportKey for RootCertificatePublicKey. For more information on TR-34 key import, see section Importing symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
\n\n KeyMaterial: Use Tr34KeyBlock parameters.
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KDH signing key certificate.
\n ImportToken: Obtained from KRD by calling GetParametersForImport.
\n WrappedKeyBlock: The TR-34 wrapped key material from KDH. It contains the KDH key under import, wrapped with KRD wrapping certificate and signed by KDH signing private key. This TR-34 key block is typically generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.
\n SigningKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KDH signing key generated under the root certificate (CertificateAuthorityPublicKeyIdentifier) imported in Amazon Web Services Payment Cryptography.
\n To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap\n
\nUsing this operation, you can import initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate import, call GetParametersForImport with KeyMaterial set to KEY_CRYPTOGRAM to generate an import token. This operation also generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate in PEM format (base64 encoded) and its root certificate chain. The import token and associated KRD wrapping certificate expires after 7 days.
You must trust and install the wrapping certificate and its certificate chain on the sending HSM and use it to wrap the key under export for WrappedKeyCryptogram generation. Next call ImportKey with KeyMaterial set to KEY_CRYPTOGRAM and provide the ImportToken and KeyAttributes for the key under import.
\n To import working keys using TR-31\n
\nAmazon Web Services Payment Cryptography uses TR-31 symmetric key exchange norm to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import or by using CreateKey. To initiate a TR-31 key import, set the following parameters:
\n\n KeyMaterial: Use Tr31KeyBlock parameters.
\n WrappedKeyBlock: The TR-31 wrapped key material. It contains the key under import, encrypted using KEK. The TR-31 key block is typically generated by a HSM outside of Amazon Web Services Payment Cryptography.
\n WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nImports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.
\nAmazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ImportKey you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms.
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
\nThe TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
\nYou can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
\n\n To import a public root key certificate\n
\nYou can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
\n\n To import a public root key certificate\n
\nUsing this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.
\nSet the following parameters:
\n\n KeyMaterial: RootCertificatePublicKey\n
\n KeyClass: PUBLIC_KEY\n
\n KeyModesOfUse: Verify\n
\n KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE\n
\n PublicKeyCertificate: The public key certificate in PEM format (base64 encoded) of the private root key under import.
\n To import a trusted public key certificate\n
\nThe root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:
\n\n KeyMaterial: TrustedCertificatePublicKey\n
\n CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.
\n KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.
\n PublicKeyCertificate: The trusted public key certificate in PEM format (base64 encoded) under import.
\n To import initial keys (KEK or ZMK or similar) using TR-34\n
\nUsing this operation, you can import initial key using TR-34 asymmetric key exchange. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During the key import process, KDH is the user who initiates the key import and KRD is Amazon Web Services Payment Cryptography who receives the key.
\nTo initiate TR-34 key import, the KDH must obtain an import token by calling GetParametersForImport. This operation generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate (also known as KRD wrapping certificate) and the root certificate chain. The KDH must trust and install the KRD wrapping certificate on its HSM and use it to encrypt (wrap) the KDH key during TR-34 WrappedKeyBlock generation. The import token and associated KRD wrapping certificate expires after 7 days.
\nNext the KDH generates a key pair for the purpose of signing the encrypted KDH key and provides the public certificate of the signing key to Amazon Web Services Payment Cryptography. The KDH will also need to import the root certificate chain of the KDH signing certificate by calling ImportKey for RootCertificatePublicKey. For more information on TR-34 key import, see section Importing symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
\n\n KeyMaterial: Use Tr34KeyBlock parameters.
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KDH signing key certificate.
\n ImportToken: Obtained from KRD by calling GetParametersForImport.
\n WrappedKeyBlock: The TR-34 wrapped key material from KDH. It contains the KDH key under import, wrapped with KRD wrapping certificate and signed by KDH signing private key. This TR-34 key block is typically generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.
\n SigningKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KDH signing key generated under the root certificate (CertificateAuthorityPublicKeyIdentifier) imported in Amazon Web Services Payment Cryptography.
\n To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap\n
\nUsing this operation, you can import initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate import, call GetParametersForImport with KeyMaterial set to KEY_CRYPTOGRAM to generate an import token. This operation also generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate in PEM format (base64 encoded) and its root certificate chain. The import token and associated KRD wrapping certificate expires after 7 days.
You must trust and install the wrapping certificate and its certificate chain on the sending HSM and use it to wrap the key under export for WrappedKeyCryptogram generation. Next call ImportKey with KeyMaterial set to KEY_CRYPTOGRAM and provide the ImportToken and KeyAttributes for the key under import.
\n To import working keys using TR-31\n
\nAmazon Web Services Payment Cryptography uses TR-31 symmetric key exchange norm to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import or by using CreateKey. To initiate a TR-31 key import, set the following parameters:
\n\n KeyMaterial: Use Tr31KeyBlock parameters.
\n WrappedKeyBlock: The TR-31 wrapped key material. It contains the key under import, encrypted using KEK. The TR-31 key block is typically generated by a HSM outside of Amazon Web Services Payment Cryptography.
\n WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nAssigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nAssigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nThe role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
" } }, + "com.amazonaws.paymentcryptography#KeyBlockHeaders": { + "type": "structure", + "members": { + "KeyModesOfUse": { + "target": "com.amazonaws.paymentcryptography#KeyModesOfUse" + }, + "KeyExportability": { + "target": "com.amazonaws.paymentcryptography#KeyExportability", + "traits": { + "smithy.api#documentation": "Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.
\nWhen set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.
Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
" + } + }, + "OptionalBlocks": { + "target": "com.amazonaws.paymentcryptography#OptionalBlocks", + "traits": { + "smithy.api#documentation": "Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.
\nOptional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" + } + }, "com.amazonaws.paymentcryptography#KeyCheckValue": { "type": "string", "traits": { @@ -1660,6 +1701,25 @@ ] } }, + "com.amazonaws.paymentcryptography#KeyExportability": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EXPORTABLE", + "name": "EXPORTABLE" + }, + { + "value": "NON_EXPORTABLE", + "name": "NON_EXPORTABLE" + }, + { + "value": "SENSITIVE", + "name": "SENSITIVE" + } + ] + } + }, "com.amazonaws.paymentcryptography#KeyMaterial": { "type": "string", "traits": { @@ -2005,6 +2065,16 @@ ] } }, + "com.amazonaws.paymentcryptography#KeyVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[0-9A-Z]{2}+$" + } + }, "com.amazonaws.paymentcryptography#ListAliases": { "type": "operation", "input": { @@ -2035,7 +2105,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.
\nThis is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value.\n Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n UpdateAlias\n
\nLists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.
\nThis is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value.\n Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n UpdateAlias\n
\nLists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.
\nThis is a paginated operation, which means that each response might contain only a subset of all the keys.\n When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", + "smithy.api#documentation": "Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.
\nThis is a paginated operation, which means that each response might contain only a subset of all the keys.\n When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2211,7 +2281,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Lists the tags for an Amazon Web Services resource.
\nThis is a paginated operation, which means that each response might contain only a subset of all the tags.\n When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTagsForResource request to get more tags.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n TagResource\n
\n\n UntagResource\n
\nLists the tags for an Amazon Web Services resource.
\nThis is a paginated operation, which means that each response might contain only a subset of all the tags.\n When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTagsForResource request to get more tags.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n TagResource\n
\n\n UntagResource\n
\nCancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion.
During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted.\n After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nCancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion.
During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted.\n After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nEnables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n StopKeyUsage\n
\nEnables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n StopKeyUsage\n
\nDisables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
\nYou can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\nDisables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
\nYou can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\nAdds or edits tags on an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nEach tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n UntagResource\n
\nAdds or edits tags on an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nEach tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n UntagResource\n
\nOne or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTo use this parameter, you must have TagResource permission in an IAM policy.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nOne or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTo use this parameter, you must have TagResource permission in an IAM policy.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nDeletes a tag from an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n TagResource\n
\nDeletes a tag from an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n TagResource\n
\nOne or more tag keys. Don't include the tag values.
\nIf the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the ListTagsForResource operation.
", + "smithy.api#documentation": "One or more tag keys. Don't include the tag values.
\nIf the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the ListTagsForResource operation.
", "smithy.api#required": {} } } @@ -3602,7 +3703,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Associates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the Amazon Web Services Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web Services Region
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\nAssociates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the Amazon Web Services Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web Services Region
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\nWhen the solution performs AutoML (performAutoML is true in\n CreateSolution), specifies the recipe that best optimized the\n specified metric.
Specifies how often to automatically train new solution versions. Specify a rate expression in rate(value\n unit) format.\n For value, specify a number between 1 and 30. For unit, specify day or days.\n For example, to automatically create a new solution version every 5 days, specify rate(5 days). The default is every 7 days.
For more information about auto training, see Creating and configuring a solution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The automatic training configuration to use when performAutoTraining is true.
The Amazon Resource Name (ARN) of a specific version of the solution.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the solution version the campaign uses.
" } }, "minProvisionedTPS": { @@ -1651,6 +1665,12 @@ "traits": { "smithy.api#documentation": "Whether metadata with recommendations is enabled for the campaign. \n If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response.\n For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.
\n\n If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.\n
" } + }, + "syncWithLatestSolutionVersion": { + "target": "com.amazonaws.personalize#Boolean", + "traits": { + "smithy.api#documentation": "Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, \n you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format.\n The default is False and you must manually update the campaign to deploy the latest solution version. \n
\n For more information about automatic campaign updates, see \n Enabling automatic campaign updates.\n
" + } } }, "traits": { @@ -2153,7 +2173,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a campaign that deploys a solution version. When a client calls the\n GetRecommendations\n and\n GetPersonalizedRanking\n APIs, a campaign is specified in the request.
\n\n Minimum Provisioned TPS and Auto-Scaling\n
\n A high minProvisionedTPS will increase your cost. We recommend starting with 1 for minProvisionedTPS (the default). Track\n your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS\n as necessary.
\n When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second\n (minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by\n Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or\n GetPersonalizedRanking request. The default minProvisionedTPS is 1.
If your TPS increases beyond the minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up\n and down, but never below minProvisionedTPS. \n There's a short time delay while the capacity is increased\n that might cause loss of transactions. When your traffic reduces, capacity returns to the minProvisionedTPS.\n
You are charged for the\n the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. \n The actual TPS is the total number of recommendation requests you make.\n We recommend starting with a low minProvisionedTPS, track\n your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.
For more information about campaign costs, see Amazon Personalize pricing.
\n\n Status\n
\nA campaign can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nTo get the campaign status, call DescribeCampaign.
\nWait until the status of the campaign\n is ACTIVE before asking the campaign for recommendations.
\n Related APIs\n
\n\n ListCampaigns\n
\n\n DescribeCampaign\n
\n\n UpdateCampaign\n
\n\n DeleteCampaign\n
\nYou incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign\n costs, see Amazon Personalize pricing.
\nCreates a campaign that deploys a solution version. When a client calls the\n GetRecommendations\n and\n GetPersonalizedRanking\n APIs, a campaign is specified in the request.
\n\n Minimum Provisioned TPS and Auto-Scaling\n
\n A high minProvisionedTPS will increase your cost. We recommend starting with 1 for minProvisionedTPS (the default). Track\n your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS\n as necessary.
\n When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second\n (minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by\n Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or\n GetPersonalizedRanking request. The default minProvisionedTPS is 1.
If your TPS increases beyond the minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up\n and down, but never below minProvisionedTPS. \n There's a short time delay while the capacity is increased\n that might cause loss of transactions. When your traffic reduces, capacity returns to the minProvisionedTPS.\n
You are charged for the\n the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. \n The actual TPS is the total number of recommendation requests you make.\n We recommend starting with a low minProvisionedTPS, track\n your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.
For more information about campaign costs, see Amazon Personalize pricing.
\n\n Status\n
\nA campaign can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nTo get the campaign status, call DescribeCampaign.
\nWait until the status of the campaign\n is ACTIVE before asking the campaign for recommendations.
\n Related APIs\n
\n\n ListCampaigns\n
\n\n DescribeCampaign\n
\n\n UpdateCampaign\n
\n\n DeleteCampaign\n
\nThe Amazon Resource Name (ARN) of the solution version to deploy.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, \n specify the ARN of your solution in SolutionArn/$LATEST format.\n You must use this format if you set syncWithLatestSolutionVersion to True in the \n CampaignConfig.\n
\n To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.\n
\n\n For more information about automatic campaign updates, see \n Enabling automatic campaign updates.\n
", "smithy.api#required": {} } }, @@ -3001,7 +3021,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates the configuration for training a model. A trained model is known as\n a solution version. After the configuration is created, you train the model (create a solution version)\n by calling the CreateSolutionVersion operation. Every time you call\n CreateSolutionVersion, a new version of the solution is created.
After creating a solution version, you check its accuracy by calling\n GetSolutionMetrics. When you are satisfied with the version, you\n deploy it using CreateCampaign. The campaign provides recommendations\n to a client through the\n GetRecommendations API.
\nTo train a model, Amazon Personalize requires training data and a recipe. The training data\n comes from the dataset group that you provide in the request. A recipe specifies\n the training algorithm and a feature transformation. You can specify one of the predefined\n recipes provided by Amazon Personalize.
\nAmazon Personalize doesn't support configuring the hpoObjective \n for solution hyperparameter optimization at this time.
\n Status\n
\nA solution can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nTo get the status of the solution, call DescribeSolution. Wait\n until the status shows as ACTIVE before calling CreateSolutionVersion.
\n Related APIs\n
\n\n ListSolutions\n
\n\n DescribeSolution\n
\n\n DeleteSolution\n
\n\n ListSolutionVersions\n
\nAfter you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while\n your solution is active. You can't stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training\n costs, see Amazon Personalize pricing.
\nCreates the configuration for training a model (creating a solution version). This configuration\n includes the recipe to use for model training and optional training configuration, such as columns to use\n in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution.\n
\n\n By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency.\n Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within\n the hour, the solution skips the first automatic training. For more information,\n see Configuring automatic training.
\n\n To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version\n by calling the CreateSolutionVersion operation.
After training starts, you can\n get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. \n To get its status, use the DescribeSolutionVersion.\n
\nAfter training completes you can evaluate model accuracy by calling\n GetSolutionMetrics. When you are satisfied with the solution version, you\n deploy it using CreateCampaign. The campaign provides recommendations\n to a client through the\n GetRecommendations API.
\nAmazon Personalize doesn't support configuring the hpoObjective \n for solution hyperparameter optimization at this time.
\n Status\n
\nA solution can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nTo get the status of the solution, call DescribeSolution. If you use\n manual training, the status must be ACTIVE before you call CreateSolutionVersion.
\n Related APIs\n
\n\n ListSolutions\n
\n\n DescribeSolution\n
\n\n DeleteSolution\n
\n\n ListSolutionVersions\n
\nWe don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize \n recipes. For more information, see Choosing a recipe.
\nWhether to perform automated machine learning (AutoML). The default is false.\n For this case, you must specify recipeArn.
When set to true, Amazon Personalize analyzes your training data and selects\n the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit\n recipeArn. Amazon Personalize determines the optimal recipe by running tests with\n different values for the hyperparameters.\n AutoML lengthens the training process as compared to selecting a specific recipe.
Whether the solution uses automatic training to create new solution versions (trained models). The default is\n True and the solution automatically creates new solution versions every 7 days. You can change the training\n frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution\n configuration. For more information about automatic training,\n see Configuring automatic training.
\n Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within\n the hour, the solution skips the first automatic training.\n
\n\n After training starts, you can\n get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. \n To get its status, use the DescribeSolutionVersion.\n
" + } + }, "recipeArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when\n performAutoML is false. For information about different Amazon Personalize recipes and their ARNs, \n see Choosing a recipe.\n \n
The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when\n performAutoML is false. For information about different Amazon Personalize recipes and their ARNs, \n see Choosing a recipe.\n
Returns a list of solutions that use the given dataset group.\n When a dataset group is not specified, all the solutions associated with the account are listed.\n The response provides the properties for each solution, including the Amazon Resource Name (ARN).\n For more information on solutions, see CreateSolution.
", + "smithy.api#documentation": "Returns a list of solutions in a given dataset group.\n When a dataset group is not specified, all the solutions associated with the account are listed.\n The response provides the properties for each solution, including the Amazon Resource Name (ARN).\n For more information on solutions, see CreateSolution.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -7106,7 +7132,7 @@ "resourceArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "The resource's Amazon Resource Name.
", + "smithy.api#documentation": "The resource's Amazon Resource Name (ARN).
", "smithy.api#required": {} } } @@ -7385,7 +7411,8 @@ "smithy.api#length": { "min": 0, "max": 1500 - } + }, + "smithy.api#pattern": "^\\p{ASCII}{0,1500}$" } }, "com.amazonaws.personalize#NumBatchResults": { @@ -7464,6 +7491,9 @@ "smithy.api#default": false } }, + "com.amazonaws.personalize#PerformAutoTraining": { + "type": "boolean" + }, "com.amazonaws.personalize#PerformHPO": { "type": "boolean", "traits": { @@ -7915,6 +7945,16 @@ "smithy.api#pattern": "^(s3|http|https)://.+$" } }, + "com.amazonaws.personalize#SchedulingExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#pattern": "^rate\\(\\d+ days?\\)$" + } + }, "com.amazonaws.personalize#Schemas": { "type": "list", "member": { @@ -7956,6 +7996,12 @@ "smithy.api#documentation": "We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize \n recipes. For more information, see Determining your use case.\n
\nWhen true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from\n the list specified in the solution configuration (recipeArn must not be specified).\n When false (the default), Amazon Personalize uses recipeArn for training.
Specifies whether the solution automatically creates solution versions. The default is True\n and the solution automatically creates new solution versions every 7 days.
For more information about auto training, see Creating and configuring a solution.
" + } + }, "recipeArn": { "target": "com.amazonaws.personalize#Arn", "traits": { @@ -8012,7 +8058,7 @@ } }, "traits": { - "smithy.api#documentation": "An object that provides information about a solution. A solution is a trained model\n that can be deployed as a campaign.
" + "smithy.api#documentation": "After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while\n your solution is active. You can't stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training\n costs, see Amazon Personalize pricing.
\nAn object that provides information about a solution. A solution includes the custom recipe, customized parameters, and\n trained models (Solution Versions) that Amazon Personalize uses to generate recommendations.
\nAfter you create a solution, you can’t change its configuration. If you need to make changes, you can clone the solution with the Amazon Personalize console\n or create a new one.
" } }, "com.amazonaws.personalize#SolutionConfig": { @@ -8059,6 +8105,12 @@ "traits": { "smithy.api#documentation": "\n Specifies the training data configuration to use when creating a custom solution version (trained model).\n
" } + }, + "autoTrainingConfig": { + "target": "com.amazonaws.personalize#AutoTrainingConfig", + "traits": { + "smithy.api#documentation": "Specifies the automatic training configuration to use.
" + } } }, "traits": { @@ -8177,7 +8229,7 @@ "trainingMode": { "target": "com.amazonaws.personalize#TrainingMode", "traits": { - "smithy.api#documentation": "The scope of training to be performed when creating the solution version. The\n FULL option trains the solution version based on the entirety of the input\n solution's training data, while the UPDATE option processes only the data that\n has changed in comparison to the input solution. Choose UPDATE when you want to\n incrementally update your solution version instead of creating an entirely new one.
The UPDATE option can only be used when you already have an active solution\n version created from the input solution using the FULL option and the input\n solution was trained with the \n User-Personalization\n recipe or the \n HRNN-Coldstart recipe.
The scope of training to be performed when creating the solution version. A\n FULL training considers all of the data in your dataset group.\n An UPDATE processes only the data that\n has changed since the latest training. Only solution versions created with the User-Personalization\n recipe can use UPDATE.\n
The date and time (in\n Unix\n time) that the solution was last updated.
" } + }, + "trainingType": { + "target": "com.amazonaws.personalize#TrainingType", + "traits": { + "smithy.api#documentation": "Whether the solution version was created automatically or manually.
" + } } }, "traits": { @@ -8230,6 +8288,18 @@ "smithy.api#documentation": "The status of the solution version.
\nA solution version can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nThe scope of training to be performed when creating the solution version. A\n FULL training considers all of the data in your dataset group.\n An UPDATE processes only the data that\n has changed since the latest training. Only solution versions created with the User-Personalization\n recipe can use UPDATE.\n
Whether the solution version was created automatically or manually.
" + } + }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { @@ -8450,7 +8520,7 @@ } }, "traits": { - "smithy.api#documentation": "The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.\n For more information see Tagging Amazon Personalize recources.\n
" + "smithy.api#documentation": "The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.\n For more information see Tagging Amazon Personalize resources.\n
" } }, "com.amazonaws.personalize#TagKey": { @@ -8517,7 +8587,7 @@ "tags": { "target": "com.amazonaws.personalize#Tags", "traits": { - "smithy.api#documentation": "Tags to apply to the resource. For more information see Tagging Amazon Personalize recources.
", + "smithy.api#documentation": "Tags to apply to the resource. For more information see Tagging Amazon Personalize resources.
", "smithy.api#required": {} } } @@ -8611,7 +8681,7 @@ "excludedDatasetColumns": { "target": "com.amazonaws.personalize#ExcludedDatasetColumns", "traits": { - "smithy.api#documentation": "Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns.\n Exclude columns to control what data Amazon Personalize uses to generate recommendations. \n For example, you might have a column that you want to use only to filter recommendations. You can\n exclude this column from training and Amazon Personalize considers it only when filtering.\n
" + "smithy.api#documentation": "Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns.\n Exclude columns to control what data Amazon Personalize uses to generate recommendations.
\n\n For example, you might have a column that you want to use only to filter recommendations. You can\n exclude this column from training and Amazon Personalize considers it only when filtering.\n
" } } }, @@ -8650,6 +8720,29 @@ "traits": { "smithy.api#enumValue": "UPDATE" } + }, + "AUTOTRAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOTRAIN" + } + } + } + }, + "com.amazonaws.personalize#TrainingType": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } } } }, @@ -8704,7 +8797,7 @@ } ], "traits": { - "smithy.api#documentation": "Remove tags that are attached to a resource.
" + "smithy.api#documentation": "Removes the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.
" } }, "com.amazonaws.personalize#UntagResourceRequest": { @@ -8720,7 +8813,7 @@ "tagKeys": { "target": "com.amazonaws.personalize#TagKeys", "traits": { - "smithy.api#documentation": "Keys to remove from the resource's tags.
", + "smithy.api#documentation": "The keys of the tags to be removed.
", "smithy.api#required": {} } } @@ -8756,7 +8849,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS,\n or modify your campaign's configuration, such as the exploration configuration.\n
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.\n Check the campaign status using the DescribeCampaign operation.
\nYou can still get recommendations from a campaign while an update is in progress.\n The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.\n
For more information about updating a campaign, including code samples, see Updating a campaign.\n For more information about campaigns, see Creating a campaign.
", + "smithy.api#documentation": "\n Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS,\n or modify your campaign's configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign.
\n To update a campaign to start automatically using the latest solution version, specify the following:
\nFor the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN) of your solution in\n SolutionArn/$LATEST format.
In the campaignConfig, set syncWithLatestSolutionVersion to true.\n
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.\n Check the campaign status using the DescribeCampaign operation.
\nYou can still get recommendations from a campaign while an update is in progress.\n The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.\n
For more information about updating a campaign, including code samples, see Updating a campaign.\n For more information about campaigns, see Creating a campaign.
", "smithy.api#idempotent": {} } }, @@ -8773,7 +8866,7 @@ "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "The ARN of a new solution version to deploy.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a new model to deploy. To specify the latest solution version of your solution, \n specify the ARN of your solution in SolutionArn/$LATEST format.\n You must use this format if you set syncWithLatestSolutionVersion to True in the \n CampaignConfig.\n
\n To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.\n
\n\n For more information about automatic campaign updates, see \n Enabling automatic campaign updates.\n
" } }, "minProvisionedTPS": { diff --git a/codegen/sdk-codegen/aws-models/pinpoint.2016-12-01.json b/codegen/sdk-codegen/aws-models/pinpoint.2016-12-01.json index ba8881f5c45..bd176ea385a 100644 --- a/codegen/sdk-codegen/aws-models/pinpoint.2016-12-01.json +++ b/codegen/sdk-codegen/aws-models/pinpoint.2016-12-01.json @@ -5906,6 +5906,12 @@ "traits": { "smithy.api#documentation": "The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
" } + }, + "OrchestrationSendingRoleArn": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.
" + } } }, "traits": { @@ -6001,6 +6007,12 @@ "smithy.api#documentation": "The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
" } }, + "OrchestrationSendingRoleArn": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.
" + } + }, "Version": { "target": "com.amazonaws.pinpoint#__integer", "traits": { @@ -6469,7 +6481,7 @@ "target": "com.amazonaws.pinpoint#DeliveryStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
TIMEOUT - The message couldn't be sent within the timeout period.
UNKNOWN_FAILURE - An unknown error occurred.
The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
UNKNOWN_FAILURE - An unknown error occurred.
The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint address.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
TIMEOUT - The message couldn't be sent within the timeout period.
UNKNOWN_FAILURE - An unknown error occurred.
The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint address.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
UNKNOWN_FAILURE - An unknown error occurred.
A mapping of field names to the field values in input that an end user provides to\n Amazon Q requests to perform their plugin action.
", + "smithy.api#documentation": "A mapping of field names to the field values in input that an end user provides to\n Amazon Q Business requests to perform their plugin action.
", "smithy.api#required": {} } }, @@ -91,7 +91,7 @@ } }, "traits": { - "smithy.api#documentation": "Performs an Amazon Q plugin action during a non-streaming chat\n conversation.
" + "smithy.api#documentation": "Performs an Amazon Q Business plugin action during a non-streaming chat\n conversation.
" } }, "com.amazonaws.qbusiness#ActionExecutionPayload": { @@ -185,7 +185,7 @@ "payload": { "target": "com.amazonaws.qbusiness#ActionReviewPayload", "traits": { - "smithy.api#documentation": "Field values that an end user needs to provide to Amazon Q for Amazon Q to\n perform the requested plugin action.
" + "smithy.api#documentation": "Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to\n perform the requested plugin action.
" } }, "payloadFieldNameSeparator": { @@ -196,7 +196,7 @@ } }, "traits": { - "smithy.api#documentation": "An output event that Amazon Q returns to an user who wants to perform a plugin\n action during a non-streaming chat conversation. It contains information about the\n selected action with a list of possible user input fields, some pre-populated by\n Amazon Q.
" + "smithy.api#documentation": "An output event that Amazon Q Business returns to an user who wants to perform a plugin\n action during a non-streaming chat conversation. It contains information about the\n selected action with a list of possible user input fields, some pre-populated by\n Amazon Q Business.
" } }, "com.amazonaws.qbusiness#ActionReviewPayload": { @@ -238,7 +238,7 @@ "allowedValues": { "target": "com.amazonaws.qbusiness#ActionReviewPayloadFieldAllowedValues", "traits": { - "smithy.api#documentation": "Information about the field values that an end user can use to provide to\n Amazon Q for Amazon Q to perform the requested plugin action.
" + "smithy.api#documentation": "Information about the field values that an end user can use to provide to\n Amazon Q Business for Amazon Q Business to perform the requested plugin action.
" } }, "required": { @@ -269,7 +269,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about the field values that an end user can use to provide to\n Amazon Q for Amazon Q to perform the requested plugin action.
" + "smithy.api#documentation": "Information about the field values that an end user can use to provide to\n Amazon Q Business for Amazon Q Business to perform the requested plugin action.
" } }, "com.amazonaws.qbusiness#ActionReviewPayloadFieldAllowedValues": { @@ -293,36 +293,36 @@ "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { - "smithy.api#documentation": "The name of the Amazon Q application.
" + "smithy.api#documentation": "The name of the Amazon Q Business application.
" } }, "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier for the Amazon Q application.
" + "smithy.api#documentation": "The identifier for the Amazon Q Business application.
" } }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was created.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was created.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "status": { "target": "com.amazonaws.qbusiness#ApplicationStatus", "traits": { - "smithy.api#documentation": "The status of the Amazon Q application. The application is ready to use when the\n status is ACTIVE.
The status of the Amazon Q Business application. The application is ready to use when the\n status is ACTIVE.
Summary information for an Amazon Q application.
" + "smithy.api#documentation": "Summary information for an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#ApplicationArn": { @@ -452,6 +452,21 @@ "smithy.api#documentation": "Configuration information about the file upload during chat feature for your\n application.
" } }, + "com.amazonaws.qbusiness#AppliedCreatorModeConfiguration": { + "type": "structure", + "members": { + "creatorModeControl": { + "target": "com.amazonaws.qbusiness#CreatorModeControl", + "traits": { + "smithy.api#documentation": "Information about whether creator mode is enabled or disabled for an Amazon Q Business\n application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The creator mode specific admin controls configured for an Amazon Q Business application.\n Determines whether an end user can generate LLM-only responses when they use the web\n experience.
\nFor more information, see Admin controls and guardrails and Conversation settings.
" + } + }, "com.amazonaws.qbusiness#AttachmentInput": { "type": "structure", "members": { @@ -600,43 +615,43 @@ "equalsTo": { "target": "com.amazonaws.qbusiness#DocumentAttribute", "traits": { - "smithy.api#documentation": "Performs an equals operation on two document attributes or metadata fields.
" + "smithy.api#documentation": "Performs an equals operation on two document attributes or metadata fields. Supported\n for the following document attribute value types: dateValue,\n longValue, stringListValue and\n stringValue.
Returns true when a document contains all the specified document\n attributes or metadata fields.
Returns true when a document contains all the specified document\n attributes or metadata fields. Supported for the following document attribute value types:\n stringListValue.
Returns true when a document contains any of the specified document\n attributes or metadata fields.
Returns true when a document contains any of the specified document\n attributes or metadata fields. Supported for the following document attribute value types: dateValue,\n longValue, stringListValue and\n stringValue.
Performs a greater than operation on two document attributes or metadata fields. Use\n with a document attribute of type Date or Long.
Performs a greater than operation on two document attributes or metadata fields.\n Supported for the following document attribute value types: dateValue\n and longValue.
Performs a greater or equals than operation on two document attributes or metadata\n fields. Use with a document attribute of type Date or Long.\n
Performs a greater or equals than operation on two document attributes or metadata\n fields. Supported for the following document attribute value types: dateValue\n and longValue.
Performs a less than operation on two document attributes or metadata fields. Use with\n a document attribute of type Date or Long.
Performs a less than operation on two document attributes or metadata fields.\n Supported for the following document attribute value types: dateValue\n and longValue.
Performs a less than or equals operation on two document attributes or metadata\n fields. Use with a document attribute of type Date or Long.\n
Performs a less than or equals operation on two document attributes or metadata\n fields.Supported for the following document attribute value type: dateValue\n and longValue.
The ARN of an IAM role used by Amazon Q to access the basic\n authentication credentials stored in a Secrets Manager secret.
", + "smithy.api#documentation": "The ARN of an IAM role used by Amazon Q Business to access the basic\n authentication credentials stored in a Secrets Manager secret.
", "smithy.api#required": {} } } @@ -741,7 +756,7 @@ } ], "traits": { - "smithy.api#documentation": "Asynchronously deletes one or more documents added using the\n BatchPutDocument API from an Amazon Q index.
You can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.
", + "smithy.api#documentation": "Asynchronously deletes one or more documents added using the\n BatchPutDocument API from an Amazon Q Business index.
You can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.
", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/indices/{indexId}/documents/delete" @@ -754,7 +769,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -762,7 +777,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index that contains the documents to\n delete.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business index that contains the documents to\n delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -770,7 +785,7 @@ "documents": { "target": "com.amazonaws.qbusiness#DeleteDocuments", "traits": { - "smithy.api#documentation": "Documents deleted from the Amazon Q index.
", + "smithy.api#documentation": "Documents deleted from the Amazon Q Business index.
", "smithy.api#required": {} } }, @@ -791,7 +806,7 @@ "failedDocuments": { "target": "com.amazonaws.qbusiness#FailedDocuments", "traits": { - "smithy.api#documentation": "A list of documents that couldn't be removed from the Amazon Q index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.
" + "smithy.api#documentation": "A list of documents that couldn't be removed from the Amazon Q Business index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.
" } } }, @@ -831,7 +846,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds one or more documents to an Amazon Q index.
\nYou use this API to:
\ningest your structured and unstructured documents and documents stored in an\n Amazon S3 bucket into an Amazon Q index.
\nadd custom attributes to documents in an Amazon Q index.
\nattach an access control list to the documents added to an Amazon Q\n index.
\nYou can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.
", + "smithy.api#documentation": "Adds one or more documents to an Amazon Q Business index.
\nYou use this API to:
\ningest your structured and unstructured documents and documents stored in an\n Amazon S3 bucket into an Amazon Q Business index.
\nadd custom attributes to documents in an Amazon Q Business index.
\nattach an access control list to the documents added to an Amazon Q Business\n index.
\nYou can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.
", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/indices/{indexId}/documents" @@ -844,7 +859,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -852,7 +867,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index to add the documents to.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business index to add the documents to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -887,7 +902,7 @@ "failedDocuments": { "target": "com.amazonaws.qbusiness#FailedDocuments", "traits": { - "smithy.api#documentation": "A list of documents that were not added to the Amazon Q index because the\n document failed a validation check. Each document contains an error message that\n indicates why the document couldn't be added to the index.
" + "smithy.api#documentation": "A list of documents that were not added to the Amazon Q Business index because the\n document failed a validation check. Each document contains an error message that\n indicates why the document couldn't be added to the index.
" } } }, @@ -924,7 +939,7 @@ "blockedPhrases": { "target": "com.amazonaws.qbusiness#BlockedPhrases", "traits": { - "smithy.api#documentation": "A list of phrases blocked from a Amazon Q web experience chat.
" + "smithy.api#documentation": "A list of phrases blocked from a Amazon Q Business web experience chat.
" } }, "systemMessageOverride": { @@ -944,13 +959,13 @@ "blockedPhrasesToCreateOrUpdate": { "target": "com.amazonaws.qbusiness#BlockedPhrases", "traits": { - "smithy.api#documentation": "Creates or updates a blocked phrases configuration in your Amazon Q\n application.
" + "smithy.api#documentation": "Creates or updates a blocked phrases configuration in your Amazon Q Business\n application.
" } }, "blockedPhrasesToDelete": { "target": "com.amazonaws.qbusiness#BlockedPhrases", "traits": { - "smithy.api#documentation": "Deletes a blocked phrases configuration in your Amazon Q application.
" + "smithy.api#documentation": "Deletes a blocked phrases configuration in your Amazon Q Business application.
" } }, "systemMessageOverride": { @@ -961,7 +976,7 @@ } }, "traits": { - "smithy.api#documentation": "Updates a blocked phrases configuration in your Amazon Q application.
" + "smithy.api#documentation": "Updates a blocked phrases configuration in your Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#BoostingDurationInSeconds": { @@ -973,6 +988,43 @@ } } }, + "com.amazonaws.qbusiness#ChatMode": { + "type": "enum", + "members": { + "RETRIEVAL_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRIEVAL_MODE" + } + }, + "CREATOR_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATOR_MODE" + } + }, + "PLUGIN_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLUGIN_MODE" + } + } + } + }, + "com.amazonaws.qbusiness#ChatModeConfiguration": { + "type": "union", + "members": { + "pluginConfiguration": { + "target": "com.amazonaws.qbusiness#PluginConfiguration", + "traits": { + "smithy.api#documentation": "Configuration information required to invoke chat in PLUGIN_MODE.
Configuration information for Amazon Q Business conversation modes.
\nFor more information, see Admin controls and guardrails and Conversation settings.
" + } + }, "com.amazonaws.qbusiness#ChatSync": { "type": "operation", "input": { @@ -1005,7 +1057,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts or continues a non-streaming Amazon Q conversation.
", + "smithy.api#documentation": "Starts or continues a non-streaming Amazon Q Business conversation.
", "smithy.api#http": { "uri": "/applications/{applicationId}/conversations?sync", "method": "POST" @@ -1018,7 +1070,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the Amazon Q\n conversation.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the Amazon Q Business\n conversation.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1027,8 +1079,7 @@ "target": "com.amazonaws.qbusiness#UserId", "traits": { "smithy.api#documentation": "The identifier of the user attached to the chat input.
", - "smithy.api#httpQuery": "userId", - "smithy.api#required": {} + "smithy.api#httpQuery": "userId" } }, "userGroups": { @@ -1053,13 +1104,13 @@ "actionExecution": { "target": "com.amazonaws.qbusiness#ActionExecution", "traits": { - "smithy.api#documentation": "A request from an end user to perform an Amazon Q plugin action.
" + "smithy.api#documentation": "A request from an end user to perform an Amazon Q Business plugin action.
" } }, "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q conversation.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business conversation.
" } }, "parentMessageId": { @@ -1071,7 +1122,19 @@ "attributeFilter": { "target": "com.amazonaws.qbusiness#AttributeFilter", "traits": { - "smithy.api#documentation": "Enables filtering of Amazon Q web experience responses based on document\n attributes or metadata fields.
" + "smithy.api#documentation": "Enables filtering of Amazon Q Business web experience responses based on document\n attributes or metadata fields.
" + } + }, + "chatMode": { + "target": "com.amazonaws.qbusiness#ChatMode", + "traits": { + "smithy.api#documentation": "The chat modes available in an Amazon Q Business web experience.
\n\n RETRIEVAL_MODE - The default chat mode for an\n Amazon Q Business application. When this mode is enabled, Amazon Q Business generates\n responses only from data sources connected to an Amazon Q Business\n application.
\n CREATOR_MODE - By selecting this mode, users can choose to\n generate responses only from the LLM knowledge, without consulting connected\n data sources, for a chat request.
\n PLUGIN_MODE - By selecting this mode, users can choose to\n use plugins in chat.
For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.
" + } + }, + "chatModeConfiguration": { + "target": "com.amazonaws.qbusiness#ChatModeConfiguration", + "traits": { + "smithy.api#documentation": "The chat mode configuration for an Amazon Q Business application.
" } }, "clientToken": { @@ -1092,7 +1155,7 @@ "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q conversation.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business conversation.
" } }, "systemMessage": { @@ -1104,19 +1167,19 @@ "systemMessageId": { "target": "com.amazonaws.qbusiness#MessageId", "traits": { - "smithy.api#documentation": "The identifier of an Amazon Q AI generated message within the\n conversation.
" + "smithy.api#documentation": "The identifier of an Amazon Q Business AI generated message within the\n conversation.
" } }, "userMessageId": { "target": "com.amazonaws.qbusiness#MessageId", "traits": { - "smithy.api#documentation": "The identifier of an Amazon Q end user text input message within the\n conversation.
" + "smithy.api#documentation": "The identifier of an Amazon Q Business end user text input message within the\n conversation.
" } }, "actionReview": { "target": "com.amazonaws.qbusiness#ActionReview", "traits": { - "smithy.api#documentation": "A request from Amazon Q to the end user for information Amazon Q needs to\n successfully complete a requested plugin action.
" + "smithy.api#documentation": "A request from Amazon Q Business to the end user for information Amazon Q Business needs to\n successfully complete a requested plugin action.
" } }, "sourceAttributions": { @@ -1187,7 +1250,7 @@ } }, "traits": { - "smithy.api#documentation": "A rule for configuring how Amazon Q responds when it encounters a a blocked\n topic. You can configure a custom message to inform your end users that they have asked\n about a restricted topic and suggest any next steps they should take.
" + "smithy.api#documentation": "A rule for configuring how Amazon Q Business responds when it encounters a a blocked\n topic. You can configure a custom message to inform your end users that they have asked\n about a restricted topic and suggest any next steps they should take.
" } }, "com.amazonaws.qbusiness#ContentRetrievalRule": { @@ -1196,12 +1259,12 @@ "eligibleDataSources": { "target": "com.amazonaws.qbusiness#EligibleDataSources", "traits": { - "smithy.api#documentation": "Specifies data sources in a Amazon Q application to use for content\n generation.
" + "smithy.api#documentation": "Specifies data sources in a Amazon Q Business application to use for content\n generation.
" } } }, "traits": { - "smithy.api#documentation": "Rules for retrieving content from data sources connected to a Amazon Q\n application for a specific topic control configuration.
" + "smithy.api#documentation": "Rules for retrieving content from data sources connected to a Amazon Q Business\n application for a specific topic control configuration.
" } }, "com.amazonaws.qbusiness#ContentType": { @@ -1287,7 +1350,7 @@ "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q conversation.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business conversation.
" } }, "title": { @@ -1304,7 +1367,7 @@ } }, "traits": { - "smithy.api#documentation": "A conversation in an Amazon Q application.
" + "smithy.api#documentation": "A conversation in an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#ConversationId": { @@ -1366,7 +1429,7 @@ "kms:DescribeKey", "kms:CreateGrant" ], - "smithy.api#documentation": "Creates an Amazon Q application.
", + "smithy.api#documentation": "Creates an Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications", "method": "POST" @@ -1380,7 +1443,7 @@ "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { - "smithy.api#documentation": "A name for the Amazon Q application.
", + "smithy.api#documentation": "A name for the Amazon Q Business application.
", "smithy.api#required": {} } }, @@ -1391,29 +1454,35 @@ "smithy.api#required": {} } }, + "identityCenterInstanceArn": { + "target": "com.amazonaws.qbusiness#InstanceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either\n creating for—or connecting to—your Amazon Q Business application.
" + } + }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "A description for the Amazon Q application.
" + "smithy.api#documentation": "A description for the Amazon Q Business application.
" } }, "encryptionConfiguration": { "target": "com.amazonaws.qbusiness#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "The identifier of the KMS key that is used to encrypt your data.\n Amazon Q doesn't support asymmetric keys.
" + "smithy.api#documentation": "The identifier of the KMS key that is used to encrypt your data.\n Amazon Q Business doesn't support asymmetric keys.
" } }, "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "A list of key-value pairs that identify or categorize your Amazon Q application.\n You can also use tags to help control access to the application. Tag keys and values can\n consist of Unicode letters, digits, white space, and any of the following symbols: _ . :\n / = + - @.
" + "smithy.api#documentation": "A list of key-value pairs that identify or categorize your Amazon Q Business application.\n You can also use tags to help control access to the application. Tag keys and values can\n consist of Unicode letters, digits, white space, and any of the following symbols: _ . :\n / = + - @.
" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q\n application.
", + "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q Business\n application.
", "smithy.api#idempotencyToken": {} } }, @@ -1435,13 +1504,13 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
" } }, "applicationArn": { "target": "com.amazonaws.qbusiness#ApplicationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q application.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application.
" } } }, @@ -1487,7 +1556,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Creates a data source connector for an Amazon Q application.
\n\n CreateDataSource is a synchronous operation. The operation returns 200 if\n the data source was successfully created. Otherwise, an exception is raised.
Creates a data source connector for an Amazon Q Business application.
\n\n CreateDataSource is a synchronous operation. The operation returns 200 if\n the data source was successfully created. Otherwise, an exception is raised.
The identifier of the Amazon Q application the data source will be attached\n to.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application the data source will be attached\n to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1525,14 +1594,14 @@ "configuration": { "target": "com.amazonaws.qbusiness#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "Configuration information to connect to your data source repository. For configuration\n templates for your specific data source, see Supported\n connectors.
", + "smithy.api#documentation": "Configuration information to connect to your data source repository. For configuration\n templates for your specific data source, see Supported\n connectors.
", "smithy.api#required": {} } }, "vpcConfiguration": { "target": "com.amazonaws.qbusiness#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for an Amazon VPC (Virtual Private Cloud) to connect\n to your data source. For more information, see Using\n Amazon VPC with Amazon Q connectors.
" + "smithy.api#documentation": "Configuration information for an Amazon VPC (Virtual Private Cloud) to connect\n to your data source. For more information, see Using\n Amazon VPC with Amazon Q Business connectors.
" } }, "description": { @@ -1551,7 +1620,7 @@ "syncSchedule": { "target": "com.amazonaws.qbusiness#SyncSchedule", "traits": { - "smithy.api#documentation": "Sets the frequency for Amazon Q to check the documents in your data source\n repository and update your index. If you don't set a schedule, Amazon Q won't\n periodically update the index.
\nSpecify a cron- format schedule string or an empty string to indicate\n that the index is updated on demand. You can't specify the Schedule\n parameter when the Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
Sets the frequency for Amazon Q Business to check the documents in your data source\n repository and update your index. If you don't set a schedule, Amazon Q Business won't\n periodically update the index.
\nSpecify a cron- format schedule string or an empty string to indicate\n that the index is updated on demand. You can't specify the Schedule\n parameter when the Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
The Amazon Resource Name (ARN) of a data source in an Amazon Q application.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.\n
" } } }, @@ -1632,7 +1701,7 @@ "qbusiness:TagResource", "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "Creates an Amazon Q index.
\nTo determine if index creation has completed, check the Status field\n returned from a call to DescribeIndex. The Status field is set\n to ACTIVE when the index is ready to use.
Once the index is active, you can index your documents using the \n BatchPutDocument\n API or the \n CreateDataSource\n API.
Creates an Amazon Q Business index.
\nTo determine if index creation has completed, check the Status field\n returned from a call to DescribeIndex. The Status field is set\n to ACTIVE when the index is ready to use.
Once the index is active, you can index your documents using the \n BatchPutDocument\n API or the \n CreateDataSource\n API.
The identifier of the Amazon Q application using the index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1654,14 +1723,14 @@ "target": "com.amazonaws.qbusiness#IndexName", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "A name for the Amazon Q index.
", + "smithy.api#documentation": "A name for the Amazon Q Business index.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "A description for the Amazon Q index.
" + "smithy.api#documentation": "A description for the Amazon Q Business index.
" } }, "tags": { @@ -1695,13 +1764,13 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier for the Amazon Q index.
" + "smithy.api#documentation": "The identifier for the Amazon Q Business index.
" } }, "indexArn": { "target": "com.amazonaws.qbusiness#IndexArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Q index.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Q Business index.
" } } }, @@ -1747,7 +1816,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Creates an Amazon Q plugin.
", + "smithy.api#documentation": "Creates an Amazon Q Business plugin.
", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/plugins" @@ -1803,7 +1872,7 @@ "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q\n plugin.
", + "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q Business\n plugin.
", "smithy.api#idempotencyToken": {} } } @@ -1870,7 +1939,7 @@ "qbusiness:GetRetriever", "iam:PassRole" ], - "smithy.api#documentation": "Adds a retriever to your Amazon Q application.
", + "smithy.api#documentation": "Adds a retriever to your Amazon Q Business application.
", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/retrievers" @@ -1883,7 +1952,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of your Amazon Q application.
", + "smithy.api#documentation": "The identifier of your Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1912,13 +1981,13 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "The ARN of an IAM role used by Amazon Q to access the basic\n authentication credentials stored in a Secrets Manager secret.
" + "smithy.api#documentation": "The ARN of an IAM role used by Amazon Q Business to access the basic\n authentication credentials stored in a Secrets Manager secret.
" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q\n application retriever.
", + "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q Business\n application retriever.
", "smithy.api#idempotencyToken": {} } }, @@ -2025,7 +2094,7 @@ "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q user\n mapping.
", + "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q Business user\n mapping.
", "smithy.api#idempotencyToken": {} } } @@ -2079,7 +2148,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Creates an Amazon Q web experience.
", + "smithy.api#documentation": "Creates an Amazon Q Business web experience.
", "smithy.api#http": { "uri": "/applications/{applicationId}/experiences", "method": "POST" @@ -2092,7 +2161,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2100,19 +2169,19 @@ "title": { "target": "com.amazonaws.qbusiness#WebExperienceTitle", "traits": { - "smithy.api#documentation": "The title for your Amazon Q web experience.
" + "smithy.api#documentation": "The title for your Amazon Q Business web experience.
" } }, "subtitle": { "target": "com.amazonaws.qbusiness#WebExperienceSubtitle", "traits": { - "smithy.api#documentation": "A subtitle to personalize your Amazon Q web experience.
" + "smithy.api#documentation": "A subtitle to personalize your Amazon Q Business web experience.
" } }, "welcomeMessage": { "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", "traits": { - "smithy.api#documentation": "The customized welcome message for end users of an Amazon Q web\n experience.
" + "smithy.api#documentation": "The customized welcome message for end users of an Amazon Q Business web\n experience.
" } }, "samplePromptsControlMode": { @@ -2121,17 +2190,23 @@ "smithy.api#documentation": "Determines whether sample prompts are enabled in the web experience for an end\n user.
" } }, + "roleArn": { + "target": "com.amazonaws.qbusiness#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role attached to your web\n experience.
" + } + }, "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "A list of key-value pairs that identify or categorize your Amazon Q web\n experience. You can also use tags to help control access to the web experience. Tag keys\n and values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.
" + "smithy.api#documentation": "A list of key-value pairs that identify or categorize your Amazon Q Business web\n experience. You can also use tags to help control access to the web experience. Tag keys\n and values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.
" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token you provide to identify a request to create an Amazon Q web experience.\n
", + "smithy.api#documentation": "A token you provide to identify a request to create an Amazon Q Business web experience.\n
", "smithy.api#idempotencyToken": {} } } @@ -2146,13 +2221,13 @@ "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience.
" } }, "webExperienceArn": { "target": "com.amazonaws.qbusiness#WebExperienceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Q web experience.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
" } } }, @@ -2160,48 +2235,80 @@ "smithy.api#output": {} } }, + "com.amazonaws.qbusiness#CreatorModeConfiguration": { + "type": "structure", + "members": { + "creatorModeControl": { + "target": "com.amazonaws.qbusiness#CreatorModeControl", + "traits": { + "smithy.api#documentation": "Status information about whether CREATOR_MODE has been enabled or\n disabled. The default status is DISABLED.
Configuration information required to invoke chat in CREATOR_MODE.
For more information, see Admin controls and guardrails and Conversation settings.
" + } + }, + "com.amazonaws.qbusiness#CreatorModeControl": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.qbusiness#DataSource": { "type": "structure", "members": { "displayName": { "target": "com.amazonaws.qbusiness#DataSourceName", "traits": { - "smithy.api#documentation": "The name of the Amazon Q data source.
" + "smithy.api#documentation": "The name of the Amazon Q Business data source.
" } }, "dataSourceId": { "target": "com.amazonaws.qbusiness#DataSourceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q data source.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business data source.
" } }, "type": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "The type of the Amazon Q data source.
" + "smithy.api#documentation": "The type of the Amazon Q Business data source.
" } }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q data source was created.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business data source was created.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q data source was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business data source was last updated.
" } }, "status": { "target": "com.amazonaws.qbusiness#DataSourceStatus", "traits": { - "smithy.api#documentation": "The status of the Amazon Q data source.
" + "smithy.api#documentation": "The status of the Amazon Q Business data source.
" } } }, "traits": { - "smithy.api#documentation": "A data source in an Amazon Q application.
" + "smithy.api#documentation": "A data source in an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#DataSourceArn": { @@ -2217,7 +2324,7 @@ "com.amazonaws.qbusiness#DataSourceConfiguration": { "type": "document", "traits": { - "smithy.api#documentation": "Provides the configuration information for an Amazon Q data source.
" + "smithy.api#documentation": "Provides the configuration information for an Amazon Q Business data source.
" } }, "com.amazonaws.qbusiness#DataSourceId": { @@ -2374,7 +2481,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about an Amazon Q data source connector synchronization\n job.
" + "smithy.api#documentation": "Provides information about an Amazon Q Business data source connector synchronization\n job.
" } }, "com.amazonaws.qbusiness#DataSourceSyncJobMetrics": { @@ -2412,7 +2519,7 @@ } }, "traits": { - "smithy.api#documentation": "Maps a batch delete document request to a specific Amazon Q data source connector\n sync job.
" + "smithy.api#documentation": "Maps a batch delete document request to a specific Amazon Q Business data source connector\n sync job.
" } }, "com.amazonaws.qbusiness#DataSourceSyncJobStatus": { @@ -2491,7 +2598,7 @@ "securityGroupIds": { "target": "com.amazonaws.qbusiness#SecurityGroupIds", "traits": { - "smithy.api#documentation": "A list of identifiers of security groups within your Amazon VPC. The security\n groups should enable Amazon Q to connect to the data source.
", + "smithy.api#documentation": "A list of identifiers of security groups within your Amazon VPC. The security\n groups should enable Amazon Q Business to connect to the data source.
", "smithy.api#required": {} } } @@ -2524,7 +2631,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information on boosting DATE type document attributes.
For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.
" + "smithy.api#documentation": "Provides information on boosting DATE type document attributes.
For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.
" } }, "com.amazonaws.qbusiness#DeleteApplication": { @@ -2560,7 +2667,7 @@ "qbusiness:GetApplication", "kms:RetireGrant" ], - "smithy.api#documentation": "Deletes an Amazon Q application.
", + "smithy.api#documentation": "Deletes an Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications/{applicationId}", "method": "DELETE" @@ -2574,7 +2681,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2617,7 +2724,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes chat controls configured for an existing Amazon Q application.
", + "smithy.api#documentation": "Deletes chat controls configured for an existing Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications/{applicationId}/chatcontrols", "method": "DELETE", @@ -2678,7 +2785,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Amazon Q web experience conversation.
", + "smithy.api#documentation": "Deletes an Amazon Q Business web experience conversation.
", "smithy.api#http": { "uri": "/applications/{applicationId}/conversations/{conversationId}", "method": "DELETE" @@ -2692,7 +2799,7 @@ "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience conversation being deleted.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience conversation being deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2700,7 +2807,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application associated with the\n conversation.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application associated with the\n conversation.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2709,8 +2816,7 @@ "target": "com.amazonaws.qbusiness#UserId", "traits": { "smithy.api#documentation": "The identifier of the user who is deleting the conversation.
", - "smithy.api#httpQuery": "userId", - "smithy.api#required": {} + "smithy.api#httpQuery": "userId" } } }, @@ -2757,7 +2863,7 @@ "aws.iam#requiredActions": [ "qbusiness:GetDataSource" ], - "smithy.api#documentation": "Deletes an Amazon Q data source connector. While the data source is being\n deleted, the Status field returned by a call to the\n DescribeDataSource API is set to DELETING.
Deletes an Amazon Q Business data source connector. While the data source is being\n deleted, the Status field returned by a call to the\n DescribeDataSource API is set to DELETING.
The identifier of the Amazon Q application used with the data source\n connector.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application used with the data source\n connector.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2816,7 +2922,7 @@ } }, "traits": { - "smithy.api#documentation": "A document deleted from an Amazon Q data source connector.
" + "smithy.api#documentation": "A document deleted from an Amazon Q Business data source connector.
" } }, "com.amazonaws.qbusiness#DeleteDocuments": { @@ -2940,7 +3046,7 @@ "aws.iam#requiredActions": [ "qbusiness:GetIndex" ], - "smithy.api#documentation": "Deletes an Amazon Q index.
", + "smithy.api#documentation": "Deletes an Amazon Q Business index.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}", "method": "DELETE" @@ -2954,7 +3060,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application the Amazon Q index is linked\n to.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application the Amazon Q Business index is linked\n to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2962,7 +3068,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3011,7 +3117,7 @@ "aws.iam#requiredActions": [ "qbusiness:GetPlugin" ], - "smithy.api#documentation": "Deletes an Amazon Q plugin.
", + "smithy.api#documentation": "Deletes an Amazon Q Business plugin.
", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{applicationId}/plugins/{pluginId}" @@ -3025,7 +3131,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier the application attached to the Amazon Q plugin.
", + "smithy.api#documentation": "The identifier the application attached to the Amazon Q Business plugin.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3082,7 +3188,7 @@ "aws.iam#requiredActions": [ "qbusiness:GetRetriever" ], - "smithy.api#documentation": "Deletes the retriever used by an Amazon Q application.
", + "smithy.api#documentation": "Deletes the retriever used by an Amazon Q Business application.
", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{applicationId}/retrievers/{retrieverId}" @@ -3096,7 +3202,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application using the retriever.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the retriever.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3221,7 +3327,7 @@ "aws.iam#requiredActions": [ "qbusiness:GetWebExperience" ], - "smithy.api#documentation": "Deletes an Amazon Q web experience.
", + "smithy.api#documentation": "Deletes an Amazon Q Business web experience.
", "smithy.api#http": { "uri": "/applications/{applicationId}/experiences/{webExperienceId}", "method": "DELETE" @@ -3235,7 +3341,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the Amazon Q web\n experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the Amazon Q Business web\n experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3243,7 +3349,7 @@ "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience being deleted.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience being deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3283,7 +3389,7 @@ "attributes": { "target": "com.amazonaws.qbusiness#DocumentAttributes", "traits": { - "smithy.api#documentation": "Custom attributes to apply to the document for refining Amazon Q web experience\n responses.
" + "smithy.api#documentation": "Custom attributes to apply to the document for refining Amazon Q Business web experience\n responses.
" } }, "content": { @@ -3318,7 +3424,7 @@ } }, "traits": { - "smithy.api#documentation": "A document in an Amazon Q application.
" + "smithy.api#documentation": "A document in an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#DocumentAttribute": { @@ -3372,7 +3478,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information on boosting supported Amazon Q document attribute types.\n When an end user chat query matches document attributes that have been boosted,\n Amazon Q prioritizes generating responses from content that matches the boosted\n document attributes.
\nFor STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.
" + "smithy.api#documentation": "Provides information on boosting supported Amazon Q Business document attribute types.\n When an end user chat query matches document attributes that have been boosted,\n Amazon Q Business prioritizes generating responses from content that matches the boosted\n document attributes.
\nFor STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.
" } }, "com.amazonaws.qbusiness#DocumentAttributeBoostingLevel": { @@ -3430,7 +3536,7 @@ "key": { "target": "com.amazonaws.qbusiness#DocumentAttributeKey", "traits": { - "smithy.api#documentation": "The identifier of the document attribute used for the condition.
\nFor example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.
\nAmazon Q currently doesn't support _document_body as an attribute\n key used for the condition.
The identifier of the document attribute used for the condition.
\nFor example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.
\nAmazon Q Business currently doesn't support _document_body as an attribute\n key used for the condition.
The condition used for the target document attribute or metadata field when ingesting\n documents into Amazon Q. You use this with \n DocumentAttributeTarget\n to apply the condition.
For example, you can create the 'Department' target field and have it prefill\n department names associated with the documents based on information in the 'Source_URI'\n field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI\n value, then prefill the target field 'Department' with the target value 'Finance' for\n the document.
\nAmazon Q can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using DocumentAttributeTarget. Amazon Q then will map your newly\n created metadata field to your index field.
The condition used for the target document attribute or metadata field when ingesting\n documents into Amazon Q Business. You use this with \n DocumentAttributeTarget\n to apply the condition.
For example, you can create the 'Department' target field and have it prefill\n department names associated with the documents based on information in the 'Source_URI'\n field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI\n value, then prefill the target field 'Department' with the target value 'Finance' for\n the document.
\nAmazon Q Business can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using DocumentAttributeTarget. Amazon Q Business then will map your newly\n created metadata field to your index field.
The target document attribute or metadata field you want to alter when ingesting\n documents into Amazon Q.
\nFor example, you can delete all customer identification numbers associated with the\n documents, stored in the document metadata field called 'Customer_ID' by setting the\n target key as 'Customer_ID' and the deletion flag to TRUE. This removes all\n customer ID values in the field 'Customer_ID'. This would scrub personally identifiable\n information from each document's metadata.
Amazon Q can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using \n DocumentAttributeTarget\n . Amazon Q\n will then map your newly created document attribute to your index field.
You can also use this with \n DocumentAttributeCondition\n .
The target document attribute or metadata field you want to alter when ingesting\n documents into Amazon Q Business.
\nFor example, you can delete all customer identification numbers associated with the\n documents, stored in the document metadata field called 'Customer_ID' by setting the\n target key as 'Customer_ID' and the deletion flag to TRUE. This removes all\n customer ID values in the field 'Customer_ID'. This would scrub personally identifiable\n information from each document's metadata.
Amazon Q Business can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using \n DocumentAttributeTarget\n . Amazon Q Business\n will then map your newly created document attribute to your index field.
You can also use this with \n DocumentAttributeCondition\n .
The contents of the document. Documents passed to the blob parameter must\n be base64 encoded. Your code might not need to encode the document file bytes if you're\n using an Amazon Web Services SDK to call Amazon Q APIs. If you are calling the\n Amazon Q endpoint directly using REST, you must base64 encode the contents before\n sending.
The contents of the document. Documents passed to the blob parameter must\n be base64 encoded. Your code might not need to encode the document file bytes if you're\n using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the\n Amazon Q Business endpoint directly using REST, you must base64 encode the contents before\n sending.
The details of a document within an Amazon Q index.
" + "smithy.api#documentation": "The details of a document within an Amazon Q Business index.
" } }, "com.amazonaws.qbusiness#DocumentEnrichmentConditionOperator": { @@ -3734,7 +3840,7 @@ "inlineConfigurations": { "target": "com.amazonaws.qbusiness#InlineDocumentEnrichmentConfigurations", "traits": { - "smithy.api#documentation": "Configuration information to alter document attributes or metadata fields and content\n when ingesting documents into Amazon Q.
" + "smithy.api#documentation": "Configuration information to alter document attributes or metadata fields and content\n when ingesting documents into Amazon Q Business.
" } }, "preExtractionHookConfiguration": { @@ -3840,7 +3946,7 @@ } }, "traits": { - "smithy.api#documentation": "The identifier of the data source Amazon Q will generate responses from.
" + "smithy.api#documentation": "The identifier of the data source Amazon Q Business will generate responses from.
" } }, "com.amazonaws.qbusiness#EligibleDataSources": { @@ -3860,12 +3966,12 @@ "kmsKeyId": { "target": "com.amazonaws.qbusiness#KmsKeyId", "traits": { - "smithy.api#documentation": "The identifier of the KMS key. Amazon Q doesn't support asymmetric\n keys.
" + "smithy.api#documentation": "The identifier of the KMS key. Amazon Q Business doesn't support asymmetric\n keys.
" } } }, "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt data indexed by\n Amazon Q. Amazon Q doesn't support asymmetric keys.
" + "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt data indexed by\n Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
" } }, "com.amazonaws.qbusiness#ErrorCode": { @@ -4061,7 +4167,7 @@ "h2" ] }, - "smithy.api#documentation": "Amazon Q is in preview release and is subject to change.
\nThis is the Amazon Q (for business use) API Reference.\n Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that\n you can deploy within your organization. Amazon Q enhances employee productivity by\n supporting key tasks such as question-answering, knowledge discovery, writing email\n messages, summarizing text, drafting document outlines, and brainstorming ideas. Users\n ask questions of Amazon Q and get answers that are presented in a conversational\n manner. For an introduction to the service, see the \n Amazon Q (for business use) Developer\n Guide\n .
\nFor an overview of the Amazon Q APIs, see Overview of Amazon Q API operations.
\nFor information about the IAM access control permissions you need to\n use this API, see IAM roles for Amazon Q in the\n Amazon Q (for business use) Developer Guide.
\nYou can use the following AWS SDKs to access Amazon Q APIs:
\n\n AWS SDK for C++\n
\n\n AWS SDK for Go\n
\n\n AWS SDK for Java\n
\n\n AWS SDK for .NET\n
\n\n AWS SDK for Ruby\n
\nThe following resources provide additional information about using the Amazon Q\n API:
\n\n \n Setting up for\n Amazon Q\n \n
\n\n \n Amazon Q CLI Reference\n \n
\n\n \n Amazon Web Services General Reference\n \n
\nAmazon Q is in preview release and is subject to change.
\nThis is the Amazon Q Business API Reference. Amazon Q Business is a fully\n managed, generative-AI powered enterprise chat assistant that you can deploy within your\n organization. Amazon Q Business enhances employee productivity by supporting key tasks such\n as question-answering, knowledge discovery, writing email messages, summarizing text,\n drafting document outlines, and brainstorming ideas. Users ask questions of\n Amazon Q Business and get answers that are presented in a conversational manner. For an\n introduction to the service, see the \n Amazon Q Business User Guide\n .
\nFor an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.
\nFor information about the IAM access control permissions you need to\n use this API, see IAM roles for Amazon Q Business in the\n Amazon Q Business User Guide.
\nYou can use the following AWS SDKs to access Amazon Q Business APIs:
\n\n AWS SDK for C++\n
\n\n AWS SDK for Go\n
\n\n AWS SDK for Java\n
\n\n AWS SDK for .NET\n
\n\n AWS SDK for Ruby\n
\nThe following resources provide additional information about using the Amazon Q Business\n API:
\n\n \n Setting up for\n Amazon Q Business\n \n
\n\n \n Amazon Q Business CLI Reference\n \n
\n\n \n Amazon Web Services General Reference\n \n
\nThe identifier of the document that couldn't be removed from the Amazon Q\n index.
" + "smithy.api#documentation": "The identifier of the document that couldn't be removed from the Amazon Q Business\n index.
" } }, "error": { @@ -4449,12 +4555,12 @@ "dataSourceId": { "target": "com.amazonaws.qbusiness#DataSourceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q data source connector that contains the failed\n document.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business data source connector that contains the failed\n document.
" } } }, "traits": { - "smithy.api#documentation": "A list of documents that could not be removed from an Amazon Q index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.
" + "smithy.api#documentation": "A list of documents that could not be removed from an Amazon Q Business index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.
" } }, "com.amazonaws.qbusiness#FailedDocuments": { @@ -4492,7 +4598,7 @@ "aws.iam#requiredActions": [ "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "Gets information about an existing Amazon Q application.
", + "smithy.api#documentation": "Gets information about an existing Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications/{applicationId}", "method": "GET" @@ -4506,7 +4612,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4522,19 +4628,25 @@ "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { - "smithy.api#documentation": "The name of the Amazon Q application.
" + "smithy.api#documentation": "The name of the Amazon Q Business application.
" } }, "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
" } }, "applicationArn": { "target": "com.amazonaws.qbusiness#ApplicationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q application.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application.
" + } + }, + "identityCenterApplicationArn": { + "target": "com.amazonaws.qbusiness#IdcApplicationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to\n your Amazon Q Business application.
" } }, "roleArn": { @@ -4546,32 +4658,32 @@ "status": { "target": "com.amazonaws.qbusiness#ApplicationStatus", "traits": { - "smithy.api#documentation": "The status of the Amazon Q application.
" + "smithy.api#documentation": "The status of the Amazon Q Business application.
" } }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "A description for the Amazon Q application.
" + "smithy.api#documentation": "A description for the Amazon Q Business application.
" } }, "encryptionConfiguration": { "target": "com.amazonaws.qbusiness#EncryptionConfiguration", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "The identifier of the Amazon Web Services\n KMS key that is used to encrypt your data. Amazon Q doesn't support\n asymmetric keys.
" + "smithy.api#documentation": "The identifier of the Amazon Web Services\n KMS key that is used to encrypt your data. Amazon Q Business doesn't support\n asymmetric keys.
" } }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "error": { @@ -4619,7 +4731,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about an chat controls configured for an existing Amazon Q\n application.
", + "smithy.api#documentation": "Gets information about an chat controls configured for an existing Amazon Q Business\n application.
", "smithy.api#http": { "uri": "/applications/{applicationId}/chatcontrols", "method": "GET", @@ -4655,7 +4767,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q chat controls\n configured.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business chat controls\n configured.
The response scope configured for a Amazon Q application. This determines whether\n your application uses its retrieval augmented generation (RAG) system to generate\n answers only from your enterprise data, or also uses the large language models (LLM)\n knowledge to respons to end user questions in chat.
" + "smithy.api#documentation": "The response scope configured for a Amazon Q Business application. This determines whether\n your application uses its retrieval augmented generation (RAG) system to generate\n answers only from your enterprise data, or also uses the large language models (LLM)\n knowledge to respons to end user questions in chat.
" } }, "blockedPhrases": { @@ -4682,13 +4794,19 @@ "topicConfigurations": { "target": "com.amazonaws.qbusiness#TopicConfigurations", "traits": { - "smithy.api#documentation": "The topic specific controls configured for a Amazon Q application.
" + "smithy.api#documentation": "The topic specific controls configured for a Amazon Q Business application.
" + } + }, + "creatorModeConfiguration": { + "target": "com.amazonaws.qbusiness#AppliedCreatorModeConfiguration", + "traits": { + "smithy.api#documentation": "The configuration details for CREATOR_MODE.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q chat controls\n configured.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business chat controls\n configured.
Gets information about an existing Amazon Q data source connector.
", + "smithy.api#documentation": "Gets information about an existing Amazon Q Business data source connector.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", "method": "GET" @@ -4739,7 +4857,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4771,7 +4889,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
" } }, "indexId": { @@ -4843,7 +4961,7 @@ "syncSchedule": { "target": "com.amazonaws.qbusiness#SyncSchedule", "traits": { - "smithy.api#documentation": "The schedule for Amazon Q to update the index.
" + "smithy.api#documentation": "The schedule for Amazon Q Business to update the index.
" } }, "roleArn": { @@ -4992,7 +5110,7 @@ "aws.iam#requiredActions": [ "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "Gets information about an existing Amazon Q index.
", + "smithy.api#documentation": "Gets information about an existing Amazon Q Business index.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}", "method": "GET" @@ -5006,7 +5124,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application connected to the index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application connected to the index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5014,7 +5132,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index you want information on.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business index you want information on.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5030,25 +5148,25 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application associated with the index.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application associated with the index.
" } }, "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business index.
" } }, "displayName": { "target": "com.amazonaws.qbusiness#IndexName", "traits": { - "smithy.api#documentation": "The name of the Amazon Q index.
" + "smithy.api#documentation": "The name of the Amazon Q Business index.
" } }, "indexArn": { "target": "com.amazonaws.qbusiness#IndexArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q index.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business index.
" } }, "status": { @@ -5060,25 +5178,25 @@ "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "The description for the Amazon Q index.
" + "smithy.api#documentation": "The description for the Amazon Q Business index.
" } }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q index was created.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business index was created.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q index was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business index was last updated.
" } }, "capacityConfiguration": { "target": "com.amazonaws.qbusiness#IndexCapacityConfiguration", "traits": { - "smithy.api#documentation": "The storage capacity units chosen for your Amazon Q index.
" + "smithy.api#documentation": "The storage capacity units chosen for your Amazon Q Business index.
" } }, "documentAttributeConfigurations": { @@ -5134,7 +5252,7 @@ "aws.iam#requiredActions": [ "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "Gets information about an existing Amazon Q plugin.
", + "smithy.api#documentation": "Gets information about an existing Amazon Q Business plugin.
", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/plugins/{pluginId}" @@ -5260,7 +5378,7 @@ "aws.iam#requiredActions": [ "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "Gets information about an existing retriever used by an Amazon Q\n application.
", + "smithy.api#documentation": "Gets information about an existing retriever used by an Amazon Q Business\n application.
", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/retrievers/{retrieverId}" @@ -5274,7 +5392,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application using the retriever.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the retriever.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5298,7 +5416,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application using the retriever.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the retriever.
" } }, "retrieverId": { @@ -5461,7 +5579,7 @@ "aws.iam#requiredActions": [ "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "Gets information about an existing Amazon Q web experience.
", + "smithy.api#documentation": "Gets information about an existing Amazon Q Business web experience.
", "smithy.api#http": { "uri": "/applications/{applicationId}/experiences/{webExperienceId}", "method": "GET" @@ -5475,7 +5593,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the web experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the web experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5483,7 +5601,7 @@ "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5499,31 +5617,31 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the web experience.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the web experience.
" } }, "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience.
" } }, "webExperienceArn": { "target": "com.amazonaws.qbusiness#WebExperienceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role with the permission to access the\n Amazon Q web experience and required resources.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role with the permission to access the\n Amazon Q Business web experience and required resources.
" } }, "defaultEndpoint": { "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#documentation": "The endpoint of your Amazon Q web experience.
" + "smithy.api#documentation": "The endpoint of your Amazon Q Business web experience.
" } }, "status": { "target": "com.amazonaws.qbusiness#WebExperienceStatus", "traits": { - "smithy.api#documentation": "The current status of the Amazon Q web experience. When the Status\n field value is FAILED, the ErrorMessage field contains a\n description of the error that caused the data source connector to fail.
The current status of the Amazon Q Business web experience. When the Status\n field value is FAILED, the ErrorMessage field contains a\n description of the error that caused the data source connector to fail.
The title for your Amazon Q web experience.
" + "smithy.api#documentation": "The title for your Amazon Q Business web experience.
" } }, "subtitle": { "target": "com.amazonaws.qbusiness#WebExperienceSubtitle", "traits": { - "smithy.api#documentation": "The subtitle for your Amazon Q web experience.
" + "smithy.api#documentation": "The subtitle for your Amazon Q Business web experience.
" } }, "welcomeMessage": { "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", "traits": { - "smithy.api#documentation": "The customized welcome message for end users of an Amazon Q web\n experience.
" + "smithy.api#documentation": "The customized welcome message for end users of an Amazon Q Business web\n experience.
" } }, "samplePromptsControlMode": { @@ -5562,10 +5680,16 @@ "smithy.api#documentation": "Determines whether sample prompts are enabled in the web experience for an end\n user.
" } }, + "roleArn": { + "target": "com.amazonaws.qbusiness#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role attached to your web\n experience.
" + } + }, "authenticationConfiguration": { "target": "com.amazonaws.qbusiness#WebExperienceAuthConfiguration", "traits": { - "smithy.api#documentation": "The authentication configuration information for your Amazon Q web\n experience.
" + "smithy.api#documentation": "The authentication configuration information for your Amazon Q Business web\n experience.
" } }, "error": { @@ -5597,7 +5721,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of users or sub groups that belong to a group. This is for generating\n Amazon Q chat results only from document a user has access to.
" + "smithy.api#documentation": "A list of users or sub groups that belong to a group. This is for generating\n Amazon Q Business chat results only from document a user has access to.
" } }, "com.amazonaws.qbusiness#GroupName": { @@ -5657,7 +5781,7 @@ "lastUpdatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "errorDetail": { @@ -5703,7 +5827,7 @@ "invocationCondition": { "target": "com.amazonaws.qbusiness#DocumentAttributeCondition", "traits": { - "smithy.api#documentation": "The condition used for when a Lambda function should be invoked.
\nFor example, you can specify a condition that if there are empty date-time values,\n then Amazon Q should invoke a function that inserts the current date-time.
" + "smithy.api#documentation": "The condition used for when a Lambda function should be invoked.
\nFor example, you can specify a condition that if there are empty date-time values,\n then Amazon Q Business should invoke a function that inserts the current date-time.
" } }, "lambdaArn": { @@ -5726,7 +5850,17 @@ } }, "traits": { - "smithy.api#documentation": "Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q.
\nYou can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on\n the original or raw documents.
\nIf you want to apply advanced alterations on the Amazon Q structured documents,\n you must configure your Lambda function using PostExtractionHookConfiguration.
\nYou can only invoke one Lambda function. However, this function can invoke\n other functions it requires.
\nFor more information, see Custom document enrichment.
" + "smithy.api#documentation": "Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q Business.
\nYou can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on\n the original or raw documents.
\nIf you want to apply advanced alterations on the Amazon Q Business structured documents,\n you must configure your Lambda function using PostExtractionHookConfiguration.
\nYou can only invoke one Lambda function. However, this function can invoke\n other functions it requires.
\nFor more information, see Custom document enrichment.
" + } + }, + "com.amazonaws.qbusiness#IdcApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" } }, "com.amazonaws.qbusiness#Index": { @@ -5764,7 +5898,7 @@ } }, "traits": { - "smithy.api#documentation": "Summary information for your Amazon Q index.
" + "smithy.api#documentation": "Summary information for your Amazon Q Business index.
" } }, "com.amazonaws.qbusiness#IndexArn": { @@ -5783,7 +5917,7 @@ "units": { "target": "com.amazonaws.qbusiness#IndexCapacityInteger", "traits": { - "smithy.api#documentation": "The number of storage units configured for an Amazon Q index.
" + "smithy.api#documentation": "The number of storage units configured for an Amazon Q Business index.
" } } }, @@ -5943,7 +6077,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the configuration information for applying basic logic to alter document\n metadata and content when ingesting documents into Amazon Q.
\nTo apply advanced logic, to go beyond what you can do with basic logic, see \n HookConfiguration\n .
For more information, see Custom document enrichment.
" + "smithy.api#documentation": "Provides the configuration information for applying basic logic to alter document\n metadata and content when ingesting documents into Amazon Q Business.
\nTo apply advanced logic, to go beyond what you can do with basic logic, see \n HookConfiguration\n .
For more information, see Custom document enrichment.
" } }, "com.amazonaws.qbusiness#InlineDocumentEnrichmentConfigurations": { @@ -5958,6 +6092,16 @@ } } }, + "com.amazonaws.qbusiness#InstanceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + } + }, "com.amazonaws.qbusiness#Integer": { "type": "integer" }, @@ -5972,7 +6116,7 @@ } }, "traits": { - "smithy.api#documentation": "An issue occurred with the internal server used for your Amazon Q service. Wait\n some minutes and try again, or contact Support for help.
", + "smithy.api#documentation": "An issue occurred with the internal server used for your Amazon Q Business service. Wait\n some minutes and try again, or contact Support for help.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -6061,7 +6205,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists Amazon Q applications.
", + "smithy.api#documentation": "Lists Amazon Q Business applications.
", "smithy.api#http": { "uri": "/applications", "method": "GET" @@ -6081,14 +6225,14 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q applications.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business applications.
The maximum number of Amazon Q applications to return.
", + "smithy.api#documentation": "The maximum number of Amazon Q Business applications to return.
", "smithy.api#httpQuery": "maxResults" } } @@ -6103,13 +6247,13 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Q returns this token. You can use this token\n in a subsequent request to retrieve the next set of applications.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token. You can use this token\n in a subsequent request to retrieve the next set of applications.
" } }, "applications": { "target": "com.amazonaws.qbusiness#Applications", "traits": { - "smithy.api#documentation": "An array of summary information on the configuration of one or more Amazon Q\n applications.
" + "smithy.api#documentation": "An array of summary information on the configuration of one or more Amazon Q Business\n applications.
" } } }, @@ -6146,7 +6290,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists one or more Amazon Q conversations.
", + "smithy.api#documentation": "Lists one or more Amazon Q Business conversations.
", "smithy.api#http": { "uri": "/applications/{applicationId}/conversations", "method": "GET" @@ -6166,7 +6310,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6174,22 +6318,21 @@ "userId": { "target": "com.amazonaws.qbusiness#UserId", "traits": { - "smithy.api#documentation": "The identifier of the user involved in the Amazon Q web experience conversation.\n
", - "smithy.api#httpQuery": "userId", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the user involved in the Amazon Q Business web experience conversation.\n
", + "smithy.api#httpQuery": "userId" } }, "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q conversations.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business conversations.
The maximum number of Amazon Q conversations to return.
", + "smithy.api#documentation": "The maximum number of Amazon Q Business conversations to return.
", "smithy.api#httpQuery": "maxResults" } } @@ -6204,13 +6347,13 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of messages.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of messages.
" } }, "conversations": { "target": "com.amazonaws.qbusiness#Conversations", "traits": { - "smithy.api#documentation": "An array of summary information on the configuration of one or more Amazon Q web\n experiences.
" + "smithy.api#documentation": "An array of summary information on the configuration of one or more Amazon Q Business web\n experiences.
" } } }, @@ -6244,7 +6387,7 @@ } ], "traits": { - "smithy.api#documentation": "Get information about an Amazon Q data source connector synchronization.
", + "smithy.api#documentation": "Get information about an Amazon Q Business data source connector synchronization.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs", "method": "GET" @@ -6272,7 +6415,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application connected to the data source.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application connected to the data source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6280,7 +6423,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index used with the Amazon Q data source connector.
", + "smithy.api#documentation": "The identifier of the index used with the Amazon Q Business data source connector.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6288,7 +6431,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incpmplete because there is more data to\n retriever, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of responses.
If the maxResults response was incpmplete because there is more data to\n retriever, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of responses.
If the response is truncated, Amazon Q returns this token. You can use this token\n in any subsequent request to retrieve the next set of jobs.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token. You can use this token\n in any subsequent request to retrieve the next set of jobs.
" } } }, @@ -6371,7 +6514,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Amazon Q data source connectors that you have created.
", + "smithy.api#documentation": "Lists the Amazon Q Business data source connectors that you have created.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources", "method": "GET" @@ -6391,7 +6534,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the data source\n connectors.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the data source\n connectors.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6407,7 +6550,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q data source\n connectors.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business data source\n connectors.
If the response is truncated, Amazon Q returns this token. You can use this token\n in a subsequent request to retrieve the next set of data source connectors.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token. You can use this token\n in a subsequent request to retrieve the next set of data source connectors.
" } } }, @@ -6512,7 +6655,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.
If the previous response was incomplete (because there is more data to retrieve),\n Amazon Q returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of groups that are mapped to users.
", + "smithy.api#documentation": "If the previous response was incomplete (because there is more data to retrieve),\n Amazon Q Business returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of groups that are mapped to users.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6650,7 +6793,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Q returns this token that you can use in the\n subsequent request to retrieve the next set of groups that are mapped to users.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token that you can use in the\n subsequent request to retrieve the next set of groups that are mapped to users.
" } }, "items": { @@ -6690,7 +6833,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Amazon Q indices you have created.
", + "smithy.api#documentation": "Lists the Amazon Q Business indices you have created.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices", "method": "GET" @@ -6710,7 +6853,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application connected to the index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application connected to the index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6718,7 +6861,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to retrieve,\n Amazon Q returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of Amazon Q indices.
", + "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to retrieve,\n Amazon Q Business returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of Amazon Q Business indices.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6740,7 +6883,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Q returns this token that you can use in the\n subsequent request to retrieve the next set of indexes.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token that you can use in the\n subsequent request to retrieve the next set of indexes.
" } }, "indices": { @@ -6783,7 +6926,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of messages associated with an Amazon Q web experience.
", + "smithy.api#documentation": "Gets a list of messages associated with an Amazon Q Business web experience.
", "smithy.api#http": { "uri": "/applications/{applicationId}/conversations/{conversationId}", "method": "GET" @@ -6803,7 +6946,7 @@ "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience conversation.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience conversation.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6811,7 +6954,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier for the Amazon Q application.
", + "smithy.api#documentation": "The identifier for the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6819,15 +6962,14 @@ "userId": { "target": "com.amazonaws.qbusiness#UserId", "traits": { - "smithy.api#documentation": "The identifier of the user involved in the Amazon Q web experience\n conversation.
", - "smithy.api#httpQuery": "userId", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the user involved in the Amazon Q Business web experience\n conversation.
", + "smithy.api#httpQuery": "userId" } }, "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the number of retrievers returned exceeds maxResults, Amazon Q\n returns a next token as a pagination token to retrieve the next set of messages.
If the number of retrievers returned exceeds maxResults, Amazon Q Business\n returns a next token as a pagination token to retrieve the next set of messages.
If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of messages.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of messages.
" } } }, @@ -6889,7 +7031,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists configured Amazon Q plugins.
", + "smithy.api#documentation": "Lists configured Amazon Q Business plugins.
", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/plugins" @@ -6917,7 +7059,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.
Lists the retriever used by an Amazon Q application.
", + "smithy.api#documentation": "Lists the retriever used by an Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications/{applicationId}/retrievers", "method": "GET" @@ -6999,7 +7141,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application using the retriever.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the retriever.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7007,7 +7149,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the number of retrievers returned exceeds maxResults, Amazon Q\n returns a next token as a pagination token to retrieve the next set of\n retrievers.
If the number of retrievers returned exceeds maxResults, Amazon Q Business\n returns a next token as a pagination token to retrieve the next set of\n retrievers.
If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of retrievers.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of retrievers.
" } } }, @@ -7069,7 +7211,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of tags associated with a specified resource. Amazon Q applications\n and data sources can have tags associated with them.
", + "smithy.api#documentation": "Gets a list of tags associated with a specified resource. Amazon Q Business applications\n and data sources can have tags associated with them.
", "smithy.api#http": { "uri": "/v1/tags/{resourceARN}", "method": "GET" @@ -7083,7 +7225,7 @@ "resourceARN": { "target": "com.amazonaws.qbusiness#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q application or data source to get\n a list of tags for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get\n a list of tags for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7099,7 +7241,7 @@ "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { - "smithy.api#documentation": "A list of tags associated with the Amazon Q application or data source.
" + "smithy.api#documentation": "A list of tags associated with the Amazon Q Business application or data source.
" } } }, @@ -7133,7 +7275,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists one or more Amazon Q Web Experiences.
", + "smithy.api#documentation": "Lists one or more Amazon Q Business Web Experiences.
", "smithy.api#http": { "uri": "/applications/{applicationId}/experiences", "method": "GET" @@ -7153,7 +7295,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the listed web\n experiences.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the listed web\n experiences.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7161,14 +7303,14 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q conversations.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business conversations.
The maximum number of Amazon Q Web Experiences to return.
", + "smithy.api#documentation": "The maximum number of Amazon Q Business Web Experiences to return.
", "smithy.api#httpQuery": "maxResults" } } @@ -7183,13 +7325,13 @@ "webExperiences": { "target": "com.amazonaws.qbusiness#WebExperiences", "traits": { - "smithy.api#documentation": "An array of summary information for one or more Amazon Q experiences.
" + "smithy.api#documentation": "An array of summary information for one or more Amazon Q Business experiences.
" } }, "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of messages.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of messages.
" } } }, @@ -7414,37 +7556,37 @@ "messageId": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience message.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience message.
" } }, "body": { "target": "com.amazonaws.qbusiness#MessageBody", "traits": { - "smithy.api#documentation": "The content of the Amazon Q web experience message.
" + "smithy.api#documentation": "The content of the Amazon Q Business web experience message.
" } }, "time": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp of the first Amazon Q web experience message.
" + "smithy.api#documentation": "The timestamp of the first Amazon Q Business web experience message.
" } }, "type": { "target": "com.amazonaws.qbusiness#MessageType", "traits": { - "smithy.api#documentation": "The type of Amazon Q message, whether HUMAN or AI\n generated.
The type of Amazon Q Business message, whether HUMAN or AI\n generated.
A file directly uploaded into an Amazon Q web experience chat.
" + "smithy.api#documentation": "A file directly uploaded into an Amazon Q Business web experience chat.
" } }, "sourceAttribution": { "target": "com.amazonaws.qbusiness#SourceAttributions", "traits": { - "smithy.api#documentation": "The source documents used to generate Amazon Q web experience message.
" + "smithy.api#documentation": "The source documents used to generate Amazon Q Business web experience message.
" } }, "actionReview": { @@ -7455,7 +7597,7 @@ } }, "traits": { - "smithy.api#documentation": "A message in an Amazon Q web experience.
" + "smithy.api#documentation": "A message in an Amazon Q Business web experience.
" } }, "com.amazonaws.qbusiness#MessageBody": { @@ -7651,19 +7793,19 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier for the Amazon Q index.
", + "smithy.api#documentation": "The identifier for the Amazon Q Business index.
", "smithy.api#required": {} } }, "boostingOverride": { "target": "com.amazonaws.qbusiness#DocumentAttributeBoostingOverrideMap", "traits": { - "smithy.api#documentation": "Overrides the default boosts applied by Amazon Q to supported document attribute\n data types.
" + "smithy.api#documentation": "Overrides the default boosts applied by Amazon Q Business to supported document attribute\n data types.
" } } }, "traits": { - "smithy.api#documentation": "Configuration information for an Amazon Q index.
" + "smithy.api#documentation": "Configuration information for an Amazon Q Business index.
" } }, "com.amazonaws.qbusiness#NextToken": { @@ -7693,7 +7835,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information on boosting NUMBER type document attributes.
For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.
" + "smithy.api#documentation": "Provides information on boosting NUMBER type document attributes.
For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.
" } }, "com.amazonaws.qbusiness#NumberAttributeBoostingType": { @@ -7726,7 +7868,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "The ARN of an IAM role used by Amazon Q to access the OAuth 2.0\n authentication credentials stored in a Secrets Manager secret.
", + "smithy.api#documentation": "The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0\n authentication credentials stored in a Secrets Manager secret.
", "smithy.api#required": {} } } @@ -7782,7 +7924,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about an Amazon Q plugin and its configuration.
" + "smithy.api#documentation": "Information about an Amazon Q Business plugin and its configuration.
" } }, "com.amazonaws.qbusiness#PluginArn": { @@ -7812,7 +7954,22 @@ } }, "traits": { - "smithy.api#documentation": "Authentication configuration information for an Amazon Q plugin.
" + "smithy.api#documentation": "Authentication configuration information for an Amazon Q Business plugin.
" + } + }, + "com.amazonaws.qbusiness#PluginConfiguration": { + "type": "structure", + "members": { + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "The identifier of the plugin you want to use.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information required to invoke chat in PLUGIN_MODE.
For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.
" } }, "com.amazonaws.qbusiness#PluginId": { @@ -7935,7 +8092,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides user and group information used for filtering documents to use for generating\n Amazon Q conversation responses.
" + "smithy.api#documentation": "Provides user and group information used for filtering documents to use for generating\n Amazon Q Business conversation responses.
" } }, "com.amazonaws.qbusiness#PrincipalGroup": { @@ -8024,7 +8181,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables your end user to to provide feedback on their Amazon Q generated chat\n responses.
", + "smithy.api#documentation": "Enables your end user to provide feedback on their Amazon Q Business generated chat\n responses.
", "smithy.api#http": { "uri": "/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/feedback", "method": "POST" @@ -8046,8 +8203,7 @@ "target": "com.amazonaws.qbusiness#UserId", "traits": { "smithy.api#documentation": "The identifier of the user giving the feedback.
", - "smithy.api#httpQuery": "userId", - "smithy.api#required": {} + "smithy.api#httpQuery": "userId" } }, "conversationId": { @@ -8115,7 +8271,7 @@ } ], "traits": { - "smithy.api#documentation": "Create, or updates, a mapping of users—who have access to a document—to\n groups.
\nYou can also map sub groups to groups. For example, the group \"Company Intellectual\n Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups\n include their own list of users or people who work in these teams. Only users who work\n in research and engineering, and therefore belong in the intellectual property group,\n can see top-secret company documents in their Amazon Q chat results.
", + "smithy.api#documentation": "Create, or updates, a mapping of users—who have access to a document—to\n groups.
\nYou can also map sub groups to groups. For example, the group \"Company Intellectual\n Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups\n include their own list of users or people who work in these teams. Only users who work\n in research and engineering, and therefore belong in the intellectual property group,\n can see top-secret company documents in their Amazon Q Business chat results.
", "smithy.api#http": { "method": "PUT", "uri": "/applications/{applicationId}/indices/{indexId}/groups" @@ -8251,13 +8407,13 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application using the retriever.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the retriever.
" } }, "retrieverId": { "target": "com.amazonaws.qbusiness#RetrieverId", "traits": { - "smithy.api#documentation": "The identifier of the retriever used by your Amazon Q application.
" + "smithy.api#documentation": "The identifier of the retriever used by your Amazon Q Business application.
" } }, "type": { @@ -8280,7 +8436,7 @@ } }, "traits": { - "smithy.api#documentation": "Summary information for the retriever used for your Amazon Q application.
" + "smithy.api#documentation": "Summary information for the retriever used for your Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#RetrieverArn": { @@ -8299,18 +8455,18 @@ "nativeIndexConfiguration": { "target": "com.amazonaws.qbusiness#NativeIndexConfiguration", "traits": { - "smithy.api#documentation": "Provides information on how a Amazon Q index used as a retriever for your\n Amazon Q application is configured.
" + "smithy.api#documentation": "Provides information on how a Amazon Q Business index used as a retriever for your\n Amazon Q Business application is configured.
" } }, "kendraIndexConfiguration": { "target": "com.amazonaws.qbusiness#KendraIndexConfiguration", "traits": { - "smithy.api#documentation": "Provides information on how the Amazon Kendra index used as a retriever for your\n Amazon Q application is configured.
" + "smithy.api#documentation": "Provides information on how the Amazon Kendra index used as a retriever for your\n Amazon Q Business application is configured.
" } } }, "traits": { - "smithy.api#documentation": "Provides information on how the retriever used for your Amazon Q application is\n configured.
" + "smithy.api#documentation": "Provides information on how the retriever used for your Amazon Q Business application is\n configured.
" } }, "com.amazonaws.qbusiness#RetrieverId": { @@ -8450,7 +8606,7 @@ } }, "traits": { - "smithy.api#documentation": "Guardrail rules for an Amazon Q application. Amazon Q supports only one rule\n at a time.
" + "smithy.api#documentation": "Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule\n at a time.
" } }, "com.amazonaws.qbusiness#RuleConfiguration": { @@ -8459,7 +8615,7 @@ "contentBlockerRule": { "target": "com.amazonaws.qbusiness#ContentBlockerRule", "traits": { - "smithy.api#documentation": "A rule for configuring how Amazon Q responds when it encounters a a blocked\n topic.
" + "smithy.api#documentation": "A rule for configuring how Amazon Q Business responds when it encounters a a blocked\n topic.
" } }, "contentRetrievalRule": { @@ -8517,7 +8673,7 @@ } }, "traits": { - "smithy.api#documentation": "Information required for Amazon Q to find a specific file in an Amazon S3\n bucket.
" + "smithy.api#documentation": "Information required for Amazon Q Business to find a specific file in an Amazon S3\n bucket.
" } }, "com.amazonaws.qbusiness#S3BucketName": { @@ -8561,7 +8717,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role assumed by users when\n they authenticate into their Amazon Q web experience, containing the relevant\n Amazon Q permissions for conversing with Amazon Q.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role assumed by users when\n they authenticate into their Amazon Q Business web experience, containing the relevant\n Amazon Q Business permissions for conversing with Amazon Q Business.
", "smithy.api#required": {} } }, @@ -8580,7 +8736,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the SAML 2.0 compliant identity provider (IdP) configuration information\n Amazon Q needs to deploy a Amazon Q web experience.
" + "smithy.api#documentation": "Provides the SAML 2.0 compliant identity provider (IdP) configuration information\n Amazon Q Business needs to deploy a Amazon Q Business web experience.
" } }, "com.amazonaws.qbusiness#SamlMetadataXML": { @@ -8651,7 +8807,7 @@ } }, "traits": { - "smithy.api#documentation": "You have exceeded the set limits for your Amazon Q service.
", + "smithy.api#documentation": "You have exceeded the set limits for your Amazon Q Business service.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -8662,7 +8818,7 @@ "title": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "The title of the document which is the source for the Amazon Q generated\n response.
" + "smithy.api#documentation": "The title of the document which is the source for the Amazon Q Business generated\n response.
" } }, "snippet": { @@ -8674,19 +8830,19 @@ "url": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "The URL of the document which is the source for the Amazon Q generated response.\n
" + "smithy.api#documentation": "The URL of the document which is the source for the Amazon Q Business generated response.\n
" } }, "citationNumber": { "target": "com.amazonaws.qbusiness#Integer", "traits": { - "smithy.api#documentation": "The number attached to a citation in an Amazon Q generated response.
" + "smithy.api#documentation": "The number attached to a citation in an Amazon Q Business generated response.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "textMessageSegments": { @@ -8697,7 +8853,7 @@ } }, "traits": { - "smithy.api#documentation": "The documents used to generate an Amazon Q web experience response.
" + "smithy.api#documentation": "The documents used to generate an Amazon Q Business web experience response.
" } }, "com.amazonaws.qbusiness#SourceAttributions": { @@ -8741,7 +8897,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a data source connector synchronization job. If a synchronization job is\n already in progress, Amazon Q returns a ConflictException.
Starts a data source connector synchronization job. If a synchronization job is\n already in progress, Amazon Q Business returns a ConflictException.
The identifier of Amazon Q application the data source is connected to.
", + "smithy.api#documentation": "The identifier of Amazon Q Business application the data source is connected to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8837,7 +8993,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops an Amazon Q data source connector synchronization job already in\n progress.
", + "smithy.api#documentation": "Stops an Amazon Q Business data source connector synchronization job already in\n progress.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/stopsync", "method": "POST" @@ -8858,7 +9014,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application that the data source is connected\n to.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application that the data source is connected\n to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8866,7 +9022,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index used with the Amazon Q data source connector.
", + "smithy.api#documentation": "The identifier of the index used with the Amazon Q Business data source connector.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8910,7 +9066,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information on boosting STRING type document attributes.
For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.
" + "smithy.api#documentation": "Provides information on boosting STRING type document attributes.
For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.
" } }, "com.amazonaws.qbusiness#StringAttributeValueBoosting": { @@ -8969,7 +9125,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information on boosting STRING_LIST type document\n attributes.
For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.
" + "smithy.api#documentation": "Provides information on boosting STRING_LIST type document\n attributes.
For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.
" } }, "com.amazonaws.qbusiness#SubnetId": { @@ -9022,7 +9178,7 @@ "key": { "target": "com.amazonaws.qbusiness#TagKey", "traits": { - "smithy.api#documentation": "The key for the tag. Keys are not case sensitive and must be unique for the\n Amazon Q application or data source.
", + "smithy.api#documentation": "The key for the tag. Keys are not case sensitive and must be unique for the\n Amazon Q Business application or data source.
", "smithy.api#required": {} } }, @@ -9088,7 +9244,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds the specified tag to the specified Amazon Q application or data source\n resource. If the tag already exists, the existing value is replaced with the new\n value.
", + "smithy.api#documentation": "Adds the specified tag to the specified Amazon Q Business application or data source\n resource. If the tag already exists, the existing value is replaced with the new\n value.
", "smithy.api#http": { "uri": "/v1/tags/{resourceARN}", "method": "POST" @@ -9102,7 +9258,7 @@ "resourceARN": { "target": "com.amazonaws.qbusiness#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q application or data source to\n tag.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to\n tag.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9110,7 +9266,7 @@ "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { - "smithy.api#documentation": "A list of tag keys to add to the Amazon Q application or data source. If a tag\n already exists, the existing value is replaced with the new value.
", + "smithy.api#documentation": "A list of tag keys to add to the Amazon Q Business application or data source. If a tag\n already exists, the existing value is replaced with the new value.
", "smithy.api#required": {} } } @@ -9252,7 +9408,7 @@ } }, "traits": { - "smithy.api#documentation": "The topic specific controls configured for an Amazon Q application.
" + "smithy.api#documentation": "The topic specific controls configured for an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#TopicConfigurationName": { @@ -9312,7 +9468,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes a tag from an Amazon Q application or a data source.
", + "smithy.api#documentation": "Removes a tag from an Amazon Q Business application or a data source.
", "smithy.api#http": { "uri": "/v1/tags/{resourceARN}", "method": "DELETE" @@ -9326,7 +9482,7 @@ "resourceARN": { "target": "com.amazonaws.qbusiness#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q application, or data source to\n remove the tag from.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to\n remove the tag from.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9334,7 +9490,7 @@ "tagKeys": { "target": "com.amazonaws.qbusiness#TagKeys", "traits": { - "smithy.api#documentation": "A list of tag keys to remove from the Amazon Q application or data source. If a\n tag key does not exist on the resource, it is ignored.
", + "smithy.api#documentation": "A list of tag keys to remove from the Amazon Q Business application or data source. If a\n tag key does not exist on the resource, it is ignored.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -9387,7 +9543,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Updates an existing Amazon Q application.
", + "smithy.api#documentation": "Updates an existing Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications/{applicationId}", "method": "PUT" @@ -9401,7 +9557,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9409,19 +9565,19 @@ "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { - "smithy.api#documentation": "A name for the Amazon Q application.
" + "smithy.api#documentation": "A name for the Amazon Q Business application.
" } }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "A description for the Amazon Q application.
" + "smithy.api#documentation": "A description for the Amazon Q Business application.
" } }, "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "An Amazon Web Services Identity and Access Management (IAM) role that\n gives Amazon Q permission to access Amazon CloudWatch logs and\n metrics.
" + "smithy.api#documentation": "An Amazon Web Services Identity and Access Management (IAM) role that\n gives Amazon Q Business permission to access Amazon CloudWatch logs and\n metrics.
" } }, "attachmentsConfiguration": { @@ -9474,7 +9630,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an set of chat controls configured for an existing Amazon Q\n application.
", + "smithy.api#documentation": "Updates an set of chat controls configured for an existing Amazon Q Business\n application.
", "smithy.api#http": { "uri": "/applications/{applicationId}/chatcontrols", "method": "PATCH", @@ -9497,7 +9653,7 @@ "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to update a Amazon Q application\n chat configuration.
", + "smithy.api#documentation": "A token that you provide to identify the request to update a Amazon Q Business application\n chat configuration.
", "smithy.api#idempotencyToken": {} } }, @@ -9524,6 +9680,12 @@ "traits": { "smithy.api#documentation": "The configured topic specific chat controls you want to delete.
" } + }, + "creatorModeConfiguration": { + "target": "com.amazonaws.qbusiness#CreatorModeConfiguration", + "traits": { + "smithy.api#documentation": "The configuration details for CREATOR_MODE.
Updates an existing Amazon Q data source connector.
", + "smithy.api#documentation": "Updates an existing Amazon Q Business data source connector.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", "method": "PUT" @@ -9587,7 +9749,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application the data source is attached\n to.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application the data source is attached\n to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9691,7 +9853,7 @@ "qbusiness:UntagResource", "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "Updates an Amazon Q index.
", + "smithy.api#documentation": "Updates an Amazon Q Business index.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}", "method": "PUT" @@ -9705,7 +9867,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application connected to the index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application connected to the index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9713,7 +9875,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9721,19 +9883,19 @@ "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { - "smithy.api#documentation": "The name of the Amazon Q index.
" + "smithy.api#documentation": "The name of the Amazon Q Business index.
" } }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "The description of the Amazon Q index.
" + "smithy.api#documentation": "The description of the Amazon Q Business index.
" } }, "capacityConfiguration": { "target": "com.amazonaws.qbusiness#IndexCapacityConfiguration", "traits": { - "smithy.api#documentation": "The storage capacity units you want to provision for your Amazon Q index. You can\n add and remove capacity to fit your usage needs.
" + "smithy.api#documentation": "The storage capacity units you want to provision for your Amazon Q Business index. You can\n add and remove capacity to fit your usage needs.
" } }, "documentAttributeConfigurations": { @@ -9793,7 +9955,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Updates an Amazon Q plugin.
", + "smithy.api#documentation": "Updates an Amazon Q Business plugin.
", "smithy.api#http": { "method": "PUT", "uri": "/applications/{applicationId}/plugins/{pluginId}" @@ -9895,7 +10057,7 @@ "qbusiness:GetRetriever", "iam:PassRole" ], - "smithy.api#documentation": "Updates the retriever used for your Amazon Q application.
", + "smithy.api#documentation": "Updates the retriever used for your Amazon Q Business application.
", "smithy.api#http": { "method": "PUT", "uri": "/applications/{applicationId}/retrievers/{retrieverId}" @@ -9909,7 +10071,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of your Amazon Q application.
", + "smithy.api#documentation": "The identifier of your Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10084,7 +10246,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Updates an Amazon Q web experience.
", + "smithy.api#documentation": "Updates an Amazon Q Business web experience.
", "smithy.api#http": { "uri": "/applications/{applicationId}/experiences/{webExperienceId}", "method": "PUT" @@ -10098,7 +10260,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application attached to the web experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application attached to the web experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10106,7 +10268,7 @@ "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10114,25 +10276,25 @@ "authenticationConfiguration": { "target": "com.amazonaws.qbusiness#WebExperienceAuthConfiguration", "traits": { - "smithy.api#documentation": "The authentication configuration of the Amazon Q web experience.
" + "smithy.api#documentation": "The authentication configuration of the Amazon Q Business web experience.
" } }, "title": { "target": "com.amazonaws.qbusiness#WebExperienceTitle", "traits": { - "smithy.api#documentation": "The title of the Amazon Q web experience.
" + "smithy.api#documentation": "The title of the Amazon Q Business web experience.
" } }, "subtitle": { "target": "com.amazonaws.qbusiness#WebExperienceSubtitle", "traits": { - "smithy.api#documentation": "The subtitle of the Amazon Q web experience.
" + "smithy.api#documentation": "The subtitle of the Amazon Q Business web experience.
" } }, "welcomeMessage": { "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", "traits": { - "smithy.api#documentation": "A customized welcome message for an end user in an Amazon Q web\n experience.
" + "smithy.api#documentation": "A customized welcome message for an end user in an Amazon Q Business web\n experience.
" } }, "samplePromptsControlMode": { @@ -10187,7 +10349,7 @@ } }, "traits": { - "smithy.api#documentation": "Aliases attached to a user id within an Amazon Q application.
" + "smithy.api#documentation": "Aliases attached to a user id within an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#UserAliases": { @@ -10272,7 +10434,7 @@ } }, "traits": { - "smithy.api#documentation": "The input doesn't meet the constraints set by the Amazon Q service. Provide the\n correct input and try again.
", + "smithy.api#documentation": "The input doesn't meet the constraints set by the Amazon Q Business service. Provide the\n correct input and try again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -10296,7 +10458,7 @@ } }, "traits": { - "smithy.api#documentation": "The input failed to meet the constraints specified by Amazon Q in a specified\n field.
" + "smithy.api#documentation": "The input failed to meet the constraints specified by Amazon Q Business in a specified\n field.
" } }, "com.amazonaws.qbusiness#ValidationExceptionFields": { @@ -10334,36 +10496,36 @@ "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of your Amazon Q web experience.
" + "smithy.api#documentation": "The identifier of your Amazon Q Business web experience.
" } }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when your Amazon Q web experience was updated.
" + "smithy.api#documentation": "The Unix timestamp when your Amazon Q Business web experience was updated.
" } }, "defaultEndpoint": { "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#documentation": "The endpoint URLs for your Amazon Q web experience. The URLs are unique and fully\n hosted by Amazon Web Services.
" + "smithy.api#documentation": "The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully\n hosted by Amazon Web Services.
" } }, "status": { "target": "com.amazonaws.qbusiness#WebExperienceStatus", "traits": { - "smithy.api#documentation": "The status of your Amazon Q web experience.
" + "smithy.api#documentation": "The status of your Amazon Q Business web experience.
" } } }, "traits": { - "smithy.api#documentation": "Provides information for an Amazon Q web experience.
" + "smithy.api#documentation": "Provides information for an Amazon Q Business web experience.
" } }, "com.amazonaws.qbusiness#WebExperienceArn": { @@ -10384,7 +10546,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the authorization configuration information needed to deploy a Amazon Q\n web experience to end users.
" + "smithy.api#documentation": "Provides the authorization configuration information needed to deploy a Amazon Q Business\n web experience to end users.
" } }, "com.amazonaws.qbusiness#WebExperienceId": { diff --git a/codegen/sdk-codegen/aws-models/qconnect.2020-10-19.json b/codegen/sdk-codegen/aws-models/qconnect.2020-10-19.json index 52019425c48..74a2f64b812 100644 --- a/codegen/sdk-codegen/aws-models/qconnect.2020-10-19.json +++ b/codegen/sdk-codegen/aws-models/qconnect.2020-10-19.json @@ -14,6 +14,12 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.qconnect#AndConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#TagCondition" + } + }, "com.amazonaws.qconnect#AppIntegrationsConfiguration": { "type": "structure", "members": { @@ -27,7 +33,7 @@ "objectFields": { "target": "com.amazonaws.qconnect#ObjectFieldsList", "traits": { - "smithy.api#documentation": "The fields from the source that are made available to your agents in Amazon Q. Optional if\n ObjectConfiguration is included in the provided DataIntegration.
\n For Salesforce, you must include at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted.
For ServiceNow, you must include at least number,\n short_description, sys_mod_count, workflow_state,\n and active.
For \n Zendesk, you must include at least id, title,\n updated_at, and draft.
Make sure to include additional fields. These fields are indexed and used to source\n recommendations.
" + "smithy.api#documentation": "The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if\n ObjectConfiguration is included in the provided DataIntegration.
\n For Salesforce, you must include at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted.
For ServiceNow, you must include at least number,\n short_description, sys_mod_count, workflow_state,\n and active.
For \n Zendesk, you must include at least id, title,\n updated_at, and draft.
Make sure to include additional fields. These fields are indexed and used to source\n recommendations.
" } } }, @@ -143,14 +149,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q assistant.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, @@ -190,12 +196,12 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
" + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
" } } }, "traits": { - "smithy.api#documentation": "The data that is input into Amazon Q as a result of the assistant association.
" + "smithy.api#documentation": "The data that is input into Amazon Q in Connect as a result of the assistant association.
" } }, "com.amazonaws.qconnect#AssistantAssociationOutputData": { @@ -232,14 +238,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q assistant.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, @@ -285,12 +291,12 @@ "type": { "target": "com.amazonaws.qconnect#AssistantCapabilityType", "traits": { - "smithy.api#documentation": "The type of Amazon Q assistant capability.
" + "smithy.api#documentation": "The type of Amazon Q in Connect assistant capability.
" } } }, "traits": { - "smithy.api#documentation": "The capability configuration for an Amazon Q assistant.
" + "smithy.api#documentation": "The capability configuration for an Amazon Q in Connect assistant.
" } }, "com.amazonaws.qconnect#AssistantCapabilityType": { @@ -314,14 +320,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q assistant.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, @@ -361,19 +367,19 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.
For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.
" + "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.
" } }, "integrationConfiguration": { "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", "traits": { - "smithy.api#documentation": "The configuration information for the Amazon Q assistant integration.
" + "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant integration.
" } }, "capabilityConfiguration": { "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", "traits": { - "smithy.api#documentation": "The configuration information for the Amazon Q assistant capability.
" + "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant capability.
" } } }, @@ -392,7 +398,7 @@ } }, "traits": { - "smithy.api#documentation": "The configuration information for the Amazon Q assistant integration.
" + "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant integration.
" } }, "com.amazonaws.qconnect#AssistantList": { @@ -438,14 +444,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q assistant.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, @@ -485,19 +491,19 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.
For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.
" + "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.
" } }, "integrationConfiguration": { "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", "traits": { - "smithy.api#documentation": "The configuration information for the Amazon Q assistant integration.
" + "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant integration.
" } }, "capabilityConfiguration": { "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", "traits": { - "smithy.api#documentation": "The configuration information for the Amazon Q assistant capability.
" + "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant capability.
" } } }, @@ -688,7 +694,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
", + "smithy.api#documentation": "The identifier of the knowledge base.
", "smithy.api#required": {} } }, @@ -730,7 +736,7 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.
", + "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
", "smithy.api#required": {} } }, @@ -837,7 +843,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
" + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
" } }, "contentArn": { @@ -919,7 +925,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
", + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
", "smithy.api#required": {} } }, @@ -961,7 +967,7 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.
", + "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
", "smithy.api#required": {} } }, @@ -1076,7 +1082,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1160,7 +1166,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThe customer managed key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.
For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.
" + "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThe customer managed key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.
" } } } @@ -1202,7 +1208,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates Amazon Q content. Before to calling this API, use StartContentUpload to\n upload an asset.
", + "smithy.api#documentation": "Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/contents", "method": "POST" @@ -1216,7 +1222,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1224,7 +1230,7 @@ "name": { "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "The name of the content. Each piece of content in a knowledge base must have a unique\n name. You can retrieve a piece of content using only its knowledge base and its name with the\n SearchContent API.
", + "smithy.api#documentation": "The name of the content. Each piece of content in a knowledge base must have a unique\n name. You can retrieve a piece of content using only its knowledge base and its name with the\n SearchContent\n API.
", "smithy.api#required": {} } }, @@ -1243,7 +1249,7 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.
" + "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
" } }, "uploadId": { @@ -1349,7 +1355,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q.
For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.
" + "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.
" } }, "description": { @@ -1403,7 +1409,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon Q quick response.
", + "smithy.api#documentation": "Creates an Amazon Q in Connect quick response.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses", "method": "POST" @@ -1417,7 +1423,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1439,13 +1445,13 @@ "contentType": { "target": "com.amazonaws.qconnect#QuickResponseType", "traits": { - "smithy.api#documentation": "The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for a quick response written in plain text.
Use application/x.quickresponse;format=markdown for a quick response written in richtext.
The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for a quick response written\n in plain text.
Use application/x.quickresponse;format=markdown for a quick response\n written in richtext.
The configuration information of the user groups that the quick response is accessible to.
" + "smithy.api#documentation": "The configuration information of the user groups that the quick response is accessible\n to.
" } }, "description": { @@ -1457,7 +1463,7 @@ "shortcutKey": { "target": "com.amazonaws.qconnect#ShortCutKey", "traits": { - "smithy.api#documentation": "The shortcut key of the quick response. The value should be unique across the\n knowledge base.\n
" + "smithy.api#documentation": "The shortcut key of the quick response. The value should be unique across the\n knowledge base.
" } }, "isActive": { @@ -1475,7 +1481,7 @@ "language": { "target": "com.amazonaws.qconnect#LanguageCode", "traits": { - "smithy.api#documentation": "The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES,\n fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR,\n zh_CN, zh_TW\n
The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES,\n fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR,\n zh_CN, zh_TW\n
Creates a session. A session is a contextual container used for generating\n recommendations. Amazon Connect creates a new Amazon Q session for each contact on which\n Amazon Q is enabled.
", + "smithy.api#documentation": "Creates a session. A session is a contextual container used for generating\n recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which\n Amazon Q in Connect is enabled.
", "smithy.api#http": { "uri": "/assistants/{assistantId}/sessions", "method": "POST" @@ -1551,7 +1560,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1574,6 +1583,12 @@ "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } + }, + "tagFilter": { + "target": "com.amazonaws.qconnect#TagFilter", + "traits": { + "smithy.api#documentation": "An object that can be used to specify Tag conditions.
" + } } } }, @@ -1731,7 +1746,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1748,7 +1763,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1794,7 +1809,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1851,7 +1866,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
", + "smithy.api#documentation": "The identifier of the knowledge base.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1960,7 +1975,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
", + "smithy.api#documentation": "The knowledge base from which the quick response is deleted. The identifier of the knowledge base.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2276,7 +2291,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2300,7 +2315,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2360,7 +2375,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2420,7 +2435,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2538,7 +2553,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2645,7 +2660,7 @@ "smithy.api#deprecated": { "message": "GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications." }, - "smithy.api#documentation": "Retrieves recommendations for the specified session. To avoid retrieving the same\n recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the\n waitTimeSeconds parameter. Short poll is the default behavior and only returns\n recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
This API will be discontinued starting June 1, 2024. To receive generative responses\n after March 1, 2024, you will need to create a new Assistant in the Amazon Connect\n console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into\n your applications.
\nRetrieves recommendations for the specified session. To avoid retrieving the same\n recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the\n waitTimeSeconds parameter. Short poll is the default behavior and only returns\n recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2741,7 +2756,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2773,18 +2788,18 @@ "criteria": { "target": "com.amazonaws.qconnect#GroupingCriteria", "traits": { - "smithy.api#documentation": "The criteria used for grouping Amazon Q users.
\nThe following is the list of supported criteria values.
\n\n RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and\n DescribeRoutingProfile permissions when setting criteria to this value.
The criteria used for grouping Amazon Q in Connect users.
\nThe following is the list of supported criteria values.
\n\n RoutingProfileArn: Grouping the users by their Amazon\n Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
The list of values that define different groups of Amazon Q users.
\nWhen setting criteria to RoutingProfileArn, you need to provide a list of\n ARNs of Amazon Connect routing profiles as values of this parameter.
The list of values that define different groups of Amazon Q in Connect users.
\nWhen setting criteria to RoutingProfileArn, you need to\n provide a list of ARNs of Amazon Connect routing\n profiles as values of this parameter.
The configuration information of the grouping of Amazon Q users.
" + "smithy.api#documentation": "The configuration information of the grouping of Amazon Q in Connect users.
" } }, "com.amazonaws.qconnect#GroupingCriteria": { @@ -2872,7 +2887,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
", + "smithy.api#documentation": "The identifier of the knowledge base.
", "smithy.api#required": {} } }, @@ -2944,7 +2959,7 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "The metadata fields of the imported Amazon Q resources.
" + "smithy.api#documentation": "The metadata fields of the imported Amazon Q in Connect resources.
" } }, "externalSourceConfiguration": { @@ -3005,7 +3020,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
", + "smithy.api#documentation": "The identifier of the knowledge base.
", "smithy.api#required": {} } }, @@ -3056,13 +3071,13 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "The metadata fields of the imported Amazon Q resources.
" + "smithy.api#documentation": "The metadata fields of the imported Amazon Q in Connect resources.
" } }, "externalSourceConfiguration": { "target": "com.amazonaws.qconnect#ExternalSourceConfiguration", "traits": { - "smithy.api#documentation": "The configuration information of the external source that the resource data are imported from.
" + "smithy.api#documentation": "The configuration information of the external source that the resource data are imported\n from.
" } } }, @@ -3151,7 +3166,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
" + "smithy.api#documentation": "The identifier of the knowledge base.
" } }, "knowledgeBaseArn": { @@ -3171,7 +3186,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
", + "smithy.api#documentation": "The identifier of the knowledge base.
", "smithy.api#required": {} } }, @@ -3225,7 +3240,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q.
For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.
" + "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.
" } }, "description": { @@ -3293,7 +3308,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
", + "smithy.api#documentation": "The identifier of the knowledge base.
", "smithy.api#required": {} } }, @@ -3340,7 +3355,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q.
For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.
" + "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.
" } }, "description": { @@ -3447,7 +3462,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3594,7 +3609,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3670,7 +3685,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3823,7 +3838,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4009,7 +4024,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4060,6 +4075,32 @@ } } }, + "com.amazonaws.qconnect#OrCondition": { + "type": "union", + "members": { + "andConditions": { + "target": "com.amazonaws.qconnect#AndConditions", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an OR condition.
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
", + "smithy.api#documentation": "Provides feedback against the specified assistant for the specified target. This API only\n supports generative targets.
", "smithy.api#http": { "uri": "/assistants/{assistantId}/feedback", "method": "PUT" @@ -4141,7 +4182,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4178,14 +4219,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q assistant.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, @@ -4241,7 +4282,7 @@ "smithy.api#deprecated": { "message": "QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications." }, - "smithy.api#documentation": "Performs a manual search against the specified assistant. To retrieve recommendations for\n an assistant, use GetRecommendations.\n
", + "smithy.api#documentation": "This API will be discontinued starting June 1, 2024. To receive generative responses\n after March 1, 2024, you will need to create a new Assistant in the Amazon Connect\n console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into\n your applications.
\nPerforms a manual search against the specified assistant. To retrieve recommendations for\n an assistant, use GetRecommendations.
", "smithy.api#http": { "uri": "/assistants/{assistantId}/query", "method": "POST" @@ -4264,7 +4305,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4291,7 +4332,7 @@ "sessionId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot\n contain the ARN.
" + "smithy.api#documentation": "The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot\n contain the ARN.
" } }, "queryCondition": { @@ -4538,7 +4579,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#required": {} } }, @@ -4552,7 +4593,7 @@ "contentType": { "target": "com.amazonaws.qconnect#QuickResponseType", "traits": { - "smithy.api#documentation": "The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written\n in plain text.
Use application/x.quickresponse;format=markdown for quick response\n written in richtext.
The configuration information of the user groups that the quick response is accessible to.
" + "smithy.api#documentation": "The configuration information of the user groups that the quick response is accessible\n to.
" } }, "shortcutKey": { @@ -4606,7 +4647,7 @@ "lastModifiedBy": { "target": "com.amazonaws.qconnect#GenericArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user who last updated the quick response data.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user who last updated the quick response\n data.
" } }, "isActive": { @@ -4618,7 +4659,7 @@ "channels": { "target": "com.amazonaws.qconnect#Channels", "traits": { - "smithy.api#documentation": "The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The Amazon Connect contact channels this quick response applies to.\n The supported contact channel types include Chat.
Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
" + "smithy.api#documentation": "Whether the query expects only exact matches on the attribute field values. The results of\n the query will only include exact matches if this parameter is set to false.
" } }, "priority": { "target": "com.amazonaws.qconnect#Priority", "traits": { - "smithy.api#documentation": "The importance of the attribute field when calculating query result relevancy scores.\n The value set for this parameter affects the ordering of search results.
" + "smithy.api#documentation": "The importance of the attribute field when calculating query result relevancy scores. The\n value set for this parameter affects the ordering of search results.
" } } }, @@ -4925,7 +4966,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#required": {} } }, @@ -4939,7 +4980,7 @@ "contentType": { "target": "com.amazonaws.qconnect#QuickResponseType", "traits": { - "smithy.api#documentation": "The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written\n in plain text.
Use application/x.quickresponse;format=markdown for quick response\n written in richtext.
The configuration information of the user groups that the quick response is accessible to.
" + "smithy.api#documentation": "The configuration information of the user groups that the quick response is accessible\n to.
" } }, "shortcutKey": { @@ -5001,13 +5042,13 @@ "lastModifiedBy": { "target": "com.amazonaws.qconnect#GenericArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user who last updated the quick response search\n result data.
" } }, "channels": { "target": "com.amazonaws.qconnect#Channels", "traits": { - "smithy.api#documentation": "The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The Amazon Connect contact channels this quick response applies to.\n The supported contact channel types include Chat.
The user defined contact attributes that are not resolved when the search result is returned.
" + "smithy.api#documentation": "The user defined contact attributes that are not resolved when the search result is\n returned.
" } }, "attributesInterpolated": { "target": "com.amazonaws.qconnect#ContactAttributeKeys", "traits": { - "smithy.api#documentation": "The user defined contact attributes that are resolved when the search result is returned.
" + "smithy.api#documentation": "The user defined contact attributes that are resolved when the search result is\n returned.
" } }, "tags": { @@ -5119,7 +5160,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.
", + "smithy.api#documentation": "The identifier of the knowledge base.
", "smithy.api#required": {} } }, @@ -5133,7 +5174,7 @@ "contentType": { "target": "com.amazonaws.qconnect#QuickResponseType", "traits": { - "smithy.api#documentation": "The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written\n in plain text.
Use application/x.quickresponse;format=markdown for quick response\n written in richtext.
The Amazon Resource Name (ARN) of the user who last updated the quick response data.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user who last updated the quick response\n data.
" } }, "isActive": { @@ -5181,7 +5222,7 @@ "channels": { "target": "com.amazonaws.qconnect#Channels", "traits": { - "smithy.api#documentation": "The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The Amazon Connect contact channels this quick response applies to.\n The supported contact channel types include Chat.
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5654,7 +5695,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5724,7 +5765,7 @@ } ], "traits": { - "smithy.api#documentation": "Searches existing Amazon Q quick responses in an Amazon Q knowledge base.
", + "smithy.api#documentation": "Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/search/quickResponses", "method": "POST" @@ -5773,7 +5814,7 @@ "attributes": { "target": "com.amazonaws.qconnect#ContactAttributes", "traits": { - "smithy.api#documentation": "The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
" + "smithy.api#documentation": "The user-defined Amazon Connect contact attributes to be resolved when search\n results are returned.
" } } }, @@ -5856,7 +5897,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5900,7 +5941,7 @@ "kmsKeyId": { "target": "com.amazonaws.qconnect#NonEmptyString", "traits": { - "smithy.api#documentation": "The customer managed key used for encryption. For more information about setting up a\n customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.\n For information about valid ID values, see Key identifiers (KeyId).
" + "smithy.api#documentation": "The customer managed key used for encryption. For more information about setting up a\n customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.\n For information about valid ID values, see Key identifiers (KeyId).
" } } }, @@ -5937,6 +5978,9 @@ "read": { "target": "com.amazonaws.qconnect#GetSession" }, + "update": { + "target": "com.amazonaws.qconnect#UpdateSession" + }, "traits": { "aws.api#arn": { "template": "session/{assistantId}/{sessionId}" @@ -5985,6 +6029,12 @@ "traits": { "smithy.api#documentation": "The configuration information for the session integration.
" } + }, + "tagFilter": { + "target": "com.amazonaws.qconnect#TagFilter", + "traits": { + "smithy.api#documentation": "An object that can be used to specify Tag conditions.
" + } } }, "traits": { @@ -6031,14 +6081,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q assistant.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q assistant.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } } @@ -6137,7 +6187,7 @@ } ], "traits": { - "smithy.api#documentation": "Get a URL to upload content to a knowledge base. To upload content, first make a PUT\n request to the returned URL with your file, making sure to include the required headers. Then\n use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a\n knowledge base of type CUSTOM.
", + "smithy.api#documentation": "Get a URL to upload content to a knowledge base. To upload content, first make a PUT\n request to the returned URL with your file, making sure to include the required headers. Then\n use CreateContent to\n finalize the content creation process or UpdateContent to\n modify an existing resource. You can only upload content to a knowledge base of type\n CUSTOM.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/upload", "method": "POST" @@ -6150,7 +6200,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6230,7 +6280,7 @@ } ], "traits": { - "smithy.api#documentation": "Start an asynchronous job to import Amazon Q resources from an uploaded source file. Before calling this API, use StartContentUpload to\n upload an asset that contains the resource data.
\nFor importing Amazon Q quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
\nStart an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.\n Before calling this API, use StartContentUpload to\n upload an asset that contains the resource data.
\nFor importing Amazon Q in Connect quick responses, you need to upload a csv file including the\n quick responses. For information about how to format the csv file for importing quick\n responses, see Import quick responses.
\nThe identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
\nFor importing Amazon Q quick responses, this should be a QUICK_RESPONSES type knowledge base.
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
\nFor importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES\n type knowledge base.
The type of the import job.
\nFor importing quick response resource, set the value to QUICK_RESPONSES.
The type of the import job.
\nFor importing quick response resource, set the value to\n QUICK_RESPONSES.
The metadata fields of the imported Amazon Q resources.
" + "smithy.api#documentation": "The metadata fields of the imported Amazon Q in Connect resources.
" } }, "externalSourceConfiguration": { "target": "com.amazonaws.qconnect#ExternalSourceConfiguration", "traits": { - "smithy.api#documentation": "The configuration information of the external source that the resource data are imported from.
" + "smithy.api#documentation": "The configuration information of the external source that the resource data are imported\n from.
" } } }, @@ -6301,6 +6351,53 @@ "smithy.api#output": {} } }, + "com.amazonaws.qconnect#TagCondition": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.qconnect#TagKey", + "traits": { + "smithy.api#documentation": "The tag key in the tag condition.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.qconnect#TagValue", + "traits": { + "smithy.api#documentation": "The tag value in the tag condition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a tag condition.\n
" + } + }, + "com.amazonaws.qconnect#TagFilter": { + "type": "union", + "members": { + "tagCondition": { + "target": "com.amazonaws.qconnect#TagCondition", + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a tag condition.
" + } + }, + "andConditions": { + "target": "com.amazonaws.qconnect#AndConditions", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an AND condition.
A list of conditions which would be applied together with an OR condition.
An object that can be used to specify Tag conditions.
" + } + }, "com.amazonaws.qconnect#TagKey": { "type": "string", "traits": { @@ -6531,7 +6628,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN
", + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6571,13 +6668,13 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. For\n example, when synchronizing data between an external system and Amazon Q, you can store an\n external version identifier as metadata to utilize for determining drift.
" + "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. For\n example, when synchronizing data between an external system and Amazon Q in Connect, you can store an\n external version identifier as metadata to utilize for determining drift.
" } }, "uploadId": { "target": "com.amazonaws.qconnect#UploadId", "traits": { - "smithy.api#documentation": "A pointer to the uploaded asset. This value is returned by StartContentUpload.\n
" + "smithy.api#documentation": "A pointer to the uploaded asset. This value is returned by StartContentUpload.
" } } } @@ -6613,7 +6710,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the template URI of a knowledge base. This is only supported for knowledge bases\n of type EXTERNAL. Include a single variable in ${variable} format; this\n interpolated by Amazon Q using ingested content. For example, if you ingest a Salesforce\n article, it has an Id value, and you can set the template URI to\n https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.\n
Updates the template URI of a knowledge base. This is only supported for knowledge bases\n of type EXTERNAL. Include a single variable in ${variable} format; this\n interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce\n article, it has an Id value, and you can set the template URI to\n https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.\n
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6677,7 +6774,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing Amazon Q quick response.
", + "smithy.api#documentation": "Updates an existing Amazon Q in Connect quick response.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", "method": "POST" @@ -6690,7 +6787,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6718,7 +6815,7 @@ "contentType": { "target": "com.amazonaws.qconnect#QuickResponseType", "traits": { - "smithy.api#documentation": "The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written\n in plain text.
Use application/x.quickresponse;format=markdown for quick response\n written in richtext.
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The Amazon Connect contact channels this quick response applies to.\n The supported contact channel types include Chat.
Updates a session. A session is a contextual container used for generating recommendations.\n Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect\n is enabled.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/sessions/{sessionId}", + "method": "POST" + } + } + }, + "com.amazonaws.qconnect#UpdateSessionRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "The description.
" + } + }, + "tagFilter": { + "target": "com.amazonaws.qconnect#TagFilter", + "traits": { + "smithy.api#documentation": "An object that can be used to specify Tag conditions.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#UpdateSessionResponse": { + "type": "structure", + "members": { + "session": { + "target": "com.amazonaws.qconnect#SessionData" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qconnect#UploadId": { "type": "string", "traits": { @@ -6890,7 +7061,7 @@ }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "\n Powered by Amazon Bedrock: Amazon Web Services implements automated abuse\n detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full\n advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the\n responsible use of artificial intelligence (AI).
\nAmazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution\n of Amazon Connect Wisdom that delivers real-time recommendations to help contact center\n agents resolve customer issues quickly and accurately.
\nAmazon Q automatically detects customer intent during calls and chats using\n conversational analytics and natural language understanding (NLU). It then provides agents\n with immediate, real-time generative responses and suggested actions, and links to relevant\n documents and articles. Agents can also query Amazon Q directly using natural language or\n keywords to answer customer requests.
\nUse the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or\n manage content by uploading custom files.
\nFor more information, see Use Amazon Q in Connect for generative AI\n powered agent assistance in real-time in the Amazon Connect\n Administrator Guide.
", + "smithy.api#documentation": "\n Powered by Amazon Bedrock: Amazon Web Services implements automated abuse\n detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of\n the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of\n artificial intelligence (AI).
\nAmazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced\n evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact\n center agents resolve customer issues quickly and accurately.
\nAmazon Q in Connect automatically detects customer intent during calls and chats using conversational\n analytics and natural language understanding (NLU). It then provides agents with immediate,\n real-time generative responses and suggested actions, and links to relevant documents and\n articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer\n customer requests.
\nUse the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or\n manage content by uploading custom files.
\nFor more information, see Use Amazon Q in Connect for generative AI\n powered agent assistance in real-time in the Amazon Connect\n Administrator Guide.
", "smithy.api#title": "Amazon Q Connect", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json index 7394a043640..2b4cd4fca57 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json +++ b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json @@ -1428,6 +1428,12 @@ "traits": { "smithy.api#enumValue": "RoleArn" } + }, + "PRODUCT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProductType" + } } } }, @@ -1779,7 +1785,7 @@ } }, "traits": { - "smithy.api#documentation": "The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to true, validation is skipped for specific UI errors.
The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors.
The ARN of the resource that the warning occurred for.
" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "A description of the warning that occurred during an Asset Bundle import job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a warning that occurred during an Asset Bundle import job.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobWarningList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobWarning" + } + }, "com.amazonaws.quicksight#AssetBundleImportSource": { "type": "structure", "members": { @@ -4693,7 +4725,7 @@ } }, "traits": { - "smithy.api#documentation": "The numeric equality type drill down filter.
" + "smithy.api#documentation": "The category drill down filter.
" } }, "com.amazonaws.quicksight#CategoryFilter": { @@ -4719,6 +4751,12 @@ "smithy.api#documentation": "The configuration for a CategoryFilter.
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
" + } } }, "traits": { @@ -13328,6 +13366,150 @@ } } }, + "com.amazonaws.quicksight#DefaultDateTimePickerControlOptions": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#SheetControlDateTimePickerType", + "traits": { + "smithy.api#documentation": "The date time picker type of the DefaultDateTimePickerControlOptions. Choose one of the following options:
\n SINGLE_VALUED: The filter condition is a fixed date.
\n DATE_RANGE: The filter condition is a date time range.
The display options of a control.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default options that correspond to the filter control type of a DateTimePicker.
The title of the DefaultFilterControlConfiguration. This title is shared by all controls that are tied to this filter.
The control option for the DefaultFilterControlConfiguration.
The default configuration for all dependent controls of the filter.
" + } + }, + "com.amazonaws.quicksight#DefaultFilterControlOptions": { + "type": "structure", + "members": { + "DefaultDateTimePickerOptions": { + "target": "com.amazonaws.quicksight#DefaultDateTimePickerControlOptions", + "traits": { + "smithy.api#documentation": "The default options that correspond to the filter control type of a DateTimePicker.
The default options that correspond to the List filter control type.
The default options that correspond to the Dropdown filter control type.
The default options that correspond to the TextField filter control type.
The default options that correspond to the TextArea filter control type.
The default options that correspond to the Slider filter control type.
The default options that correspond to the RelativeDateTime filter control type.
The option that corresponds to the control type of the filter.
" + } + }, + "com.amazonaws.quicksight#DefaultFilterDropDownControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", + "traits": { + "smithy.api#documentation": "The display options of a control.
" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "The type of the FilterDropDownControl. Choose one of the following options:
\n MULTI_SELECT: The user can select multiple entries from a dropdown menu.
\n SINGLE_SELECT: The user can select a single entry from a dropdown menu.
A list of selectable values that are used in a control.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default options that correspond to the Dropdown filter control type.
The display options of a control.
" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "The type of the DefaultFilterListControlOptions. Choose one of the following options:
\n MULTI_SELECT: The user can select multiple entries from the list.
\n SINGLE_SELECT: The user can select a single entry from the list.
A list of selectable values that are used in a control.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default options that correspond to the List filter control type.
The options that determine the default settings for a paginated layout configuration.
" } }, + "com.amazonaws.quicksight#DefaultRelativeDateTimeControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions", + "traits": { + "smithy.api#documentation": "The display options of a control.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default options that correspond to the RelativeDateTime filter control type.
The options that determine the default settings for a section-based layout configuration.
" } }, + "com.amazonaws.quicksight#DefaultSliderControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", + "traits": { + "smithy.api#documentation": "The display options of a control.
" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlSliderType", + "traits": { + "smithy.api#documentation": "The type of the DefaultSliderControlOptions. Choose one of the following options:
\n SINGLE_POINT: Filter against(equals) a single data point.
\n RANGE: Filter data that is in a specified range.
The larger value that is displayed at the right of the slider.
", + "smithy.api#required": {} + } + }, + "MinimumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The smaller value that is displayed at the left of the slider.
", + "smithy.api#required": {} + } + }, + "StepSize": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of increments that the slider bar is divided into.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The default options that correspond to the Slider filter control type.
The delimiter that is used to separate the lines in text.
" + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", + "traits": { + "smithy.api#documentation": "The display options of a control.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default options that correspond to the TextArea filter control type.
The display options of a control.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default options that correspond to the TextField filter control type.
An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.
" } + }, + "Warnings": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobWarningList", + "traits": { + "smithy.api#documentation": "An array of warning records that describe all permitted errors that are encountered during the import job.
" + } } }, "traits": { @@ -21847,6 +22127,12 @@ "traits": { "smithy.api#documentation": "A control from a date filter that is used to specify the relative date.
" } + }, + "CrossSheet": { + "target": "com.amazonaws.quicksight#FilterCrossSheetControl", + "traits": { + "smithy.api#documentation": "A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet
" + } } }, "traits": { @@ -21865,6 +22151,34 @@ } } }, + "com.amazonaws.quicksight#FilterCrossSheetControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID of the FilterCrossSheetControl.
The source filter ID of the FilterCrossSheetControl.
The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet
" + } + }, "com.amazonaws.quicksight#FilterDateTimePickerControl": { "type": "structure", "members": { @@ -21898,7 +22212,7 @@ "Type": { "target": "com.amazonaws.quicksight#SheetControlDateTimePickerType", "traits": { - "smithy.api#documentation": "The date time picker type of a FilterDateTimePickerControl. Choose one of the following options:
\n SINGLE_VALUED: The filter condition is a fixed date.
\n DATE_RANGE: The filter condition is a date time range.
The type of the FilterDropDownControl. Choose one of the following options:
\n MULTI_SELECT: The user can select multiple entries from a dropdown menu.
\n SINGLE_SELECT: The user can select a single entry from a dropdown menu.
The type of FilterListControl. Choose one of the following options:
\n MULTI_SELECT: The user can select multiple entries from the list.
\n SINGLE_SELECT: The user can select a single entry from the list.
The type of the FilterListControl. Choose one of the following options:
\n MULTI_SELECT: The user can select multiple entries from the list.
\n SINGLE_SELECT: The user can select a single entry from the list.
The type of FilterSliderControl. Choose one of the following options:
\n SINGLE_POINT: Filter against(equals) a single data point.
\n RANGE: Filter data that is in a specified range.
The type of the FilterSliderControl. Choose one of the following options:
\n SINGLE_POINT: Filter against(equals) a single data point.
\n RANGE: Filter data that is in a specified range.
The smaller value that is displayed at the left of the slider.
", + "smithy.api#documentation": "The larger value that is displayed at the right of the slider.
", "smithy.api#required": {} } }, @@ -22323,7 +22637,7 @@ "target": "com.amazonaws.quicksight#Double", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The larger value that is displayed at the right of the slider.
", + "smithy.api#documentation": "The smaller value that is displayed at the left of the slider.
", "smithy.api#required": {} } }, @@ -33047,7 +33361,7 @@ } }, "traits": { - "smithy.api#documentation": "The category drill down filter.
" + "smithy.api#documentation": "The numeric equality type drill down filter.
" } }, "com.amazonaws.quicksight#NumericEqualityFilter": { @@ -33105,6 +33419,12 @@ "smithy.api#documentation": "This option determines how null values should be treated when filtering data.
\n\n ALL_VALUES: Include null values in filtered results.
\n NULLS_ONLY: Only include null values in filtered results.
\n NON_NULLS_ONLY: Exclude null values from filtered results.
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
" + } } }, "traits": { @@ -33226,6 +33546,12 @@ "smithy.api#documentation": "This option determines how null values should be treated when filtering data.
\n\n ALL_VALUES: Include null values in filtered results.
\n NULLS_ONLY: Only include null values in filtered results.
\n NON_NULLS_ONLY: Exclude null values from filtered results.
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
" + } } }, "traits": { @@ -34058,7 +34384,7 @@ "target": "com.amazonaws.quicksight#Double", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The smaller value that is displayed at the left of the slider.
", + "smithy.api#documentation": "The larger value that is displayed at the right of the slider.
", "smithy.api#required": {} } }, @@ -34066,7 +34392,7 @@ "target": "com.amazonaws.quicksight#Double", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The larger value that is displayed at the right of the slider.
", + "smithy.api#documentation": "The smaller value that is displayed at the left of the slider.
", "smithy.api#required": {} } }, @@ -38765,6 +39091,12 @@ "traits": { "smithy.api#documentation": "The configuration for the exclude period of the filter.
" } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
" + } } }, "traits": { @@ -43156,7 +43488,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call.
\n1 paginated PDF
\n1 Excel workbook
\n5 CSVs
\nPoll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
\n1 Paginated PDF
\n1 Excel workbook that includes up to 5 table or pivot table visuals
\n5 CSVs from table or pivot table visuals
\nThe status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.
\n StartDashboardSnapshotJob API throttling\n
\nAmazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.
\n Common throttling scenarios\n
\nThe following list provides information about the most commin throttling scenarios that can occur.
\n\n A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job.
\n A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a ThrottlingException is returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
\n\n Best practices to handle throttling\n
\nIf your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.
The time that it takes to process a job can be impacted by the following factors:
\nThe dataset type (Direct Query or SPICE).
\nThe size of the dataset.
\nThe complexity of the calculated fields that are used in the dashboard.
\nThe number of visuals that are on a sheet.
\nThe types of visuals that are on the sheet.
\nThe number of formats and snapshots that are requested in the job configuration.
\nThe size of the generated snapshots.
\nThe rolling date input for the TimeEquality filter.
This field is mutually exclusive to Value and ParameterName.
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
" + } } }, "traits": { @@ -45932,6 +46270,12 @@ "traits": { "smithy.api#documentation": "The level of time precision that is used to aggregate DateTime values.
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
" + } } }, "traits": { @@ -46124,6 +46468,12 @@ "traits": { "smithy.api#documentation": "The parameter whose value should be used for the filter value.
" } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/rds.2014-10-31.json b/codegen/sdk-codegen/aws-models/rds.2014-10-31.json index b43b6ef28ad..97f337ed4c5 100644 --- a/codegen/sdk-codegen/aws-models/rds.2014-10-31.json +++ b/codegen/sdk-codegen/aws-models/rds.2014-10-31.json @@ -3797,7 +3797,7 @@ "target": "com.amazonaws.rds#CustomEngineName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The database engine to use for your custom engine version (CEV). The only supported value is \n custom-oracle-ee.
The database engine. RDS Custom for Oracle supports the following values:
\n\n custom-oracle-ee\n
\n custom-oracle-ee-cdb\n
\n custom-oracle-se2\n
\n custom-oracle-se2-cdb\n
The DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
For information about limitations and requirements for Serverless DB clusters, see the \n following sections in the Amazon Aurora User Guide:
\nValid for Cluster Type: Aurora DB clusters only
" + "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the \n provisioned engine mode.
For information about limitations and requirements for Serverless DB clusters, see the \n following sections in the Amazon Aurora User Guide:
\nValid for Cluster Type: Aurora DB clusters only
" } }, "ScalingConfiguration": { @@ -4926,7 +4926,7 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The database engine to use for this DB instance.
\nNot every database engine is available in every Amazon Web Services Region.
\nValid Values:
\n\n aurora-mysql (for Aurora MySQL DB instances)
\n aurora-postgresql (for Aurora PostgreSQL DB instances)
\n custom-oracle-ee (for RDS Custom for Oracle DB instances)
\n custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
\n custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
\n custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
\n custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to use for this DB instance.
\nNot every database engine is available in every Amazon Web Services Region.
\nValid Values:
\n\n aurora-mysql (for Aurora MySQL DB instances)
\n aurora-postgresql (for Aurora PostgreSQL DB instances)
\n custom-oracle-ee (for RDS Custom for Oracle DB instances)
\n custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
\n custom-oracle-se2 (for RDS Custom for Oracle DB instances)
\n custom-oracle-se2-cdb (for RDS Custom for Oracle DB\n instances)
\n custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
\n custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
\n custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Whether to upgrade the storage file system configuration on the read replica. This option\n migrates the read replica from the old storage file system layout to the preferred layout.
" } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The CA certificate identifier to use for the read replica's server certificate.
\nThis setting doesn't apply to RDS Custom DB instances.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" + } } }, "traits": { @@ -11892,7 +11901,7 @@ "target": "com.amazonaws.rds#CustomEngineName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The database engine. The only supported engines are custom-oracle-ee and custom-oracle-ee-cdb.
The database engine. RDS Custom for Oracle supports the following values:
\n\n custom-oracle-ee\n
\n custom-oracle-ee-cdb\n
\n custom-oracle-se2\n
\n custom-oracle-se2-cdb\n
The database engine to return version details for.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n custom-oracle-ee\n
\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to return version details for.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n custom-oracle-ee\n
\n custom-oracle-ee-cdb\n
\n custom-oracle-se2\n
\n custom-oracle-se2-cdb\n
\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the DB parameter group family.
\nValid Values:
\n\n aurora-mysql5.7\n
\n aurora-mysql8.0\n
\n aurora-postgresql10\n
\n aurora-postgresql11\n
\n aurora-postgresql12\n
\n aurora-postgresql13\n
\n aurora-postgresql14\n
\n custom-oracle-ee-19\n
\n db2-ae\n
\n db2-se\n
\n mariadb10.2\n
\n mariadb10.3\n
\n mariadb10.4\n
\n mariadb10.5\n
\n mariadb10.6\n
\n mysql5.7\n
\n mysql8.0\n
\n oracle-ee-19\n
\n oracle-ee-cdb-19\n
\n oracle-ee-cdb-21\n
\n oracle-se2-19\n
\n oracle-se2-cdb-19\n
\n oracle-se2-cdb-21\n
\n postgres10\n
\n postgres11\n
\n postgres12\n
\n postgres13\n
\n postgres14\n
\n sqlserver-ee-11.0\n
\n sqlserver-ee-12.0\n
\n sqlserver-ee-13.0\n
\n sqlserver-ee-14.0\n
\n sqlserver-ee-15.0\n
\n sqlserver-ex-11.0\n
\n sqlserver-ex-12.0\n
\n sqlserver-ex-13.0\n
\n sqlserver-ex-14.0\n
\n sqlserver-ex-15.0\n
\n sqlserver-se-11.0\n
\n sqlserver-se-12.0\n
\n sqlserver-se-13.0\n
\n sqlserver-se-14.0\n
\n sqlserver-se-15.0\n
\n sqlserver-web-11.0\n
\n sqlserver-web-12.0\n
\n sqlserver-web-13.0\n
\n sqlserver-web-14.0\n
\n sqlserver-web-15.0\n
The name of the DB parameter group family.
\nValid Values:
\n\n aurora-mysql5.7\n
\n aurora-mysql8.0\n
\n aurora-postgresql10\n
\n aurora-postgresql11\n
\n aurora-postgresql12\n
\n aurora-postgresql13\n
\n aurora-postgresql14\n
\n custom-oracle-ee-19\n
\n custom-oracle-ee-cdb-19\n
\n db2-ae\n
\n db2-se\n
\n mariadb10.2\n
\n mariadb10.3\n
\n mariadb10.4\n
\n mariadb10.5\n
\n mariadb10.6\n
\n mysql5.7\n
\n mysql8.0\n
\n oracle-ee-19\n
\n oracle-ee-cdb-19\n
\n oracle-ee-cdb-21\n
\n oracle-se2-19\n
\n oracle-se2-cdb-19\n
\n oracle-se2-cdb-21\n
\n postgres10\n
\n postgres11\n
\n postgres12\n
\n postgres13\n
\n postgres14\n
\n sqlserver-ee-11.0\n
\n sqlserver-ee-12.0\n
\n sqlserver-ee-13.0\n
\n sqlserver-ee-14.0\n
\n sqlserver-ee-15.0\n
\n sqlserver-ex-11.0\n
\n sqlserver-ex-12.0\n
\n sqlserver-ex-13.0\n
\n sqlserver-ex-14.0\n
\n sqlserver-ex-15.0\n
\n sqlserver-se-11.0\n
\n sqlserver-se-12.0\n
\n sqlserver-se-13.0\n
\n sqlserver-se-14.0\n
\n sqlserver-se-15.0\n
\n sqlserver-web-11.0\n
\n sqlserver-web-12.0\n
\n sqlserver-web-13.0\n
\n sqlserver-web-14.0\n
\n sqlserver-web-15.0\n
The name of the engine to describe DB instance options for.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n custom-oracle-ee\n
\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the database engine to describe DB instance options for.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n custom-oracle-ee\n
\n custom-oracle-ee-cdb\n
\n custom-oracle-se2\n
\n custom-oracle-se2-cdb\n
\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 10000.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 1000.
" } }, "Marker": { @@ -21207,7 +21216,7 @@ "target": "com.amazonaws.rds#CustomEngineName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The DB engine. The only supported values are custom-oracle-ee and custom-oracle-ee-cdb.
The database engine. RDS Custom for Oracle supports the following values:
\n\n custom-oracle-ee\n
\n custom-oracle-ee-cdb\n
\n custom-oracle-se2\n
\n custom-oracle-se2-cdb\n
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nFor RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.
\nFor the valid values for allocated storage for each engine,\n see CreateDBInstance.
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nFor RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.
\nFor the valid values for allocated storage for each engine,\n see CreateDBInstance.
Constraints:
\nWhen you increase the allocated storage for a DB instance that uses\n Provisioned IOPS (gp3, io1, or io2\n storage type), you must also specify the Iops parameter. You can\n use the current value for Iops.
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
\nChanging this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nConstraints:
\nFor RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
\nDefault: Uses existing setting
" + "smithy.api#documentation": "The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
\nChanging this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nConstraints:
\nFor RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
\nWhen you increase the Provisioned IOPS, you must also specify the\n AllocatedStorage parameter. You can use the current value for\n AllocatedStorage.
Default: Uses existing setting
" } }, "OptionGroupName": { @@ -27613,6 +27622,9 @@ { "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + }, { "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" }, @@ -27953,6 +27965,12 @@ "traits": { "smithy.api#documentation": "Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
" } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The CA certificate identifier to use for the DB instance's server certificate.
\nThis setting doesn't apply to RDS Custom DB instances.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" + } } }, "traits": { @@ -27986,6 +28004,9 @@ { "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + }, { "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, @@ -28349,6 +28370,12 @@ "traits": { "smithy.api#documentation": "Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
" } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The CA certificate identifier to use for the DB instance's server certificate.
\nThis setting doesn't apply to RDS Custom DB instances.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" + } } }, "traits": { @@ -28381,6 +28408,9 @@ { "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + }, { "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, @@ -28807,6 +28837,12 @@ "traits": { "smithy.api#documentation": "Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
" } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The CA certificate identifier to use for the DB instance's server certificate.
\nThis setting doesn't apply to RDS Custom DB instances.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json b/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json index 825fedc9a6a..ad0d218df9a 100644 --- a/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json +++ b/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json @@ -543,7 +543,7 @@ "schedule": { "target": "com.amazonaws.redshiftserverless#Schedule", "traits": { - "smithy.api#documentation": "The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
\nFormat of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
\nFormat of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The timestamp of when Amazon Redshift Serverless should run the scheduled action. Format of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour.
\nFormat of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
\nFormat of cron expressions is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
\nFormat of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
\nFormat of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
\nFormat of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
\nFormat of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
" } + }, + "SnapshotArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json b/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json index de18bed9573..13101444568 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json +++ b/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json @@ -1150,6 +1150,12 @@ "traits": { "smithy.api#documentation": "The time duration of a segment in milliseconds, I.e. time elapsed from\n StartTimestampMillis to EndTimestampMillis.
" } + }, + "ContentTypes": { + "target": "com.amazonaws.rekognition#ContentTypes", + "traits": { + "smithy.api#documentation": "A list of predicted results for the type of content an image contains. For example, \n the image content might be from animation, sports, or a video game.
" + } } }, "traits": { @@ -1646,7 +1652,7 @@ "SessionId": { "target": "com.amazonaws.rekognition#LivenessSessionId", "traits": { - "smithy.api#documentation": "A unique 128-bit UUID identifying a Face Liveness session.
", + "smithy.api#documentation": "A unique 128-bit UUID identifying a Face Liveness session. \n A new sessionID must be used for every Face Liveness check. If a given sessionID is used for subsequent \n Face Liveness checks, the checks will fail. Additionally, a SessionId expires 3 minutes after it's sent, \n making all Liveness data associated with the session (e.g., sessionID, reference image, audit images, etc.) unavailable.\n
", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/rolesanywhere.2018-05-10.json b/codegen/sdk-codegen/aws-models/rolesanywhere.2018-05-10.json index f9d39c8382d..0d7da1ff854 100644 --- a/codegen/sdk-codegen/aws-models/rolesanywhere.2018-05-10.json +++ b/codegen/sdk-codegen/aws-models/rolesanywhere.2018-05-10.json @@ -23,6 +23,51 @@ } } }, + "com.amazonaws.rolesanywhere#AttributeMapping": { + "type": "structure", + "members": { + "certificateField": { + "target": "com.amazonaws.rolesanywhere#CertificateField", + "traits": { + "smithy.api#documentation": "Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.
" + } + }, + "mappingRules": { + "target": "com.amazonaws.rolesanywhere#MappingRules", + "traits": { + "smithy.api#documentation": "A list of mapping entries for every supported specifier or sub-field.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A mapping applied to the authenticating end-entity certificate.
" + } + }, + "com.amazonaws.rolesanywhere#AttributeMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.rolesanywhere#AttributeMapping" + } + }, + "com.amazonaws.rolesanywhere#CertificateField": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "x509Subject", + "value": "x509Subject" + }, + { + "name": "x509Issuer", + "value": "x509Issuer" + }, + { + "name": "x509SAN", + "value": "x509SAN" + } + ] + } + }, "com.amazonaws.rolesanywhere#CreateProfile": { "type": "operation", "input": { @@ -327,6 +372,120 @@ "target": "com.amazonaws.rolesanywhere#CrlDetail" } }, + "com.amazonaws.rolesanywhere#DeleteAttributeMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.rolesanywhere#DeleteAttributeMappingRequest" + }, + "output": { + "target": "com.amazonaws.rolesanywhere#DeleteAttributeMappingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rolesanywhere#AccessDeniedException" + }, + { + "target": "com.amazonaws.rolesanywhere#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rolesanywhere#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete an entry from the attribute mapping rules enforced by a given profile.
", + "smithy.api#examples": [ + { + "title": "DeleteAttributeMapping - Deletes a custom attribute mapping rule", + "input": { + "profileId": "00000000-0000-0000-0000-000000000000", + "specifiers": [ + "OU" + ], + "certificateField": "x509Subject" + }, + "output": { + "profile": { + "attributeMappings": [ + { + "mappingRules": [ + { + "specifier": "CN" + } + ], + "certificateField": "x509Subject" + } + ], + "createdAt": "2021-07-19T15:55:25.986591Z", + "createdBy": "arn:aws:sts::123456789012:assumed-role/Admin/DummyRole", + "durationSeconds": 3600, + "enabled": true, + "managedPolicyArns": [], + "name": "Dummy Profile", + "profileArn": "arn:aws:rolesanywhere:us-east-1:123456789012:profile/00000000-0000-0000-0000-000000000000", + "profileId": "00000000-0000-0000-0000-000000000000", + "requireInstanceProperties": false, + "roleArns": [ + "arn:aws:iam::123456789012:role/DummyRole" + ], + "sessionPolicy": "", + "updatedAt": "2021-07-19T15:55:25.986591Z" + } + } + } + ], + "smithy.api#http": { + "uri": "/profiles/{profileId}/mappings", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.rolesanywhere#DeleteAttributeMappingRequest": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.rolesanywhere#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier of the profile.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "certificateField": { + "target": "com.amazonaws.rolesanywhere#CertificateField", + "traits": { + "smithy.api#documentation": "Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.
", + "smithy.api#httpQuery": "certificateField", + "smithy.api#required": {} + } + }, + "specifiers": { + "target": "com.amazonaws.rolesanywhere#SpecifierList", + "traits": { + "smithy.api#documentation": "A list of specifiers of a certificate field; for example, CN, OU, UID from a Subject.
", + "smithy.api#httpQuery": "specifiers" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rolesanywhere#DeleteAttributeMappingResponse": { + "type": "structure", + "members": { + "profile": { + "target": "com.amazonaws.rolesanywhere#ProfileDetail", + "traits": { + "smithy.api#documentation": "The state of the profile after a read or write operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.rolesanywhere#DeleteCrl": { "type": "operation", "input": { @@ -1054,6 +1213,30 @@ } } }, + "com.amazonaws.rolesanywhere#MappingRule": { + "type": "structure", + "members": { + "specifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specifier within a certificate field, such as CN, OU, or UID from the Subject field.
", + "smithy.api#length": { + "max": 60 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A single mapping entry for each supported specifier or sub-field.
" + } + }, + "com.amazonaws.rolesanywhere#MappingRules": { + "type": "list", + "member": { + "target": "com.amazonaws.rolesanywhere#MappingRule" + } + }, "com.amazonaws.rolesanywhere#NotificationChannel": { "type": "string", "traits": { @@ -1246,11 +1429,17 @@ "target": "com.amazonaws.rolesanywhere#ListProfiles" }, "operations": [ + { + "target": "com.amazonaws.rolesanywhere#DeleteAttributeMapping" + }, { "target": "com.amazonaws.rolesanywhere#DisableProfile" }, { "target": "com.amazonaws.rolesanywhere#EnableProfile" + }, + { + "target": "com.amazonaws.rolesanywhere#PutAttributeMapping" } ], "traits": { @@ -1343,6 +1532,12 @@ "traits": { "smithy.api#documentation": " Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the \nCreateSession API documentation\npage for more details. In requests, if this value is not provided, the default value will be 3600.
A mapping applied to the authenticating end-entity certificate.
" + } } }, "traits": { @@ -1366,6 +1561,121 @@ "target": "com.amazonaws.rolesanywhere#ProfileDetail" } }, + "com.amazonaws.rolesanywhere#PutAttributeMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.rolesanywhere#PutAttributeMappingRequest" + }, + "output": { + "target": "com.amazonaws.rolesanywhere#PutAttributeMappingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rolesanywhere#AccessDeniedException" + }, + { + "target": "com.amazonaws.rolesanywhere#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rolesanywhere#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Put an entry in the attribute mapping rules that will be enforced by a given profile. \n A mapping specifies a certificate field and one or more specifiers that have contextual meanings.
", + "smithy.api#examples": [ + { + "title": "PutAttributeMapping - Adds a custom attribute mapping rule", + "input": { + "profileId": "00000000-0000-0000-0000-000000000000", + "mappingRules": [ + { + "specifier": "CN" + } + ], + "certificateField": "x509Subject" + }, + "output": { + "profile": { + "attributeMappings": [ + { + "mappingRules": [ + { + "specifier": "CN" + } + ], + "certificateField": "x509Subject" + } + ], + "createdAt": "2021-07-19T15:55:25.986591Z", + "createdBy": "arn:aws:sts::123456789012:assumed-role/Admin/DummyRole", + "durationSeconds": 3600, + "enabled": true, + "managedPolicyArns": [], + "name": "Dummy Profile", + "profileArn": "arn:aws:rolesanywhere:us-east-1:123456789012:profile/00000000-0000-0000-0000-000000000000", + "profileId": "00000000-0000-0000-0000-000000000000", + "requireInstanceProperties": false, + "roleArns": [ + "arn:aws:iam::123456789012:role/DummyRole" + ], + "sessionPolicy": "", + "updatedAt": "2021-07-19T15:55:25.986591Z" + } + } + } + ], + "smithy.api#http": { + "uri": "/profiles/{profileId}/mappings", + "method": "PUT" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.rolesanywhere#PutAttributeMappingRequest": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.rolesanywhere#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier of the profile.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "certificateField": { + "target": "com.amazonaws.rolesanywhere#CertificateField", + "traits": { + "smithy.api#documentation": "Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.
", + "smithy.api#required": {} + } + }, + "mappingRules": { + "target": "com.amazonaws.rolesanywhere#MappingRules", + "traits": { + "smithy.api#documentation": "A list of mapping entries for every supported specifier or sub-field.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rolesanywhere#PutAttributeMappingResponse": { + "type": "structure", + "members": { + "profile": { + "target": "com.amazonaws.rolesanywhere#ProfileDetail", + "traits": { + "smithy.api#documentation": "The state of the profile after a read or write operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.rolesanywhere#PutNotificationSettings": { "type": "operation", "input": { @@ -2635,6 +2945,12 @@ "smithy.api#documentation": "The data field of the trust anchor depending on its type.
" } }, + "com.amazonaws.rolesanywhere#SpecifierList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.rolesanywhere#Subject": { "type": "resource", "identifiers": { diff --git a/codegen/sdk-codegen/aws-models/route53profiles.2018-05-10.json b/codegen/sdk-codegen/aws-models/route53profiles.2018-05-10.json new file mode 100644 index 00000000000..54abbdfaa3f --- /dev/null +++ b/codegen/sdk-codegen/aws-models/route53profiles.2018-05-10.json @@ -0,0 +1,2610 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.route53profiles#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "\n The current account doesn't have the IAM permissions required to perform the specified operation.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 32 + } + } + }, + "com.amazonaws.route53profiles#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53profiles#AssociateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#AssociateProfileRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#AssociateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ConflictException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#LimitExceededException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceExistsException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Associates a Route 53 Profiles profile with a VPC. A VPC can have only one Profile associated with it, but a Profile can be associated with up to 5000 VPCs.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/profileassociation", + "code": 200 + } + } + }, + "com.amazonaws.route53profiles#AssociateProfileRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile.\n
", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The ID of the VPC.\n
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n A name for the association.\n
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.route53profiles#TagList", + "traits": { + "smithy.api#documentation": "\n A list of the tag keys and values that you want to identify the Profile association.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#AssociateProfileResponse": { + "type": "structure", + "members": { + "ProfileAssociation": { + "target": "com.amazonaws.route53profiles#ProfileAssociation", + "traits": { + "smithy.api#documentation": "\n The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53profiles#AssociateResourceToProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#AssociateResourceToProfileRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#AssociateResourceToProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ConflictException" + }, + { + "target": "com.amazonaws.route53profiles#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#LimitExceededException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Associates a DNS reource configuration to a Route 53 Profile.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/profileresourceassociation", + "code": 200 + } + } + }, + "com.amazonaws.route53profiles#AssociateResourceToProfileRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile.\n
", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n Amazon resource number, ARN, of the DNS resource.\n
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n Name for the resource association.\n
", + "smithy.api#required": {} + } + }, + "ResourceProperties": { + "target": "com.amazonaws.route53profiles#ResourceProperties", + "traits": { + "smithy.api#documentation": "\n If you are adding a DNS Firewall rule group, include also a priority in this format:\n
\n\n Key=FirewallRuleGroupPriority,Value=100\n
\n Infromation about the AssociateResourceToProfile, including a status message.\n
\nThe request you submitted conflicts with an existing request.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#CreateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#CreateProfileRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#CreateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#LimitExceededException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Creates an empty Route 53 Profile.\n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/profile" + } + } + }, + "com.amazonaws.route53profiles#CreateProfileRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n A name for the Profile.\n
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.route53profiles#CreatorRequestId", + "traits": { + "smithy.api#documentation": "\n ClientToken is an idempotency token that ensures a call to CreateProfile completes only once. You choose the value to pass. \n For example, an issue might prevent you from getting a response from CreateProfile. \n In this case, safely retry your call to CreateProfile by using the same CreateProfile parameter value.\n
\n A list of the tag keys and values that you want to associate with the Route 53 Profile.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#CreateProfileResponse": { + "type": "structure", + "members": { + "Profile": { + "target": "com.amazonaws.route53profiles#Profile", + "traits": { + "smithy.api#documentation": "\n The Profile that you just created.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53profiles#CreatorRequestId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53profiles#DeleteProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#DeleteProfileRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#DeleteProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ConflictException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.\n
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/profile/{ProfileId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.route53profiles#DeleteProfileRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The ID of the Profile that you want to delete.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#DeleteProfileResponse": { + "type": "structure", + "members": { + "Profile": { + "target": "com.amazonaws.route53profiles#Profile", + "traits": { + "smithy.api#documentation": "\n Information about the DeleteProfile request, including the status of the request.\n
\n Dissociates a specified Route 53 Profile from the specified VPC.\n
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/profileassociation/Profileid/{ProfileId}/resourceid/{ResourceId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.route53profiles#DisassociateProfileRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The ID of the VPC.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#DisassociateProfileResponse": { + "type": "structure", + "members": { + "ProfileAssociation": { + "target": "com.amazonaws.route53profiles#ProfileAssociation", + "traits": { + "smithy.api#documentation": "\n Information about the DisassociateProfile request.\n
\n Dissoaciated a specified resource, from the Route 53 Profile.\n
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/profileresourceassociation/profileid/{ProfileId}/resourcearn/{ResourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.route53profiles#DisassociateResourceFromProfileRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The ID of the Profile.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#DisassociateResourceFromProfileResponse": { + "type": "structure", + "members": { + "ProfileResourceAssociation": { + "target": "com.amazonaws.route53profiles#ProfileResourceAssociation", + "traits": { + "smithy.api#documentation": "\n Information about the DisassociateResourceFromProfile request, including the status of the request.\n
\n Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profile/{ProfileId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#GetProfileAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#GetProfileAssociationRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#GetProfileAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Retrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile association, but a Profile can be associated with up to 5000 VPCs. \n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profileassociation/{ProfileAssociationId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#GetProfileAssociationRequest": { + "type": "structure", + "members": { + "ProfileAssociationId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The identifier of the association you want to get information about.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#GetProfileAssociationResponse": { + "type": "structure", + "members": { + "ProfileAssociation": { + "target": "com.amazonaws.route53profiles#ProfileAssociation", + "traits": { + "smithy.api#documentation": "\n Information about the Profile association that you specified in a GetProfileAssociation request.\n
\n ID of the Profile.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#GetProfileResourceAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#GetProfileResourceAssociationRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#GetProfileResourceAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Returns information about a specified Route 53 Profile resource association.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profileresourceassociation/{ProfileResourceAssociationId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#GetProfileResourceAssociationRequest": { + "type": "structure", + "members": { + "ProfileResourceAssociationId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n \n The ID of the profile resource association that you want to get information about.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#GetProfileResourceAssociationResponse": { + "type": "structure", + "members": { + "ProfileResourceAssociation": { + "target": "com.amazonaws.route53profiles#ProfileResourceAssociation", + "traits": { + "smithy.api#documentation": "\n Information about the Profile resource association that you specified in a GetProfileResourceAssociation request.\n
\n Information about the Profile, including the status of the Profile.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53profiles#InternalServiceErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "\nAn internal server error occured. Retry your request.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#InvalidNextTokenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#String" + } + }, + "traits": { + "smithy.api#documentation": "\nThe NextToken you provided isn;t valid.\n
\n The parameter field name for the invalid parameter exception.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n One or more parameters in this request are not valid.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#String" + }, + "ResourceType": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n The resource type that caused the limits to be exceeded.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The request caused one or more limits to be exceeded.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#ListProfileAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#ListProfileAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#ListProfileAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Lists all the VPCs that the specified Route 53 Profile is associated with.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profileassociations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ProfileAssociations", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#ListProfileAssociationsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the VPC.\n
", + "smithy.api#httpQuery": "resourceId" + } + }, + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\nID of the Profile.\n
", + "smithy.api#httpQuery": "profileId" + } + }, + "MaxResults": { + "target": "com.amazonaws.route53profiles#MaxResults", + "traits": { + "smithy.api#documentation": "\n The maximum number of objects that you want to return for this request. If more objects are available, in the response, \n a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.
\n If you don't specify a value for MaxResults, up to 100 objects are returned.\n
\n For the first call to this list request, omit this value.\n
\nWhen you request a list of objects, at most the number of objects specified by MaxResults is returned. \n If more objects are available for retrieval, a NextToken value is returned in the response. \n To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
\n A complex type that containts settings information about the profile's VPC associations.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.route53profiles#NextToken", + "traits": { + "smithy.api#documentation": "\n If more than MaxResults profile associations match the specified criteria, you can submit another \n ListProfileAssociations request to get the next group of results. In the next request, specify the value of NextToken from the previous response.\n
\n Lists all the resource associations for the specified Route 53 Profile.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profileresourceassociations/profileid/{ProfileId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ProfileResourceAssociations", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#ListProfileResourceAssociationsRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\nThe ID of the Profile.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n ID of a resource if you want information on only one type.\n
", + "smithy.api#httpQuery": "resourceType" + } + }, + "MaxResults": { + "target": "com.amazonaws.route53profiles#MaxResults", + "traits": { + "smithy.api#documentation": "\n The maximum number of objects that you want to return for this request. If more objects are available, in the response, \n a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.
\n If you don't specify a value for MaxResults, up to 100 objects are returned.\n
\n For the first call to this list request, omit this value.\n
\nWhen you request a list of objects, at most the number of objects specified by MaxResults is returned. \n If more objects are available for retrieval, a NextToken value is returned in the response. \n To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
\n Information about the profile resource association that you specified in a GetProfileResourceAssociation request.\n
\n If more than MaxResults resource associations match the specified criteria, you can submit another \n ListProfileResourceAssociations request to get the next group of results. In the next request, specify the value of NextToken from the previous response.\n
\n Lists all the Route 53 Profiles associated with your Amazon Web Services account.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profiles", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ProfileSummaries", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#ListProfilesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.route53profiles#MaxResults", + "traits": { + "smithy.api#documentation": "\n The maximum number of objects that you want to return for this request. If more objects are available, in the response, \n a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.
\n If you don't specify a value for MaxResults, up to 100 objects are returned.\n
\n For the first call to this list request, omit this value.\n
\nWhen you request a list of objects, at most the number of objects specified by MaxResults is returned. \n If more objects are available for retrieval, a NextToken value is returned in the response. \n To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
\n Summary information about the Profiles.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.route53profiles#NextToken", + "traits": { + "smithy.api#documentation": "\n If more than MaxResults resource associations match the specified criteria, you can submit another \n ListProfiles request to get the next group of results. In the next request, specify the value of NextToken from the previous response.\n
\n Lists the tags that you associated with the specified resource.\n
", + "smithy.api#http": { + "uri": "/tags/{ResourceArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for the resource that you want to list the tags for.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.route53profiles#TagMap", + "traits": { + "smithy.api#documentation": "\n The tags that are associated with the resource that you specified in the ListTagsForResource request.\n
\nID of the Profile.\n
" + } + }, + "Arn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the Profile.\n
" + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\nName of the Profile.\n
" + } + }, + "OwnerId": { + "target": "com.amazonaws.route53profiles#AccountId", + "traits": { + "smithy.api#documentation": "\n Amazon Web Services account ID of the Profile owner.\n
" + } + }, + "Status": { + "target": "com.amazonaws.route53profiles#ProfileStatus", + "traits": { + "smithy.api#documentation": "\n The status for the Profile.\n
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n Status message that includes additiona information about the Profile.\n
" + } + }, + "ShareStatus": { + "target": "com.amazonaws.route53profiles#ShareStatus", + "traits": { + "smithy.api#documentation": "\n Sharing status for the Profile.\n
" + } + }, + "CreationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile was created, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + }, + "ModificationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile was modified, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + }, + "ClientToken": { + "target": "com.amazonaws.route53profiles#CreatorRequestId", + "traits": { + "smithy.api#documentation": "\n The ClientToken value that was assigned when the Profile was created.\n
\n A complex type that includes settings for a Route 53 Profile.\n
" + } + }, + "com.amazonaws.route53profiles#ProfileAssociation": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile association.\n
" + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n Name of the Profile association.\n
" + } + }, + "OwnerId": { + "target": "com.amazonaws.route53profiles#AccountId", + "traits": { + "smithy.api#documentation": "\n Amazon Web Services account ID of the Profile association owner.\n
" + } + }, + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\nID of the Profile.\n
" + } + }, + "ResourceId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the VPC.\n
" + } + }, + "Status": { + "target": "com.amazonaws.route53profiles#ProfileStatus", + "traits": { + "smithy.api#documentation": "\n Status of the Profile association.\n
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n Additional information about the Profile association.\n
" + } + }, + "CreationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile association was created, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + }, + "ModificationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile association was modified, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n An association between a Route 53 Profile and a VPC.\n
" + } + }, + "com.amazonaws.route53profiles#ProfileAssociations": { + "type": "list", + "member": { + "target": "com.amazonaws.route53profiles#ProfileAssociation" + } + }, + "com.amazonaws.route53profiles#ProfileResourceAssociation": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile resource association.\n
" + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n Name of the Profile resource association.\n
" + } + }, + "OwnerId": { + "target": "com.amazonaws.route53profiles#AccountId", + "traits": { + "smithy.api#documentation": "\n Amazon Web Services account ID of the Profile resource association owner.\n
" + } + }, + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n Profile ID of the Profile that the resources are associated with.\n
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the resource association.\n
" + } + }, + "ResourceType": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n Resource type, such as a private hosted zone, or DNS Firewall rule group.\n
" + } + }, + "ResourceProperties": { + "target": "com.amazonaws.route53profiles#ResourceProperties", + "traits": { + "smithy.api#documentation": "\n If the DNS resource is a DNS Firewall rule group, this indicates the priority.\n
" + } + }, + "Status": { + "target": "com.amazonaws.route53profiles#ProfileStatus", + "traits": { + "smithy.api#documentation": "\n Status of the Profile resource association.\n
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n Additional information about the Profile resource association.\n
" + } + }, + "CreationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + }, + "ModificationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The association between a Route 53 Profile and resources.\n
" + } + }, + "com.amazonaws.route53profiles#ProfileResourceAssociations": { + "type": "list", + "member": { + "target": "com.amazonaws.route53profiles#ProfileResourceAssociation" + } + }, + "com.amazonaws.route53profiles#ProfileStatus": { + "type": "enum", + "members": { + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.route53profiles#ProfileSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile.\n
" + } + }, + "Arn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the Profile.\n
" + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n Name of the Profile.\n
" + } + }, + "ShareStatus": { + "target": "com.amazonaws.route53profiles#ShareStatus", + "traits": { + "smithy.api#documentation": "\n Share status of the Profile.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Summary information about a Route 53 Profile.\n
" + } + }, + "com.amazonaws.route53profiles#ProfileSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53profiles#ProfileSummary" + } + }, + "com.amazonaws.route53profiles#ResourceExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#String" + }, + "ResourceType": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n The resource type that caused the resource exists exception.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The resource you are trying to associate, has already been associated.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53profiles#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#String" + }, + "ResourceType": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n The resource type that caused the resource not found exception.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nThe resource you are associating is not found.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#ResourceProperties": { + "type": "string" + }, + "com.amazonaws.route53profiles#Rfc3339Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.route53profiles#Route53Profiles": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.route53profiles#AssociateProfile" + }, + { + "target": "com.amazonaws.route53profiles#AssociateResourceToProfile" + }, + { + "target": "com.amazonaws.route53profiles#CreateProfile" + }, + { + "target": "com.amazonaws.route53profiles#DeleteProfile" + }, + { + "target": "com.amazonaws.route53profiles#DisassociateProfile" + }, + { + "target": "com.amazonaws.route53profiles#DisassociateResourceFromProfile" + }, + { + "target": "com.amazonaws.route53profiles#GetProfile" + }, + { + "target": "com.amazonaws.route53profiles#GetProfileAssociation" + }, + { + "target": "com.amazonaws.route53profiles#GetProfileResourceAssociation" + }, + { + "target": "com.amazonaws.route53profiles#ListProfileAssociations" + }, + { + "target": "com.amazonaws.route53profiles#ListProfileResourceAssociations" + }, + { + "target": "com.amazonaws.route53profiles#ListProfiles" + }, + { + "target": "com.amazonaws.route53profiles#ListTagsForResource" + }, + { + "target": "com.amazonaws.route53profiles#TagResource" + }, + { + "target": "com.amazonaws.route53profiles#UntagResource" + }, + { + "target": "com.amazonaws.route53profiles#UpdateProfileResourceAssociation" + } + ], + "traits": { + "aws.api#service": { + "cloudTrailEventSource": "route53profiles.amazonaws.com", + "sdkId": "Route53Profiles", + "arnNamespace": "route53profiles" + }, + "aws.auth#sigv4": { + "name": "route53profiles" + }, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the presence of tag key-value pairs attached to the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the presence of tag key-value pairs in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by the presence of tag keys in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "\n With Amazon Route 53 Profiles you can share Route 53 configurations with VPCs and AWS accounts\n
", + "smithy.api#title": "Route 53 Profiles", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53profiles-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53profiles-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53profiles.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53profiles.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.route53profiles#ShareStatus": { + "type": "enum", + "members": { + "NOT_SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_SHARED" + } + }, + "SHARED_WITH_ME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED_WITH_ME" + } + }, + "SHARED_BY_ME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED_BY_ME" + } + } + } + }, + "com.amazonaws.route53profiles#String": { + "type": "string" + }, + "com.amazonaws.route53profiles#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.route53profiles#TagKey", + "traits": { + "smithy.api#documentation": "\n Key associated with the Tag.\n
\nValue for the Tag.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\nTag for the Profile.\n
" + } + }, + "com.amazonaws.route53profiles#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.route53profiles#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53profiles#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.route53profiles#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53profiles#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.route53profiles#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.route53profiles#TagKey" + }, + "value": { + "target": "com.amazonaws.route53profiles#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.route53profiles#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Adds one or more tags to a specified resource.\n
", + "smithy.api#http": { + "uri": "/tags/{ResourceArn}", + "method": "POST", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.route53profiles#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for the resource that you want to add tags to. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.route53profiles#TagMap", + "traits": { + "smithy.api#documentation": "\n The tags that you want to add to the specified resource.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53profiles#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.route53profiles#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "\n The request was throttled. Try again in a few minutes.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ConflictException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Removes one or more tags from a specified resource.\n
", + "smithy.api#http": { + "uri": "/tags/{ResourceArn}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.route53profiles#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for the resource that you want to remove tags from.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.route53profiles#TagKeyList", + "traits": { + "smithy.api#documentation": "\n The tags that you want to remove to the specified resource.\n
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53profiles#UpdateProfileResourceAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#UpdateProfileResourceAssociationRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#UpdateProfileResourceAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ConflictException" + }, + { + "target": "com.amazonaws.route53profiles#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#LimitExceededException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nUpdates the specified Route 53 Profile resourse association.\n
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/profileresourceassociation/{ProfileResourceAssociationId}", + "code": 200 + } + } + }, + "com.amazonaws.route53profiles#UpdateProfileResourceAssociationRequest": { + "type": "structure", + "members": { + "ProfileResourceAssociationId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\nID of the resource association.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\nName of the resource association.\n
" + } + }, + "ResourceProperties": { + "target": "com.amazonaws.route53profiles#ResourceProperties", + "traits": { + "smithy.api#documentation": "\n If you are adding a DNS Firewall rule group, include also a priority in this format:
\n\n Key=FirewallRuleGroupPriority,Value=100.\n
\n Information about the UpdateProfileResourceAssociation request, including a status message.\n
\n You have provided an invalid command.\n
", + "smithy.api#error": "client" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/s3-control.2018-08-20.json b/codegen/sdk-codegen/aws-models/s3-control.2018-08-20.json index 75e5c663b05..718467956ed 100644 --- a/codegen/sdk-codegen/aws-models/s3-control.2018-08-20.json +++ b/codegen/sdk-codegen/aws-models/s3-control.2018-08-20.json @@ -7826,7 +7826,7 @@ "BucketAccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
" + "smithy.api#documentation": "The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
\nFor same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. \n For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required.\n
This operation creates an S3 Batch Operations job.
\nYou can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.\n Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.
\nFor information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3\n User Guide.
\nRelated actions include:
\n\n DescribeJob\n
\n\n ListJobs\n
\n\n UpdateJobPriority\n
\n\n UpdateJobStatus\n
\n\n JobOperation\n
\nThis operation creates an S3 Batch Operations job.
\nYou can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.\n Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.
\nFor information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3\n User Guide.
\nRelated actions include:
\n\n DescribeJob\n
\n\n ListJobs\n
\n\n UpdateJobPriority\n
\n\n UpdateJobStatus\n
\n\n JobOperation\n
\nThis operation is not supported by directory buckets.
\nCreates a Multi-Region Access Point and associates it with the specified buckets. For more information\n about creating Multi-Region Access Points, see Creating\n Multi-Region Access Points in the Amazon S3 User Guide.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.
\nThis request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.
The following actions are related to CreateMultiRegionAccessPoint:
This operation is not supported by directory buckets.
\nCreates a Multi-Region Access Point and associates it with the specified buckets. For more information\n about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThis request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.
The following actions are related to CreateMultiRegionAccessPoint:
This operation is not supported by directory buckets.
\nDeletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point,\n only the Multi-Region Access Point itself.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.
\nThis request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.
The following actions are related to DeleteMultiRegionAccessPoint:
This operation is not supported by directory buckets.
\nDeletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point,\n only the Multi-Region Access Point itself.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThis request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.
The following actions are related to DeleteMultiRegionAccessPoint:
This operation is not supported by directory buckets.
\nRetrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information\n about managing Multi-Region Access Points and how asynchronous requests work, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.
\nThe following actions are related to GetMultiRegionAccessPoint:
This operation is not supported by directory buckets.
\nRetrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information\n about managing Multi-Region Access Points and how asynchronous requests work, see Using Multi-Region Access Points in the Amazon S3 User Guide.
\nThe following actions are related to GetMultiRegionAccessPoint:
Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.
\nIf you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the s3-outposts:GetBucket\n permissions on the specified Outposts bucket and belong to the Outposts bucket owner's\n account in order to use this action. Only users from Outposts bucket owner account with\n the right permissions can perform actions on an Outposts bucket.
If you don't have s3-outposts:GetBucket permissions or you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access\n Denied error.
The following actions are related to GetBucket for Amazon S3 on Outposts:
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
\n PutObject\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\nGets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.
\nIf you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the s3-outposts:GetBucket\n permissions on the specified Outposts bucket and belong to the Outposts bucket owner's\n account in order to use this action. Only users from Outposts bucket owner account with\n the right permissions can perform actions on an Outposts bucket.
If you don't have s3-outposts:GetBucket permissions or you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access\n Denied error.
The following actions are related to GetBucket for Amazon S3 on Outposts:
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
\n PutObject\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\nReturns a temporary access credential from S3 Access Grants to the grantee or client application. The temporary credential is an Amazon Web Services STS token that grants them access to the S3 data.
\nYou must have the s3:GetDataAccess permission to use this operation.
The IAM role that S3 Access Grants assumes must have the following permissions specified in the trust policy when registering the location: sts:AssumeRole, for directory users or groups sts:SetContext, and for IAM users or roles sts:SourceIdentity.
Returns a temporary access credential from S3 Access Grants to the grantee or client application. The temporary credential is an Amazon Web Services STS token that grants them access to the S3 data.
\nYou must have the s3:GetDataAccess permission to use this operation.
The IAM role that S3 Access Grants assumes must have the following permissions specified in the trust policy when registering the location: sts:AssumeRole, for directory users or groups sts:SetContext, and for IAM users or roles sts:SetSourceIdentity.
This operation is not supported by directory buckets.
\nReturns configuration information about the specified Multi-Region Access Point.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.
\nThe following actions are related to GetMultiRegionAccessPoint:
This operation is not supported by directory buckets.
\nReturns configuration information about the specified Multi-Region Access Point.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThe following actions are related to GetMultiRegionAccessPoint:
This operation is not supported by directory buckets.
\nReturns the access control policy of the specified Multi-Region Access Point.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.
\nThe following actions are related to\n GetMultiRegionAccessPointPolicy:
This operation is not supported by directory buckets.
\nReturns the access control policy of the specified Multi-Region Access Point.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThe following actions are related to\n GetMultiRegionAccessPointPolicy:
Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more\n information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points in the\n Amazon S3 User Guide.
", + "smithy.api#documentation": "Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more\n information about the distinction between the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the\n Amazon S3 User Guide.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11612,7 +11612,7 @@ "target": "com.amazonaws.s3control#GetMultiRegionAccessPointPolicyStatusResult" }, "traits": { - "smithy.api#documentation": "This operation is not supported by directory buckets.
\nIndicates whether the specified Multi-Region Access Point has an access control policy that allows public\n access.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.
\nThe following actions are related to\n GetMultiRegionAccessPointPolicyStatus:
This operation is not supported by directory buckets.
\nIndicates whether the specified Multi-Region Access Point has an access control policy that allows public\n access.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThe following actions are related to\n GetMultiRegionAccessPointPolicyStatus:
Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more\n information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points in the\n Amazon S3 User Guide.
", + "smithy.api#documentation": "Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more\n information about the distinction between the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the\n Amazon S3 User Guide.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11686,7 +11686,7 @@ "Name": { "target": "com.amazonaws.s3control#MultiRegionAccessPointName", "traits": { - "smithy.api#documentation": "The name of the Multi-Region Access Point whose configuration information you want to receive. The name of\n the Multi-Region Access Point is different from the alias. For more information about the distinction between\n the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points in the\n Amazon S3 User Guide.
", + "smithy.api#documentation": "The name of the Multi-Region Access Point whose configuration information you want to receive. The name of\n the Multi-Region Access Point is different from the alias. For more information about the distinction between\n the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the\n Amazon S3 User Guide.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11719,7 +11719,7 @@ "target": "com.amazonaws.s3control#GetMultiRegionAccessPointRoutesResult" }, "traits": { - "smithy.api#documentation": "This operation is not supported by directory buckets.
\nReturns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or\n passive.
\nTo obtain routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:
\n\n us-east-1\n
\n us-west-2\n
\n ap-southeast-2\n
\n ap-northeast-1\n
\n eu-west-1\n
Your Amazon S3 bucket does not need to be in these five Regions.
\nThis operation is not supported by directory buckets.
\nReturns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or\n passive.
\nTo obtain routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:
\n\n us-east-1\n
\n us-west-2\n
\n ap-southeast-2\n
\n ap-northeast-1\n
\n eu-west-1\n
Specifies the schema version for the payload that Batch Operations sends when invoking\n an Lambda function. Version 1.0 is the default. Version\n 2.0 is required when you use Batch Operations to invoke Lambda functions that act on directory buckets, or if you need to specify\n UserArguments. For more information, see Using Lambda with Amazon S3 Batch Operations and Amazon S3 Express One Zone in the Amazon Web Services Storage\n Blog.
Ensure that your Lambda function code expects\n InvocationSchemaVersion\n 2.0 and uses bucket name rather than bucket ARN. If the\n InvocationSchemaVersion does not match what your Lambda\n function expects, your function might not work as expected.
\n Directory buckets - To initiate Amazon Web Services Lambda function to perform custom actions on objects in directory buckets, you must specify 2.0.
Specifies the schema version for the payload that Batch Operations sends when invoking\n an Lambda function. Version 1.0 is the default. Version\n 2.0 is required when you use Batch Operations to invoke Lambda functions that act on directory buckets, or if you need to specify\n UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and\n Lambda in the Amazon Web Services Storage Blog.
Ensure that your Lambda function code expects\n InvocationSchemaVersion\n 2.0 and uses bucket name rather than bucket ARN. If the\n InvocationSchemaVersion does not match what your Lambda\n function expects, your function might not work as expected.
\n Directory buckets - To initiate Amazon Web Services Lambda function to perform custom actions on objects in directory buckets, you must specify 2.0.
Key-value pairs that are passed in the payload that Batch Operations sends when invoking\n an Lambda function. You must specify InvocationSchemaVersion\n 2.0 for LambdaInvoke operations that include\n UserArguments. For more information, see Using Lambda with Amazon S3 Batch Operations and Amazon S3 Express One Zone in the Amazon Web Services Storage\n Blog.
Key-value pairs that are passed in the payload that Batch Operations sends when invoking\n an Lambda function. You must specify InvocationSchemaVersion\n 2.0 for LambdaInvoke operations that include\n UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and\n Lambda in the Amazon Web Services Storage Blog.
Minimum object size to which the rule applies.
" + "smithy.api#documentation": "The non-inclusive minimum object size for the lifecycle rule. Setting this property to 7 means the rule applies to objects with a size that is greater than 7.
" } }, "ObjectSizeLessThan": { "target": "com.amazonaws.s3control#ObjectSizeLessThanBytes", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "Maximum object size to which the rule applies.
" + "smithy.api#documentation": "The non-inclusive maximum object size for the lifecycle rule. Setting this property to 77 means the rule applies to objects with a size that is less than 77.
" } } }, @@ -13882,7 +13882,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 30 days for\n the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the\n Amazon S3 User Guide.
\nTo use the\n ListJobs operation, you must have permission to\n perform the s3:ListJobs action.
Related actions include:
\n \n\n CreateJob\n
\n\n DescribeJob\n
\n\n UpdateJobPriority\n
\n\n UpdateJobStatus\n
\nLists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90\n days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
\nTo use the\n ListJobs operation, you must have permission to\n perform the s3:ListJobs action.
Related actions include:
\n \n\n CreateJob\n
\n\n DescribeJob\n
\n\n UpdateJobPriority\n
\n\n UpdateJobStatus\n
\nThis operation is not supported by directory buckets.
\nReturns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.\n Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be\n associated with a single account.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.
\nThe following actions are related to ListMultiRegionAccessPoint:
This operation is not supported by directory buckets.
\nReturns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.\n Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be\n associated with a single account.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThe following actions are related to ListMultiRegionAccessPoint:
The alias for the Multi-Region Access Point. For more information about the distinction between the name\n and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points.
" + "smithy.api#documentation": "The alias for the Multi-Region Access Point. For more information about the distinction between the name\n and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points.
" } }, "CreatedAt": { @@ -16262,7 +16262,7 @@ "target": "com.amazonaws.s3control#PutMultiRegionAccessPointPolicyResult" }, "traits": { - "smithy.api#documentation": "This operation is not supported by directory buckets.
\nAssociates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only\n one policy, so a request made to this action replaces any existing policy that is\n associated with the specified Multi-Region Access Point.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.
\nThe following actions are related to\n PutMultiRegionAccessPointPolicy:
This operation is not supported by directory buckets.
\nAssociates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only\n one policy, so a request made to this action replaces any existing policy that is\n associated with the specified Multi-Region Access Point.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThe following actions are related to\n PutMultiRegionAccessPointPolicy:
Specifies the destination bucket\n Amazon Resource Name\n (ARN)\n for the batch copy operation.
\n\n General purpose buckets - For example, to copy objects to a general purpose bucket named\n destinationBucket, set the TargetResource property to\n arn:aws:s3:::destinationBucket.
\n Directory buckets - For example, to copy objects to a directory bucket named\n destinationBucket in the Availability Zone; identified by the AZ ID usw2-az2, set the TargetResource property to\n arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az2--x-s3.
Specifies the destination bucket\n Amazon Resource Name\n (ARN)\n for the batch copy operation.
\n\n General purpose buckets - For example, to copy objects to a general purpose bucket named\n destinationBucket, set the TargetResource property to\n arn:aws:s3:::destinationBucket.
\n Directory buckets - For example, to copy objects to a directory bucket named\n destinationBucket in the Availability Zone; identified by the AZ ID usw2-az1, set the TargetResource property to\n arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3.
This operation is not supported by directory buckets.
\nSubmits an updated route configuration for a Multi-Region Access Point. This API operation updates the\n routing status for the specified Regions from active to passive, or from passive to active.\n A value of 0 indicates a passive status, which means that traffic won't be\n routed to the specified Region. A value of 100 indicates an active status,\n which means that traffic will be routed to the specified Region. At least one Region must\n be active at all times.
When the routing configuration is changed, any in-progress operations (uploads, copies,\n deletes, and so on) to formerly active Regions will continue to run to their final\n completion state (success or failure). The routing configurations of any Regions that\n aren’t specified remain unchanged.
\nUpdated routing configurations might not be immediately applied. It can take up to 2\n minutes for your changes to take effect.
\nTo submit routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:
\n\n us-east-1\n
\n us-west-2\n
\n ap-southeast-2\n
\n ap-northeast-1\n
\n eu-west-1\n
Your Amazon S3 bucket does not need to be in these five Regions.
\nThis operation is not supported by directory buckets.
\nSubmits an updated route configuration for a Multi-Region Access Point. This API operation updates the\n routing status for the specified Regions from active to passive, or from passive to active.\n A value of 0 indicates a passive status, which means that traffic won't be\n routed to the specified Region. A value of 100 indicates an active status,\n which means that traffic will be routed to the specified Region. At least one Region must\n be active at all times.
When the routing configuration is changed, any in-progress operations (uploads, copies,\n deletes, and so on) to formerly active Regions will continue to run to their final\n completion state (success or failure). The routing configurations of any Regions that\n aren’t specified remain unchanged.
\nUpdated routing configurations might not be immediately applied. It can take up to 2\n minutes for your changes to take effect.
\nTo submit routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:
\n\n us-east-1\n
\n us-west-2\n
\n ap-southeast-2\n
\n ap-northeast-1\n
\n eu-west-1\n
An Amazon S3 bucket path where your LifeCycle scripts are stored.
", + "smithy.api#documentation": "An Amazon S3 bucket path where your lifecycle scripts are stored.
\nMake sure that the S3 bucket path starts with s3://sagemaker-. The\n IAM role for SageMaker HyperPod has the managed \n AmazonSageMakerClusterInstanceRolePolicy\n attached, which\n allows access to S3 buckets with the specific prefix sagemaker-.
The directory of the LifeCycle script under SourceS3Uri. This LifeCycle\n script runs during cluster creation.
The file name of the entrypoint script of lifecycle scripts under\n SourceS3Uri. This entrypoint script runs during cluster creation.
The LifeCycle configuration for a SageMaker HyperPod cluster.
" + "smithy.api#documentation": "The lifecycle configuration for a SageMaker HyperPod cluster.
" } }, "com.amazonaws.sagemaker#ClusterLifeCycleConfigFileName": { @@ -9899,7 +9881,7 @@ "target": "com.amazonaws.sagemaker#FeatureGroupName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
The name:
\nMust start and end with an alphanumeric character.
\nCan only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.
\nThe name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
The name:
\nMust start with an alphanumeric character.
\nCan only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.
\nThe name of the Feature whose value uniquely identifies a\n Record defined in the FeatureStore. Only the latest record per\n identifier value will be stored in the OnlineStore.\n RecordIdentifierFeatureName must be one of feature definitions'\n names.
You use the RecordIdentifierFeatureName to access data in a\n FeatureStore.
This name:
\nMust start and end with an alphanumeric character.
\nCan only contains alphanumeric characters, hyphens, underscores. Spaces are not\n allowed.
\nThe name of the Feature whose value uniquely identifies a\n Record defined in the FeatureStore. Only the latest record per\n identifier value will be stored in the OnlineStore.\n RecordIdentifierFeatureName must be one of feature definitions'\n names.
You use the RecordIdentifierFeatureName to access data in a\n FeatureStore.
This name:
\nMust start with an alphanumeric character.
\nCan only contains alphanumeric characters, hyphens, underscores. Spaces are not\n allowed.
\nThe default size of the EBS storage volume for a private space.
", + "smithy.api#documentation": "The default size of the EBS storage volume for a space.
", "smithy.api#required": {} } }, @@ -14107,13 +14089,13 @@ "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum size of the EBS storage volume for a private space.
", + "smithy.api#documentation": "The maximum size of the EBS storage volume for a space.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A collection of default EBS storage settings that applies to private spaces created within a domain or user profile.
" + "smithy.api#documentation": "A collection of default EBS storage settings that apply to spaces created within a domain or user profile.
" } }, "com.amazonaws.sagemaker#DefaultGid": { @@ -14145,6 +14127,21 @@ }, "KernelGatewayAppSettings": { "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings" + }, + "JupyterLabAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterLabAppSettings" + }, + "SpaceStorageSettings": { + "target": "com.amazonaws.sagemaker#DefaultSpaceStorageSettings" + }, + "CustomPosixUserConfig": { + "target": "com.amazonaws.sagemaker#CustomPosixUserConfig" + }, + "CustomFileSystemConfigs": { + "target": "com.amazonaws.sagemaker#CustomFileSystemConfigs", + "traits": { + "smithy.api#documentation": "The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.
" + } } }, "traits": { @@ -14157,12 +14154,12 @@ "DefaultEbsStorageSettings": { "target": "com.amazonaws.sagemaker#DefaultEbsStorageSettings", "traits": { - "smithy.api#documentation": "The default EBS storage settings for a private space.
" + "smithy.api#documentation": "The default EBS storage settings for a space.
" } } }, "traits": { - "smithy.api#documentation": "The default storage settings for a private space.
" + "smithy.api#documentation": "The default storage settings for a space.
" } }, "com.amazonaws.sagemaker#DefaultUid": { @@ -25384,13 +25381,13 @@ "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The size of an EBS storage volume for a private space.
", + "smithy.api#documentation": "The size of an EBS storage volume for a space.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A collection of EBS storage settings that applies to private spaces.
" + "smithy.api#documentation": "A collection of EBS storage settings that apply to both private and shared spaces.
" } }, "com.amazonaws.sagemaker#Edge": { @@ -27129,7 +27126,7 @@ "target": "com.amazonaws.sagemaker#FeatureName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of a feature. The type must be a string. FeatureName cannot be any\n of the following: is_deleted, write_time,\n api_invocation_time.
The name:
\nMust start and end with an alphanumeric character.
\nCan only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.
\nThe name of a feature. The type must be a string. FeatureName cannot be any\n of the following: is_deleted, write_time,\n api_invocation_time.
The name:
\nMust start with an alphanumeric character.
\nCan only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.
\nThe user profile who is the owner of the private space.
", + "smithy.api#documentation": "The user profile who is the owner of the space.
", "smithy.api#required": {} } } @@ -47655,7 +47652,7 @@ "OwnerUserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "The user profile who is the owner of the private space.
" + "smithy.api#documentation": "The user profile who is the owner of the space.
" } } }, @@ -58022,7 +58019,7 @@ "SpaceStorageSettings": { "target": "com.amazonaws.sagemaker#SpaceStorageSettings", "traits": { - "smithy.api#documentation": "The storage settings for a private space.
" + "smithy.api#documentation": "The storage settings for a space.
" } }, "CustomFileSystems": { @@ -58048,7 +58045,7 @@ "SpaceStorageSettings": { "target": "com.amazonaws.sagemaker#SpaceStorageSettings", "traits": { - "smithy.api#documentation": "The storage settings for a private space.
" + "smithy.api#documentation": "The storage settings for a space.
" } } }, @@ -58156,12 +58153,12 @@ "EbsStorageSettings": { "target": "com.amazonaws.sagemaker#EbsStorageSettings", "traits": { - "smithy.api#documentation": "A collection of EBS storage settings for a private space.
" + "smithy.api#documentation": "A collection of EBS storage settings for a space.
" } } }, "traits": { - "smithy.api#documentation": "The storage settings for a private space.
" + "smithy.api#documentation": "The storage settings for a space.
" } }, "com.amazonaws.sagemaker#SpawnRate": { @@ -66384,7 +66381,7 @@ "SpaceStorageSettings": { "target": "com.amazonaws.sagemaker#DefaultSpaceStorageSettings", "traits": { - "smithy.api#documentation": "The storage settings for a private space.
" + "smithy.api#documentation": "The storage settings for a space.
" } }, "DefaultLandingUri": { diff --git a/codegen/sdk-codegen/aws-models/servicediscovery.2017-03-14.json b/codegen/sdk-codegen/aws-models/servicediscovery.2017-03-14.json index 9a14d84a2e6..483b9e06716 100644 --- a/codegen/sdk-codegen/aws-models/servicediscovery.2017-03-14.json +++ b/codegen/sdk-codegen/aws-models/servicediscovery.2017-03-14.json @@ -105,7 +105,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an HTTP namespace. Service instances registered using an HTTP namespace can be\n discovered using a DiscoverInstances request but can't be discovered using\n DNS.
For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.
", + "smithy.api#documentation": "Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a\n DiscoverInstances request but can't be discovered using DNS.
For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map\n quotas in the Cloud Map Developer Guide.
", "smithy.api#examples": [ { "title": "CreateHttpNamespace example", @@ -135,7 +135,7 @@ "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "A unique string that identifies the request and that allows failed\n CreateHttpNamespace requests to be retried without the risk of running the\n operation twice. CreatorRequestId can be any unique string (for example, a date/time\n stamp).
A unique string that identifies the request and that allows failed CreateHttpNamespace\n requests to be retried without the risk of running the operation twice. CreatorRequestId can be any\n unique string (for example, a date/time stamp).
The tags to add to the namespace. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" + "smithy.api#documentation": "The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" } } }, @@ -196,7 +196,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a private namespace based on DNS, which is visible only inside a specified Amazon\n VPC. The namespace defines your service naming scheme. For example, if you name your namespace\n example.com and name your service backend, the resulting DNS name for\n the service is backend.example.com. Service instances that are registered using a\n private DNS namespace can be discovered using either a DiscoverInstances request or\n using DNS. For the current quota on the number of namespaces that you can create using the same\n Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The\n namespace defines your service naming scheme. For example, if you name your namespace example.com\n and name your service backend, the resulting DNS name for the service is\n backend.example.com. Service instances that are registered using a private DNS namespace can be\n discovered using either a DiscoverInstances request or using DNS. For the current quota on the\n number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.
The name that you want to assign to this namespace. When you create a private DNS namespace,\n Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the\n namespace.
", + "smithy.api#documentation": "The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map\n automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.
", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "A unique string that identifies the request and that allows failed\n CreatePrivateDnsNamespace requests to be retried without the risk of running the\n operation twice. CreatorRequestId can be any unique string (for example, a\n date/timestamp).
A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace\n requests to be retried without the risk of running the operation twice. CreatorRequestId can be any\n unique string (for example, a date/timestamp).
The tags to add to the namespace. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" + "smithy.api#documentation": "The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PrivateDnsNamespaceProperties", "traits": { - "smithy.api#documentation": "Properties for the\n private DNS namespace.
" + "smithy.api#documentation": "Properties for the private DNS\n namespace.
" } } }, @@ -300,7 +300,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a public namespace based on DNS, which is visible on the internet. The namespace\n defines your service naming scheme. For example, if you name your namespace\n example.com and name your service backend, the resulting DNS name for\n the service is backend.example.com. You can discover instances that were registered\n with a public DNS namespace by using either a DiscoverInstances request or using\n DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.
The CreatePublicDnsNamespace API operation is not supported in the Amazon Web Services GovCloud (US) Regions.
Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your\n service naming scheme. For example, if you name your namespace example.com and name your service\n backend, the resulting DNS name for the service is backend.example.com. You can\n discover instances that were registered with a public DNS namespace by using either a\n DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you\n can create using the same Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.
The CreatePublicDnsNamespace API operation is not supported in the Amazon Web Services GovCloud (US)\n Regions.
The name that you want to assign to this namespace.
\nDo not include sensitive information in the name. The name is publicly available using DNS\n queries.
\nThe name that you want to assign to this namespace.
\nDo not include sensitive information in the name. The name is publicly available using DNS queries.
\nA unique string that identifies the request and that allows failed\n CreatePublicDnsNamespace requests to be retried without the risk of running the\n operation twice. CreatorRequestId can be any unique string (for example, a\n date/timestamp).
A unique string that identifies the request and that allows failed CreatePublicDnsNamespace\n requests to be retried without the risk of running the operation twice. CreatorRequestId can be any\n unique string (for example, a date/timestamp).
The tags to add to the namespace. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" + "smithy.api#documentation": "The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PublicDnsNamespaceProperties", "traits": { - "smithy.api#documentation": "Properties for the\n public DNS namespace.
" + "smithy.api#documentation": "Properties for the public DNS\n namespace.
" } } }, @@ -363,7 +363,7 @@ "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { - "smithy.api#documentation": "A value that you can use to determine whether the request completed successfully. To get the\n status of the operation, see GetOperation.
" + "smithy.api#documentation": "A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.
" } } }, @@ -397,7 +397,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a service. This action defines the configuration for the following entities:
\nFor public and private DNS namespaces, one of the following combinations of DNS records in\n Amazon Route 53:
\n\n A\n
\n AAAA\n
\n A and AAAA\n
\n SRV\n
\n CNAME\n
Optionally, a health check
\nAfter you create the service, you can submit a RegisterInstance request, and\n Cloud Map uses the values in the configuration to create the specified entities.
\nFor the current quota on the number of instances that you can register using the same\n namespace and using the same service, see Cloud Map quotas in the\n Cloud Map Developer Guide.
", + "smithy.api#documentation": "Creates a service. This action defines the configuration for the following entities:
\nFor public and private DNS namespaces, one of the following combinations of DNS records in\n Amazon Route 53:
\n\n A\n
\n AAAA\n
\n A and AAAA\n
\n SRV\n
\n CNAME\n
Optionally, a health check
\nAfter you create the service, you can submit a RegisterInstance request, and Cloud Map uses the\n values in the configuration to create the specified entities.
\nFor the current quota on the number of instances that you can register using the same namespace and using\n the same service, see Cloud Map\n quotas in the Cloud Map Developer Guide.
", "smithy.api#examples": [ { "title": "Example: Create service", @@ -447,20 +447,20 @@ "Name": { "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { - "smithy.api#documentation": "The name that you want to assign to the service.
\nDo not include sensitive information in the name if the namespace is discoverable by public\n DNS queries.
\nIf you want Cloud Map to create an SRV record when you register an instance\n and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for\n Name:
Start the name with an underscore (_), such as _exampleservice.
End the name with ._protocol, such as ._tcp.
When you register an instance, Cloud Map creates an SRV record and assigns a\n name to the record by concatenating the service name and the namespace name (for example,
\n _exampleservice._tcp.example.com).
For services that are accessible by DNS queries, you can't create multiple services with\n names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the\n same DNS name and can't be distinguished. However, if you use a namespace that's only accessible\n by API calls, then you can create services that with names that differ only by case.
\nThe name that you want to assign to the service.
\nDo not include sensitive information in the name if the namespace is discoverable by public DNS\n queries.
\nIf you want Cloud Map to create an SRV record when you register an instance and you're using\n a system that requires a specific SRV format, such as HAProxy, specify the following for Name:
Start the name with an underscore (_), such as _exampleservice.
End the name with ._protocol, such as ._tcp.
When you register an instance, Cloud Map creates an SRV record and assigns a name to the\n record by concatenating the service name and the namespace name (for example,
\n _exampleservice._tcp.example.com).
For services that are accessible by DNS queries, you can't create multiple services with names that differ\n only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be\n distinguished. However, if you use a namespace that's only accessible by API calls, then you can create\n services that with names that differ only by case.
\nThe ID of the namespace that you want to use to create the service. The namespace ID must be\n specified, but it can be specified either here or in the DnsConfig object.
The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but\n it can be specified either here or in the DnsConfig object.
A unique string that identifies the request and that allows failed\n CreateService requests to be retried without the risk of running the operation\n twice. CreatorRequestId can be any unique string (for example, a\n date/timestamp).
A unique string that identifies the request and that allows failed CreateService requests to\n be retried without the risk of running the operation twice. CreatorRequestId can be any unique\n string (for example, a date/timestamp).
A complex type that contains information about the Amazon Route 53 records that you want\n Cloud Map to create when you register an instance.
" + "smithy.api#documentation": "A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create\n when you register an instance.
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains\n settings for an optional Route 53 health check. If you specify settings for a health check,\n Cloud Map associates the health check with all the Route 53 DNS records that you specify in\n DnsConfig.
If you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.
For information about the charges for health checks, see Cloud Map Pricing.
" + "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains settings for an\n optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check\n with all the Route 53 DNS records that you specify in DnsConfig.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.
For information about the charges for health checks, see Cloud Map Pricing.
" } }, "HealthCheckCustomConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", "traits": { - "smithy.api#documentation": "A complex type that contains information about an optional custom health check.
\nIf you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.
You can't add, update, or delete a HealthCheckCustomConfig configuration from\n an existing service.
A complex type that contains information about an optional custom health check.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.
You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing\n service.
The tags to add to the service. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" + "smithy.api#documentation": "The tags to add to the service. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" } }, "Type": { "target": "com.amazonaws.servicediscovery#ServiceTypeOption", "traits": { - "smithy.api#documentation": "If present, specifies that the service instances are only discoverable using the\n DiscoverInstances API operation. No DNS records is registered for the service\n instances. The only valid value is HTTP.
If present, specifies that the service instances are only discoverable using the\n DiscoverInstances API operation. No DNS records is registered for the service instances. The only\n valid value is HTTP.
The health check for the instance that's specified by ServiceId and\n InstanceId isn't a custom health check.
The health check for the instance that's specified by ServiceId and InstanceId\n isn't a custom health check.
Deletes a namespace from the current account. If the namespace still contains one or more\n services, the request fails.
", + "smithy.api#documentation": "Deletes a namespace from the current account. If the namespace still contains one or more services, the\n request fails.
", "smithy.api#examples": [ { "title": "Example: Delete namespace", @@ -636,7 +636,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified service. If the service still contains one or more registered instances,\n the request fails.
", + "smithy.api#documentation": "Deletes a specified service. If the service still contains one or more registered instances, the request\n fails.
", "smithy.api#examples": [ { "title": "Example: Delete service", @@ -697,7 +697,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the\n specified instance.
", + "smithy.api#documentation": "Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified\n instance.
", "smithy.api#examples": [ { "title": "Example: Deregister a service instance", @@ -772,7 +772,7 @@ } ], "traits": { - "smithy.api#documentation": "Discovers registered instances for a specified namespace and service. You can use\n DiscoverInstances to discover instances for any type of namespace.\n DiscoverInstances returns a randomized list of instances allowing customers to\n distribute traffic evenly across instances. For public and private DNS namespaces, you can also\n use DNS queries to discover instances.
Discovers registered instances for a specified namespace and service. You can use\n DiscoverInstances to discover instances for any type of namespace. DiscoverInstances\n returns a randomized list of instances allowing customers to distribute traffic evenly across instances. For\n public and private DNS namespaces, you can also use DNS queries to discover instances.
The HttpName name of the namespace. It's found in the\n HttpProperties member of the Properties member of the\n namespace.
The HttpName name of the namespace. It's found in the HttpProperties member of\n the Properties member of the namespace. In most cases, Name and HttpName\n match. However, if you reuse Name for namespace creation, a generated hash is added to\n HttpName to distinguish the two.
The maximum number of instances that you want Cloud Map to return in the response to a\n DiscoverInstances request. If you don't specify a value for\n MaxResults, Cloud Map returns up to 100 instances.
The maximum number of instances that you want Cloud Map to return in the response to a\n DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map\n returns up to 100 instances.
Filters to scope the results based on custom attributes for the instance (for example,\n {version=v1, az=1a}). Only instances that match all the specified key-value pairs\n are returned.
Filters to scope the results based on custom attributes for the instance (for example, {version=v1,\n az=1a}). Only instances that match all the specified key-value pairs are returned.
Opportunistic filters to scope the results based on custom attributes. If there are\n instances that match both the filters specified in both the QueryParameters\n parameter and this parameter, all of these instances are returned. Otherwise, the filters are\n ignored, and only instances that match the filters that are specified in the\n QueryParameters parameter are returned.
Opportunistic filters to scope the results based on custom attributes. If there are instances that match\n both the filters specified in both the QueryParameters parameter and this parameter, all of these\n instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are\n specified in the QueryParameters parameter are returned.
The health status of the instances that you want to discover. This parameter is ignored for\n services that don't have a health check configured, and\n all\n instances are returned.
\nReturns healthy instances.
\nReturns unhealthy instances.
\nReturns all instances.
\nReturns healthy instances, unless none are reporting a healthy state. In that case,\n return all instances. This is also called failing open.
\nThe health status of the instances that you want to discover. This parameter is ignored for services that\n don't have a health check configured, and\n all\n instances are returned.
\nReturns healthy instances.
\nReturns unhealthy instances.
\nReturns all instances.
\nReturns healthy instances, unless none are reporting a healthy state. In that case, return all\n instances. This is also called failing open.
\nA complex type that contains one HttpInstanceSummary for each registered\n instance.
A complex type that contains one HttpInstanceSummary for each registered instance.
The increasing revision associated to the response Instances list. If a new instance is\n registered or deregistered, the InstancesRevision updates. The health status updates\n don't update InstancesRevision.
The increasing revision associated to the response Instances list. If a new instance is registered or\n deregistered, the InstancesRevision updates. The health status updates don't update\n InstancesRevision.
Discovers the increasing revision associated with an instance.
", "smithy.api#endpoint": { "hostPrefix": "data-" - } + }, + "smithy.api#examples": [ + { + "title": "To discover the revision for a registered instance", + "documentation": "The following example discovers the revision ID for a registered instance.", + "input": { + "NamespaceName": "example-namespace", + "ServiceName": "example-service" + }, + "output": { + "InstancesRevision": 123456 + } + } + ] } }, "com.amazonaws.servicediscovery#DiscoverInstancesRevisionRequest": { @@ -905,7 +918,7 @@ "NamespaceName": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { - "smithy.api#documentation": "The HttpName name of the namespace. It's found in the\n HttpProperties member of the Properties member of the\n namespace.
The HttpName name of the namespace. It's found in the HttpProperties member of\n the Properties member of the namespace.
The increasing revision associated to the response Instances list. If a new instance is\n registered or deregistered, the InstancesRevision updates. The health status updates\n don't update InstancesRevision.
The increasing revision associated to the response Instances list. If a new instance is registered or\n deregistered, the InstancesRevision updates. The health status updates don't update\n InstancesRevision.
\n Use\n NamespaceId in Service instead.\n
\nThe ID of the namespace to use for DNS configuration.
" + "smithy.api#documentation": "\n Use\n NamespaceId in Service\n instead.\n
\nThe ID of the namespace to use for DNS configuration.
" } }, "RoutingPolicy": { "target": "com.amazonaws.servicediscovery#RoutingPolicy", "traits": { - "smithy.api#documentation": "The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates\n when you register an instance and specify this service.
\nIf you want to use this service to register instances that create alias records, specify\n WEIGHTED for the routing policy.
You can specify the following values:
\nIf you define a health check for the service and the health check is healthy, Route 53\n returns the applicable value for up to eight instances.
\nFor example, suppose that the service includes configurations for one A\n record and a health check. You use the service to register 10 instances. Route 53 responds to DNS\n queries with IP addresses for up to eight healthy instances. If fewer than eight instances are\n healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy\n instances.
If you don't define a health check for the service, Route 53 assumes that all instances are\n healthy and returns the values for up to eight instances.
\nFor more information about the multivalue routing policy, see Multivalue\n Answer Routing in the Route 53 Developer Guide.
\nRoute 53 returns the applicable value from one randomly selected instance from among the\n instances that you registered using the same service. Currently, all records have the same\n weight, so you can't route more or less traffic to any instances.
\nFor example, suppose that the service includes configurations for one A\n record and a health check. You use the service to register 10 instances. Route 53 responds to DNS\n queries with the IP address for one randomly selected instance from among the healthy\n instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the\n instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are\n healthy and returns the applicable value for one randomly selected instance.
\nFor more information about the weighted routing policy, see Weighted\n Routing in the Route 53 Developer Guide.
\nThe routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you\n register an instance and specify this service.
\nIf you want to use this service to register instances that create alias records, specify\n WEIGHTED for the routing policy.
You can specify the following values:
\nIf you define a health check for the service and the health check is healthy, Route 53 returns the\n applicable value for up to eight instances.
\nFor example, suppose that the service includes configurations for one A record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up\n to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with\n the IP addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and\n returns the values for up to eight instances.
\nFor more information about the multivalue routing policy, see Multivalue Answer\n Routing in the Route 53 Developer Guide.
\nRoute 53 returns the applicable value from one randomly selected instance from among the instances that you\n registered using the same service. Currently, all records have the same weight, so you can't route more or\n less traffic to any instances.
\nFor example, suppose that the service includes configurations for one A record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for\n one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds\n to DNS queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and\n returns the applicable value for one randomly selected instance.
\nFor more information about the weighted routing policy, see Weighted Routing in\n the Route 53 Developer Guide.
\nAn array that contains one DnsRecord object for each Route 53 DNS record that you\n want Cloud Map to create when you register an instance.
An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map\n to create when you register an instance.
A complex type that contains information about the Amazon Route 53 DNS records that you want\n Cloud Map to create when you register an instance.
\nThe record types of a service can only be changed by deleting the service and recreating it\n with a new Dnsconfig.
A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create\n when you register an instance.
\nThe record types of a service can only be changed by deleting the service and recreating it with a new\n Dnsconfig.
An array that contains one DnsRecord object for each Route 53 record that you want\n Cloud Map to create when you register an instance.
An array that contains one DnsRecord object for each Route 53 record that you want Cloud Map to\n create when you register an instance.
A complex type that contains information about changes to the Route 53 DNS records that\n Cloud Map creates when you register an instance.
" + "smithy.api#documentation": "A complex type that contains information about changes to the Route 53 DNS records that Cloud Map creates\n when you register an instance.
" } }, "com.amazonaws.servicediscovery#DnsProperties": { @@ -1006,7 +1019,7 @@ } }, "traits": { - "smithy.api#documentation": "A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when\n you create a namespace.
" + "smithy.api#documentation": "A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a\n namespace.
" } }, "com.amazonaws.servicediscovery#DnsRecord": { @@ -1015,20 +1028,20 @@ "Type": { "target": "com.amazonaws.servicediscovery#RecordType", "traits": { - "smithy.api#documentation": "The type of the resource, which indicates the type of value that Route 53 returns in response\n to DNS queries. You can specify values for Type in the following\n combinations:
\n \n A\n \n
\n \n AAAA\n \n
\n \n A\n and \n AAAA\n \n
\n \n SRV\n \n
\n \n CNAME\n \n
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify\n A or AAAA for Type.
You specify other settings, such as the IP address for A and AAAA\n records, when you register an instance. For more information, see RegisterInstance.
The following values are supported:
\nRoute 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
\nRoute 53 returns the IP address of the resource in IPv6 format, such as\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.
\nRoute 53 returns the domain name of the resource, such as www.example.com. Note the\n following:
\nYou specify the domain name that you want to route traffic to when you register an\n instance. For more information, see Attributes in the topic RegisterInstance.
\nYou must specify WEIGHTED for the value of\n RoutingPolicy.
You can't specify both CNAME for Type and settings for\n HealthCheckConfig. If you do, the request will fail with an\n InvalidInput error.
Route 53 returns the value for an SRV record. The value for an SRV\n record uses the following values:
\n priority weight port service-hostname\n
Note the following about the values:
\nThe values of priority and weight are both set to\n 1 and can't be changed.
The value of port comes from the value that you specify for the\n AWS_INSTANCE_PORT attribute when you submit a RegisterInstance\n request.
The value of service-hostname is a concatenation of the following\n values:
The value that you specify for InstanceId when you register an\n instance.
The name of the service.
\nThe name of the namespace.
\nFor example, if the value of InstanceId is test, the name of\n the service is backend, and the name of the namespace is\n example.com, the value of service-hostname is the\n following:
\n test.backend.example.com\n
If you specify settings for an SRV record, note the following:
If you specify values for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both in the RegisterInstance request,\n Cloud Map automatically creates A and/or AAAA records that have\n the same name as the value of service-hostname in the SRV record.\n You can ignore these records.
If you're using a system that requires a specific SRV format, such as\n HAProxy, see the Name element in the documentation about CreateService for information\n about how to specify the correct name format.
The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.\n You can specify values for Type in the following combinations:
\n \n A\n \n
\n \n AAAA\n \n
\n \n A\n and \n AAAA\n \n
\n \n SRV\n \n
\n \n CNAME\n \n
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A\n or AAAA for Type.
You specify other settings, such as the IP address for A and AAAA records, when\n you register an instance. For more information, see RegisterInstance.
The following values are supported:
\nRoute 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
\nRoute 53 returns the IP address of the resource in IPv6 format, such as\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.
\nRoute 53 returns the domain name of the resource, such as www.example.com. Note the following:
\nYou specify the domain name that you want to route traffic to when you register an instance. For more\n information, see Attributes in the topic RegisterInstance.
\nYou must specify WEIGHTED for the value of RoutingPolicy.
You can't specify both CNAME for Type and settings for\n HealthCheckConfig. If you do, the request will fail with an InvalidInput\n error.
Route 53 returns the value for an SRV record. The value for an SRV record uses\n the following values:
\n priority weight port service-hostname\n
Note the following about the values:
\nThe values of priority and weight are both set to 1 and can't\n be changed.
The value of port comes from the value that you specify for the\n AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.
The value of service-hostname is a concatenation of the following values:
The value that you specify for InstanceId when you register an instance.
The name of the service.
\nThe name of the namespace.
\nFor example, if the value of InstanceId is test, the name of the service is\n backend, and the name of the namespace is example.com, the value of\n service-hostname is the following:
\n test.backend.example.com\n
If you specify settings for an SRV record, note the following:
If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in\n the RegisterInstance request, Cloud Map automatically creates A and/or\n AAAA records that have the same name as the value of service-hostname in the\n SRV record. You can ignore these records.
If you're using a system that requires a specific SRV format, such as HAProxy, see the\n Name element\n in the documentation about CreateService for information about how to specify the correct name\n format.
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this\n record.
\nAlias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an\n alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute\n when you submit a RegisterInstance request, the\n TTL value is ignored. Always specify a TTL for the service; you can use a service\n to register instances that create either alias or non-alias records.
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
\nAlias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an alias record\n routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request,\n the TTL value is ignored. Always specify a TTL for the service; you can use a service to register\n instances that create either alias or non-alias records.
A complex type that contains information about the Route 53 DNS records that you want\n Cloud Map to create when you register an instance.
" + "smithy.api#documentation": "A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create\n when you register an instance.
" } }, "com.amazonaws.servicediscovery#DnsRecordList": { @@ -1216,7 +1229,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the current health status (Healthy, Unhealthy, or\n Unknown) of one or more instances that are associated with a specified\n service.
There's a brief delay between when you register an instance and when the health status for\n the instance is available.
\nGets the current health status (Healthy, Unhealthy, or Unknown) of\n one or more instances that are associated with a specified service.
There's a brief delay between when you register an instance and when the health status for the instance is\n available.
\nAn array that contains the IDs of all the instances that you want to get the health status\n for.
\nIf you omit Instances, Cloud Map returns the health status for all the\n instances that are associated with the specified service.
To get the IDs for the instances that you've registered by using a specified service,\n submit a ListInstances request.
\nAn array that contains the IDs of all the instances that you want to get the health status for.
\nIf you omit Instances, Cloud Map returns the health status for all the instances that are\n associated with the specified service.
To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.
\nThe maximum number of instances that you want Cloud Map to return in the response to a\n GetInstancesHealthStatus request. If you don't specify a value for\n MaxResults, Cloud Map returns up to 100 instances.
The maximum number of instances that you want Cloud Map to return in the response to a\n GetInstancesHealthStatus request. If you don't specify a value for MaxResults,\n Cloud Map returns up to 100 instances.
For the first GetInstancesHealthStatus request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit\n another GetInstancesHealthStatus request to get the next group of results. Specify\n the value of NextToken from the previous response in the next request.
For the first GetInstancesHealthStatus request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit another\n GetInstancesHealthStatus request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.
A complex type that contains the IDs and the health status of the instances that you\n specified in the GetInstancesHealthStatus request.
A complex type that contains the IDs and the health status of the instances that you specified in the\n GetInstancesHealthStatus request.
If more than MaxResults instances match the specified criteria, you can submit\n another GetInstancesHealthStatus request to get the next group of results. Specify\n the value of NextToken from the previous response in the next request.
If more than MaxResults instances match the specified criteria, you can submit another\n GetInstancesHealthStatus request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.
The type of health check that you want to create, which indicates how Route 53 determines\n whether an endpoint is healthy.
\nYou can't change the value of Type after you create a health check.
You can create the following types of health checks:
\n\n HTTP: Route 53 tries to establish a TCP connection. If\n successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater\n and less than 400.
\n\n HTTPS: Route 53 tries to establish a TCP connection. If\n successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater\n and less than 400.
\nIf you specify HTTPS for the value of Type, the endpoint must support TLS\n v1.0 or later.
\n TCP: Route 53 tries to establish a TCP connection.
\nIf you specify TCP for Type, don't specify a value for\n ResourcePath.
For more information, see How Route 53\n Determines Whether an Endpoint Is Healthy in the\n Route 53 Developer Guide.
", + "smithy.api#documentation": "The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint\n is healthy.
\nYou can't change the value of Type after you create a health check.
You can create the following types of health checks:
\n\n HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53\n submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
\n\n HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53\n submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
\nIf you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or\n later.
\n TCP: Route 53 tries to establish a TCP connection.
\nIf you specify TCP for Type, don't specify a value for\n ResourcePath.
For more information, see How Route 53 Determines\n Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
", "smithy.api#required": {} } }, "ResourcePath": { "target": "com.amazonaws.servicediscovery#ResourcePath", "traits": { - "smithy.api#documentation": "The path that you want Route 53 to request when performing health checks. The path can be any\n value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint\n is healthy. An example file is /docs/route53-health-check.html. Route 53 automatically\n adds the DNS name for the service. If you don't specify a value for ResourcePath,\n the default value is /.
If you specify TCP for Type, you must not\n specify a value for ResourcePath.
The path that you want Route 53 to request when performing health checks. The path can be any value that your\n endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is\n /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you\n don't specify a value for ResourcePath, the default value is /.
If you specify TCP for Type, you must not specify a value\n for ResourcePath.
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to\n change the current status of the endpoint from unhealthy to healthy or the other way around. For\n more information, see How Route 53\n Determines Whether an Endpoint Is Healthy in the\n Route 53 Developer Guide.
" + "smithy.api#documentation": "The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current\n status of the endpoint from unhealthy to healthy or the other way around. For more information, see How\n Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains\n settings for an optional health check. If you specify settings for a health check, Cloud Map\n associates the health check with the records that you specify in DnsConfig.
If you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.
Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For\n information about pricing for health checks, see Amazon Route 53 Pricing.
\nNote the following about configuring health checks.
\nIf DnsConfig includes configurations for both A and\n AAAA records, Cloud Map creates a health check that uses the IPv4 address to\n check the health of the resource. If the endpoint tthat's specified by the IPv4 address is\n unhealthy, Route 53 considers both the A and AAAA records to be\n unhealthy.
You can't specify settings for HealthCheckConfig when the\n DNSConfig includes CNAME for the value of Type. If you\n do, the CreateService request will fail with an InvalidInput\n error.
A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request\n to an endpoint every 30 seconds. On average, your endpoint receives a health check request\n about every two seconds. However, health checkers don't coordinate with one another.\n Therefore, you might sometimes see several requests in one second that's followed by a few\n seconds with no health checks at all.
\nHealth checkers perform checks from all Route 53 health-checking Regions. For a list of the\n current Regions, see Regions.
\nWhen you register an instance, if you include the AWS_ALIAS_DNS_NAME\n attribute, Cloud Map creates a Route 53 alias record. Note the following:
Route 53 automatically sets EvaluateTargetHealth to true for alias records.\n When EvaluateTargetHealth is true, the alias record inherits the health of the\n referenced Amazon Web Services resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.
If you include HealthCheckConfig and then use the service to register an\n instance that creates an alias record, Route 53 doesn't create the health check.
Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For\n information about pricing for health checks, see Amazon Route 53 Pricing.
\n\n Public DNS and HTTP namespaces only. A complex type that contains settings for an\n optional health check. If you specify settings for a health check, Cloud Map associates the health check with\n the records that you specify in DnsConfig.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.
Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information\n about pricing for health checks, see Amazon Route 53\n Pricing.
\nNote the following about configuring health checks.
\nIf DnsConfig includes configurations for both A and AAAA records,\n Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the\n endpoint tthat's specified by the IPv4 address is unhealthy, Route 53 considers both the A and\n AAAA records to be unhealthy.
You can't specify settings for HealthCheckConfig when the DNSConfig includes\n CNAME for the value of Type. If you do, the CreateService request\n will fail with an InvalidInput error.
A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request to an endpoint\n every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However,\n health checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one\n second that's followed by a few seconds with no health checks at all.
\nHealth checkers perform checks from all Route 53 health-checking Regions. For a list of the current\n Regions, see Regions.
\nWhen you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, Cloud Map\n creates a Route 53 alias record. Note the following:
Route 53 automatically sets EvaluateTargetHealth to true for alias records. When\n EvaluateTargetHealth is true, the alias record inherits the health of the referenced Amazon Web Services\n resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.
If you include HealthCheckConfig and then use the service to register an instance that\n creates an alias record, Route 53 doesn't create the health check.
Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about\n pricing for health checks, see Amazon Route 53\n Pricing.
\nThis parameter is no longer supported and is always set to 1. Cloud Map waits for\n approximately 30 seconds after receiving an UpdateInstanceCustomHealthStatus\n request before changing the status of the service instance.
The number of 30-second intervals that you want Cloud Map to wait after receiving an\n UpdateInstanceCustomHealthStatus request before it changes the health status of a\n service instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus request with\n the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits\n 30 seconds after the first request to make the change.
This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds\n after receiving an UpdateInstanceCustomHealthStatus request before changing the status of the\n service instance.
The number of 30-second intervals that you want Cloud Map to wait after receiving an\n UpdateInstanceCustomHealthStatus request before it changes the health status of a service\n instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value\n before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30 seconds after the\n first request to make the change.
A complex type that contains information about an optional custom health check. A custom\n health check, which requires that you use a third-party health checker to evaluate the health of\n your resources, is useful in the following circumstances:
\nYou can't use a health check that's defined by HealthCheckConfig because the\n resource isn't available over the internet. For example, you can use a custom health check when\n the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health\n checker must also be in the VPC.)
You want to use a third-party health checker regardless of where your resources are\n located.
\nIf you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.
To change the status of a custom health check, submit an\n UpdateInstanceCustomHealthStatus request. Cloud Map doesn't monitor the status of the\n resource, it just keeps a record of the status specified in the most recent\n UpdateInstanceCustomHealthStatus request.
Here's how custom health checks work:
\nYou create a service.
\nYou register an instance.
\nYou configure a third-party health checker to monitor the resource that's associated with\n the new instance.
\nCloud Map doesn't check the health of the resource directly.
\nThe third-party health-checker determines that the resource is unhealthy and notifies your\n application.
\nYour application submits an UpdateInstanceCustomHealthStatus request.
Cloud Map waits for 30 seconds.
\nIf another UpdateInstanceCustomHealthStatus request doesn't arrive during\n that time to change the status back to healthy, Cloud Map stops routing traffic to the\n resource.
A complex type that contains information about an optional custom health check. A custom health check,\n which requires that you use a third-party health checker to evaluate the health of your resources, is useful in\n the following circumstances:
\nYou can't use a health check that's defined by HealthCheckConfig because the resource isn't\n available over the internet. For example, you can use a custom health check when the instance is in an Amazon\n VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)
You want to use a third-party health checker regardless of where your resources are located.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.
To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus\n request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in\n the most recent UpdateInstanceCustomHealthStatus request.
Here's how custom health checks work:
\nYou create a service.
\nYou register an instance.
\nYou configure a third-party health checker to monitor the resource that's associated with the new\n instance.
\nCloud Map doesn't check the health of the resource directly.
\nThe third-party health-checker determines that the resource is unhealthy and notifies your\n application.
\nYour application submits an UpdateInstanceCustomHealthStatus request.
Cloud Map waits for 30 seconds.
\nIf another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to\n change the status back to healthy, Cloud Map stops routing traffic to the resource.
\n \n \n \n
The HttpName name of the namespace. It's found in the\n HttpProperties member of the Properties member of the\n namespace.
\n \n \n \n
The HttpName name of the namespace. It's found in the HttpProperties member of\n the Properties member of the namespace.
If you configured health checking in the service, the current health status of the service\n instance.
" + "smithy.api#documentation": "If you configured health checking in the service, the current health status of the service instance.
" } }, "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "If you included any attributes when you registered the instance, the values of those\n attributes.
" + "smithy.api#documentation": "If you included any attributes when you registered the instance, the values of those attributes.
" } } }, "traits": { - "smithy.api#documentation": "In a response to a DiscoverInstances request,\n HttpInstanceSummary contains information about one instance that matches the values\n that you specified in the request.
In a response to a DiscoverInstances request, HttpInstanceSummary contains information about one instance\n that matches the values that you specified in the request.
An updated\n description for the HTTP namespace.
", + "smithy.api#documentation": "An updated description for the HTTP\n namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated properties\n for the HTTP namespace.
" + "smithy.api#documentation": "Updated properties for the HTTP\n namespace.
" } }, "com.amazonaws.servicediscovery#HttpProperties": { @@ -1658,25 +1671,25 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "An identifier that you want to associate with the instance. Note the following:
\nIf the service that's specified by ServiceId includes settings for an\n SRV record, the value of InstanceId is automatically included as\n part of the value for the SRV record. For more information, see DnsRecord >\n Type.
You can use this value to update an existing instance.
\nTo register a new instance, you must specify a value that's unique among instances that\n you register by using the same service.
\nIf you specify an existing InstanceId and ServiceId, Cloud Map\n updates the existing DNS records. If there's also an existing health check, Cloud Map deletes\n the old health check and creates a new one.
The health check isn't deleted immediately, so it will still appear for a while if you\n submit a ListHealthChecks request, for example.
An identifier that you want to associate with the instance. Note the following:
\nIf the service that's specified by ServiceId includes settings for an SRV\n record, the value of InstanceId is automatically included as part of the value for the\n SRV record. For more information, see DnsRecord > Type.
You can use this value to update an existing instance.
\nTo register a new instance, you must specify a value that's unique among instances that you register by\n using the same service.
\nIf you specify an existing InstanceId and ServiceId, Cloud Map updates the\n existing DNS records. If there's also an existing health check, Cloud Map deletes the old health check and\n creates a new one.
The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks request, for example.
A unique string that identifies the request and that allows failed\n RegisterInstance requests to be retried without the risk of executing the operation\n twice. You must use a unique CreatorRequestId string every time you submit a\n RegisterInstance request if you're registering additional instances for the same\n namespace and service. CreatorRequestId can be any unique string (for example, a\n date/time stamp).
A unique string that identifies the request and that allows failed RegisterInstance requests\n to be retried without the risk of executing the operation twice. You must use a unique\n CreatorRequestId string every time you submit a RegisterInstance request if you're\n registering additional instances for the same namespace and service. CreatorRequestId can be any\n unique string (for example, a date/time stamp).
A string map that contains the following information for the service that you specify in\n ServiceId:
The attributes that apply to the records that are defined in the service.
\nFor each attribute, the applicable value.
\nDo not include sensitive information in the attributes if the namespace is discoverable by\n public DNS queries.
\nSupported attribute keys include the following:
\nIf you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing\n load balancer, specify the DNS name that's associated with the load balancer. For information\n about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference.
\nNote the following:
\nThe configuration for the service that's specified by ServiceId must\n include settings for an A record, an AAAA record, or both.
In the service that's specified by ServiceId, the value of\n RoutingPolicy must be WEIGHTED.
If the service that's specified by ServiceId includes\n HealthCheckConfig settings, Cloud Map creates the health check, but it won't\n associate the health check with the alias record.
Auto naming currently doesn't support creating alias records that route traffic to\n Amazon Web Services resources other than ELB load balancers.
\nIf you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for\n any of the AWS_INSTANCE attributes.
\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. The\n AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
If the service configuration includes HealthCheckCustomConfig, you can\n optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom\n health check, HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
If the service configuration includes a CNAME record, the domain name that\n you want Route 53 to return in response to DNS queries (for example,\n example.com).
This value is required if the service specified by ServiceId includes\n settings for an CNAME record.
If the service configuration includes an A record, the IPv4 address that you\n want Route 53 to return in response to DNS queries (for example, 192.0.2.44).
This value is required if the service specified by ServiceId includes\n settings for an A record. If the service includes settings for an\n SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.
If the service configuration includes an AAAA record, the IPv6 address that\n you want Route 53 to return in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345).
This value is required if the service specified by ServiceId includes\n settings for an AAAA record. If the service includes settings for an\n SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.
If the service includes an SRV record, the value that you want Route 53 to\n return for the port.
If the service includes HealthCheckConfig, the port on the endpoint that you\n want Route 53 to send requests to.
This value is required if you specified settings for an SRV record or a\n Route 53 health check when you created the service.
A string map that contains the following information for the service that you specify in\n ServiceId:
The attributes that apply to the records that are defined in the service.
\nFor each attribute, the applicable value.
\nDo not include sensitive information in the attributes if the namespace is discoverable by public DNS\n queries.
\nSupported attribute keys include the following:
\nIf you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer,\n specify the DNS name that's associated with the load balancer. For information about how to get the DNS name,\n see AliasTarget->DNSName in the Route 53 API Reference.
\nNote the following:
\nThe configuration for the service that's specified by ServiceId must include settings for\n an A record, an AAAA record, or both.
In the service that's specified by ServiceId, the value of RoutingPolicy\n must be WEIGHTED.
If the service that's specified by ServiceId includes HealthCheckConfig\n settings, Cloud Map creates the health check, but it won't associate the health check with the alias\n record.
Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources\n other than ELB load balancers.
\nIf you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.
\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. The\n AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
If the service configuration includes a CNAME record, the domain name that you want Route 53\n to return in response to DNS queries (for example, example.com).
This value is required if the service specified by ServiceId includes settings for an\n CNAME record.
If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n return in response to DNS queries (for example, 192.0.2.44).
This value is required if the service specified by ServiceId includes settings for an\n A record. If the service includes settings for an SRV record, you must specify a\n value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
If the service configuration includes an AAAA record, the IPv6 address that you want Route 53\n to return in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345).
This value is required if the service specified by ServiceId includes settings for an\n AAAA record. If the service includes settings for an SRV record, you must specify\n a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
If the service includes an SRV record, the value that you want Route 53 to return for the\n port.
If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to\n send requests to.
This value is required if you specified settings for an SRV record or a Route 53 health check\n when you created the service.
A complex type that contains information about an instance that Cloud Map creates when you\n submit a RegisterInstance request.
A complex type that contains information about an instance that Cloud Map creates when you submit a\n RegisterInstance request.
No instance exists with the specified ID, or the instance was recently registered, and\n information about the instance hasn't propagated yet.
", + "smithy.api#documentation": "No instance exists with the specified ID, or the instance was recently registered, and information about\n the instance hasn't propagated yet.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1737,12 +1750,12 @@ "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "A string map that contains the following information:
\nThe attributes that are associated with the instance.
\nFor each attribute, the applicable value.
\nSupported attribute keys include the following:
\nFor an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's\n associated with the load balancer.
\nThe Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID\n attribute is specified, then the AWS_INSTANCE_IPV4 attribute contains the primary\n private IPv4 address.
If the service configuration includes HealthCheckCustomConfig, you can\n optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom\n health check, HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
For a CNAME record, the domain name that Route 53 returns in response to DNS\n queries (for example, example.com).
For an A record, the IPv4 address that Route 53 returns in response to DNS\n queries (for example, 192.0.2.44).
For an AAAA record, the IPv6 address that Route 53 returns in response to DNS\n queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).
For an SRV record, the value that Route 53 returns for the port. In addition,\n if the service includes HealthCheckConfig, the port on the endpoint that Route 53\n sends requests to.
A string map that contains the following information:
\nThe attributes that are associated with the instance.
\nFor each attribute, the applicable value.
\nSupported attribute keys include the following:
\nFor an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with\n the load balancer.
\nThe Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is\n specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4\n address.
If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for\n example, example.com).
For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for\n example, 192.0.2.44).
For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for\n example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).
For an SRV record, the value that Route 53 returns for the port. In addition, if the service\n includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
A complex type that contains information about the instances that you registered by using a\n specified service.
" + "smithy.api#documentation": "A complex type that contains information about the instances that you registered by using a specified\n service.
" } }, "com.amazonaws.servicediscovery#InstanceSummaryList": { @@ -1762,7 +1775,7 @@ } }, "traits": { - "smithy.api#documentation": "One or more specified values aren't valid. For example, a required value might be missing, a\n numeric value might be outside the allowed range, or a string value might exceed length\n constraints.
", + "smithy.api#documentation": "One or more specified values aren't valid. For example, a required value might be missing, a numeric value\n might be outside the allowed range, or a string value might exceed length constraints.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1784,7 +1797,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists summary information about the instances that you registered by using a specified\n service.
", + "smithy.api#documentation": "Lists summary information about the instances that you registered by using a specified service.
", "smithy.api#examples": [ { "title": "Example: List service instances", @@ -1825,13 +1838,13 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "For the first ListInstances request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit\n another ListInstances request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.
For the first ListInstances request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit another\n ListInstances request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.
The maximum number of instances that you want Cloud Map to return in the response to a\n ListInstances request. If you don't specify a value for MaxResults,\n Cloud Map returns up to 100 instances.
The maximum number of instances that you want Cloud Map to return in the response to a\n ListInstances request. If you don't specify a value for MaxResults, Cloud Map\n returns up to 100 instances.
Summary information about the instances that are associated with the specified\n service.
" + "smithy.api#documentation": "Summary information about the instances that are associated with the specified service.
" } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "If more than MaxResults instances match the specified criteria, you can submit\n another ListInstances request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.
If more than MaxResults instances match the specified criteria, you can submit another\n ListInstances request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.
For the first ListNamespaces request, omit this value.
If the response contains NextToken, submit another ListNamespaces\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.
Cloud Map gets MaxResults namespaces and then filters them based on the\n specified criteria. It's possible that no namespaces in the first MaxResults\n namespaces matched the specified criteria but that subsequent groups of MaxResults\n namespaces do contain namespaces that match the criteria.
For the first ListNamespaces request, omit this value.
If the response contains NextToken, submit another ListNamespaces request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.
Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria.\n It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria\n but that subsequent groups of MaxResults namespaces do contain namespaces that match the\n criteria.
The maximum number of namespaces that you want Cloud Map to return in the response to a\n ListNamespaces request. If you don't specify a value for MaxResults,\n Cloud Map returns up to 100 namespaces.
The maximum number of namespaces that you want Cloud Map to return in the response to a\n ListNamespaces request. If you don't specify a value for MaxResults, Cloud Map\n returns up to 100 namespaces.
An array that contains one NamespaceSummary object for each namespace that\n matches the specified filter criteria.
An array that contains one NamespaceSummary object for each namespace that matches the\n specified filter criteria.
If the response contains NextToken, submit another ListNamespaces\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.
Cloud Map gets MaxResults namespaces and then filters them based on the\n specified criteria. It's possible that no namespaces in the first MaxResults\n namespaces matched the specified criteria but that subsequent groups of MaxResults\n namespaces do contain namespaces that match the criteria.
If the response contains NextToken, submit another ListNamespaces request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.
Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria.\n It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria\n but that subsequent groups of MaxResults namespaces do contain namespaces that match the\n criteria.
For the first ListOperations request, omit this value.
If the response contains NextToken, submit another ListOperations\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.
Cloud Map gets MaxResults operations and then filters them based on the\n specified criteria. It's possible that no operations in the first MaxResults\n operations matched the specified criteria but that subsequent groups of MaxResults\n operations do contain operations that match the criteria.
For the first ListOperations request, omit this value.
If the response contains NextToken, submit another ListOperations request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.
Cloud Map gets MaxResults operations and then filters them based on the specified criteria.\n It's possible that no operations in the first MaxResults operations matched the specified criteria\n but that subsequent groups of MaxResults operations do contain operations that match the\n criteria.
The maximum number of items that you want Cloud Map to return in the response to a\n ListOperations request. If you don't specify a value for MaxResults,\n Cloud Map returns up to 100 operations.
The maximum number of items that you want Cloud Map to return in the response to a\n ListOperations request. If you don't specify a value for MaxResults, Cloud Map\n returns up to 100 operations.
A complex type that contains specifications for the operations that you want to list, for\n example, operations that you started between a specified start date and end date.
\nIf you specify more than one filter, an operation must match all filters to be returned by\n ListOperations.
A complex type that contains specifications for the operations that you want to list, for example,\n operations that you started between a specified start date and end date.
\nIf you specify more than one filter, an operation must match all filters to be returned by\n ListOperations.
If the response contains NextToken, submit another ListOperations\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.
Cloud Map gets MaxResults operations and then filters them based on the\n specified criteria. It's possible that no operations in the first MaxResults\n operations matched the specified criteria but that subsequent groups of MaxResults\n operations do contain operations that match the criteria.
If the response contains NextToken, submit another ListOperations request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.
Cloud Map gets MaxResults operations and then filters them based on the specified criteria.\n It's possible that no operations in the first MaxResults operations matched the specified criteria\n but that subsequent groups of MaxResults operations do contain operations that match the\n criteria.
Lists summary information for all the services that are associated with one or more\n specified namespaces.
", + "smithy.api#documentation": "Lists summary information for all the services that are associated with one or more\n namespaces.
", "smithy.api#examples": [ { "title": "Example: List services", @@ -2136,19 +2149,19 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "For the first ListServices request, omit this value.
If the response contains NextToken, submit another ListServices\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.
Cloud Map gets MaxResults services and then filters them based on the\n specified criteria. It's possible that no services in the first MaxResults services\n matched the specified criteria but that subsequent groups of MaxResults services do\n contain services that match the criteria.
For the first ListServices request, omit this value.
If the response contains NextToken, submit another ListServices request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.
Cloud Map gets MaxResults services and then filters them based on the specified criteria.\n It's possible that no services in the first MaxResults services matched the specified criteria but\n that subsequent groups of MaxResults services do contain services that match the criteria.
The maximum number of services that you want Cloud Map to return in the response to a\n ListServices request. If you don't specify a value for MaxResults,\n Cloud Map returns up to 100 services.
The maximum number of services that you want Cloud Map to return in the response to a\n ListServices request. If you don't specify a value for MaxResults, Cloud Map returns\n up to 100 services.
A complex type that contains specifications for the namespaces that you want to list\n services for.
\nIf you specify more than one filter, an operation must match all filters to be returned by\n ListServices.
A complex type that contains specifications for the namespaces that you want to list services for.
\nIf you specify more than one filter, an operation must match all filters to be returned by\n ListServices.
An array that contains one ServiceSummary object for each service that matches\n the specified filter criteria.
An array that contains one ServiceSummary object for each service that matches the specified\n filter criteria.
If the response contains NextToken, submit another ListServices\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.
Cloud Map gets MaxResults services and then filters them based on the\n specified criteria. It's possible that no services in the first MaxResults services\n matched the specified criteria but that subsequent groups of MaxResults services do\n contain services that match the criteria.
If the response contains NextToken, submit another ListServices request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.
Cloud Map gets MaxResults services and then filters them based on the specified criteria.\n It's possible that no services in the first MaxResults services matched the specified criteria but\n that subsequent groups of MaxResults services do contain services that match the criteria.
The type of the namespace. The methods for discovering instances depends on the value that\n you specify:
\nInstances can be discovered only programmatically, using the Cloud Map\n DiscoverInstances API.
Instances can be discovered using public DNS queries and using the\n DiscoverInstances API.
Instances can be discovered using DNS queries in VPCs and using the\n DiscoverInstances API.
The type of the namespace. The methods for discovering instances depends on the value that you\n specify:
\nInstances can be discovered only programmatically, using the Cloud Map DiscoverInstances\n API.
Instances can be discovered using public DNS queries and using the DiscoverInstances\n API.
Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances\n API.
A complex type that contains information that's specific to the type of the\n namespace.
" + "smithy.api#documentation": "A complex type that contains information that's specific to the type of the namespace.
" } }, "CreateDate": { "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "The date that the namespace was created, in Unix date/time format and Coordinated Universal\n Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The\n value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.
A unique string that identifies the request and that allows failed requests to be retried\n without the risk of running an operation twice.
" + "smithy.api#documentation": "A unique string that identifies the request and that allows failed requests to be retried without the risk\n of running an operation twice.
" } } }, @@ -2358,19 +2371,19 @@ "Values": { "target": "com.amazonaws.servicediscovery#FilterValues", "traits": { - "smithy.api#documentation": "Specify the values that are applicable to the value that you specify for\n Name.
\n TYPE: Specify HTTP, DNS_PUBLIC, or\n DNS_PRIVATE.
\n NAME: Specify the name of the namespace, which is found in\n Namespace.Name.
\n HTTP_NAME: Specify the HTTP name of the namespace, which is found in\n Namespace.Properties.HttpProperties.HttpName.
Specify the values that are applicable to the value that you specify for Name.
\n TYPE: Specify HTTP, DNS_PUBLIC, or\n DNS_PRIVATE.
\n NAME: Specify the name of the namespace, which is found in\n Namespace.Name.
\n HTTP_NAME: Specify the HTTP name of the namespace, which is found in\n Namespace.Properties.HttpProperties.HttpName.
Specify the operator that you want to use to determine whether a namespace matches the\n specified value. Valid values for Condition are one of the following.
\n EQ: When you specify EQ for Condition, you can\n specify only one value. EQ is supported for TYPE, NAME,\n and HTTP_NAME. EQ is the default condition and can be omitted.
\n BEGINS_WITH: When you specify BEGINS_WITH for\n Condition, you can specify only one value. BEGINS_WITH is supported\n for TYPE, NAME, and HTTP_NAME.
Specify the operator that you want to use to determine whether a namespace matches the specified value.\n Valid values for Condition are one of the following.
\n EQ: When you specify EQ for Condition, you can specify only one\n value. EQ is supported for TYPE, NAME, and HTTP_NAME.\n EQ is the default condition and can be omitted.
\n BEGINS_WITH: When you specify BEGINS_WITH for Condition, you can\n specify only one value. BEGINS_WITH is supported for TYPE, NAME, and\n HTTP_NAME.
A complex type that identifies the namespaces that you want to list. You can choose to list\n public or private namespaces.
" + "smithy.api#documentation": "A complex type that identifies the namespaces that you want to list. You can choose to list public or\n private namespaces.
" } }, "com.amazonaws.servicediscovery#NamespaceFilterName": { @@ -2463,7 +2476,7 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#DnsProperties", "traits": { - "smithy.api#documentation": "A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when\n you create a namespace.
" + "smithy.api#documentation": "A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a\n namespace.
" } }, "HttpProperties": { @@ -2501,7 +2514,7 @@ "Name": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { - "smithy.api#documentation": "The name of the namespace. When you create a namespace, Cloud Map automatically creates a\n Route 53 hosted zone that has the same name as the namespace.
" + "smithy.api#documentation": "The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted\n zone that has the same name as the namespace.
" } }, "Type": { @@ -2595,25 +2608,25 @@ "ErrorMessage": { "target": "com.amazonaws.servicediscovery#Message", "traits": { - "smithy.api#documentation": "If the value of Status is FAIL, the reason that the operation\n failed.
If the value of Status is FAIL, the reason that the operation failed.
The code associated with ErrorMessage. Values for ErrorCode\n include the following:
\n ACCESS_DENIED\n
\n CANNOT_CREATE_HOSTED_ZONE\n
\n EXPIRED_TOKEN\n
\n HOSTED_ZONE_NOT_FOUND\n
\n INTERNAL_FAILURE\n
\n INVALID_CHANGE_BATCH\n
\n THROTTLED_REQUEST\n
The code associated with ErrorMessage. Values for ErrorCode include the\n following:
\n ACCESS_DENIED\n
\n CANNOT_CREATE_HOSTED_ZONE\n
\n EXPIRED_TOKEN\n
\n HOSTED_ZONE_NOT_FOUND\n
\n INTERNAL_FAILURE\n
\n INVALID_CHANGE_BATCH\n
\n THROTTLED_REQUEST\n
The date and time that the request was submitted, in Unix date/time format and Coordinated\n Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.
The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time\n (UTC). The value of CreateDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that the value of Status changed to the current value, in\n Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate\n is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087 AM.
The date and time that the value of Status changed to the current value, in Unix date/time\n format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Specify the operations that you want to get:
\n\n NAMESPACE_ID: Gets operations related to specified\n namespaces.
\n\n SERVICE_ID: Gets operations related to specified\n services.
\n\n STATUS: Gets operations based on the status of the\n operations: SUBMITTED, PENDING, SUCCEED, or\n FAIL.
\n TYPE: Gets specified types of operation.
\n\n UPDATE_DATE: Gets operations that changed status during a\n specified date/time range.
\nSpecify the operations that you want to get:
\n\n NAMESPACE_ID: Gets operations related to specified namespaces.
\n\n SERVICE_ID: Gets operations related to specified services.
\n\n STATUS: Gets operations based on the status of the operations:\n SUBMITTED, PENDING, SUCCEED, or FAIL.
\n TYPE: Gets specified types of operation.
\n\n UPDATE_DATE: Gets operations that changed status during a specified\n date/time range.
\nSpecify values that are applicable to the value that you specify for Name:
\n NAMESPACE_ID: Specify one namespace ID.
\n\n SERVICE_ID: Specify one service ID.
\n\n STATUS: Specify one or more statuses:\n SUBMITTED, PENDING, SUCCEED, or\n FAIL.
\n TYPE: Specify one or more of the following types:\n CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE,\n REGISTER_INSTANCE, or DEREGISTER_INSTANCE.
\n UPDATE_DATE: Specify a start date and an end date in Unix\n date/time format and Coordinated Universal Time (UTC). The start date must be the first\n value.
\nSpecify values that are applicable to the value that you specify for Name:
\n NAMESPACE_ID: Specify one namespace ID.
\n\n SERVICE_ID: Specify one service ID.
\n\n STATUS: Specify one or more statuses: SUBMITTED,\n PENDING, SUCCEED, or FAIL.
\n TYPE: Specify one or more of the following types:\n CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE,\n REGISTER_INSTANCE, or DEREGISTER_INSTANCE.
\n UPDATE_DATE: Specify a start date and an end date in Unix date/time\n format and Coordinated Universal Time (UTC). The start date must be the first value.
\nThe operator that you want to use to determine whether an operation matches the specified\n value. Valid values for condition include:
\n\n EQ: When you specify EQ for the condition, you can specify only\n one value. EQ is supported for NAMESPACE_ID, SERVICE_ID,\n STATUS, and TYPE. EQ is the default condition and can\n be omitted.
\n IN: When you specify IN for the condition, you can specify a\n list of one or more values. IN is supported for STATUS and\n TYPE. An operation must match one of the specified values to be returned in the\n response.
\n BETWEEN: Specify a start date and an end date in Unix date/time format and\n Coordinated Universal Time (UTC). The start date must be the first value. BETWEEN\n is supported for UPDATE_DATE.
The operator that you want to use to determine whether an operation matches the specified value. Valid\n values for condition include:
\n\n EQ: When you specify EQ for the condition, you can specify only one value.\n EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and\n TYPE. EQ is the default condition and can be omitted.
\n IN: When you specify IN for the condition, you can specify a list of one or\n more values. IN is supported for STATUS and TYPE. An operation must\n match one of the specified values to be returned in the response.
\n BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated\n Universal Time (UTC). The start date must be the first value. BETWEEN is supported for\n UPDATE_DATE.
The status of the operation. Values include the following:
\n\n SUBMITTED: This is the initial state immediately after\n you submit a request.
\n\n PENDING: Cloud Map is performing the operation.
\n\n SUCCESS: The operation succeeded.
\n\n FAIL: The operation failed. For the failure reason, see\n ErrorMessage.
The status of the operation. Values include the following:
\n\n SUBMITTED: This is the initial state immediately after you submit a\n request.
\n\n PENDING: Cloud Map is performing the operation.
\n\n SUCCESS: The operation succeeded.
\n\n FAIL: The operation failed. For the failure reason, see\n ErrorMessage.
A complex type that contains information about an operation that matches the criteria that\n you specified in a ListOperations request.
" + "smithy.api#documentation": "A complex type that contains information about an operation that matches the criteria that you specified in\n a ListOperations\n request.
" } }, "com.amazonaws.servicediscovery#OperationSummaryList": { @@ -2858,18 +2871,18 @@ "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "An updated\n description for the private DNS namespace.
" + "smithy.api#documentation": "An updated description for the\n private DNS namespace.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PrivateDnsNamespacePropertiesChange", "traits": { - "smithy.api#documentation": "Properties to be\n updated in the private DNS namespace.
" + "smithy.api#documentation": "Properties to be updated in the\n private DNS namespace.
" } } }, "traits": { - "smithy.api#documentation": "Updated properties\n for the private DNS namespace.
" + "smithy.api#documentation": "Updated properties for the private\n DNS namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsNamespaceProperties": { @@ -2878,13 +2891,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutable", "traits": { - "smithy.api#documentation": "DNS properties for\n the private DNS namespace.
", + "smithy.api#documentation": "DNS properties for the private DNS\n namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for\n the private DNS namespace.
" + "smithy.api#documentation": "DNS properties for the private DNS\n namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsNamespacePropertiesChange": { @@ -2893,13 +2906,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutableChange", "traits": { - "smithy.api#documentation": "Updated DNS\n properties for the private DNS namespace.
", + "smithy.api#documentation": "Updated DNS properties for the\n private DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated properties\n for the private DNS namespace.
" + "smithy.api#documentation": "Updated properties for the private\n DNS namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutable": { @@ -2908,13 +2921,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOA", "traits": { - "smithy.api#documentation": "Fields for the Start\n of Authority (SOA) record for the hosted zone for the private DNS\n namespace.
", + "smithy.api#documentation": "Fields for the Start of Authority\n (SOA) record for the hosted zone for the private DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for\n the private DNS namespace.
" + "smithy.api#documentation": "DNS properties for the private DNS\n namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutableChange": { @@ -2923,13 +2936,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOAChange", "traits": { - "smithy.api#documentation": "Updated fields for\n the Start of Authority (SOA) record for the hosted zone for the private DNS\n namespace.
", + "smithy.api#documentation": "Updated fields for the Start of\n Authority (SOA) record for the hosted zone for the private DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated DNS\n properties for the private DNS namespace.
" + "smithy.api#documentation": "Updated DNS properties for the\n private DNS namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsNamespaceChange": { @@ -2938,18 +2951,18 @@ "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "An updated\n description for the public DNS namespace.
" + "smithy.api#documentation": "An updated description for the\n public DNS namespace.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PublicDnsNamespacePropertiesChange", "traits": { - "smithy.api#documentation": "Properties to be\n updated in the public DNS namespace.
" + "smithy.api#documentation": "Properties to be updated in the\n public DNS namespace.
" } } }, "traits": { - "smithy.api#documentation": "Updated properties\n for the public DNS namespace.
" + "smithy.api#documentation": "Updated properties for the public\n DNS namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsNamespaceProperties": { @@ -2958,13 +2971,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PublicDnsPropertiesMutable", "traits": { - "smithy.api#documentation": "DNS properties for\n the public DNS namespace.
", + "smithy.api#documentation": "DNS properties for the public DNS\n namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for\n the public DNS namespace.
" + "smithy.api#documentation": "DNS properties for the public DNS\n namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsNamespacePropertiesChange": { @@ -2973,13 +2986,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PublicDnsPropertiesMutableChange", "traits": { - "smithy.api#documentation": "Updated DNS\n properties for the hosted zone for the public DNS namespace.
", + "smithy.api#documentation": "Updated DNS properties for the\n hosted zone for the public DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated properties\n for the public DNS namespace.
" + "smithy.api#documentation": "Updated properties for the public\n DNS namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsPropertiesMutable": { @@ -2988,13 +3001,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOA", "traits": { - "smithy.api#documentation": "Start of Authority\n (SOA) record for the hosted zone for the public DNS namespace.
", + "smithy.api#documentation": "Start of Authority (SOA) record for\n the hosted zone for the public DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for\n the public DNS namespace.
" + "smithy.api#documentation": "DNS properties for the public DNS\n namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsPropertiesMutableChange": { @@ -3003,13 +3016,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOAChange", "traits": { - "smithy.api#documentation": "Updated fields for\n the Start of Authority (SOA) record for the hosted zone for the public DNS\n namespace.
", + "smithy.api#documentation": "Updated fields for the Start of\n Authority (SOA) record for the hosted zone for the public DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated DNS\n properties for the public DNS namespace.
" + "smithy.api#documentation": "Updated DNS properties for the\n public DNS namespace.
" } }, "com.amazonaws.servicediscovery#RecordTTL": { @@ -3076,7 +3089,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates one or more records and, optionally, creates a health check based on the\n settings in a specified service. When you submit a RegisterInstance request, the\n following occurs:
For each DNS record that you define in the service that's specified by\n ServiceId, a record is created or updated in the hosted zone that's associated\n with the corresponding namespace.
If the service includes HealthCheckConfig, a health check is created based on\n the settings in the health check configuration.
The health check, if any, is associated with each of the new or updated records.
\nOne RegisterInstance request must complete before you can submit another\n request and specify the same service ID and instance ID.
For more information, see CreateService.
\nWhen Cloud Map receives a DNS query for the specified DNS name, it returns the applicable\n value:
\n\n If the health check is healthy: returns all the\n records
\n\n If the health check is unhealthy: returns the applicable\n value for the last healthy instance
\n\n If you didn't specify a health check configuration:\n returns all the records
\nFor the current quota on the number of instances that you can register using the same\n namespace and using the same service, see Cloud Map quotas in the\n Cloud Map Developer Guide.
", + "smithy.api#documentation": "Creates or updates one or more records and, optionally, creates a health check based on the settings in a\n specified service. When you submit a RegisterInstance request, the following occurs:
For each DNS record that you define in the service that's specified by ServiceId, a record\n is created or updated in the hosted zone that's associated with the corresponding namespace.
If the service includes HealthCheckConfig, a health check is created based on the settings\n in the health check configuration.
The health check, if any, is associated with each of the new or updated records.
\nOne RegisterInstance request must complete before you can submit another request and specify\n the same service ID and instance ID.
For more information, see CreateService.
\nWhen Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
\n\n If the health check is healthy: returns all the records
\n\n If the health check is unhealthy: returns the applicable value for the\n last healthy instance
\n\n If you didn't specify a health check configuration: returns all the\n records
\nFor the current quota on the number of instances that you can register using the same namespace and using\n the same service, see Cloud Map\n quotas in the Cloud Map Developer Guide.
", "smithy.api#examples": [ { "title": "Example: Register Instance", @@ -3110,21 +3123,21 @@ "InstanceId": { "target": "com.amazonaws.servicediscovery#InstanceId", "traits": { - "smithy.api#documentation": "An identifier that you want to associate with the instance. Note the following:
\nIf the service that's specified by ServiceId includes settings for an\n SRV record, the value of InstanceId is automatically included as\n part of the value for the SRV record. For more information, see DnsRecord >\n Type.
You can use this value to update an existing instance.
\nTo register a new instance, you must specify a value that's unique among instances that\n you register by using the same service.
\nIf you specify an existing InstanceId and ServiceId, Cloud Map\n updates the existing DNS records, if any. If there's also an existing health check, Cloud Map\n deletes the old health check and creates a new one.
The health check isn't deleted immediately, so it will still appear for a while if you\n submit a ListHealthChecks request, for example.
Do not include sensitive information in InstanceId if the namespace is\n discoverable by public DNS queries and any Type member of DnsRecord\n for the service contains SRV because the InstanceId is discoverable by\n public DNS queries.
An identifier that you want to associate with the instance. Note the following:
\nIf the service that's specified by ServiceId includes settings for an SRV\n record, the value of InstanceId is automatically included as part of the value for the\n SRV record. For more information, see DnsRecord > Type.
You can use this value to update an existing instance.
\nTo register a new instance, you must specify a value that's unique among instances that you register by\n using the same service.
\nIf you specify an existing InstanceId and ServiceId, Cloud Map updates the\n existing DNS records, if any. If there's also an existing health check, Cloud Map deletes the old health\n check and creates a new one.
The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks request, for example.
Do not include sensitive information in InstanceId if the namespace is discoverable by public\n DNS queries and any Type member of DnsRecord for the service contains\n SRV because the InstanceId is discoverable by public DNS queries.
A unique string that identifies the request and that allows failed\n RegisterInstance requests to be retried without the risk of executing the operation\n twice. You must use a unique CreatorRequestId string every time you submit a\n RegisterInstance request if you're registering additional instances for the same\n namespace and service. CreatorRequestId can be any unique string (for example, a\n date/time stamp).
A unique string that identifies the request and that allows failed RegisterInstance requests\n to be retried without the risk of executing the operation twice. You must use a unique\n CreatorRequestId string every time you submit a RegisterInstance request if you're\n registering additional instances for the same namespace and service. CreatorRequestId can be any\n unique string (for example, a date/time stamp).
A string map that contains the following information for the service that you specify in\n ServiceId:
The attributes that apply to the records that are defined in the service.
\nFor each attribute, the applicable value.
\nDo not include sensitive information in the attributes if the namespace is discoverable by\n public DNS queries.
\nSupported attribute keys include the following:
\nIf you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an\n Elastic Load Balancing load balancer, specify the DNS name that's associated with the load balancer. For\n information about how to get the DNS name, see \"DNSName\" in the topic AliasTarget in the Route 53 API Reference.
\nNote the following:
\nThe configuration for the service that's specified by ServiceId must\n include settings for an A record, an AAAA record, or both.
In the service that's specified by ServiceId, the value of\n RoutingPolicy must be WEIGHTED.
If the service that's specified by ServiceId includes\n HealthCheckConfig settings, Cloud Map will create the Route 53 health check, but\n it doesn't associate the health check with the alias record.
Cloud Map currently doesn't support creating alias records that route traffic to\n Amazon Web Services resources other than Elastic Load Balancing load balancers.
\nIf you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for\n any of the AWS_INSTANCE attributes.
\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the\n AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute that\n can be specified is AWS_INIT_HEALTH_STATUS. When the\n AWS_EC2_INSTANCE_ID attribute is specified, then the\n AWS_INSTANCE_IPV4 attribute will be filled out with the primary private IPv4\n address.
If the service configuration includes HealthCheckCustomConfig, you can\n optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom\n health check, HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
If the service configuration includes a CNAME record, the domain name that\n you want Route 53 to return in response to DNS queries (for example,\n example.com).
This value is required if the service specified by ServiceId includes\n settings for an CNAME record.
If the service configuration includes an A record, the IPv4 address that you\n want Route 53 to return in response to DNS queries (for example, 192.0.2.44).
This value is required if the service specified by ServiceId includes\n settings for an A record. If the service includes settings for an\n SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.
If the service configuration includes an AAAA record, the IPv6 address that\n you want Route 53 to return in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345).
This value is required if the service specified by ServiceId includes\n settings for an AAAA record. If the service includes settings for an\n SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.
If the service includes an SRV record, the value that you want Route 53 to\n return for the port.
If the service includes HealthCheckConfig, the port on the endpoint that you\n want Route 53 to send requests to.
This value is required if you specified settings for an SRV record or a\n Route 53 health check when you created the service.
You can add up to 30 custom attributes. For each key-value pair, the maximum length of\n the attribute name is 255 characters, and the maximum length of the attribute value is 1,024\n characters. The total size of all provided attributes (sum of all keys and values) must not\n exceed 5,000 characters.
\nA string map that contains the following information for the service that you specify in\n ServiceId:
The attributes that apply to the records that are defined in the service.
\nFor each attribute, the applicable value.
\nDo not include sensitive information in the attributes if the namespace is discoverable by public DNS\n queries.
\nThe following are the supported attribute keys.
\nIf you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load\n balancer, specify the DNS name that's associated with the load balancer. For information about how to get the\n DNS name, see \"DNSName\" in the topic AliasTarget in the\n Route 53 API Reference.
\nNote the following:
\nThe configuration for the service that's specified by ServiceId must include settings for\n an A record, an AAAA record, or both.
In the service that's specified by ServiceId, the value of RoutingPolicy\n must be WEIGHTED.
If the service that's specified by ServiceId includes HealthCheckConfig\n settings, Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the\n alias record.
Cloud Map currently doesn't support creating alias records that route traffic to Amazon Web Services\n resources other than Elastic Load Balancing load balancers.
\nIf you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.
The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US) Regions.
\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the\n AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute that can be specified\n is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is specified,\n then the AWS_INSTANCE_IPV4 attribute will be filled out with the primary private IPv4\n address.
If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
If the service configuration includes a CNAME record, the domain name that you want Route 53\n to return in response to DNS queries (for example, example.com).
This value is required if the service specified by ServiceId includes settings for an\n CNAME record.
If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n return in response to DNS queries (for example, 192.0.2.44).
This value is required if the service specified by ServiceId includes settings for an\n A record. If the service includes settings for an SRV record, you must specify a\n value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
If the service configuration includes an AAAA record, the IPv6 address that you want Route 53\n to return in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345).
This value is required if the service specified by ServiceId includes settings for an\n AAAA record. If the service includes settings for an SRV record, you must specify\n a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
If the service includes an SRV record, the value that you want Route 53 to return for the\n port.
If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to\n send requests to.
This value is required if you specified settings for an SRV record or a Route 53 health check\n when you created the service.
You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute\n name is 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of\n all provided attributes (sum of all keys and values) must not exceed 5,000 characters.
\nThe operation can't be completed because you've reached the quota for the number of\n requests. For more information, see Cloud Map API request throttling quota in the\n Cloud Map Developer Guide.
", + "smithy.api#documentation": "The operation can't be completed because you've reached the quota for the number of requests. For more\n information, see Cloud Map API request\n throttling quota in the Cloud Map Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -3189,7 +3202,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified resource can't be deleted because it contains other resources. For example,\n you can't delete a service that contains any instances.
", + "smithy.api#documentation": "The specified resource can't be deleted because it contains other resources. For example, you can't delete\n a service that contains any instances.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -3202,7 +3215,7 @@ } }, "traits": { - "smithy.api#documentation": "The resource can't be created because you've reached the quota on the number of\n resources.
", + "smithy.api#documentation": "The resource can't be created because you've reached the quota on the number of resources.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3330,7 +3343,7 @@ "name": "servicediscovery" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your\n microservice applications run in. When an instance becomes available, you can call the Cloud Map\n API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map\n automatically creates DNS records and an optional health check. Clients that submit public or\n private DNS queries, or HTTP requests, for the service receive an answer that contains up to\n eight healthy records.
", + "smithy.api#documentation": "With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice\n applications run in. When an instance becomes available, you can call the Cloud Map API to register the\n instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and\n an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service\n receive an answer that contains up to eight healthy records.
", "smithy.api#title": "AWS Cloud Map", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -4398,13 +4411,13 @@ "TTL": { "target": "com.amazonaws.servicediscovery#RecordTTL", "traits": { - "smithy.api#documentation": "The time to live\n (TTL) for purposes of negative caching.
", + "smithy.api#documentation": "The time to live (TTL) for purposes\n of negative caching.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Start of Authority\n (SOA) properties for a public or private DNS namespace.
" + "smithy.api#documentation": "Start of Authority (SOA) properties\n for a public or private DNS namespace.
" } }, "com.amazonaws.servicediscovery#SOAChange": { @@ -4413,13 +4426,13 @@ "TTL": { "target": "com.amazonaws.servicediscovery#RecordTTL", "traits": { - "smithy.api#documentation": "The updated time to\n live (TTL) for purposes of negative caching.
", + "smithy.api#documentation": "The updated time to live (TTL) for\n purposes of negative caching.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated Start of\n Authority (SOA) properties for a public or private DNS namespace.
" + "smithy.api#documentation": "Updated Start of Authority (SOA)\n properties for a public or private DNS namespace.
" } }, "com.amazonaws.servicediscovery#Service": { @@ -4458,43 +4471,43 @@ "InstanceCount": { "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { - "smithy.api#documentation": "The number of instances that are currently associated with the service. Instances that were\n previously associated with the service but that are deleted aren't included in the count. The\n count might not reflect pending registrations and deregistrations.
" + "smithy.api#documentation": "The number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that are deleted aren't included in the count. The count might not reflect\n pending registrations and deregistrations.
" } }, "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "A complex type that contains information about the Route 53 DNS records that you want\n Cloud Map to create when you register an instance.
\nThe record types of a service can only be changed by deleting the service and recreating it\n with a new Dnsconfig.
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create\n when you register an instance.
\nThe record types of a service can only be changed by deleting the service and recreating it with a new\n Dnsconfig.
Describes the systems that can be used to discover the service instances.
\nThe service instances can be discovered using either DNS queries or the\n DiscoverInstances API operation.
The service instances can only be discovered using the DiscoverInstances API\n operation.
Reserved.
\nDescribes the systems that can be used to discover the service instances.
\nThe service instances can be discovered using either DNS queries or the DiscoverInstances\n API operation.
The service instances can only be discovered using the DiscoverInstances API\n operation.
Reserved.
\n\n Public DNS and HTTP namespaces only. A complex type that contains\n settings for an optional health check. If you specify settings for a health check, Cloud Map\n associates the health check with the records that you specify in DnsConfig.
For information about the charges for health checks, see Amazon Route 53 Pricing.
" + "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains settings for an\n optional health check. If you specify settings for a health check, Cloud Map associates the health check with\n the records that you specify in DnsConfig.
For information about the charges for health checks, see Amazon Route 53 Pricing.
" } }, "HealthCheckCustomConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", "traits": { - "smithy.api#documentation": "A complex type that contains information about an optional custom health check.
\nIf you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.
A complex type that contains information about an optional custom health check.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.
The date and time that the service was created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The\n value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.
A unique string that identifies the request and that allows failed requests to be retried\n without the risk of running the operation twice. CreatorRequestId can be any unique\n string (for example, a date/timestamp).
A unique string that identifies the request and that allows failed requests to be retried without the risk\n of running the operation twice. CreatorRequestId can be any unique string (for example, a\n date/timestamp).
Information about the Route 53 DNS records that you want Cloud Map to create when you register\n an instance.
" + "smithy.api#documentation": "Information about the Route 53 DNS records that you want Cloud Map to create when you register an\n instance.
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. Settings for an optional health\n check. If you specify settings for a health check, Cloud Map associates the health check with\n the records that you specify in DnsConfig.
\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you\n specify settings for a health check, Cloud Map associates the health check with the records that you specify in\n DnsConfig.
The values that are applicable to the value that you specify for Condition to\n filter the list of services.
The values that are applicable to the value that you specify for Condition to filter the list\n of services.
The operator that you want to use to determine whether a service is returned by\n ListServices. Valid values for Condition include the following:
\n EQ: When you specify EQ, specify one namespace ID for\n Values. EQ is the default condition and can be omitted.
The operator that you want to use to determine whether a service is returned by ListServices.\n Valid values for Condition include the following:
\n EQ: When you specify EQ, specify one namespace ID for Values.\n EQ is the default condition and can be omitted.
A complex type that lets you specify the namespaces that you want to list services\n for.
" + "smithy.api#documentation": "A complex type that lets you specify the namespaces that you want to list services for.
" } }, "com.amazonaws.servicediscovery#ServiceFilterName": { @@ -4650,7 +4663,7 @@ "Type": { "target": "com.amazonaws.servicediscovery#ServiceType", "traits": { - "smithy.api#documentation": "Describes the systems that can be used to discover the service instances.
\nThe service instances can be discovered using either DNS queries or the\n DiscoverInstances API operation.
The service instances can only be discovered using the DiscoverInstances API\n operation.
Reserved.
\nDescribes the systems that can be used to discover the service instances.
\nThe service instances can be discovered using either DNS queries or the DiscoverInstances\n API operation.
The service instances can only be discovered using the DiscoverInstances API\n operation.
Reserved.
\nThe number of instances that are currently associated with the service. Instances that were\n previously associated with the service but that are deleted aren't included in the count. The\n count might not reflect pending registrations and deregistrations.
" + "smithy.api#documentation": "The number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that are deleted aren't included in the count. The count might not reflect\n pending registrations and deregistrations.
" } }, "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "Information about the Route 53 DNS records that you want Cloud Map to create when you register\n an instance.
" + "smithy.api#documentation": "Information about the Route 53 DNS records that you want Cloud Map to create when you register an\n instance.
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. Settings for an optional health\n check. If you specify settings for a health check, Cloud Map associates the health check with\n the records that you specify in DnsConfig.
\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you\n specify settings for a health check, Cloud Map associates the health check with the records that you specify in\n DnsConfig.
Information about an optional custom health check. A custom health check, which requires\n that you use a third-party health checker to evaluate the health of your resources, is useful in\n the following circumstances:
\nYou can't use a health check that's defined by HealthCheckConfig because the\n resource isn't available over the internet. For example, you can use a custom health check when\n the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health\n checker must also be in the VPC.)
You want to use a third-party health checker regardless of where your resources are\n located.
\nIf you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.
Information about an optional custom health check. A custom health check, which requires that you use a\n third-party health checker to evaluate the health of your resources, is useful in the following\n circumstances:
\nYou can't use a health check that's defined by HealthCheckConfig because the resource isn't\n available over the internet. For example, you can use a custom health check when the instance is in an Amazon\n VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)
You want to use a third-party health checker regardless of where your resources are located.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.
The string value that's associated with the key of the tag. You can set the value of a tag\n to an empty string, but you can't set the value of a tag to null.
", + "smithy.api#documentation": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty\n string, but you can't set the value of a tag to null.
", "smithy.api#required": {} } } @@ -4839,7 +4852,7 @@ "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "The tags to add to the specified resource. Specifying the tag key is required. You can set\n the value of a tag to an empty string, but you can't set the value of a tag to null.
", + "smithy.api#documentation": "The tags to add to the specified resource. Specifying the tag key is required. You can set the value of a\n tag to an empty string, but you can't set the value of a tag to null.
", "smithy.api#required": {} } } @@ -4881,7 +4894,7 @@ } }, "traits": { - "smithy.api#documentation": "The list of tags on the resource is over the quota. The maximum number of tags that can be\n applied to a resource is 50.
", + "smithy.api#documentation": "The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a\n resource is 50.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4972,7 +4985,22 @@ } ], "traits": { - "smithy.api#documentation": "Updates an HTTP\n namespace.
" + "smithy.api#documentation": "Updates an HTTP\n namespace.
", + "smithy.api#examples": [ + { + "title": "To update a HTTP namespace", + "documentation": "The following example updates the description of a HTTP namespace.", + "input": { + "Id": "ns-vh4nbmEXAMPLE", + "Namespace": { + "Description": "The updated namespace description." + } + }, + "output": { + "OperationId": "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE" + } + } + ] } }, "com.amazonaws.servicediscovery#UpdateHttpNamespaceRequest": { @@ -4981,21 +5009,21 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the\n namespace that you want to update.
", + "smithy.api#documentation": "The ID of the namespace that you\n want to update.
", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "A unique string that\n identifies the request and that allows failed UpdateHttpNamespace requests to be\n retried without the risk of running the operation twice. UpdaterRequestId can be any\n unique string (for example, a date/timestamp).
A unique string that identifies the\n request and that allows failed UpdateHttpNamespace requests to be retried without the risk of\n running the operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).
Updated properties\n for the the HTTP namespace.
", + "smithy.api#documentation": "Updated properties for the the HTTP\n namespace.
", "smithy.api#required": {} } } @@ -5041,7 +5069,7 @@ } ], "traits": { - "smithy.api#documentation": "Submits a request to change the health status of a custom health check to healthy or\n unhealthy.
\nYou can use UpdateInstanceCustomHealthStatus to change the status only for\n custom health checks, which you define using HealthCheckCustomConfig when you create\n a service. You can't use it to change the status for Route 53 health checks, which you define using\n HealthCheckConfig.
For more information, see HealthCheckCustomConfig.
", + "smithy.api#documentation": "Submits a request to change the health status of a custom health check to healthy or unhealthy.
\nYou can use UpdateInstanceCustomHealthStatus to change the status only for custom health\n checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it\n to change the status for Route 53 health checks, which you define using HealthCheckConfig.
For more information, see HealthCheckCustomConfig.
", "smithy.api#examples": [ { "title": "UpdateInstanceCustomHealthStatus Example", @@ -5061,7 +5089,7 @@ "ServiceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the service that includes the configuration for the custom health check that you\n want to change the status for.
", + "smithy.api#documentation": "The ID of the service that includes the configuration for the custom health check that you want to change\n the status for.
", "smithy.api#required": {} } }, @@ -5107,7 +5135,37 @@ } ], "traits": { - "smithy.api#documentation": "Updates a private DNS\n namespace.
" + "smithy.api#documentation": "Updates a private DNS\n namespace.
", + "smithy.api#examples": [ + { + "title": "To update a private DNS namespace", + "documentation": "The following example updates the description of a private DNS namespace.", + "input": { + "Id": "ns-bk3aEXAMPLE", + "UpdaterRequestId": "", + "Namespace": { + "Description": "The updated namespace description." + } + }, + "output": { + "OperationId": "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE" + } + }, + { + "title": "To update a public DNS namespace", + "documentation": "The following example updates the description of a public DNS namespace.", + "input": { + "Id": "ns-bk3aEXAMPLE", + "UpdaterRequestId": "", + "Namespace": { + "Description": "The updated namespace description." + } + }, + "output": { + "OperationId": "ft52xe2koxhoeormaceymagglsdjEXAMPLE" + } + } + ] } }, "com.amazonaws.servicediscovery#UpdatePrivateDnsNamespaceRequest": { @@ -5116,21 +5174,21 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the\n namespace that you want to update.
", + "smithy.api#documentation": "The ID of the namespace that you\n want to update.
", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "A unique string that\n identifies the request and that allows failed UpdatePrivateDnsNamespace requests to\n be retried without the risk of running the operation twice. UpdaterRequestId can be\n any unique string (for example, a date/timestamp).
A unique string that identifies the\n request and that allows failed UpdatePrivateDnsNamespace requests to be retried without the risk of\n running the operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).
Updated properties\n for the private DNS namespace.
", + "smithy.api#documentation": "Updated properties for the private\n DNS namespace.
", "smithy.api#required": {} } } @@ -5185,21 +5243,21 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the\n namespace being updated.
", + "smithy.api#documentation": "The ID of the namespace being\n updated.
", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "A unique string that\n identifies the request and that allows failed UpdatePublicDnsNamespace requests to\n be retried without the risk of running the operation twice. UpdaterRequestId can be\n any unique string (for example, a date/timestamp).
A unique string that identifies the\n request and that allows failed UpdatePublicDnsNamespace requests to be retried without the risk of\n running the operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).
Updated properties\n for the public DNS namespace.
", + "smithy.api#documentation": "Updated properties for the public\n DNS namespace.
", "smithy.api#required": {} } } @@ -5242,7 +5300,7 @@ } ], "traits": { - "smithy.api#documentation": "Submits a request to perform the following operations:
\nUpdate the TTL setting for existing DnsRecords configurations
Add, update, or delete HealthCheckConfig for a specified service
You can't add, update, or delete a HealthCheckCustomConfig\n configuration.
For public and private DNS namespaces, note the following:
\nIf you omit any existing DnsRecords or HealthCheckConfig\n configurations from an UpdateService request, the configurations are deleted from\n the service.
If you omit an existing HealthCheckCustomConfig configuration from an\n UpdateService request, the configuration isn't deleted from the service.
When you update settings for a service, Cloud Map also updates the corresponding settings\n in all the records and health checks that were created by using the specified service.
", + "smithy.api#documentation": "Submits a request to perform the following operations:
\nUpdate the TTL setting for existing DnsRecords configurations
Add, update, or delete HealthCheckConfig for a specified service
You can't add, update, or delete a HealthCheckCustomConfig configuration.
For public and private DNS namespaces, note the following:
\nIf you omit any existing DnsRecords or HealthCheckConfig configurations from an\n UpdateService request, the configurations are deleted from the service.
If you omit an existing HealthCheckCustomConfig configuration from an\n UpdateService request, the configuration isn't deleted from the service.
When you update settings for a service, Cloud Map also updates the corresponding settings in all the\n records and health checks that were created by using the specified service.
", "smithy.api#examples": [ { "title": "UpdateService Example", diff --git a/codegen/sdk-codegen/aws-models/supplychain.2024-01-01.json b/codegen/sdk-codegen/aws-models/supplychain.2024-01-01.json index f79e717f53a..79911da8b9f 100644 --- a/codegen/sdk-codegen/aws-models/supplychain.2024-01-01.json +++ b/codegen/sdk-codegen/aws-models/supplychain.2024-01-01.json @@ -259,12 +259,162 @@ "smithy.api#output": {} } }, + "com.amazonaws.supplychain#DataIntegrationEventData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1048576 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.supplychain#DataIntegrationEventGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationEventResource": { + "type": "resource", + "identifiers": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID" + }, + "eventId": { + "target": "com.amazonaws.supplychain#UUID" + } + }, + "properties": { + "eventType": { + "target": "com.amazonaws.supplychain#DataIntegrationEventType" + }, + "data": { + "target": "com.amazonaws.supplychain#DataIntegrationEventData" + }, + "eventGroupId": { + "target": "com.amazonaws.supplychain#DataIntegrationEventGroupId" + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp" + } + }, + "create": { + "target": "com.amazonaws.supplychain#SendDataIntegrationEvent" + }, + "traits": { + "aws.api#arn": { + "template": "instance/{instanceId}/data-integration-events/{eventId}" + } + } + }, + "com.amazonaws.supplychain#DataIntegrationEventType": { + "type": "enum", + "members": { + "FORECAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.forecast" + } + }, + "INVENTORY_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inventorylevel" + } + }, + "INBOUND_ORDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inboundorder" + } + }, + "INBOUND_ORDER_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inboundorderline" + } + }, + "INBOUND_ORDER_LINE_SCHEDULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inboundorderlineschedule" + } + }, + "OUTBOUND_ORDER_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.outboundorderline" + } + }, + "OUTBOUND_SHIPMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.outboundshipment" + } + }, + "PROCESS_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.processheader" + } + }, + "PROCESS_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.processoperation" + } + }, + "PROCESS_PRODUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.processproduct" + } + }, + "RESERVATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.reservation" + } + }, + "SHIPMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.shipment" + } + }, + "SHIPMENT_STOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.shipmentstop" + } + }, + "SHIPMENT_STOP_ORDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.shipmentstoporder" + } + }, + "SUPPLY_PLAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.supplyplan" + } + } + } + }, "com.amazonaws.supplychain#GalaxyPublicAPIGateway": { "type": "service", "version": "2024-01-01", "resources": [ { "target": "com.amazonaws.supplychain#BillOfMaterialsImportJobResource" + }, + { + "target": "com.amazonaws.supplychain#DataIntegrationEventResource" } ], "errors": [ @@ -1121,6 +1271,312 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.supplychain#SendDataIntegrationEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#SendDataIntegrationEventRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#SendDataIntegrationEventResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#ConflictException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Send transactional data events with real-time data for analysis or monitoring.
", + "smithy.api#examples": [ + { + "title": "Successful SendDataIntegrationEvent for inboundorder event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.inboundorder", + "data": "{\"id\": \"inbound-order-id-test-123\", \"tpartner_id\": \"partner-id-test-123\" }", + "eventGroupId": "inboundOrderId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "c4132c1d-8f60-44a2-9932-f723c4f7b8a7" + } + }, + { + "title": "Successful SendDataIntegrationEvent for inboundorderline event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.inboundorderline", + "data": "{\"id\": \"inbound-order-line-id-test-123\", \"order_id\": \"order-id-test-123\", \"tpartner_id\": \"partner-id-test-123\", \"product_id\": \"product-id-test-123\", \"quantity_submitted\": \"100.0\" }", + "eventGroupId": "inboundOrderLineId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "45d95db2-d106-40e0-aa98-f1204230a691" + } + }, + { + "title": "Successful SendDataIntegrationEvent for inboundorderlineschedule event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.inboundorderlineschedule", + "data": "{\"id\": \"inbound-order-line-schedule-id-test-123\", \"order_id\": \"order-id-test-123\", \"order_line_id\": \"order-line-id-test-123\", \"product_id\": \"product-id-test-123\"}", + "eventGroupId": "inboundOrderLineScheduleId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "5abba995-7735-4d1e-95c4-7cc93e48cf9f" + } + }, + { + "title": "Successful SendDataIntegrationEvent for forecast event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.forecast", + "data": "{\"snapshot_date\": \"1672470400000\", \"product_id\": \"product-id-test-123\", \"site_id\": \"site-id-test-123\", \"region_id\": \"region-id-test-123\", \"product_group_id\": \"product-group-id-test-123\", \"forecast_start_dttm\": \"1672470400000\", \"forecast_end_dttm\": \"1672470400000\" }", + "eventGroupId": "forecastId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "29312d5b-f499-4dcd-b017-3dab3cd34d61" + } + }, + { + "title": "Successful SendDataIntegrationEvent for inventorylevel event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.inventorylevel", + "data": "{\"snapshot_date\": \"1672470400000\", \"site_id\": \"site-id-test-123\", \"product_id\": \"product-id-test-123\", \"on_hand_inventory\": \"100.0\", \"inv_condition\": \"good\", \"lot_number\": \"lot-number-test-123\"}", + "eventGroupId": "inventoryLevelId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "3aa78324-acd8-4fdd-a19e-231ea003c2b3" + } + }, + { + "title": "Successful SendDataIntegrationEvent for outboundorderline event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.outboundorderline", + "data": "{\"id\": \"outbound-orderline-id-test-123\", \"cust_order_id\": \"cust-order-id-test-123\", \"product_id\": \"product-id-test-123\" }", + "eventGroupId": "outboundOrderLineId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "959b7ef9-5e2d-4795-b1ca-5b16a3eb6b89" + } + }, + { + "title": "Successful SendDataIntegrationEvent for outboundshipment event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.outboundshipment", + "data": "{\"id\": \"outbound-shipment-id-test-123\", \"cust_order_id\": \"cust-order-id-test-123\", \"cust_order_line_id\": \"cust-order-line-id-test-123\", \"product_id\": \"product-id-test-123\" }", + "eventGroupId": "outboundShipmentId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "59feded3-5e46-4126-81bf-0137ca176ee0" + } + }, + { + "title": "Successful SendDataIntegrationEvent for processheader event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.processheader", + "data": "{\"process_id\": \"process-id-test-123\" }", + "eventGroupId": "processHeaderId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "564130eb-2d8a-4550-a768-ddf0daf7b4a9" + } + }, + { + "title": "Successful SendDataIntegrationEvent for processoperation event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.processoperation", + "data": "{\"process_operation_id\": \"process-operation-id-test-123\", \"process_id\": \"process-id-test-123\" }", + "eventGroupId": "processOperationId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "db5df408-89c7-4b9f-a326-016f6c2b3396" + } + }, + { + "title": "Successful SendDataIntegrationEvent for processproduct event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.processproduct", + "data": "{\"process_product_id\": \"process-product-id-test-123\", \"process_id\": \"process-id-test-123\" }", + "eventGroupId": "processProductId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "6929b275-485e-4035-a798-99077ca6d669" + } + }, + { + "title": "Successful SendDataIntegrationEvent for reservation event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.reservation", + "data": "{\"reservation_id\": \"reservation-id-test-123\", \"reservation_detail_id\": \"reservation-detail-id-test-123\" }", + "eventGroupId": "reservationId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "f6c55a8b-fde2-44f6-848a-9b4336c77209" + } + }, + { + "title": "Successful SendDataIntegrationEvent for shipment event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.shipment", + "data": "{\"id\": \"shipment-id-test-123\", \"supplier_tpartner_id\": \"supplier-tpartner-id-test-123\", \"product_id\": \"product-id-test-123\", \"order_id\": \"order-id-test-123\", \"order_line_id\": \"order-line-id-test-123\", \"package_id\": \"package-id-test-123\" }", + "eventGroupId": "shipmentId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "61d079d8-3f56-49bb-b35a-c0271a4e4f0a" + } + }, + { + "title": "Successful SendDataIntegrationEvent for shipmentstop event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.shipmentstop", + "data": "{\"shipment_stop_id\": \"shipment-stop-id-test-123\", \"shipment_id\": \"shipment-id-test-123\" }", + "eventGroupId": "shipmentStopId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "3610992a-fc2f-4da4-9beb-724994622ba1" + } + }, + { + "title": "Successful SendDataIntegrationEvent for shipmentstoporder event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.shipmentstoporder", + "data": "{\"shipment_stop_order_id\": \"shipment-stop-order-id-test-123\", \"shipment_stop_id\": \"shipment-stop-id-test-123\", \"shipment_id\": \"shipment-id-test-123\" }", + "eventGroupId": "shipmentStopOrderId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "1d550a60-9321-4d25-a132-9dd4b2d9e934" + } + }, + { + "title": "Successful SendDataIntegrationEvent for supplyplan event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.supplyplan", + "data": "{\"supply_plan_id\": \"supply-plan-id-test-123\" }", + "eventGroupId": "supplyPlanId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "9abaee56-5dc4-4c31-8250-3206a651d8a1" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/api-data/data-integration/instance/{instanceId}/data-integration-events" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.supplychain#SendDataIntegrationEventRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The AWS Supply Chain instance identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "eventType": { + "target": "com.amazonaws.supplychain#DataIntegrationEventType", + "traits": { + "smithy.api#documentation": "The data event type.
", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.supplychain#DataIntegrationEventData", + "traits": { + "smithy.api#documentation": "The data payload of the event.
", + "smithy.api#required": {} + } + }, + "eventGroupId": { + "target": "com.amazonaws.supplychain#DataIntegrationEventGroupId", + "traits": { + "smithy.api#documentation": "Event identifier (for example, orderId for InboundOrder) used for data sharing or partitioning.
", + "smithy.api#required": {} + } + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The event timestamp (in epoch seconds).
", + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "clientToken": { + "target": "com.amazonaws.supplychain#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotent client token.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request parameters for SendDataIntegrationEvent.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#SendDataIntegrationEventResponse": { + "type": "structure", + "members": { + "eventId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The unique event identifier.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The response parameters for SendDataIntegrationEvent.
", + "smithy.api#output": {} + } + }, "com.amazonaws.supplychain#ServiceQuotaExceededException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json b/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json index e074956080b..9a7d0b552f5 100644 --- a/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json +++ b/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json @@ -292,6 +292,12 @@ "traits": { "smithy.api#enumValue": "ENCRYPTION" } + }, + "TLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TLS" + } } } }, @@ -5622,6 +5628,16 @@ "target": "com.amazonaws.transfer#ListedWorkflow" } }, + "com.amazonaws.transfer#ListingId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[0-9a-zA-Z./-]+$" + } + }, "com.amazonaws.transfer#LogGroupName": { "type": "string", "traits": { @@ -5689,6 +5705,15 @@ } } }, + "com.amazonaws.transfer#MaxItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, "com.amazonaws.transfer#MaxResults": { "type": "integer", "traits": { @@ -5812,6 +5837,16 @@ } } }, + "com.amazonaws.transfer#OutputFileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 26, + "max": 537 + }, + "smithy.api#pattern": "^c-([0-9a-f]{17})-[0-9a-zA-Z./-]+.json$" + } + }, "com.amazonaws.transfer#OverwriteExisting": { "type": "enum", "members": { @@ -6714,6 +6749,92 @@ } } }, + "com.amazonaws.transfer#StartDirectoryListing": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#StartDirectoryListingRequest" + }, + "output": { + "target": "com.amazonaws.transfer#StartDirectoryListingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.transfer#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of the contents of a directory from a remote SFTP server. You specify the\n connector ID, the output path, and the remote directory path. You can also specify the\n optional MaxItems value to control the maximum number of items that are listed\n from the remote directory. This API returns a list of all files and directories in the remote\n directory (up to the maximum value), but does not return files or folders in sub-directories.\n That is, it only returns a list of files and directories one-level deep.
After you receive the listing file, you can provide the files that you want to transfer to\n the RetrieveFilePaths parameter of the StartFileTransfer API\n call.
The naming convention for the output file is\n \n connector-ID-listing-ID.json. The\n output file contains the following information:
\n filePath: the complete path of a remote file, relative to the directory\n of the listing request for your SFTP connector on the remote server.
\n modifiedTimestamp: the last time the file was modified, in UTC time\n format. This field is optional. If the remote file attributes don't contain a timestamp,\n it is omitted from the file listing.
\n size: the size of the file, in bytes. This field is optional. If the\n remote file attributes don't contain a file size, it is omitted from the file\n listing.
\n path: the complete path of a remote directory, relative to the directory\n of the listing request for your SFTP connector on the remote server.
\n truncated: a flag indicating whether the list output contains all of the\n items contained in the remote directory or not. If your Truncated output\n value is true, you can increase the value provided in the optional max-items\n input attribute to be able to list more items (up to the maximum allowed list size of\n 10,000 items).
The unique identifier for the connector.
", + "smithy.api#required": {} + } + }, + "RemoteDirectoryPath": { + "target": "com.amazonaws.transfer#FilePath", + "traits": { + "smithy.api#documentation": "Specifies the directory on the remote SFTP server for which you want to list its contents.
", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "com.amazonaws.transfer#MaxItems", + "traits": { + "smithy.api#documentation": "An optional parameter where you can specify the maximum number of file/directory names to\n retrieve. The default value is 1,000.
" + } + }, + "OutputDirectoryPath": { + "target": "com.amazonaws.transfer#FilePath", + "traits": { + "smithy.api#documentation": "Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transfer#StartDirectoryListingResponse": { + "type": "structure", + "members": { + "ListingId": { + "target": "com.amazonaws.transfer#ListingId", + "traits": { + "smithy.api#documentation": "Returns a unique identifier for the directory listing call.
", + "smithy.api#required": {} + } + }, + "OutputFileName": { + "target": "com.amazonaws.transfer#OutputFileName", + "traits": { + "smithy.api#documentation": "Returns the file name where the results are stored. This is a combination of the connector ID and the listing ID: <connector-id>-<listing-id>.json.
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
\nFor an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files\n you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both\n cases, you specify the ConnectorId. Depending on the direction of the transfer,\n you also specify the following items:
If you are transferring file from a partner's SFTP server to Amazon Web Services\n storage, you specify one or more RetreiveFilePaths to identify the files\n you want to transfer, and a LocalDirectoryPath to specify the destination\n folder.
If you are transferring file to a partner's SFTP server from Amazon Web Services\n storage, you specify one or more SendFilePaths to identify the files you\n want to transfer, and a RemoteDirectoryPath to specify the destination\n folder.
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
\nFor an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files\n you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both\n cases, you specify the ConnectorId. Depending on the direction of the transfer,\n you also specify the following items:
If you are transferring file from a partner's SFTP server to Amazon Web Services\n storage, you specify one or more RetrieveFilePaths to identify the files\n you want to transfer, and a LocalDirectoryPath to specify the destination\n folder.
If you are transferring file to a partner's SFTP server from Amazon Web Services\n storage, you specify one or more SendFilePaths to identify the files you\n want to transfer, and a RemoteDirectoryPath to specify the destination\n folder.
Retrieves an array of WebACLSummary objects for the web ACLs that you\n manage.
" + "smithy.api#documentation": "Retrieves an array of WebACLSummary objects for the web ACLs that you\n manage.
", + "smithy.test#smokeTests": [ + { + "id": "ListWebACLsSuccess", + "params": { + "Scope": "REGIONAL", + "Limit": 20 + }, + "vendorParams": { + "region": "us-east-1" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] } }, "com.amazonaws.wafv2#ListWebACLsRequest": { diff --git a/codegen/sdk-codegen/aws-models/wellarchitected.2020-03-31.json b/codegen/sdk-codegen/aws-models/wellarchitected.2020-03-31.json index 01c131ec3d7..f381759fc57 100644 --- a/codegen/sdk-codegen/aws-models/wellarchitected.2020-03-31.json +++ b/codegen/sdk-codegen/aws-models/wellarchitected.2020-03-31.json @@ -46,6 +46,99 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.wellarchitected#AccountJiraConfigurationInput": { + "type": "structure", + "members": { + "IssueManagementStatus": { + "target": "com.amazonaws.wellarchitected#AccountJiraIssueManagementStatus", + "traits": { + "smithy.api#documentation": "Account-level: Jira issue management status.
" + } + }, + "IssueManagementType": { + "target": "com.amazonaws.wellarchitected#IssueManagementType", + "traits": { + "smithy.api#documentation": "Account-level: Jira issue management type.
" + } + }, + "JiraProjectKey": { + "target": "com.amazonaws.wellarchitected#JiraProjectKey", + "traits": { + "smithy.api#documentation": "Account-level: Jira project key to sync workloads to.
" + } + }, + "IntegrationStatus": { + "target": "com.amazonaws.wellarchitected#IntegrationStatusInput", + "traits": { + "smithy.api#documentation": "Account-level: Configuration status of the Jira integration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Account-level: Input for the Jira configuration.
" + } + }, + "com.amazonaws.wellarchitected#AccountJiraConfigurationOutput": { + "type": "structure", + "members": { + "IntegrationStatus": { + "target": "com.amazonaws.wellarchitected#IntegrationStatus", + "traits": { + "smithy.api#documentation": "Account-level: Configuration status of the Jira integration.
" + } + }, + "IssueManagementStatus": { + "target": "com.amazonaws.wellarchitected#AccountJiraIssueManagementStatus", + "traits": { + "smithy.api#documentation": "Account-level: Jira issue management status.
" + } + }, + "IssueManagementType": { + "target": "com.amazonaws.wellarchitected#IssueManagementType", + "traits": { + "smithy.api#documentation": "Account-level: Jira issue management type.
" + } + }, + "Subdomain": { + "target": "com.amazonaws.wellarchitected#Subdomain", + "traits": { + "smithy.api#documentation": "Account-level: Jira subdomain URL.
" + } + }, + "JiraProjectKey": { + "target": "com.amazonaws.wellarchitected#JiraProjectKey", + "traits": { + "smithy.api#documentation": "Account-level: Jira project key to sync workloads to.
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.wellarchitected#StatusMessage", + "traits": { + "smithy.api#documentation": "Account-level: Status message on configuration of the Jira integration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Account-level: Output configuration of the Jira integration.
" + } + }, + "com.amazonaws.wellarchitected#AccountJiraIssueManagementStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.wellarchitected#AccountSummary": { "type": "map", "key": { @@ -154,6 +247,12 @@ "traits": { "smithy.api#documentation": "The reason why the question is not applicable to your workload.
" } + }, + "JiraConfiguration": { + "target": "com.amazonaws.wellarchitected#JiraConfiguration", + "traits": { + "smithy.api#documentation": "Configuration of the Jira integration.
" + } } }, "traits": { @@ -245,6 +344,12 @@ "traits": { "smithy.api#documentation": "The type of the question.
" } + }, + "JiraConfiguration": { + "target": "com.amazonaws.wellarchitected#JiraConfiguration", + "traits": { + "smithy.api#documentation": "Configuration of the Jira integration.
" + } } }, "traits": { @@ -1850,6 +1955,12 @@ "traits": { "smithy.api#documentation": "The list of review template ARNs to associate with the workload.
" } + }, + "JiraConfiguration": { + "target": "com.amazonaws.wellarchitected#WorkloadJiraConfigurationInput", + "traits": { + "smithy.api#documentation": "Jira configuration settings when creating a workload.
" + } } }, "traits": { @@ -2981,6 +3092,63 @@ "smithy.api#output": {} } }, + "com.amazonaws.wellarchitected#GetGlobalSettings": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetGlobalSettingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Global settings for all workloads.
", + "smithy.api#http": { + "method": "GET", + "uri": "/global-settings", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetGlobalSettingsOutput": { + "type": "structure", + "members": { + "OrganizationSharingStatus": { + "target": "com.amazonaws.wellarchitected#OrganizationSharingStatus", + "traits": { + "smithy.api#documentation": "Amazon Web Services Organizations sharing status.
" + } + }, + "DiscoveryIntegrationStatus": { + "target": "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus", + "traits": { + "smithy.api#documentation": "Discovery integration status.
" + } + }, + "JiraConfiguration": { + "target": "com.amazonaws.wellarchitected#AccountJiraConfigurationOutput", + "traits": { + "smithy.api#documentation": "Jira configuration status.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wellarchitected#GetLens": { "type": "operation", "input": { @@ -3970,6 +4138,12 @@ "traits": { "smithy.api#documentation": "The improvement plan details.
" } + }, + "JiraConfiguration": { + "target": "com.amazonaws.wellarchitected#JiraConfiguration", + "traits": { + "smithy.api#documentation": "Configuration of the Jira integration.
" + } } }, "traits": { @@ -3979,6 +4153,45 @@ "com.amazonaws.wellarchitected#IncludeSharedResources": { "type": "boolean" }, + "com.amazonaws.wellarchitected#IntegratingService": { + "type": "enum", + "members": { + "JIRA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIRA" + } + } + } + }, + "com.amazonaws.wellarchitected#IntegrationStatus": { + "type": "enum", + "members": { + "CONFIGURED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFIGURED" + } + }, + "NOT_CONFIGURED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CONFIGURED" + } + } + } + }, + "com.amazonaws.wellarchitected#IntegrationStatusInput": { + "type": "enum", + "members": { + "NOT_CONFIGURED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CONFIGURED" + } + } + } + }, "com.amazonaws.wellarchitected#InternalServerException": { "type": "structure", "members": { @@ -4008,6 +4221,73 @@ "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged": { "type": "boolean" }, + "com.amazonaws.wellarchitected#IssueManagementType": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, + "com.amazonaws.wellarchitected#JiraConfiguration": { + "type": "structure", + "members": { + "JiraIssueUrl": { + "target": "com.amazonaws.wellarchitected#JiraIssueUrl", + "traits": { + "smithy.api#documentation": "The URL of the associated Jira issue.
" + } + }, + "LastSyncedTime": { + "target": "com.amazonaws.wellarchitected#Timestamp" + } + }, + "traits": { + "smithy.api#documentation": "Configuration of the Jira integration.
" + } + }, + "com.amazonaws.wellarchitected#JiraIssueUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.wellarchitected#JiraProjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[A-Z][A-Z0-9_]*$" + } + }, + "com.amazonaws.wellarchitected#JiraSelectedQuestionConfiguration": { + "type": "structure", + "members": { + "SelectedPillars": { + "target": "com.amazonaws.wellarchitected#SelectedPillars", + "traits": { + "smithy.api#documentation": "Selected pillars in the workload.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Selected questions in the workload.
" + } + }, "com.amazonaws.wellarchitected#Lens": { "type": "structure", "members": { @@ -4177,6 +4457,12 @@ "PillarReviewSummaries": { "target": "com.amazonaws.wellarchitected#PillarReviewSummaries" }, + "JiraConfiguration": { + "target": "com.amazonaws.wellarchitected#JiraSelectedQuestionConfiguration", + "traits": { + "smithy.api#documentation": "Jira configuration status of the Lens review.
" + } + }, "UpdatedAt": { "target": "com.amazonaws.wellarchitected#Timestamp" }, @@ -4880,7 +5166,7 @@ } ], "traits": { - "smithy.api#documentation": "List lens review improvements.
", + "smithy.api#documentation": "List the improvements of a particular lens review.
", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements", @@ -6801,8 +7087,7 @@ "smithy.api#length": { "min": 3, "max": 100 - }, - "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + } } }, "com.amazonaws.wellarchitected#ProfileName": { @@ -6811,8 +7096,7 @@ "smithy.api#length": { "min": 3, "max": 100 - }, - "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + } } }, "com.amazonaws.wellarchitected#ProfileNamePrefix": { @@ -6821,8 +7105,7 @@ "smithy.api#length": { "min": 0, "max": 100 - }, - "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + } } }, "com.amazonaws.wellarchitected#ProfileNotificationSummaries": { @@ -7805,12 +8088,44 @@ "smithy.api#documentation": "List of selected choice IDs in a question answer.
\nThe values entered replace the previously selected choices.
" } }, + "com.amazonaws.wellarchitected#SelectedPillar": { + "type": "structure", + "members": { + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "SelectedQuestionIds": { + "target": "com.amazonaws.wellarchitected#SelectedQuestionIds", + "traits": { + "smithy.api#documentation": "Selected question IDs in the selected pillar.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The selected pillar.
" + } + }, + "com.amazonaws.wellarchitected#SelectedPillars": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#SelectedPillar" + } + }, "com.amazonaws.wellarchitected#SelectedProfileChoiceIds": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ChoiceId" } }, + "com.amazonaws.wellarchitected#SelectedQuestionId": { + "type": "string" + }, + "com.amazonaws.wellarchitected#SelectedQuestionIds": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#SelectedQuestionId" + } + }, "com.amazonaws.wellarchitected#ServiceCode": { "type": "string", "traits": { @@ -8118,6 +8433,15 @@ } } }, + "com.amazonaws.wellarchitected#Subdomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.wellarchitected#TagKey": { "type": "string", "traits": { @@ -8533,7 +8857,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
", + "smithy.api#documentation": "Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
", "smithy.api#http": { "method": "PATCH", "uri": "/global-settings", @@ -8555,6 +8879,80 @@ "traits": { "smithy.api#documentation": "The status of discovery support settings.
" } + }, + "JiraConfiguration": { + "target": "com.amazonaws.wellarchitected#AccountJiraConfigurationInput", + "traits": { + "smithy.api#documentation": "The status of Jira integration settings.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#UpdateIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateIntegrationInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update integration features.
", + "smithy.api#http": { + "method": "POST", + "uri": "/workloads/{WorkloadId}/updateIntegration", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#UpdateIntegrationInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "IntegratingService": { + "target": "com.amazonaws.wellarchitected#IntegratingService", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Which integrated service to update.
", + "smithy.api#required": {} + } } }, "traits": { @@ -8620,6 +9018,12 @@ }, "PillarNotes": { "target": "com.amazonaws.wellarchitected#PillarNotes" + }, + "JiraConfiguration": { + "target": "com.amazonaws.wellarchitected#JiraSelectedQuestionConfiguration", + "traits": { + "smithy.api#documentation": "Configuration of the Jira integration.
" + } } }, "traits": { @@ -9190,6 +9594,12 @@ "traits": { "smithy.api#documentation": "List of AppRegistry application ARNs to associate to the workload.
" } + }, + "JiraConfiguration": { + "target": "com.amazonaws.wellarchitected#WorkloadJiraConfigurationInput", + "traits": { + "smithy.api#documentation": "Configuration of the Jira integration.
" + } } }, "traits": { @@ -9312,6 +9722,9 @@ { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, @@ -9381,6 +9794,9 @@ { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, @@ -9680,6 +10096,9 @@ { "target": "com.amazonaws.wellarchitected#GetConsolidatedReport" }, + { + "target": "com.amazonaws.wellarchitected#GetGlobalSettings" + }, { "target": "com.amazonaws.wellarchitected#GetLens" }, @@ -9785,6 +10204,9 @@ { "target": "com.amazonaws.wellarchitected#UpdateGlobalSettings" }, + { + "target": "com.amazonaws.wellarchitected#UpdateIntegration" + }, { "target": "com.amazonaws.wellarchitected#UpdateLensReview" }, @@ -10785,6 +11207,12 @@ }, "PrioritizedRiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "JiraConfiguration": { + "target": "com.amazonaws.wellarchitected#WorkloadJiraConfigurationOutput", + "traits": { + "smithy.api#documentation": "Jira configuration for a specific workload.
" + } } }, "traits": { @@ -10965,6 +11393,87 @@ } } }, + "com.amazonaws.wellarchitected#WorkloadIssueManagementStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "INHERIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INHERIT" + } + } + } + }, + "com.amazonaws.wellarchitected#WorkloadJiraConfigurationInput": { + "type": "structure", + "members": { + "IssueManagementStatus": { + "target": "com.amazonaws.wellarchitected#WorkloadIssueManagementStatus", + "traits": { + "smithy.api#documentation": "Workload-level: Jira issue management status.
" + } + }, + "IssueManagementType": { + "target": "com.amazonaws.wellarchitected#IssueManagementType", + "traits": { + "smithy.api#documentation": "Workload-level: Jira issue management type.
" + } + }, + "JiraProjectKey": { + "target": "com.amazonaws.wellarchitected#JiraProjectKey", + "traits": { + "smithy.api#documentation": "Workload-level: Jira project key to sync workloads to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Workload-level: Input for the Jira configuration.
" + } + }, + "com.amazonaws.wellarchitected#WorkloadJiraConfigurationOutput": { + "type": "structure", + "members": { + "IssueManagementStatus": { + "target": "com.amazonaws.wellarchitected#WorkloadIssueManagementStatus", + "traits": { + "smithy.api#documentation": "Workload-level: Jira issue management status.
" + } + }, + "IssueManagementType": { + "target": "com.amazonaws.wellarchitected#IssueManagementType", + "traits": { + "smithy.api#documentation": "Workload-level: Jira issue management type.
" + } + }, + "JiraProjectKey": { + "target": "com.amazonaws.wellarchitected#JiraProjectKey", + "traits": { + "smithy.api#documentation": "Workload-level: Jira project key to sync workloads to.
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.wellarchitected#StatusMessage", + "traits": { + "smithy.api#documentation": "Workload-level: Status message on configuration of the Jira integration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Workload-level: Output configuration of the Jira integration.
" + } + }, "com.amazonaws.wellarchitected#WorkloadLenses": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/workspaces-thin-client.2023-08-22.json b/codegen/sdk-codegen/aws-models/workspaces-thin-client.2023-08-22.json index 860bb555274..5b1c36302b9 100644 --- a/codegen/sdk-codegen/aws-models/workspaces-thin-client.2023-08-22.json +++ b/codegen/sdk-codegen/aws-models/workspaces-thin-client.2023-08-22.json @@ -655,7 +655,7 @@ } }, "tags": { - "target": "com.amazonaws.workspacesthinclient#EmbeddedTag", + "target": "com.amazonaws.workspacesthinclient#TagsMap", "traits": { "smithy.api#documentation": "The tag keys and optional values for the resource.
" } @@ -828,39 +828,12 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the device.
" } - }, - "tags": { - "target": "com.amazonaws.workspacesthinclient#EmbeddedTag", - "traits": { - "smithy.api#documentation": "The tag keys and optional values for the resource.
" - } } }, "traits": { "smithy.api#documentation": "Describes a thin client device.
" } }, - "com.amazonaws.workspacesthinclient#EmbeddedTag": { - "type": "structure", - "members": { - "resourceArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a resource to tag.
" - } - }, - "internalId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The internal ID of a resource to tag.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The resource and internal ID of a resource to tag.
", - "smithy.api#sensitive": {} - } - }, "com.amazonaws.workspacesthinclient#Environment": { "type": "structure", "members": { @@ -973,7 +946,7 @@ } }, "tags": { - "target": "com.amazonaws.workspacesthinclient#EmbeddedTag", + "target": "com.amazonaws.workspacesthinclient#TagsMap", "traits": { "smithy.api#documentation": "The tag keys and optional values for the resource.
" } @@ -1111,12 +1084,6 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the environment.
" } - }, - "tags": { - "target": "com.amazonaws.workspacesthinclient#EmbeddedTag", - "traits": { - "smithy.api#documentation": "The tag keys and optional values for the resource.
" - } } }, "traits": { @@ -1363,26 +1330,6 @@ "smithy.api#httpError": 500 } }, - "com.amazonaws.workspacesthinclient#InternalServiceException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspacesthinclient#ExceptionMessage" - }, - "retryAfterSeconds": { - "target": "com.amazonaws.workspacesthinclient#RetryAfterSeconds", - "traits": { - "smithy.api#documentation": "The number of seconds to wait before retrying the next request.
", - "smithy.api#httpHeader": "Retry-After" - } - } - }, - "traits": { - "smithy.api#documentation": "Request processing failed due to some unknown error, exception, or failure.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, "com.amazonaws.workspacesthinclient#KmsKeyArn": { "type": "string", "traits": { @@ -1652,11 +1599,17 @@ }, "errors": [ { - "target": "com.amazonaws.workspacesthinclient#InternalServiceException" + "target": "com.amazonaws.workspacesthinclient#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesthinclient#InternalServerException" }, { "target": "com.amazonaws.workspacesthinclient#ResourceNotFoundException" }, + { + "target": "com.amazonaws.workspacesthinclient#ThrottlingException" + }, { "target": "com.amazonaws.workspacesthinclient#ValidationException" } @@ -1945,6 +1898,12 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the software set.
" } + }, + "tags": { + "target": "com.amazonaws.workspacesthinclient#TagsMap", + "traits": { + "smithy.api#documentation": "The tag keys and optional values for the resource.
" + } } }, "traits": { @@ -2106,11 +2065,20 @@ }, "errors": [ { - "target": "com.amazonaws.workspacesthinclient#InternalServiceException" + "target": "com.amazonaws.workspacesthinclient#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesthinclient#ConflictException" + }, + { + "target": "com.amazonaws.workspacesthinclient#InternalServerException" }, { "target": "com.amazonaws.workspacesthinclient#ResourceNotFoundException" }, + { + "target": "com.amazonaws.workspacesthinclient#ThrottlingException" + }, { "target": "com.amazonaws.workspacesthinclient#ValidationException" } @@ -2962,11 +2930,20 @@ }, "errors": [ { - "target": "com.amazonaws.workspacesthinclient#InternalServiceException" + "target": "com.amazonaws.workspacesthinclient#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesthinclient#ConflictException" + }, + { + "target": "com.amazonaws.workspacesthinclient#InternalServerException" }, { "target": "com.amazonaws.workspacesthinclient#ResourceNotFoundException" }, + { + "target": "com.amazonaws.workspacesthinclient#ThrottlingException" + }, { "target": "com.amazonaws.workspacesthinclient#ValidationException" } diff --git a/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json b/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json index 74b4d588336..06482832e7a 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json +++ b/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json @@ -35,6 +35,70 @@ "smithy.api#pattern": "^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$" } }, + "com.amazonaws.workspaces#AcceptAccountLinkInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#AcceptAccountLinkInvitationRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#AcceptAccountLinkInvitationResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#ConflictException" + }, + { + "target": "com.amazonaws.workspaces#InternalServerException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Accepts the account link invitation.
\nThere's currently no unlinking capability after you accept the account linking invitation.
\nThe identifier of the account link.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.workspaces#ClientToken", + "traits": { + "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#AcceptAccountLinkInvitationResult": { + "type": "structure", + "members": { + "AccountLink": { + "target": "com.amazonaws.workspaces#AccountLink", + "traits": { + "smithy.api#documentation": "Information about the account link.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#AccessDeniedException": { "type": "structure", "members": { @@ -64,6 +128,79 @@ } } }, + "com.amazonaws.workspaces#AccountLink": { + "type": "structure", + "members": { + "AccountLinkId": { + "target": "com.amazonaws.workspaces#LinkId", + "traits": { + "smithy.api#documentation": "The identifier of the account link.
" + } + }, + "AccountLinkStatus": { + "target": "com.amazonaws.workspaces#AccountLinkStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the account link.
" + } + }, + "SourceAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "The identifier of the source account.
" + } + }, + "TargetAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "The identifier of the target account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about about the account link.
" + } + }, + "com.amazonaws.workspaces#AccountLinkList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#AccountLink" + } + }, + "com.amazonaws.workspaces#AccountLinkStatusEnum": { + "type": "enum", + "members": { + "LINKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINKED" + } + }, + "LINKING_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINKING_FAILED" + } + }, + "LINK_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINK_NOT_FOUND" + } + }, + "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + } + } + }, "com.amazonaws.workspaces#AccountModification": { "type": "structure", "members": { @@ -987,6 +1124,12 @@ "smithy.api#documentation": "Information about the Amazon WorkSpaces client.
" } }, + "com.amazonaws.workspaces#ClientToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "^.{1,64}$" + } + }, "com.amazonaws.workspaces#ClientUrl": { "type": "string", "traits": { @@ -1087,6 +1230,18 @@ "com.amazonaws.workspaces#ComputerName": { "type": "string" }, + "com.amazonaws.workspaces#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "The TargetAccountId is already linked or invited.
Creates the account link invitation.
" + } + }, + "com.amazonaws.workspaces#CreateAccountLinkInvitationRequest": { + "type": "structure", + "members": { + "TargetAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "The identifier of the target account.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.workspaces#ClientToken", + "traits": { + "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#CreateAccountLinkInvitationResult": { + "type": "structure", + "members": { + "AccountLink": { + "target": "com.amazonaws.workspaces#AccountLink", + "traits": { + "smithy.api#documentation": "Information about the account link.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#CreateConnectClientAddIn": { "type": "operation", "input": { @@ -2164,6 +2380,23 @@ "smithy.api#documentation": "Describes the data replication settings.
" } }, + "com.amazonaws.workspaces#DedicatedTenancyAccountType": { + "type": "enum", + "members": { + "SOURCE_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_ACCOUNT" + } + }, + "TARGET_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TARGET_ACCOUNT" + } + } + } + }, "com.amazonaws.workspaces#DedicatedTenancyCidrRangeList": { "type": "list", "member": { @@ -2399,6 +2632,70 @@ } } }, + "com.amazonaws.workspaces#DeleteAccountLinkInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeleteAccountLinkInvitationRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeleteAccountLinkInvitationResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#ConflictException" + }, + { + "target": "com.amazonaws.workspaces#InternalServerException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the account link invitation.
" + } + }, + "com.amazonaws.workspaces#DeleteAccountLinkInvitationRequest": { + "type": "structure", + "members": { + "LinkId": { + "target": "com.amazonaws.workspaces#LinkId", + "traits": { + "smithy.api#documentation": "The identifier of the account link.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.workspaces#ClientToken", + "traits": { + "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DeleteAccountLinkInvitationResult": { + "type": "structure", + "members": { + "AccountLink": { + "target": "com.amazonaws.workspaces#AccountLink", + "traits": { + "smithy.api#documentation": "Information about the account link.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#DeleteClientBranding": { "type": "operation", "input": { @@ -2953,6 +3250,12 @@ "traits": { "smithy.api#documentation": "The IP address range, specified as an IPv4 CIDR block, used for the management network\n interface.
\nThe management network interface is connected to a secure Amazon WorkSpaces management\n network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces\n clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
" } + }, + "DedicatedTenancyAccountType": { + "target": "com.amazonaws.workspaces#DedicatedTenancyAccountType", + "traits": { + "smithy.api#documentation": "The type of linked account.
" + } } }, "traits": { @@ -4665,6 +4968,66 @@ "smithy.api#documentation": "Describes a WorkSpace that could not be rebooted. (RebootWorkspaces),\n rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).
" } }, + "com.amazonaws.workspaces#GetAccountLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#GetAccountLinkRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#GetAccountLinkResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InternalServerException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves account link information.
" + } + }, + "com.amazonaws.workspaces#GetAccountLinkRequest": { + "type": "structure", + "members": { + "LinkId": { + "target": "com.amazonaws.workspaces#LinkId", + "traits": { + "smithy.api#documentation": "The identifier of the account to link.
" + } + }, + "LinkedAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "The identifier of the account link
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#GetAccountLinkResult": { + "type": "structure", + "members": { + "AccountLink": { + "target": "com.amazonaws.workspaces#AccountLink", + "traits": { + "smithy.api#documentation": "The account link of the account link to retrieve.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#ImageAssociatedResourceType": { "type": "enum", "members": { @@ -4998,6 +5361,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.workspaces#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "Unexpected server error occured.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.workspaces#InvalidParameterValuesException": { "type": "structure", "members": { @@ -5220,6 +5595,93 @@ } } }, + "com.amazonaws.workspaces#LinkId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^link-.{8,24}$" + } + }, + "com.amazonaws.workspaces#LinkStatusFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#AccountLinkStatusEnum" + } + }, + "com.amazonaws.workspaces#ListAccountLinks": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ListAccountLinksRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ListAccountLinksResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InternalServerException" + }, + { + "target": "com.amazonaws.workspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all account links.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AccountLinks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.workspaces#ListAccountLinksRequest": { + "type": "structure", + "members": { + "LinkStatusFilter": { + "target": "com.amazonaws.workspaces#LinkStatusFilterList", + "traits": { + "smithy.api#documentation": "Filters the account based on their link status.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "The maximum number of accounts to return.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#ListAccountLinksResult": { + "type": "structure", + "members": { + "AccountLinks": { + "target": "com.amazonaws.workspaces#AccountLinkList", + "traits": { + "smithy.api#documentation": "Information about the account links.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#ListAvailableManagementCidrRanges": { "type": "operation", "input": { @@ -6476,6 +6938,70 @@ } } }, + "com.amazonaws.workspaces#RejectAccountLinkInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#RejectAccountLinkInvitationRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#RejectAccountLinkInvitationResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#ConflictException" + }, + { + "target": "com.amazonaws.workspaces#InternalServerException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Rejects the account link invitation.
" + } + }, + "com.amazonaws.workspaces#RejectAccountLinkInvitationRequest": { + "type": "structure", + "members": { + "LinkId": { + "target": "com.amazonaws.workspaces#LinkId", + "traits": { + "smithy.api#documentation": "The identifier of the account link
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.workspaces#ClientToken", + "traits": { + "smithy.api#documentation": "The client token of the account link invitation to reject.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#RejectAccountLinkInvitationResult": { + "type": "structure", + "members": { + "AccountLink": { + "target": "com.amazonaws.workspaces#AccountLink", + "traits": { + "smithy.api#documentation": "Information about the account link.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#RelatedWorkspaceProperties": { "type": "structure", "members": { @@ -7713,6 +8239,18 @@ "com.amazonaws.workspaces#UserVolumeSizeGib": { "type": "integer" }, + "com.amazonaws.workspaces#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "You either haven't provided a TargetAccountId or \n are using the same value for TargetAccountId and SourceAccountId.