The endpoint type.
", + "documentation":"The endpoint type (such as iot:Data, iot:CredentialProvider and iot:Jobs).
Thing indexing configuration.
" + }, + "thingGroupIndexingConfiguration":{ + "shape":"ThingGroupIndexingConfiguration", + "documentation":"The index configuration.
" } } }, @@ -8815,7 +8819,6 @@ }, "QueryString":{ "type":"string", - "max":1000, "min":1 }, "QueryVersion":{"type":"string"}, @@ -9427,6 +9430,10 @@ "things":{ "shape":"ThingDocumentList", "documentation":"The things that match the search query.
" + }, + "thingGroups":{ + "shape":"ThingGroupDocumentList", + "documentation":"The thing groups that match the search query.
" } } }, @@ -10127,12 +10134,60 @@ "max":2028, "pattern":"[\\p{Graph}\\x20]*" }, + "ThingGroupDocument":{ + "type":"structure", + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"The thing group name.
" + }, + "thingGroupId":{ + "shape":"ThingGroupId", + "documentation":"The thing group ID.
" + }, + "thingGroupDescription":{ + "shape":"ThingGroupDescription", + "documentation":"The thing group description.
" + }, + "attributes":{ + "shape":"Attributes", + "documentation":"The thing group attributes.
" + }, + "parentGroupNames":{ + "shape":"ThingGroupNameList", + "documentation":"Parent group names.
" + } + }, + "documentation":"The thing group search index document.
" + }, + "ThingGroupDocumentList":{ + "type":"list", + "member":{"shape":"ThingGroupDocument"} + }, "ThingGroupId":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9\\-]+" }, + "ThingGroupIndexingConfiguration":{ + "type":"structure", + "required":["thingGroupIndexingMode"], + "members":{ + "thingGroupIndexingMode":{ + "shape":"ThingGroupIndexingMode", + "documentation":"Thing group indexing mode.
" + } + }, + "documentation":"Thing group indexing configuration.
" + }, + "ThingGroupIndexingMode":{ + "type":"string", + "enum":[ + "OFF", + "ON" + ] + }, "ThingGroupList":{ "type":"list", "member":{"shape":"ThingGroupName"} @@ -10186,6 +10241,7 @@ "ThingId":{"type":"string"}, "ThingIndexingConfiguration":{ "type":"structure", + "required":["thingIndexingMode"], "members":{ "thingIndexingMode":{ "shape":"ThingIndexingMode", @@ -10660,6 +10716,10 @@ "thingIndexingConfiguration":{ "shape":"ThingIndexingConfiguration", "documentation":"Thing indexing configuration.
" + }, + "thingGroupIndexingConfiguration":{ + "shape":"ThingGroupIndexingConfiguration", + "documentation":"Thing group indexing configuration.
" } } }, diff --git a/botocore/data/iotanalytics/2017-11-27/service-2.json b/botocore/data/iotanalytics/2017-11-27/service-2.json index a047fd12c1..1587d51875 100644 --- a/botocore/data/iotanalytics/2017-11-27/service-2.json +++ b/botocore/data/iotanalytics/2017-11-27/service-2.json @@ -82,7 +82,7 @@ {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"} ], - "documentation":"Creates a data set. A data set stores data retrieved from a data store by applying an SQL action.
This operation creates the skeleton of a data set. To populate the data set, call \"CreateDatasetContent\".
Creates a data set. A data set stores data retrieved from a data store by applying a \"queryAction\" (a SQL query) or a \"containerAction\" (executing a containerized application). This operation creates the skeleton of a data set. The data set can be populated manually by calling \"CreateDatasetContent\" or automatically according to a \"trigger\" you specify.
" }, "CreateDatasetContent":{ "name":"CreateDatasetContent", @@ -91,6 +91,7 @@ "requestUri":"/datasets/{datasetName}/content" }, "input":{"shape":"CreateDatasetContentRequest"}, + "output":{"shape":"CreateDatasetContentResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, @@ -98,7 +99,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ThrottlingException"} ], - "documentation":"Creates the content of a data set by applying an SQL action.
" + "documentation":"Creates the content of a data set by applying a SQL action.
" }, "CreateDatastore":{ "name":"CreateDatastore", @@ -805,6 +806,40 @@ }, "documentation":"A summary of information about a channel.
" }, + "ComputeType":{ + "type":"string", + "enum":[ + "ACU_1", + "ACU_2" + ] + }, + "ContainerDatasetAction":{ + "type":"structure", + "required":[ + "image", + "executionRoleArn", + "resourceConfiguration" + ], + "members":{ + "image":{ + "shape":"Image", + "documentation":"The ARN of the Docker container stored in your account. The Docker container contains an application and needed support libraries and is used to generate data set contents.
" + }, + "executionRoleArn":{ + "shape":"RoleArn", + "documentation":"The ARN of the role which gives permission to the system to access needed resources in order to run the \"containerAction\". This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application.
" + }, + "resourceConfiguration":{ + "shape":"ResourceConfiguration", + "documentation":"Configuration of the resource which executes the \"containerAction\".
" + }, + "variables":{ + "shape":"Variables", + "documentation":"The values of variables used within the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of \"stringValue\", \"datasetContentVersionValue\", or \"outputFileUriValue\".
" + } + }, + "documentation":"Information needed to run the \"containerAction\" to produce data set contents.
" + }, "CreateChannelRequest":{ "type":"structure", "required":["channelName"], @@ -852,6 +887,15 @@ } } }, + "CreateDatasetContentResponse":{ + "type":"structure", + "members":{ + "versionId":{ + "shape":"DatasetContentVersion", + "documentation":"The version ID of the data set contents which are being created.
" + } + } + }, "CreateDatasetRequest":{ "type":"structure", "required":[ @@ -865,11 +909,15 @@ }, "actions":{ "shape":"DatasetActions", - "documentation":"A list of actions that create the data set. Only one action is supported at this time.
" + "documentation":"A list of actions that create the data set contents.
" }, "triggers":{ "shape":"DatasetTriggers", - "documentation":"A list of triggers. A trigger causes data set content to be populated at a specified time or time interval. The list of triggers can be empty or contain up to five DataSetTrigger objects.
" + "documentation":"A list of triggers. A trigger causes data set contents to be populated at a specified time interval or when another data set's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.
" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"[Optional] How long, in days, message data is kept for the data set. If not given or set to null, the latest version of the dataset content plus the latest succeeded version (if they are different) are retained for at most 90 days.
" }, "tags":{ "shape":"TagList", @@ -887,6 +935,10 @@ "datasetArn":{ "shape":"DatasetArn", "documentation":"The ARN of the data set.
" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"How long, in days, message data is kept for the data set.
" } } }, @@ -972,7 +1024,7 @@ }, "actions":{ "shape":"DatasetActions", - "documentation":"The \"DatasetAction\" objects that create the data set.
" + "documentation":"The \"DatasetAction\" objects that automatically create the data set contents.
" }, "triggers":{ "shape":"DatasetTriggers", @@ -989,6 +1041,10 @@ "lastUpdateTime":{ "shape":"Timestamp", "documentation":"The last time the data set was updated.
" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"[Optional] How long, in days, message data is kept for the data set.
" } }, "documentation":"Information about a data set.
" @@ -998,11 +1054,15 @@ "members":{ "actionName":{ "shape":"DatasetActionName", - "documentation":"The name of the data set action.
" + "documentation":"The name of the data set action by which data set contents are automatically created.
" }, "queryAction":{ "shape":"SqlQueryDatasetAction", "documentation":"An \"SqlQueryDatasetAction\" object that contains the SQL query to modify the message.
" + }, + "containerAction":{ + "shape":"ContainerDatasetAction", + "documentation":"Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries.
" } }, "documentation":"A \"DatasetAction\" object specifying the query that creates the data set content.
" @@ -1013,6 +1073,33 @@ "min":1, "pattern":"^[a-zA-Z0-9_]+$" }, + "DatasetActionSummaries":{ + "type":"list", + "member":{"shape":"DatasetActionSummary"}, + "max":1, + "min":1 + }, + "DatasetActionSummary":{ + "type":"structure", + "members":{ + "actionName":{ + "shape":"DatasetActionName", + "documentation":"The name of the action which automatically creates the data set's contents.
" + }, + "actionType":{ + "shape":"DatasetActionType", + "documentation":"The type of action by which the data set's contents are automatically created.
" + } + }, + "documentation":"" + }, + "DatasetActionType":{ + "type":"string", + "enum":[ + "QUERY", + "CONTAINER" + ] + }, "DatasetActions":{ "type":"list", "member":{"shape":"DatasetAction"}, @@ -1033,16 +1120,31 @@ "members":{ "state":{ "shape":"DatasetContentState", - "documentation":"The state of the data set. Can be one of \"CREATING\", \"SUCCEEDED\" or \"FAILED\".
" + "documentation":"The state of the data set contents. Can be one of \"READY\", \"CREATING\", \"SUCCEEDED\" or \"FAILED\".
" }, "reason":{ "shape":"Reason", - "documentation":"The reason the data set is in this state.
" + "documentation":"The reason the data set contents are in this state.
" + } + }, + "documentation":"The state of the data set contents and the reason they are in this state.
" + }, + "DatasetContentVersion":{ + "type":"string", + "max":36, + "min":7 + }, + "DatasetContentVersionValue":{ + "type":"structure", + "required":["datasetName"], + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"The name of the data set whose latest contents will be used as input to the notebook or application.
" } }, - "documentation":"The state of the data set and the reason it is in this state.
" + "documentation":"The data set whose latest contents will be used as input to the notebook or application.
" }, - "DatasetContentVersion":{"type":"string"}, "DatasetEntries":{ "type":"list", "member":{"shape":"DatasetEntry"} @@ -1097,6 +1199,14 @@ "lastUpdateTime":{ "shape":"Timestamp", "documentation":"The last time the data set was updated.
" + }, + "triggers":{ + "shape":"DatasetTriggers", + "documentation":"A list of triggers. A trigger causes data set content to be populated at a specified time interval or when another data set is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects
" + }, + "actions":{ + "shape":"DatasetActionSummaries", + "documentation":"A list of \"DataActionSummary\" objects.
" } }, "documentation":"A summary of information about a data set.
" @@ -1107,6 +1217,10 @@ "schedule":{ "shape":"Schedule", "documentation":"The \"Schedule\" when the trigger is initiated.
" + }, + "dataset":{ + "shape":"TriggeringDataset", + "documentation":"The data set whose content creation will trigger the creation of this data set's contents.
" } }, "documentation":"The \"DatasetTrigger\" that specifies when the data set is automatically updated.
" @@ -1180,7 +1294,7 @@ "documentation":"The estimated size of the data store.
" } }, - "documentation":"Statistics information about the data store.
" + "documentation":"Statistical information about the data store.
" }, "DatastoreStatus":{ "type":"string", @@ -1282,6 +1396,24 @@ } } }, + "DeltaTime":{ + "type":"structure", + "required":[ + "offsetSeconds", + "timeExpression" + ], + "members":{ + "offsetSeconds":{ + "shape":"OffsetSeconds", + "documentation":"The number of seconds of estimated \"in flight\" lag time of message data.
" + }, + "timeExpression":{ + "shape":"TimeExpression", + "documentation":"An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated.
" + } + }, + "documentation":"When you create data set contents using message data from a specified time frame, some message data may still be \"in flight\" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the \"in flight\" time of your message data, so that data not processed from the previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.
" + }, "DescribeChannelRequest":{ "type":"structure", "required":["channelName"], @@ -1294,7 +1426,7 @@ }, "includeStatistics":{ "shape":"IncludeStatisticsFlag", - "documentation":"If true, include statistics about the channel in the response.
", + "documentation":"If true, additional statistical information about the channel is included in the response.
", "location":"querystring", "locationName":"includeStatistics" } @@ -1346,7 +1478,7 @@ }, "includeStatistics":{ "shape":"IncludeStatisticsFlag", - "documentation":"If true, include statistics about the data store in the response.
", + "documentation":"If true, additional statistical information about the datastore is included in the response.
", "location":"querystring", "locationName":"includeStatistics" } @@ -1361,7 +1493,7 @@ }, "statistics":{ "shape":"DatastoreStatistics", - "documentation":"Statistics about the data store. Included if the 'includeStatistics' parameter is set to true in the request.
" + "documentation":"Additional statistical information about the data store. Included if the 'includeStatistics' parameter is set to true in the request.
" } } }, @@ -1464,6 +1596,7 @@ }, "documentation":"An activity that adds information from the AWS IoT Device Shadows service to a message.
" }, + "DoubleValue":{"type":"double"}, "EndTime":{"type":"timestamp"}, "EntryName":{"type":"string"}, "ErrorCode":{"type":"string"}, @@ -1495,7 +1628,7 @@ }, "filter":{ "shape":"FilterExpression", - "documentation":"An expression that looks like an SQL WHERE clause that must return a Boolean value.
" + "documentation":"An expression that looks like a SQL WHERE clause that must return a Boolean value.
" }, "next":{ "shape":"ActivityName", @@ -1544,6 +1677,10 @@ } } }, + "Image":{ + "type":"string", + "max":255 + }, "IncludeStatisticsFlag":{"type":"boolean"}, "InternalFailureException":{ "type":"structure", @@ -1853,6 +1990,22 @@ "member":{"shape":"Message"} }, "NextToken":{"type":"string"}, + "OffsetSeconds":{"type":"integer"}, + "OutputFileName":{ + "type":"string", + "pattern":"[\\w\\.-]{1,255}" + }, + "OutputFileUriValue":{ + "type":"structure", + "required":["fileName"], + "members":{ + "fileName":{ + "shape":"OutputFileName", + "documentation":"The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.
" + } + }, + "documentation":"The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.
" + }, "Pipeline":{ "type":"structure", "members":{ @@ -1979,6 +2132,22 @@ } } }, + "QueryFilter":{ + "type":"structure", + "members":{ + "deltaTime":{ + "shape":"DeltaTime", + "documentation":"Used to limit data to that which has arrived since the last execution of the action. When you create data set contents using message data from a specified time frame, some message data may still be \"in flight\" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the \"in flight\" time of you message data, so that data not processed from a previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.
" + } + }, + "documentation":"Information which is used to filter message data, to segregate it according to the time frame in which it arrives.
" + }, + "QueryFilters":{ + "type":"list", + "member":{"shape":"QueryFilter"}, + "max":1, + "min":0 + }, "Reason":{"type":"string"}, "RemoveAttributesActivity":{ "type":"structure", @@ -2056,6 +2225,24 @@ "max":2048, "min":20 }, + "ResourceConfiguration":{ + "type":"structure", + "required":[ + "computeType", + "volumeSizeInGB" + ], + "members":{ + "computeType":{ + "shape":"ComputeType", + "documentation":"The type of the compute resource used to execute the \"containerAction\". Possible values are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).
" + }, + "volumeSizeInGB":{ + "shape":"VolumeSizeInGB", + "documentation":"The size (in GB) of the persistent storage available to the resource instance used to execute the \"containerAction\" (min: 1, max: 50).
" + } + }, + "documentation":"The configuration of the resource used to execute the \"containerAction\".
" + }, "ResourceNotFoundException":{ "type":"structure", "members":{ @@ -2208,7 +2395,11 @@ "members":{ "sqlQuery":{ "shape":"SqlQuery", - "documentation":"An SQL query string.
" + "documentation":"A SQL query string.
" + }, + "filters":{ + "shape":"QueryFilters", + "documentation":"Pre-filters applied to message data.
" } }, "documentation":"The SQL query to modify the message.
" @@ -2243,6 +2434,11 @@ } }, "StartTime":{"type":"timestamp"}, + "StringValue":{ + "type":"string", + "max":1024, + "min":0 + }, "Tag":{ "type":"structure", "required":[ @@ -2316,7 +2512,19 @@ "error":{"httpStatusCode":429}, "exception":true }, + "TimeExpression":{"type":"string"}, "Timestamp":{"type":"timestamp"}, + "TriggeringDataset":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"DatasetName", + "documentation":"The name of the data set whose content generation will trigger the new data set content generation.
" + } + }, + "documentation":"Information about the data set whose content generation will trigger the new data set content generation.
" + }, "UnlimitedRetentionPeriod":{"type":"boolean"}, "UntagResourceRequest":{ "type":"structure", @@ -2375,11 +2583,15 @@ }, "actions":{ "shape":"DatasetActions", - "documentation":"A list of \"DatasetAction\" objects. Only one action is supported at this time.
" + "documentation":"A list of \"DatasetAction\" objects.
" }, "triggers":{ "shape":"DatasetTriggers", "documentation":"A list of \"DatasetTrigger\" objects. The list can be empty or can contain up to five DataSetTrigger objects.
" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"How long, in days, message data is kept for the data set.
" } } }, @@ -2418,6 +2630,50 @@ } } }, + "Variable":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"VariableName", + "documentation":"The name of the variable.
" + }, + "stringValue":{ + "shape":"StringValue", + "documentation":"The value of the variable as a string.
" + }, + "doubleValue":{ + "shape":"DoubleValue", + "documentation":"The value of the variable as a double (numeric).
", + "box":true + }, + "datasetContentVersionValue":{ + "shape":"DatasetContentVersionValue", + "documentation":"The value of the variable as a structure that specifies a data set content version.
" + }, + "outputFileUriValue":{ + "shape":"OutputFileUriValue", + "documentation":"The value of the variable as a structure that specifies an output file URI.
" + } + }, + "documentation":"An instance of a variable to be passed to the \"containerAction\" execution. Each variable must have a name and a value given by one of \"stringValue\", \"datasetContentVersionValue\", or \"outputFileUriValue\".
" + }, + "VariableName":{ + "type":"string", + "max":256, + "min":1 + }, + "Variables":{ + "type":"list", + "member":{"shape":"Variable"}, + "max":50, + "min":0 + }, + "VolumeSizeInGB":{ + "type":"integer", + "max":50, + "min":1 + }, "errorMessage":{"type":"string"}, "resourceArn":{"type":"string"}, "resourceId":{"type":"string"} diff --git a/botocore/data/lex-models/2017-04-19/service-2.json b/botocore/data/lex-models/2017-04-19/service-2.json index 21e445c4ec..63d4a0872f 100644 --- a/botocore/data/lex-models/2017-04-19/service-2.json +++ b/botocore/data/lex-models/2017-04-19/service-2.json @@ -3178,6 +3178,7 @@ "enum":[ "BUILDING", "READY", + "READY_BASIC_TESTING", "FAILED", "NOT_BUILT" ] diff --git a/botocore/data/medialive/2017-10-14/paginators-1.json b/botocore/data/medialive/2017-10-14/paginators-1.json index c9bc58df44..e0a675bc05 100644 --- a/botocore/data/medialive/2017-10-14/paginators-1.json +++ b/botocore/data/medialive/2017-10-14/paginators-1.json @@ -29,6 +29,12 @@ "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Reservations" + }, + "DescribeSchedule": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ScheduleActions" } } } diff --git a/botocore/data/medialive/2017-10-14/service-2.json b/botocore/data/medialive/2017-10-14/service-2.json index a7a312795c..2b006b85a5 100644 --- a/botocore/data/medialive/2017-10-14/service-2.json +++ b/botocore/data/medialive/2017-10-14/service-2.json @@ -12,6 +12,56 @@ "serviceAbbreviation": "MediaLive" }, "operations": { + "BatchUpdateSchedule": { + "name": "BatchUpdateSchedule", + "http": { + "method": "PUT", + "requestUri": "/prod/channels/{channelId}/schedule", + "responseCode": 200 + }, + "input": { + "shape": "BatchUpdateScheduleRequest" + }, + "output": { + "shape": "BatchUpdateScheduleResponse", + "documentation": "Successful update of the schedule." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid." + }, + { + "shape": "UnprocessableEntityException", + "documentation": "The update schedule request failed validation." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to update the channel schedule." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The specified channel id does not exist." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on update schedule calls." + } + ], + "documentation": "Update a channel schedule" + }, "CreateChannel": { "name": "CreateChannel", "http": { @@ -572,6 +622,52 @@ ], "documentation": "Get details for a reservation." }, + "DescribeSchedule": { + "name": "DescribeSchedule", + "http": { + "method": "GET", + "requestUri": "/prod/channels/{channelId}/schedule", + "responseCode": 200 + }, + "input": { + "shape": "DescribeScheduleRequest" + }, + "output": { + "shape": "DescribeScheduleResponse", + "documentation": "An array of channel schedule actions." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to describe the channel schedule." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The channel you're requesting a schedule describe for does not exist." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on describe schedule calls." + } + ], + "documentation": "Get a channel schedule" + }, "ListChannels": { "name": "ListChannels", "http": { @@ -1716,6 +1812,119 @@ }, "documentation": "Placeholder documentation for BadRequestException" }, + "BatchScheduleActionCreateRequest": { + "type": "structure", + "members": { + "ScheduleActions": { + "shape": "__listOfScheduleAction", + "locationName": "scheduleActions", + "documentation": "A list of schedule actions to create." + } + }, + "documentation": "A list of schedule actions to create.", + "required": [ + "ScheduleActions" + ] + }, + "BatchScheduleActionCreateResult": { + "type": "structure", + "members": { + "ScheduleActions": { + "shape": "__listOfScheduleAction", + "locationName": "scheduleActions", + "documentation": "Returned list of created schedule actions." + } + }, + "documentation": "Returned list of created schedule actions.", + "required": [ + "ScheduleActions" + ] + }, + "BatchScheduleActionDeleteRequest": { + "type": "structure", + "members": { + "ActionNames": { + "shape": "__listOf__string", + "locationName": "actionNames", + "documentation": "A list of schedule actions to delete, identified by unique name." + } + }, + "documentation": "A list of schedule actions to delete.", + "required": [ + "ActionNames" + ] + }, + "BatchScheduleActionDeleteResult": { + "type": "structure", + "members": { + "ScheduleActions": { + "shape": "__listOfScheduleAction", + "locationName": "scheduleActions", + "documentation": "Returned list of deleted schedule actions." + } + }, + "documentation": "Returned list of deleted schedule actions.", + "required": [ + "ScheduleActions" + ] + }, + "BatchUpdateScheduleRequest": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__string", + "location": "uri", + "locationName": "channelId", + "documentation": "Id of the channel whose schedule is being updated." + }, + "Creates": { + "shape": "BatchScheduleActionCreateRequest", + "locationName": "creates", + "documentation": "Schedule actions to create in the schedule." + }, + "Deletes": { + "shape": "BatchScheduleActionDeleteRequest", + "locationName": "deletes", + "documentation": "Schedule actions to delete from the schedule." + } + }, + "documentation": "List of actions to create and list of actions to delete.", + "required": [ + "ChannelId" + ] + }, + "BatchUpdateScheduleResponse": { + "type": "structure", + "members": { + "Creates": { + "shape": "BatchScheduleActionCreateResult", + "locationName": "creates", + "documentation": "Schedule actions created in the schedule." + }, + "Deletes": { + "shape": "BatchScheduleActionDeleteResult", + "locationName": "deletes", + "documentation": "Schedule actions deleted from the schedule." + } + }, + "documentation": "Response to a batch update schedule call." + }, + "BatchUpdateScheduleResult": { + "type": "structure", + "members": { + "Creates": { + "shape": "BatchScheduleActionCreateResult", + "locationName": "creates", + "documentation": "Schedule actions created in the schedule." + }, + "Deletes": { + "shape": "BatchScheduleActionDeleteResult", + "locationName": "deletes", + "documentation": "Schedule actions deleted from the schedule." + } + }, + "documentation": "Results of a batch schedule update." + }, "BlackoutSlate": { "type": "structure", "members": { @@ -2155,7 +2364,7 @@ "ValidationErrors": { "shape": "__listOfValidationError", "locationName": "validationErrors", - "documentation": "A collection of validation error responses from attempting to create a channel with a bouquet of settings." + "documentation": "A collection of validation error responses." } }, "documentation": "Placeholder documentation for ChannelConfigurationValidationError" @@ -3100,6 +3309,47 @@ }, "documentation": "Placeholder documentation for DescribeReservationResponse" }, + "DescribeScheduleRequest": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__string", + "location": "uri", + "locationName": "channelId", + "documentation": "Id of the channel whose schedule is being updated." + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ChannelId" + ], + "documentation": "Request for a describe schedule call." + }, + "DescribeScheduleResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "The next token; for use in pagination." + }, + "ScheduleActions": { + "shape": "__listOfScheduleAction", + "locationName": "scheduleActions", + "documentation": "The list of schedule actions." + } + }, + "documentation": "Response for a describe schedule call." + }, "DvbNitSettings": { "type": "structure", "members": { @@ -3727,6 +3977,17 @@ ], "documentation": "Placeholder documentation for FixedAfd" }, + "FixedModeScheduleActionStartSettings": { + "type": "structure", + "members": { + "Time": { + "shape": "__string", + "locationName": "time", + "documentation": "Fixed timestamp action start. Conforms to ISO-8601." + } + }, + "documentation": "Fixed mode schedule action start settings" + }, "ForbiddenException": { "type": "structure", "members": { @@ -6917,6 +7178,93 @@ ], "documentation": "Placeholder documentation for RtmpOutputSettings" }, + "ScheduleAction": { + "type": "structure", + "members": { + "ActionName": { + "shape": "__string", + "locationName": "actionName", + "documentation": "The name of the action, must be unique within the schedule." + }, + "ScheduleActionSettings": { + "shape": "ScheduleActionSettings", + "locationName": "scheduleActionSettings", + "documentation": "Settings for this schedule action." + }, + "ScheduleActionStartSettings": { + "shape": "ScheduleActionStartSettings", + "locationName": "scheduleActionStartSettings", + "documentation": "When the action takes effect." + } + }, + "documentation": "A single schedule action.", + "required": [ + "ActionName", + "ScheduleActionStartSettings", + "ScheduleActionSettings" + ] + }, + "ScheduleActionSettings": { + "type": "structure", + "members": { + "Scte35ReturnToNetworkSettings": { + "shape": "Scte35ReturnToNetworkScheduleActionSettings", + "locationName": "scte35ReturnToNetworkSettings", + "documentation": "SCTE-35 Return to Network Settings" + }, + "Scte35SpliceInsertSettings": { + "shape": "Scte35SpliceInsertScheduleActionSettings", + "locationName": "scte35SpliceInsertSettings", + "documentation": "SCTE-35 Splice Insert Settings" + }, + "Scte35TimeSignalSettings": { + "shape": "Scte35TimeSignalScheduleActionSettings", + "locationName": "scte35TimeSignalSettings", + "documentation": "SCTE-35 Time Signal Settings" + }, + "StaticImageActivateSettings": { + "shape": "StaticImageActivateScheduleActionSettings", + "locationName": "staticImageActivateSettings", + "documentation": "Static Image Activate" + }, + "StaticImageDeactivateSettings": { + "shape": "StaticImageDeactivateScheduleActionSettings", + "locationName": "staticImageDeactivateSettings", + "documentation": "Static Image Deactivate" + } + }, + "documentation": "Settings for a single schedule action." + }, + "ScheduleActionStartSettings": { + "type": "structure", + "members": { + "FixedModeScheduleActionStartSettings": { + "shape": "FixedModeScheduleActionStartSettings", + "locationName": "fixedModeScheduleActionStartSettings", + "documentation": "Fixed timestamp action start. Conforms to ISO-8601." + } + }, + "documentation": "When the schedule action starts." + }, + "ScheduleDescribeResultModel": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "The next token; for use in pagination." + }, + "ScheduleActions": { + "shape": "__listOfScheduleAction", + "locationName": "scheduleActions", + "documentation": "The list of schedule actions." + } + }, + "documentation": "A complete schedule description.", + "required": [ + "ScheduleActions" + ] + }, "Scte20Convert608To708": { "type": "string", "enum": [ @@ -6980,6 +7328,179 @@ ], "documentation": "Placeholder documentation for Scte35AposWebDeliveryAllowedBehavior" }, + "Scte35ArchiveAllowedFlag": { + "type": "string", + "documentation": "SCTE-35 segmentation_descriptor archive_allowed_flag.", + "enum": [ + "ARCHIVE_NOT_ALLOWED", + "ARCHIVE_ALLOWED" + ] + }, + "Scte35DeliveryRestrictions": { + "type": "structure", + "members": { + "ArchiveAllowedFlag": { + "shape": "Scte35ArchiveAllowedFlag", + "locationName": "archiveAllowedFlag", + "documentation": "SCTE-35 segmentation_descriptor archive_allowed_flag." + }, + "DeviceRestrictions": { + "shape": "Scte35DeviceRestrictions", + "locationName": "deviceRestrictions", + "documentation": "SCTE-35 segmentation_descriptor web_delivery_allowed_flag." + }, + "NoRegionalBlackoutFlag": { + "shape": "Scte35NoRegionalBlackoutFlag", + "locationName": "noRegionalBlackoutFlag", + "documentation": "SCTE-35 segmentation_descriptor no_regional_blackout_flag." + }, + "WebDeliveryAllowedFlag": { + "shape": "Scte35WebDeliveryAllowedFlag", + "locationName": "webDeliveryAllowedFlag", + "documentation": "SCTE-35 segmentation_descriptor web_delivery_allowed_flag." + } + }, + "documentation": "SCTE-35 Delivery Restrictions.", + "required": [ + "DeviceRestrictions", + "ArchiveAllowedFlag", + "WebDeliveryAllowedFlag", + "NoRegionalBlackoutFlag" + ] + }, + "Scte35Descriptor": { + "type": "structure", + "members": { + "Scte35DescriptorSettings": { + "shape": "Scte35DescriptorSettings", + "locationName": "scte35DescriptorSettings", + "documentation": "SCTE-35 Descriptor Settings." + } + }, + "documentation": "SCTE-35 Descriptor.", + "required": [ + "Scte35DescriptorSettings" + ] + }, + "Scte35DescriptorSettings": { + "type": "structure", + "members": { + "SegmentationDescriptorScte35DescriptorSettings": { + "shape": "Scte35SegmentationDescriptor", + "locationName": "segmentationDescriptorScte35DescriptorSettings", + "documentation": "SCTE-35 Segmentation Descriptor." + } + }, + "documentation": "SCTE-35 Descriptor settings.", + "required": [ + "SegmentationDescriptorScte35DescriptorSettings" + ] + }, + "Scte35DeviceRestrictions": { + "type": "string", + "documentation": "SCTE-35 Device Restrictions.", + "enum": [ + "NONE", + "RESTRICT_GROUP0", + "RESTRICT_GROUP1", + "RESTRICT_GROUP2" + ] + }, + "Scte35NoRegionalBlackoutFlag": { + "type": "string", + "documentation": "SCTE-35 segmentation_descriptor no_regional_blackout_flag.", + "enum": [ + "REGIONAL_BLACKOUT", + "NO_REGIONAL_BLACKOUT" + ] + }, + "Scte35ReturnToNetworkScheduleActionSettings": { + "type": "structure", + "members": { + "SpliceEventId": { + "shape": "__integerMin0Max4294967295", + "locationName": "spliceEventId", + "documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35." + } + }, + "documentation": "SCTE-35 Return to Network Settings.", + "required": [ + "SpliceEventId" + ] + }, + "Scte35SegmentationCancelIndicator": { + "type": "string", + "documentation": "SCTE-35 segmentation_descriptor segmentation_event_cancel_indicator.", + "enum": [ + "SEGMENTATION_EVENT_NOT_CANCELED", + "SEGMENTATION_EVENT_CANCELED" + ] + }, + "Scte35SegmentationDescriptor": { + "type": "structure", + "members": { + "DeliveryRestrictions": { + "shape": "Scte35DeliveryRestrictions", + "locationName": "deliveryRestrictions", + "documentation": "SCTE-35 delivery restrictions." + }, + "SegmentNum": { + "shape": "__integerMin0Max255", + "locationName": "segmentNum", + "documentation": "SCTE-35 segmentation_descriptor segment_num." + }, + "SegmentationCancelIndicator": { + "shape": "Scte35SegmentationCancelIndicator", + "locationName": "segmentationCancelIndicator", + "documentation": "SCTE-35 segmentation_descriptor segmentation_event_cancel_indicator." + }, + "SegmentationDuration": { + "shape": "__integerMin0Max1099511627775", + "locationName": "segmentationDuration", + "documentation": "SCTE-35 segmentation_descriptor segmentation_duration specified in 90 KHz clock ticks." + }, + "SegmentationEventId": { + "shape": "__integerMin0Max4294967295", + "locationName": "segmentationEventId", + "documentation": "SCTE-35 segmentation_descriptor segmentation_event_id." + }, + "SegmentationTypeId": { + "shape": "__integerMin0Max255", + "locationName": "segmentationTypeId", + "documentation": "SCTE-35 segmentation_descriptor segmentation_type_id." + }, + "SegmentationUpid": { + "shape": "__string", + "locationName": "segmentationUpid", + "documentation": "SCTE-35 segmentation_descriptor segmentation_upid as a hex string." + }, + "SegmentationUpidType": { + "shape": "__integerMin0Max255", + "locationName": "segmentationUpidType", + "documentation": "SCTE-35 segmentation_descriptor segmentation_upid_type." + }, + "SegmentsExpected": { + "shape": "__integerMin0Max255", + "locationName": "segmentsExpected", + "documentation": "SCTE-35 segmentation_descriptor segments_expected." + }, + "SubSegmentNum": { + "shape": "__integerMin0Max255", + "locationName": "subSegmentNum", + "documentation": "SCTE-35 segmentation_descriptor sub_segment_num." + }, + "SubSegmentsExpected": { + "shape": "__integerMin0Max255", + "locationName": "subSegmentsExpected", + "documentation": "SCTE-35 segmentation_descriptor sub_segments_expected." + } + }, + "documentation": "SCTE-35 Segmentation Descriptor.", + "required": [ + "SegmentationEventId", + "SegmentationCancelIndicator" + ] + }, "Scte35SpliceInsert": { "type": "structure", "members": { @@ -7009,6 +7530,25 @@ ], "documentation": "Placeholder documentation for Scte35SpliceInsertNoRegionalBlackoutBehavior" }, + "Scte35SpliceInsertScheduleActionSettings": { + "type": "structure", + "members": { + "Duration": { + "shape": "__integerMin0Max8589934591", + "locationName": "duration", + "documentation": "The duration for the SCTE-35 splice_insert specified in 90KHz clock ticks. When duration is not specified the expectation is that a Scte35ReturnToNetwork action will be scheduled." + }, + "SpliceEventId": { + "shape": "__integerMin0Max4294967295", + "locationName": "spliceEventId", + "documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35." + } + }, + "documentation": "SCTE-35 Splice Insert Settings.", + "required": [ + "SpliceEventId" + ] + }, "Scte35SpliceInsertWebDeliveryAllowedBehavior": { "type": "string", "enum": [ @@ -7038,6 +7578,28 @@ }, "documentation": "Placeholder documentation for Scte35TimeSignalApos" }, + "Scte35TimeSignalScheduleActionSettings": { + "type": "structure", + "members": { + "Scte35Descriptors": { + "shape": "__listOfScte35Descriptor", + "locationName": "scte35Descriptors", + "documentation": "The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal." + } + }, + "documentation": "SCTE-35 Time Signal Settings.", + "required": [ + "Scte35Descriptors" + ] + }, + "Scte35WebDeliveryAllowedFlag": { + "type": "string", + "documentation": "SCTE-35 segmentation_descriptor web_delivery_allowed_flag.", + "enum": [ + "WEB_DELIVERY_NOT_ALLOWED", + "WEB_DELIVERY_ALLOWED" + ] + }, "SmoothGroupAudioOnlyTimecodeControl": { "type": "string", "enum": [ @@ -7205,6 +7767,81 @@ }, "documentation": "Placeholder documentation for StartChannelResponse" }, + "StaticImageActivateScheduleActionSettings": { + "type": "structure", + "members": { + "Duration": { + "shape": "__integerMin0", + "locationName": "duration", + "documentation": "The duration in milliseconds for the image to remain in the video. If omitted or set to 0, duration is infinite and image will remain until explicitly deactivated." + }, + "FadeIn": { + "shape": "__integerMin0", + "locationName": "fadeIn", + "documentation": "The time in milliseconds for the image to fade in. Defaults to 0." + }, + "FadeOut": { + "shape": "__integerMin0", + "locationName": "fadeOut", + "documentation": "The time in milliseconds for the image to fade out. Defaults to 0." + }, + "Height": { + "shape": "__integerMin1", + "locationName": "height", + "documentation": "The height of the image when inserted into the video. Defaults to the native height of the image." + }, + "Image": { + "shape": "InputLocation", + "locationName": "image", + "documentation": "The image to overlay on the video. Must be a 32 bit BMP, PNG, or TGA file. Must not be larger than the input video." + }, + "ImageX": { + "shape": "__integerMin0", + "locationName": "imageX", + "documentation": "Placement of the left edge of the image on the horizontal axis in pixels. 0 is the left edge of the frame. Defaults to 0." + }, + "ImageY": { + "shape": "__integerMin0", + "locationName": "imageY", + "documentation": "Placement of the top edge of the image on the vertical axis in pixels. 0 is the top edge of the frame. Defaults to 0." + }, + "Layer": { + "shape": "__integerMin0Max7", + "locationName": "layer", + "documentation": "The Z order of the inserted image. Images with higher layer values will be inserted on top of images with lower layer values. Permitted values are 0-7 inclusive. Defaults to 0." + }, + "Opacity": { + "shape": "__integerMin0Max100", + "locationName": "opacity", + "documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Defaults to 100." + }, + "Width": { + "shape": "__integerMin1", + "locationName": "width", + "documentation": "The width of the image when inserted into the video. Defaults to the native width of the image." + } + }, + "documentation": "Static image activate.", + "required": [ + "Image" + ] + }, + "StaticImageDeactivateScheduleActionSettings": { + "type": "structure", + "members": { + "FadeOut": { + "shape": "__integerMin0", + "locationName": "fadeOut", + "documentation": "The time in milliseconds for the image to fade out. Defaults to 0." + }, + "Layer": { + "shape": "__integerMin0Max7", + "locationName": "layer", + "documentation": "The Z order of the inserted image. Images with higher layer values will be inserted on top of images with lower layer values. Permitted values are 0-7 inclusive. Defaults to 0." + } + }, + "documentation": "Static image deactivate." + }, "StaticKeySettings": { "type": "structure", "members": { @@ -7459,7 +8096,7 @@ "ValidationErrors": { "shape": "__listOfValidationError", "locationName": "validationErrors", - "documentation": "A collection of validation error responses from attempting to create a channel with a bouquet of settings." + "documentation": "A collection of validation error responses." } }, "exception": true, @@ -7922,6 +8559,12 @@ "max": 1000000, "documentation": "Placeholder documentation for __integerMin0Max1000000" }, + "__integerMin0Max1099511627775": { + "type": "long", + "min": 0, + "max": 1099511627775, + "documentation": "Unsigned 40-bit integer." + }, "__integerMin0Max128": { "type": "integer", "min": 0, @@ -7952,6 +8595,12 @@ "max": 3600, "documentation": "Placeholder documentation for __integerMin0Max3600" }, + "__integerMin0Max4294967295": { + "type": "long", + "min": 0, + "max": 4294967295, + "documentation": "Unsigned 32-bit integer." + }, "__integerMin0Max500": { "type": "integer", "min": 0, @@ -7988,6 +8637,12 @@ "max": 8191, "documentation": "Placeholder documentation for __integerMin0Max8191" }, + "__integerMin0Max8589934591": { + "type": "long", + "min": 0, + "max": 8589934591, + "documentation": "Unsigned 33-bit integer." + }, "__integerMin1": { "type": "integer", "min": 1, @@ -8285,6 +8940,20 @@ }, "documentation": "Placeholder documentation for __listOfReservation" }, + "__listOfScheduleAction": { + "type": "list", + "member": { + "shape": "ScheduleAction" + }, + "documentation": "The list of schedule actions." + }, + "__listOfScte35Descriptor": { + "type": "list", + "member": { + "shape": "Scte35Descriptor" + }, + "documentation": "List of Scte35 descriptors" + }, "__listOfValidationError": { "type": "list", "member": { diff --git a/botocore/data/rekognition/2016-06-27/service-2.json b/botocore/data/rekognition/2016-06-27/service-2.json index b8cf7c6730..f74e7f2ead 100644 --- a/botocore/data/rekognition/2016-06-27/service-2.json +++ b/botocore/data/rekognition/2016-06-27/service-2.json @@ -124,6 +124,23 @@ ], "documentation":"Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with . You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor.
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations.
If you are using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image. To determine which version of the model you are using, check the the value of FaceModelVersion in the response from IndexFaces.
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
If you provide the optional ExternalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.
In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image. If you request all facial attributes (using the detectionAttributes parameter, Amazon Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.
The input image is passed either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
This operation requires permissions to perform the rekognition:IndexFaces action.
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations.
If you are using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image. To determine which version of the model you are using, check the the value of FaceModelVersion in the response from IndexFaces.
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
If you provide the optional ExternalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.
In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image. If you request all facial attributes (using the detectionAttributes parameter, Amazon Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mouth) and other facial attributes such gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.
The input image is passed either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
This operation requires permissions to perform the rekognition:IndexFaces action.
Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see collections-search-person.
Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos.
Confidence level that the bounding box contains a face (and not a different object such as a tree).
" - } + }, + "AssociationScore":{"shape":"Percent"} }, "documentation":"Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
" }, @@ -1624,7 +1659,10 @@ "Celebrities":{ "shape":"CelebrityRecognitions", "documentation":"Array of celebrities recognized in the video.
" - } + }, + "BillableDurationSeconds":{"shape":"UInteger"}, + "ErrorCode":{"shape":"ErrorCode"}, + "Warnings":{"shape":"Warnings"} } }, "GetContentModerationRequest":{ @@ -1671,7 +1709,10 @@ "NextToken":{ "shape":"PaginationToken", "documentation":"If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of moderation labels.
" - } + }, + "BillableDurationSeconds":{"shape":"UInteger"}, + "ErrorCode":{"shape":"ErrorCode"}, + "Warnings":{"shape":"Warnings"} } }, "GetFaceDetectionRequest":{ @@ -1714,7 +1755,10 @@ "Faces":{ "shape":"FaceDetections", "documentation":"An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
" - } + }, + "BillableDurationSeconds":{"shape":"UInteger"}, + "ErrorCode":{"shape":"ErrorCode"}, + "Warnings":{"shape":"Warnings"} } }, "GetFaceSearchRequest":{ @@ -1761,7 +1805,10 @@ "Persons":{ "shape":"PersonMatches", "documentation":"An array of persons, , in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.
An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.
" - } + }, + "BillableDurationSeconds":{"shape":"UInteger"}, + "ErrorCode":{"shape":"ErrorCode"}, + "Warnings":{"shape":"Warnings"} } }, "GetPersonTrackingRequest":{ @@ -1855,7 +1905,10 @@ "Persons":{ "shape":"PersonDetections", "documentation":"An array of the persons detected in the video and the times they are tracked throughout the video. An array element will exist for each time the person is tracked.
" - } + }, + "BillableDurationSeconds":{"shape":"UInteger"}, + "ErrorCode":{"shape":"ErrorCode"}, + "Warnings":{"shape":"Warnings"} } }, "IdempotentParameterMismatchException":{ @@ -2297,6 +2350,7 @@ }, "documentation":"The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.
" }, + "NullableBoolean":{"type":"boolean"}, "OrientationCorrection":{ "type":"string", "enum":[ @@ -2373,7 +2427,7 @@ "documentation":"Information about the faces in the input collection that match the face of a person in the video.
" } }, - "documentation":"Information about a person whose face matches a face(s) in a Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (, information about the person (PersonDetail) and the timestamp for when the person was detected in a video. An array of PersonMatch objects is returned by .
Information about a person whose face matches a face(s) in a Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (), information about the person (PersonDetail) and the timestamp for when the person was detected in a video. An array of PersonMatch objects is returned by .
The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.
" }, + "EnablePersonTracking":{"shape":"NullableBoolean"}, "JobTag":{ "shape":"JobTag", "documentation":"Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
" @@ -2749,6 +2815,7 @@ "shape":"CollectionId", "documentation":"ID of the collection that contains the faces you want to search for.
" }, + "EnablePersonTracking":{"shape":"NullableBoolean"}, "NotificationChannel":{ "shape":"NotificationChannel", "documentation":"The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
" @@ -3055,7 +3122,8 @@ "FrameWidth":{ "shape":"ULong", "documentation":"Horizontal pixel dimension of the video.
" - } + }, + "Rotation":{"shape":"UInteger"} }, "documentation":"Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.
", "exception":true + }, + "Warning":{ + "type":"structure", + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"StatusMessage"}, + "Sections":{"shape":"Sections"} + } + }, + "Warnings":{ + "type":"list", + "member":{"shape":"Warning"} } }, "documentation":"This is the Amazon Rekognition API reference.
" diff --git a/docs/source/conf.py b/docs/source/conf.py index d91cb49f86..30810bb5e1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,7 +54,7 @@ # The short X.Y version. version = '1.10.' # The full version, including alpha/beta/rc tags. -release = '1.10.83' +release = '1.10.84' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.