Creates an asset in Amazon DataZone catalog.
", "idempotent":true }, + "CreateAssetFilter":{ + "name":"CreateAssetFilter", + "http":{ + "method":"POST", + "requestUri":"/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters", + "responseCode":201 + }, + "input":{"shape":"CreateAssetFilterInput"}, + "output":{"shape":"CreateAssetFilterOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"Creates a data asset filter.
", + "idempotent":true + }, "CreateAssetRevision":{ "name":"CreateAssetRevision", "http":{ @@ -527,6 +549,26 @@ "documentation":"Delets an asset in Amazon DataZone.
", "idempotent":true }, + "DeleteAssetFilter":{ + "name":"DeleteAssetFilter", + "http":{ + "method":"DELETE", + "requestUri":"/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters/{identifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteAssetFilterInput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"Deletes an asset filter.
", + "idempotent":true + }, "DeleteAssetType":{ "name":"DeleteAssetType", "http":{ @@ -908,6 +950,25 @@ ], "documentation":"Gets an Amazon DataZone asset.
" }, + "GetAssetFilter":{ + "name":"GetAssetFilter", + "http":{ + "method":"GET", + "requestUri":"/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters/{identifier}", + "responseCode":200 + }, + "input":{"shape":"GetAssetFilterInput"}, + "output":{"shape":"GetAssetFilterOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"Gets an asset filter.
" + }, "GetAssetType":{ "name":"GetAssetType", "http":{ @@ -1370,6 +1431,25 @@ ], "documentation":"Gets a user profile in Amazon DataZone.
" }, + "ListAssetFilters":{ + "name":"ListAssetFilters", + "http":{ + "method":"GET", + "requestUri":"/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters", + "responseCode":200 + }, + "input":{"shape":"ListAssetFiltersInput"}, + "output":{"shape":"ListAssetFiltersOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"Lists asset filters.
" + }, "ListAssetRevisions":{ "name":"ListAssetRevisions", "http":{ @@ -2075,6 +2155,27 @@ "documentation":"Untags a resource in Amazon DataZone.
", "idempotent":true }, + "UpdateAssetFilter":{ + "name":"UpdateAssetFilter", + "http":{ + "method":"PATCH", + "requestUri":"/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters/{identifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateAssetFilterInput"}, + "output":{"shape":"UpdateAssetFilterOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"Updates an asset filter.
", + "idempotent":true + }, "UpdateDataSource":{ "name":"UpdateDataSource", "http":{ @@ -2586,6 +2687,77 @@ "type":"list", "member":{"shape":"TypeName"} }, + "AssetFilterConfiguration":{ + "type":"structure", + "members":{ + "columnConfiguration":{ + "shape":"ColumnFilterConfiguration", + "documentation":"The column configuration of the asset filter.
" + }, + "rowConfiguration":{ + "shape":"RowFilterConfiguration", + "documentation":"The row configuration of the asset filter.
" + } + }, + "documentation":"The configuration details of the asset filter.
", + "union":true + }, + "AssetFilterSummary":{ + "type":"structure", + "required":[ + "assetId", + "domainId", + "id", + "name" + ], + "members":{ + "assetId":{ + "shape":"AssetId", + "documentation":"The ID of the data asset.
" + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"The timestamp at which the asset filter was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the asset filter.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The ID of the domain where the asset filter lives.
" + }, + "effectiveColumnNames":{ + "shape":"ColumnNameList", + "documentation":"The effective column names of the asset filter.
" + }, + "effectiveRowFilter":{ + "shape":"String", + "documentation":"The effective row filter of the asset filter.
" + }, + "errorMessage":{ + "shape":"String", + "documentation":"The error message that is displayed if the action does not succeed.
" + }, + "id":{ + "shape":"FilterId", + "documentation":"The ID of the asset filter.
" + }, + "name":{ + "shape":"FilterName", + "documentation":"The name of the asset filter.
" + }, + "status":{ + "shape":"FilterStatus", + "documentation":"The status of the asset filter.
" + } + }, + "documentation":"The summary of the asset filter.
" + }, + "AssetFilters":{ + "type":"list", + "member":{"shape":"AssetFilterSummary"} + }, "AssetId":{ "type":"string", "pattern":"^[a-zA-Z0-9_-]{1,36}$" @@ -3152,6 +3324,20 @@ }, "documentation":"Part of the provisioning properties of the environment blueprint.
" }, + "ColumnFilterConfiguration":{ + "type":"structure", + "members":{ + "includedColumnNames":{ + "shape":"ColumnNameList", + "documentation":"Specifies whether to include column names.
" + } + }, + "documentation":"The column configuration of the asset filter.
" + }, + "ColumnNameList":{ + "type":"list", + "member":{"shape":"String"} + }, "ConfigurableActionParameter":{ "type":"structure", "members":{ @@ -3212,6 +3398,102 @@ }, "exception":true }, + "CreateAssetFilterInput":{ + "type":"structure", + "required":[ + "assetIdentifier", + "configuration", + "domainIdentifier", + "name" + ], + "members":{ + "assetIdentifier":{ + "shape":"AssetId", + "documentation":"The ID of the data asset.
", + "location":"uri", + "locationName":"assetIdentifier" + }, + "clientToken":{ + "shape":"String", + "documentation":"A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
", + "idempotencyToken":true + }, + "configuration":{ + "shape":"AssetFilterConfiguration", + "documentation":"The configuration of the asset filter.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the asset filter.
" + }, + "domainIdentifier":{ + "shape":"DomainId", + "documentation":"The ID of the domain in which you want to create an asset filter.
", + "location":"uri", + "locationName":"domainIdentifier" + }, + "name":{ + "shape":"FilterName", + "documentation":"The name of the asset filter.
" + } + } + }, + "CreateAssetFilterOutput":{ + "type":"structure", + "required":[ + "assetId", + "configuration", + "domainId", + "id", + "name" + ], + "members":{ + "assetId":{ + "shape":"AssetId", + "documentation":"The ID of the asset.
" + }, + "configuration":{ + "shape":"AssetFilterConfiguration", + "documentation":"The configuration of the asset filter.
" + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"The timestamp at which the asset filter was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the asset filter.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The ID of the domain where the asset filter is created.
" + }, + "effectiveColumnNames":{ + "shape":"ColumnNameList", + "documentation":"The column names in the asset filter.
" + }, + "effectiveRowFilter":{ + "shape":"String", + "documentation":"The row filter in the asset filter.
" + }, + "errorMessage":{ + "shape":"String", + "documentation":"The error message that is displayed if the asset filter is not created successfully.
" + }, + "id":{ + "shape":"FilterId", + "documentation":"The ID of the asset filter.
" + }, + "name":{ + "shape":"FilterName", + "documentation":"The name of the asset filter.
" + }, + "status":{ + "shape":"FilterStatus", + "documentation":"The status of the asset filter.
" + } + } + }, "CreateAssetInput":{ "type":"structure", "required":[ @@ -5471,6 +5753,34 @@ "min":1, "sensitive":true }, + "DeleteAssetFilterInput":{ + "type":"structure", + "required":[ + "assetIdentifier", + "domainIdentifier", + "identifier" + ], + "members":{ + "assetIdentifier":{ + "shape":"AssetId", + "documentation":"The ID of the data asset.
", + "location":"uri", + "locationName":"assetIdentifier" + }, + "domainIdentifier":{ + "shape":"DomainId", + "documentation":"The ID of the domain where you want to delete an asset filter.
", + "location":"uri", + "locationName":"domainIdentifier" + }, + "identifier":{ + "shape":"FilterId", + "documentation":"The ID of the asset filter that you want to delete.
", + "location":"uri", + "locationName":"identifier" + } + } + }, "DeleteAssetInput":{ "type":"structure", "required":[ @@ -6448,6 +6758,10 @@ "shape":"RoleArn", "documentation":"The ARN of the manage access role specified in the environment blueprint configuration.
" }, + "provisioningConfigurations":{ + "shape":"ProvisioningConfigurationList", + "documentation":"The provisioning configuration of a blueprint.
" + }, "provisioningRoleArn":{ "shape":"RoleArn", "documentation":"The ARN of the provisioning role specified in the environment blueprint configuration.
" @@ -6724,6 +7038,24 @@ }, "documentation":"The details of an environment.
" }, + "EqualToExpression":{ + "type":"structure", + "required":[ + "columnName", + "value" + ], + "members":{ + "columnName":{ + "shape":"String", + "documentation":"The name of the column.
" + }, + "value":{ + "shape":"String", + "documentation":"The value that might be equal to an expression.
" + } + }, + "documentation":"Specifies whether the value is equal to an expression.
" + }, "ErrorMessage":{"type":"string"}, "ExternalIdentifier":{ "type":"string", @@ -6816,12 +7148,30 @@ "type":"list", "member":{"shape":"FilterExpression"} }, + "FilterId":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_-]{1,36}$" + }, "FilterList":{ "type":"list", "member":{"shape":"FilterClause"}, "max":100, "min":1 }, + "FilterName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[\\w -]+$", + "sensitive":true + }, + "FilterStatus":{ + "type":"string", + "enum":[ + "VALID", + "INVALID" + ] + }, "FilterValueString":{ "type":"string", "max":128, @@ -7044,30 +7394,114 @@ "max":10, "min":0 }, - "GetAssetInput":{ + "GetAssetFilterInput":{ "type":"structure", "required":[ + "assetIdentifier", "domainIdentifier", "identifier" ], "members":{ + "assetIdentifier":{ + "shape":"AssetId", + "documentation":"The ID of the data asset.
", + "location":"uri", + "locationName":"assetIdentifier" + }, "domainIdentifier":{ "shape":"DomainId", - "documentation":"The ID of the Amazon DataZone domain to which the asset belongs.
", + "documentation":"The ID of the domain where you want to get an asset filter.
", "location":"uri", "locationName":"domainIdentifier" }, "identifier":{ - "shape":"AssetIdentifier", - "documentation":"The ID of the Amazon DataZone asset.
", + "shape":"FilterId", + "documentation":"The ID of the asset filter.
", "location":"uri", "locationName":"identifier" - }, - "revision":{ - "shape":"Revision", - "documentation":"The revision of the Amazon DataZone asset.
", - "location":"querystring", - "locationName":"revision" + } + } + }, + "GetAssetFilterOutput":{ + "type":"structure", + "required":[ + "assetId", + "configuration", + "domainId", + "id", + "name" + ], + "members":{ + "assetId":{ + "shape":"AssetId", + "documentation":"The ID of the data asset.
" + }, + "configuration":{ + "shape":"AssetFilterConfiguration", + "documentation":"The configuration of the asset filter.
" + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"The timestamp at which the asset filter was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the asset filter.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The ID of the domain where you want to get an asset filter.
" + }, + "effectiveColumnNames":{ + "shape":"ColumnNameList", + "documentation":"The column names of the asset filter.
" + }, + "effectiveRowFilter":{ + "shape":"String", + "documentation":"The row filter of the asset filter.
" + }, + "errorMessage":{ + "shape":"String", + "documentation":"The error message that is displayed if the action does not complete successfully.
" + }, + "id":{ + "shape":"FilterId", + "documentation":"The ID of the asset filter.
" + }, + "name":{ + "shape":"FilterName", + "documentation":"The name of the asset filter.
" + }, + "status":{ + "shape":"FilterStatus", + "documentation":"The status of the asset filter.
" + } + } + }, + "GetAssetInput":{ + "type":"structure", + "required":[ + "domainIdentifier", + "identifier" + ], + "members":{ + "domainIdentifier":{ + "shape":"DomainId", + "documentation":"The ID of the Amazon DataZone domain to which the asset belongs.
", + "location":"uri", + "locationName":"domainIdentifier" + }, + "identifier":{ + "shape":"AssetIdentifier", + "documentation":"The ID of the Amazon DataZone asset.
", + "location":"uri", + "locationName":"identifier" + }, + "revision":{ + "shape":"Revision", + "documentation":"The revision of the Amazon DataZone asset.
", + "location":"querystring", + "locationName":"revision" } } }, @@ -7636,6 +8070,10 @@ "shape":"RoleArn", "documentation":"The ARN of the manage access role with which this blueprint is created.
" }, + "provisioningConfigurations":{ + "shape":"ProvisioningConfigurationList", + "documentation":"The provisioning configuration of a blueprint.
" + }, "provisioningRoleArn":{ "shape":"RoleArn", "documentation":"The ARN of the provisioning role with which this blueprint is created.
" @@ -9281,6 +9719,42 @@ "documentation":"The details of a listing for which a subscription is to be granted.
", "union":true }, + "GreaterThanExpression":{ + "type":"structure", + "required":[ + "columnName", + "value" + ], + "members":{ + "columnName":{ + "shape":"String", + "documentation":"The name of the column.
" + }, + "value":{ + "shape":"String", + "documentation":"The value that might be greater than an expression.
" + } + }, + "documentation":"Specifies whether the value is greater than an expression.
" + }, + "GreaterThanOrEqualToExpression":{ + "type":"structure", + "required":[ + "columnName", + "value" + ], + "members":{ + "columnName":{ + "shape":"String", + "documentation":"The name of the column.
" + }, + "value":{ + "shape":"String", + "documentation":"The value that might be greater than or equal to an expression.
" + } + }, + "documentation":"Specifies whether the value is greater than or equal to an expression.
" + }, "GroupDetails":{ "type":"structure", "required":["groupId"], @@ -9387,6 +9861,24 @@ "max":10, "min":1 }, + "InExpression":{ + "type":"structure", + "required":[ + "columnName", + "values" + ], + "members":{ + "columnName":{ + "shape":"String", + "documentation":"The name of the column.
" + }, + "values":{ + "shape":"StringList", + "documentation":"The values that might be in the expression.
" + } + }, + "documentation":"Specifies whether values are in the expression.
" + }, "Integer":{ "type":"integer", "box":true @@ -9411,16 +9903,106 @@ "GLOSSARY_TERM" ] }, + "IsNotNullExpression":{ + "type":"structure", + "required":["columnName"], + "members":{ + "columnName":{ + "shape":"String", + "documentation":"The name of the column.
" + } + }, + "documentation":"Specifies that the expression is not null.
" + }, + "IsNullExpression":{ + "type":"structure", + "required":["columnName"], + "members":{ + "columnName":{ + "shape":"String", + "documentation":"The name of the column.
" + } + }, + "documentation":"Specifies that the expression is null.
" + }, "KmsKeyArn":{ "type":"string", "max":1024, "min":1, "pattern":"^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" }, + "LakeFormationConfiguration":{ + "type":"structure", + "members":{ + "locationRegistrationExcludeS3Locations":{ + "shape":"S3LocationList", + "documentation":"Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.
" + }, + "locationRegistrationRole":{ + "shape":"RoleArn", + "documentation":"The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using AWS Lake Formation hybrid access mode.
" + } + }, + "documentation":"The Lake Formation configuration of the Data Lake blueprint.
" + }, "LastName":{ "type":"string", "sensitive":true }, + "LessThanExpression":{ + "type":"structure", + "required":[ + "columnName", + "value" + ], + "members":{ + "columnName":{ + "shape":"String", + "documentation":"The name of the column.
" + }, + "value":{ + "shape":"String", + "documentation":"The value that might be less than the expression.
" + } + }, + "documentation":"Specifies that a value is less than an expression.
" + }, + "LessThanOrEqualToExpression":{ + "type":"structure", + "required":[ + "columnName", + "value" + ], + "members":{ + "columnName":{ + "shape":"String", + "documentation":"The name of the column.
" + }, + "value":{ + "shape":"String", + "documentation":"The value that might be less than or equal to an expression.
" + } + }, + "documentation":"Specifies that a value is less than or equal to an expression.
" + }, + "LikeExpression":{ + "type":"structure", + "required":[ + "columnName", + "value" + ], + "members":{ + "columnName":{ + "shape":"String", + "documentation":"The name of the column.
" + }, + "value":{ + "shape":"String", + "documentation":"The value that might be like the expression.
" + } + }, + "documentation":"Specifies that a value is like the expression.
" + }, "LineageEvent":{ "type":"blob", "max":300000, @@ -9566,6 +10148,59 @@ }, "documentation":"The details of a data lineage node type.
" }, + "ListAssetFiltersInput":{ + "type":"structure", + "required":[ + "assetIdentifier", + "domainIdentifier" + ], + "members":{ + "assetIdentifier":{ + "shape":"AssetId", + "documentation":"The ID of the data asset.
", + "location":"uri", + "locationName":"assetIdentifier" + }, + "domainIdentifier":{ + "shape":"DomainId", + "documentation":"The ID of the domain where you want to list asset filters.
", + "location":"uri", + "locationName":"domainIdentifier" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of asset filters to return in a single call to ListAssetFilters. When the number of asset filters to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAssetFilters to list the next set of asset filters.
When the number of asset filters is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of asset filters, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetFilters to list the next set of asset filters.
The status of the asset filter.
", + "location":"querystring", + "locationName":"status" + } + } + }, + "ListAssetFiltersOutput":{ + "type":"structure", + "required":["items"], + "members":{ + "items":{ + "shape":"AssetFilters", + "documentation":"The results of the ListAssetFilters action.
When the number of asset filters is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of asset filters, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetFilters to list the next set of asset filters.
The name of the column.
" + }, + "value":{ + "shape":"String", + "documentation":"The value that might not be equal to the expression.
" + } + }, + "documentation":"Specifies that a value is not equal to the expression.
" + }, + "NotInExpression":{ + "type":"structure", + "required":[ + "columnName", + "values" + ], + "members":{ + "columnName":{ + "shape":"String", + "documentation":"The name of the column.
" + }, + "values":{ + "shape":"StringList", + "documentation":"The value that might not be in the expression.
" + } + }, + "documentation":"Specifies that a value is not in the expression.
" + }, + "NotLikeExpression":{ + "type":"structure", + "required":[ + "columnName", + "value" + ], + "members":{ + "columnName":{ + "shape":"String", + "documentation":"The name of the column.
" + }, + "value":{ + "shape":"String", + "documentation":"The value that might not be like the expression.
" + } + }, + "documentation":"Specifies that a value might be not like the expression.
" + }, "NotificationOutput":{ "type":"structure", "required":[ @@ -11364,6 +12053,21 @@ }, "documentation":"The details of a Amazon DataZone project.
" }, + "ProvisioningConfiguration":{ + "type":"structure", + "members":{ + "lakeFormationConfiguration":{ + "shape":"LakeFormationConfiguration", + "documentation":"The Lake Formation configuration of the Data Lake blueprint.
" + } + }, + "documentation":"The provisioning configuration of the blueprint.
", + "union":true + }, + "ProvisioningConfigurationList":{ + "type":"list", + "member":{"shape":"ProvisioningConfiguration"} + }, "ProvisioningProperties":{ "type":"structure", "members":{ @@ -11403,6 +12107,10 @@ "shape":"RoleArn", "documentation":"The ARN of the manage access role.
" }, + "provisioningConfigurations":{ + "shape":"ProvisioningConfigurationList", + "documentation":"The provisioning configuration of a blueprint.
" + }, "provisioningRoleArn":{ "shape":"RoleArn", "documentation":"The ARN of the provisioning role.
" @@ -11440,6 +12148,10 @@ "shape":"RoleArn", "documentation":"The ARN of the manage access role.
" }, + "provisioningConfigurations":{ + "shape":"ProvisioningConfigurationList", + "documentation":"The provisioning configuration of a blueprint.
" + }, "provisioningRoleArn":{ "shape":"RoleArn", "documentation":"The ARN of the provisioning role.
" @@ -12005,6 +12717,99 @@ "type":"string", "pattern":"^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$" }, + "RowFilter":{ + "type":"structure", + "members":{ + "and":{ + "shape":"RowFilterList", + "documentation":"The 'and' clause of the row filter.
" + }, + "expression":{ + "shape":"RowFilterExpression", + "documentation":"The expression of the row filter.
" + }, + "or":{ + "shape":"RowFilterList", + "documentation":"The 'or' clause of the row filter.
" + } + }, + "documentation":"The row filter.
", + "union":true + }, + "RowFilterConfiguration":{ + "type":"structure", + "required":["rowFilter"], + "members":{ + "rowFilter":{ + "shape":"RowFilter", + "documentation":"The row filter.
" + }, + "sensitive":{ + "shape":"Boolean", + "documentation":"Specifies whether the row filter is sensitive.
" + } + }, + "documentation":"The row filter configuration details.
" + }, + "RowFilterExpression":{ + "type":"structure", + "members":{ + "equalTo":{ + "shape":"EqualToExpression", + "documentation":"The 'equal to' clause of the row filter expression.
" + }, + "greaterThan":{ + "shape":"GreaterThanExpression", + "documentation":"The 'greater than' clause of the row filter expression.
" + }, + "greaterThanOrEqualTo":{ + "shape":"GreaterThanOrEqualToExpression", + "documentation":"The 'greater than or equal to' clause of the filter expression.
" + }, + "in":{ + "shape":"InExpression", + "documentation":"The 'in' clause of the row filter expression.
" + }, + "isNotNull":{ + "shape":"IsNotNullExpression", + "documentation":"The 'is not null' clause of the row filter expression.
" + }, + "isNull":{ + "shape":"IsNullExpression", + "documentation":"The 'is null' clause of the row filter expression.
" + }, + "lessThan":{ + "shape":"LessThanExpression", + "documentation":"The 'less than' clause of the row filter expression.
" + }, + "lessThanOrEqualTo":{ + "shape":"LessThanOrEqualToExpression", + "documentation":"The 'less than or equal to' clause of the row filter expression.
" + }, + "like":{ + "shape":"LikeExpression", + "documentation":"The 'like' clause of the row filter expression.
" + }, + "notEqualTo":{ + "shape":"NotEqualToExpression", + "documentation":"The 'no equal to' clause of the row filter expression.
" + }, + "notIn":{ + "shape":"NotInExpression", + "documentation":"The 'not in' clause of the row filter expression.
" + }, + "notLike":{ + "shape":"NotLikeExpression", + "documentation":"The 'not like' clause of the row filter expression.
" + } + }, + "documentation":"The row filter expression.
", + "union":true + }, + "RowFilterList":{ + "type":"list", + "member":{"shape":"RowFilter"} + }, "RunStatisticsForAssets":{ "type":"structure", "members":{ @@ -12031,6 +12836,18 @@ }, "documentation":"The asset statistics from the data source run.
" }, + "S3Location":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^s3://.+$" + }, + "S3LocationList":{ + "type":"list", + "member":{"shape":"S3Location"}, + "max":20, + "min":0 + }, "ScheduleConfiguration":{ "type":"structure", "members":{ @@ -12745,6 +13562,10 @@ } }, "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, "SubscribedAsset":{ "type":"structure", "required":[ @@ -13707,6 +14528,102 @@ "members":{ } }, + "UpdateAssetFilterInput":{ + "type":"structure", + "required":[ + "assetIdentifier", + "domainIdentifier", + "identifier" + ], + "members":{ + "assetIdentifier":{ + "shape":"AssetId", + "documentation":"The ID of the data asset.
", + "location":"uri", + "locationName":"assetIdentifier" + }, + "configuration":{ + "shape":"AssetFilterConfiguration", + "documentation":"The configuration of the asset filter.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the asset filter.
" + }, + "domainIdentifier":{ + "shape":"DomainId", + "documentation":"The ID of the domain where you want to update an asset filter.
", + "location":"uri", + "locationName":"domainIdentifier" + }, + "identifier":{ + "shape":"FilterId", + "documentation":"The ID of the asset filter.
", + "location":"uri", + "locationName":"identifier" + }, + "name":{ + "shape":"String", + "documentation":"The name of the asset filter.
" + } + } + }, + "UpdateAssetFilterOutput":{ + "type":"structure", + "required":[ + "assetId", + "configuration", + "domainId", + "id", + "name" + ], + "members":{ + "assetId":{ + "shape":"AssetId", + "documentation":"The ID of the data asset.
" + }, + "configuration":{ + "shape":"AssetFilterConfiguration", + "documentation":"The configuration of the asset filter.
" + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"The timestamp at which the asset filter was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the asset filter.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The ID of the domain where the asset filter was created.
" + }, + "effectiveColumnNames":{ + "shape":"ColumnNameList", + "documentation":"The column names of the asset filter.
" + }, + "effectiveRowFilter":{ + "shape":"String", + "documentation":"The row filter of the asset filter.
" + }, + "errorMessage":{ + "shape":"String", + "documentation":"The error message that is displayed if the action is not completed successfully.
" + }, + "id":{ + "shape":"FilterId", + "documentation":"The ID of the asset filter.
" + }, + "name":{ + "shape":"FilterName", + "documentation":"The name of the asset filter.
" + }, + "status":{ + "shape":"FilterStatus", + "documentation":"The status of the asset filter.
" + } + } + }, "UpdateDataSourceInput":{ "type":"structure", "required":[ diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index de4927d664..7ed4272e4d 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -23710,8 +23710,6 @@ }, "endpoints" : { "us-gov-east-1" : { - "hostname" : "autoscaling-plans.us-gov-east-1.amazonaws.com", - "protocols" : [ "http", "https" ], "variants" : [ { "hostname" : "autoscaling-plans.us-gov-east-1.amazonaws.com", "tags" : [ "fips" ] @@ -23723,8 +23721,6 @@ "protocols" : [ "http", "https" ] }, "us-gov-west-1" : { - "hostname" : "autoscaling-plans.us-gov-west-1.amazonaws.com", - "protocols" : [ "http", "https" ], "variants" : [ { "hostname" : "autoscaling-plans.us-gov-west-1.amazonaws.com", "tags" : [ "fips" ] diff --git a/botocore/data/ivs/2020-07-14/service-2.json b/botocore/data/ivs/2020-07-14/service-2.json index 635dd0c199..e97e89e4cf 100644 --- a/botocore/data/ivs/2020-07-14/service-2.json +++ b/botocore/data/ivs/2020-07-14/service-2.json @@ -2,9 +2,10 @@ "version":"2.0", "metadata":{ "apiVersion":"2020-07-14", + "auth":["aws.auth#sigv4"], "endpointPrefix":"ivs", - "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceAbbreviation":"Amazon IVS", "serviceFullName":"Amazon Interactive Video Service", "serviceId":"ivs", @@ -612,21 +613,21 @@ "AudioConfiguration":{ "type":"structure", "members":{ - "channels":{ - "shape":"Integer", - "documentation":"Number of audio channels.
" - }, "codec":{ "shape":"String", "documentation":"Codec used for the audio encoding.
" }, + "targetBitrate":{ + "shape":"Integer", + "documentation":"The expected ingest bitrate (bits per second). This is configured in the encoder.
" + }, "sampleRate":{ "shape":"Integer", "documentation":"Number of audio samples recorded per second.
" }, - "targetBitrate":{ + "channels":{ "shape":"Integer", - "documentation":"The expected ingest bitrate (bits per second). This is configured in the encoder.
" + "documentation":"Number of audio channels.
" } }, "documentation":"Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.
" @@ -689,13 +690,13 @@ "BatchGetStreamKeyResponse":{ "type":"structure", "members":{ - "errors":{ - "shape":"BatchErrors", - "documentation":"" - }, "streamKeys":{ "shape":"StreamKeys", "documentation":"" + }, + "errors":{ + "shape":"BatchErrors", + "documentation":"" } } }, @@ -710,6 +711,10 @@ "shape":"ChannelArn", "documentation":"Channel ARN.
" }, + "viewerId":{ + "shape":"ViewerId", + "documentation":"The ID of the viewer session to revoke.
" + }, "code":{ "shape":"errorCode", "documentation":"Error code.
" @@ -717,10 +722,6 @@ "message":{ "shape":"errorMessage", "documentation":"Error message, determined by the application.
" - }, - "viewerId":{ - "shape":"ViewerId", - "documentation":"The ID of the viewer session to revoke.
" } }, "documentation":"Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.
" @@ -784,53 +785,53 @@ "shape":"ChannelArn", "documentation":"Channel ARN.
" }, - "authorized":{ - "shape":"IsAuthorized", - "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
" - }, - "insecureIngest":{ - "shape":"InsecureIngest", - "documentation":"Whether the channel allows insecure RTMP ingest. Default: false.
Channel name.
" }, "latencyMode":{ "shape":"ChannelLatencyMode", "documentation":"Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
Channel name.
" + "type":{ + "shape":"ChannelType", + "documentation":"Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" + "recordingConfigurationArn":{ + "shape":"ChannelRecordingConfigurationArn", + "documentation":"Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: \"\" (empty string, recording is disabled).
" + }, + "ingestEndpoint":{ + "shape":"IngestEndpoint", + "documentation":"Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
" }, "playbackUrl":{ "shape":"PlaybackURL", "documentation":"Channel playback URL.
" }, + "authorized":{ + "shape":"IsAuthorized", + "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Whether the channel allows insecure RTMP ingest. Default: false.
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: \"\" (empty string, recording is disabled).
" - }, "srt":{ "shape":"Srt", "documentation":"Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
" }, - "tags":{ - "shape":"Tags", - "documentation":"Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" } }, "documentation":"Object specifying a channel.
" @@ -839,7 +840,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$" + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+" }, "ChannelArnList":{ "type":"list", @@ -862,7 +863,7 @@ "type":"string", "max":128, "min":0, - "pattern":"^[a-zA-Z0-9-_]*$" + "pattern":"[a-zA-Z0-9-_]*" }, "ChannelNotBroadcasting":{ "type":"structure", @@ -898,29 +899,17 @@ "shape":"ChannelArn", "documentation":"Channel ARN.
" }, - "authorized":{ - "shape":"IsAuthorized", - "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Whether the channel allows insecure RTMP ingest. Default: false.
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
Channel name.
" }, - "playbackRestrictionPolicyArn":{ - "shape":"ChannelPlaybackRestrictionPolicyArn", - "documentation":"Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" + "latencyMode":{ + "shape":"ChannelLatencyMode", + "documentation":"Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Whether the channel is private (enabled for playback authorization). Default: false.
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Whether the channel allows insecure RTMP ingest. Default: false.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" } }, "documentation":"Summary information about a channel.
" @@ -968,29 +969,21 @@ "CreateChannelRequest":{ "type":"structure", "members":{ - "authorized":{ - "shape":"Boolean", - "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Whether the channel allows insecure RTMP and SRT ingest. Default: false.
Channel name.
" }, "latencyMode":{ "shape":"ChannelLatencyMode", "documentation":"Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
Channel name.
" - }, - "playbackRestrictionPolicyArn":{ - "shape":"ChannelPlaybackRestrictionPolicyArn", - "documentation":"Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" + "type":{ + "shape":"ChannelType", + "documentation":"Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Whether the channel is private (enabled for playback authorization). Default: false.
Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Whether the channel allows insecure RTMP and SRT ingest. Default: false.
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" } } }, @@ -1057,21 +1058,13 @@ "type":"structure", "required":["destinationConfiguration"], "members":{ - "destinationConfiguration":{ - "shape":"DestinationConfiguration", - "documentation":"A complex type that contains a destination configuration for where recorded video will be stored.
" - }, "name":{ "shape":"RecordingConfigurationName", "documentation":"Recording-configuration name. The value does not need to be unique.
" }, - "recordingReconnectWindowSeconds":{ - "shape":"RecordingReconnectWindowSeconds", - "documentation":"If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
" - }, - "renditionConfiguration":{ - "shape":"RenditionConfiguration", - "documentation":"Object that describes which renditions should be recorded for a stream.
" + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"A complex type that contains a destination configuration for where recorded video will be stored.
" }, "tags":{ "shape":"Tags", @@ -1080,6 +1073,14 @@ "thumbnailConfiguration":{ "shape":"ThumbnailConfiguration", "documentation":"A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
" + }, + "recordingReconnectWindowSeconds":{ + "shape":"RecordingReconnectWindowSeconds", + "documentation":"If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
" + }, + "renditionConfiguration":{ + "shape":"RenditionConfiguration", + "documentation":"Object that describes which renditions should be recorded for a stream.
" } } }, @@ -1321,14 +1322,14 @@ "type":"structure", "required":["publicKeyMaterial"], "members":{ - "name":{ - "shape":"PlaybackKeyPairName", - "documentation":"Playback-key-pair name. The value does not need to be unique.
" - }, "publicKeyMaterial":{ "shape":"PlaybackPublicKeyMaterial", "documentation":"The public portion of a customer-generated key pair.
" }, + "name":{ + "shape":"PlaybackKeyPairName", + "documentation":"Playback-key-pair name. The value does not need to be unique.
" + }, "tags":{ "shape":"Tags", "documentation":"Any tags provided with the request are added to the playback key pair tags. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
" @@ -1347,13 +1348,13 @@ "IngestConfiguration":{ "type":"structure", "members":{ - "audio":{ - "shape":"AudioConfiguration", - "documentation":"Encoder settings for audio.
" - }, "video":{ "shape":"VideoConfiguration", "documentation":"Encoder settings for video.
" + }, + "audio":{ + "shape":"AudioConfiguration", + "documentation":"Encoder settings for audio.
" } }, "documentation":"Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.
" @@ -1382,21 +1383,21 @@ "shape":"ChannelName", "documentation":"Filters the channel list to match the specified name.
" }, - "filterByPlaybackRestrictionPolicyArn":{ - "shape":"ChannelPlaybackRestrictionPolicyArn", - "documentation":"Filters the channel list to match the specified policy.
" - }, "filterByRecordingConfigurationArn":{ "shape":"ChannelRecordingConfigurationArn", "documentation":"Filters the channel list to match the specified recording-configuration ARN.
" }, - "maxResults":{ - "shape":"MaxChannelResults", - "documentation":"Maximum number of channels to return. Default: 100.
" + "filterByPlaybackRestrictionPolicyArn":{ + "shape":"ChannelPlaybackRestrictionPolicyArn", + "documentation":"Filters the channel list to match the specified policy.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The first channel to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of channels to return. Default: 100.
" } } }, @@ -1417,13 +1418,13 @@ "ListPlaybackKeyPairsRequest":{ "type":"structure", "members":{ - "maxResults":{ - "shape":"MaxPlaybackKeyPairResults", - "documentation":"Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"The first key pair to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.
" } } }, @@ -1444,13 +1445,13 @@ "ListPlaybackRestrictionPoliciesRequest":{ "type":"structure", "members":{ - "maxResults":{ - "shape":"MaxPlaybackRestrictionPolicyResults", - "documentation":"Maximum number of policies to return. Default: 1.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"The first policy to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of policies to return. Default: 1.
" } } }, @@ -1458,26 +1459,26 @@ "type":"structure", "required":["playbackRestrictionPolicies"], "members":{ - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If there are more channels than maxResults, use nextToken in the request to get the next set.
List of the matching policies.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more channels than maxResults, use nextToken in the request to get the next set.
Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.
" } } }, @@ -1485,13 +1486,13 @@ "type":"structure", "required":["recordingConfigurations"], "members":{ - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If there are more recording configurations than maxResults, use nextToken in the request to get the next set.
List of the matching recording configurations.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more recording configurations than maxResults, use nextToken in the request to get the next set.
Channel ARN used to filter the list.
" }, - "maxResults":{ - "shape":"MaxStreamKeyResults", - "documentation":"Maximum number of streamKeys to return. Default: 1.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"The first stream key to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of streamKeys to return. Default: 1.
" } } }, @@ -1517,13 +1518,13 @@ "type":"structure", "required":["streamKeys"], "members":{ - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If there are more stream keys than maxResults, use nextToken in the request to get the next set.
List of stream keys.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more stream keys than maxResults, use nextToken in the request to get the next set.
Channel ARN used to filter the list.
" }, - "maxResults":{ - "shape":"MaxStreamResults", - "documentation":"Maximum number of streams to return. Default: 100.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"The first stream to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of streams to return. Default: 100.
" } } }, @@ -1549,13 +1550,13 @@ "type":"structure", "required":["streamSessions"], "members":{ - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If there are more streams than maxResults, use nextToken in the request to get the next set.
List of stream sessions.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more streams than maxResults, use nextToken in the request to get the next set.
Filters the stream list to match the specified criterion.
" }, - "maxResults":{ - "shape":"MaxStreamResults", - "documentation":"Maximum number of streams to return. Default: 100.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"The first stream to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of streams to return. Default: 100.
" } } }, @@ -1580,13 +1581,13 @@ "type":"structure", "required":["streams"], "members":{ - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If there are more streams than maxResults, use nextToken in the request to get the next set.
List of streams.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more streams than maxResults, use nextToken in the request to get the next set.
Key-pair ARN.
" }, - "fingerprint":{ - "shape":"PlaybackKeyPairFingerprint", - "documentation":"Key-pair identifier.
" - }, "name":{ "shape":"PlaybackKeyPairName", "documentation":"Playback-key-pair name. The value does not need to be unique.
" }, + "fingerprint":{ + "shape":"PlaybackKeyPairFingerprint", + "documentation":"Key-pair identifier.
" + }, "tags":{ "shape":"Tags", "documentation":"Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Playback-restriction-policy ARN
" + }, "allowedCountries":{ "shape":"PlaybackRestrictionPolicyAllowedCountryList", "documentation":"A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
" @@ -1743,10 +1748,6 @@ "shape":"PlaybackRestrictionPolicyAllowedOriginList", "documentation":"A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
" }, - "arn":{ - "shape":"PlaybackRestrictionPolicyArn", - "documentation":"Playback-restriction-policy ARN
" - }, "enableStrictOriginEnforcement":{ "shape":"PlaybackRestrictionPolicyEnableStrictOriginEnforcement", "documentation":"Whether channel playback is constrained by origin site. Default: false.
Playback-restriction-policy ARN
" + }, "allowedCountries":{ "shape":"PlaybackRestrictionPolicyAllowedCountryList", "documentation":"A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
" @@ -1816,10 +1821,6 @@ "shape":"PlaybackRestrictionPolicyAllowedOriginList", "documentation":"A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
" }, - "arn":{ - "shape":"PlaybackRestrictionPolicyArn", - "documentation":"Playback-restriction-policy ARN
" - }, "enableStrictOriginEnforcement":{ "shape":"PlaybackRestrictionPolicyEnableStrictOriginEnforcement", "documentation":"Whether channel playback is constrained by origin site. Default: false.
Recording-configuration ARN.
" }, - "destinationConfiguration":{ - "shape":"DestinationConfiguration", - "documentation":"A complex type that contains information about where recorded video will be stored.
" - }, "name":{ "shape":"RecordingConfigurationName", "documentation":"Recording-configuration name. The value does not need to be unique.
" }, - "recordingReconnectWindowSeconds":{ - "shape":"RecordingReconnectWindowSeconds", - "documentation":"If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
" - }, - "renditionConfiguration":{ - "shape":"RenditionConfiguration", - "documentation":"Object that describes which renditions should be recorded for a stream.
" + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"A complex type that contains information about where recorded video will be stored.
" }, "state":{ "shape":"RecordingConfigurationState", @@ -1892,6 +1885,14 @@ "thumbnailConfiguration":{ "shape":"ThumbnailConfiguration", "documentation":"A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
" + }, + "recordingReconnectWindowSeconds":{ + "shape":"RecordingReconnectWindowSeconds", + "documentation":"If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
" + }, + "renditionConfiguration":{ + "shape":"RenditionConfiguration", + "documentation":"Object that describes which renditions should be recorded for a stream.
" } }, "documentation":"An object representing a configuration to record a channel stream.
" @@ -1900,7 +1901,7 @@ "type":"string", "max":128, "min":0, - "pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$" + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+" }, "RecordingConfigurationList":{ "type":"list", @@ -1910,7 +1911,7 @@ "type":"string", "max":128, "min":0, - "pattern":"^[a-zA-Z0-9-_]*$" + "pattern":"[a-zA-Z0-9-_]*" }, "RecordingConfigurationState":{ "type":"string", @@ -1932,14 +1933,14 @@ "shape":"RecordingConfigurationArn", "documentation":"Recording-configuration ARN.
" }, - "destinationConfiguration":{ - "shape":"DestinationConfiguration", - "documentation":"A complex type that contains information about where recorded video will be stored.
" - }, "name":{ "shape":"RecordingConfigurationName", "documentation":"Recording-configuration name. The value does not need to be unique.
" }, + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"A complex type that contains information about where recorded video will be stored.
" + }, "state":{ "shape":"RecordingConfigurationState", "documentation":"Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
Channel ARN for the stream.
" }, - "health":{ - "shape":"StreamHealth", - "documentation":"The stream’s health.
" + "streamId":{ + "shape":"StreamId", + "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" }, "playbackUrl":{ "shape":"PlaybackURL", @@ -2134,9 +2135,9 @@ "shape":"StreamState", "documentation":"The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a \"NotBroadcasting\" error will indicate that the stream is not live.
Unique identifier for a live or previously live stream in the specified channel.
" + "health":{ + "shape":"StreamHealth", + "documentation":"The stream’s health.
" }, "viewerCount":{ "shape":"StreamViewerCount", @@ -2148,10 +2149,6 @@ "StreamEvent":{ "type":"structure", "members":{ - "eventTime":{ - "shape":"Time", - "documentation":"Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.
" - }, "name":{ "shape":"String", "documentation":"Name that identifies the stream event within a type.
Logical group for certain events.
" + }, + "eventTime":{ + "shape":"Time", + "documentation":"Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.
" } }, "documentation":"Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.
" @@ -2191,7 +2192,7 @@ "type":"string", "max":26, "min":26, - "pattern":"^st-[a-zA-Z0-9]+$" + "pattern":"st-[a-zA-Z0-9]+" }, "StreamKey":{ "type":"structure", @@ -2200,6 +2201,10 @@ "shape":"StreamKeyArn", "documentation":"Stream-key ARN.
" }, + "value":{ + "shape":"StreamKeyValue", + "documentation":"Stream-key value.
" + }, "channelArn":{ "shape":"ChannelArn", "documentation":"Channel ARN for the stream.
" @@ -2207,10 +2212,6 @@ "tags":{ "shape":"Tags", "documentation":"Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Stream-key value.
" } }, "documentation":"Object specifying a stream key.
" @@ -2219,7 +2220,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+$" + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+" }, "StreamKeyArnList":{ "type":"list", @@ -2269,14 +2270,22 @@ "StreamSession":{ "type":"structure", "members":{ - "channel":{ - "shape":"Channel", - "documentation":"The properties of the channel at the time of going live.
" + "streamId":{ + "shape":"StreamId", + "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" + }, + "startTime":{ + "shape":"Time", + "documentation":"Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
" }, "endTime":{ "shape":"Time", "documentation":"Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
The properties of the channel at the time of going live.
" + }, "ingestConfiguration":{ "shape":"IngestConfiguration", "documentation":"The properties of the incoming RTMP stream for the stream.
" @@ -2285,14 +2294,6 @@ "shape":"RecordingConfiguration", "documentation":"The properties of recording the live stream.
" }, - "startTime":{ - "shape":"Time", - "documentation":"Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
" - }, - "streamId":{ - "shape":"StreamId", - "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" - }, "truncatedEvents":{ "shape":"StreamEvents", "documentation":"List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
" @@ -2307,6 +2308,14 @@ "StreamSessionSummary":{ "type":"structure", "members":{ + "streamId":{ + "shape":"StreamId", + "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" + }, + "startTime":{ + "shape":"Time", + "documentation":"Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, "endTime":{ "shape":"Time", "documentation":"Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
If true, this stream encountered a quota breach or failure.
Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
" - }, - "streamId":{ - "shape":"StreamId", - "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" } }, "documentation":"Summary information about a stream session.
" @@ -2344,25 +2345,25 @@ "shape":"ChannelArn", "documentation":"Channel ARN for the stream.
" }, - "health":{ - "shape":"StreamHealth", - "documentation":"The stream’s health.
" - }, - "startTime":{ - "shape":"StreamStartTime", - "documentation":"Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
" + "streamId":{ + "shape":"StreamId", + "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" }, "state":{ "shape":"StreamState", "documentation":"The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a \"NotBroadcasting\" error will indicate that the stream is not live.
Unique identifier for a live or previously live stream in the specified channel.
" + "health":{ + "shape":"StreamHealth", + "documentation":"The stream’s health.
" }, "viewerCount":{ "shape":"StreamViewerCount", "documentation":"A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
" } }, "documentation":"Summary information about a stream.
" @@ -2457,6 +2458,10 @@ "shape":"RecordingMode", "documentation":"Thumbnail recording mode. Default: INTERVAL.
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.
Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.
Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).
" @@ -2464,10 +2469,6 @@ "storage":{ "shape":"ThumbnailConfigurationStorageList", "documentation":"Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.
Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.
An object representing a configuration of thumbnails for recorded video.
" @@ -2475,9 +2476,9 @@ "ThumbnailConfigurationResolution":{ "type":"string", "enum":[ - "FULL_HD", - "HD", "SD", + "HD", + "FULL_HD", "LOWEST_RESOLUTION" ] }, @@ -2537,37 +2538,37 @@ "shape":"ChannelArn", "documentation":"ARN of the channel to be updated.
" }, + "name":{ + "shape":"ChannelName", + "documentation":"Channel name.
" + }, + "latencyMode":{ + "shape":"ChannelLatencyMode", + "documentation":"Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Whether the channel is private (enabled for playback authorization).
" }, + "recordingConfigurationArn":{ + "shape":"ChannelRecordingConfigurationArn", + "documentation":"Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.
" + }, "insecureIngest":{ "shape":"Boolean", "documentation":"Whether the channel allows insecure RTMP and SRT ingest. Default: false.
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers.
Channel name.
" - }, - "playbackRestrictionPolicyArn":{ - "shape":"ChannelPlaybackRestrictionPolicyArn", - "documentation":"Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.
" - }, "preset":{ "shape":"TranscodePreset", "documentation":"Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.
" - }, - "type":{ - "shape":"ChannelType", - "documentation":"Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.
" } } }, @@ -2584,6 +2585,10 @@ "type":"structure", "required":["arn"], "members":{ + "arn":{ + "shape":"PlaybackRestrictionPolicyArn", + "documentation":"ARN of the playback-restriction-policy to be updated.
" + }, "allowedCountries":{ "shape":"PlaybackRestrictionPolicyAllowedCountryList", "documentation":"A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
" @@ -2592,10 +2597,6 @@ "shape":"PlaybackRestrictionPolicyAllowedOriginList", "documentation":"A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
" }, - "arn":{ - "shape":"PlaybackRestrictionPolicyArn", - "documentation":"ARN of the playback-restriction-policy to be updated.
" - }, "enableStrictOriginEnforcement":{ "shape":"PlaybackRestrictionPolicyEnableStrictOriginEnforcement", "documentation":"Whether channel playback is constrained by origin site. Default: false.
Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.
" - }, "avcProfile":{ "shape":"String", "documentation":"Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.
" }, + "avcLevel":{ + "shape":"String", + "documentation":"Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.
" + }, "codec":{ "shape":"String", "documentation":"Codec used for the video encoding.
" @@ -2680,5 +2681,5 @@ "errorCode":{"type":"string"}, "errorMessage":{"type":"string"} }, - "documentation":"Introduction
The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.
All API request parameters and URLs are case sensitive.
For a summary of notable documentation changes in each release, see Document History.
Allowed Header Values
Accept: application/json
Accept-Encoding: gzip, deflate
Content-Type: application/json
Key Concepts
Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.
Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. Treat the stream key like a secret, since it allows anyone to stream to the channel.
Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.
Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.
Playback restriction policy — Restricts playback by countries and/or origin sites.
For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.
Tagging
A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.
At most 50 tags can be applied to a resource.
Authentication versus Authorization
Note the differences between these concepts:
Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed to view Amazon IVS private channels. (Private channels are channels that are enabled for \"playback authorization.\")
Authentication
All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.
You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the ivs:PutMetadata permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
Channel Endpoints
CreateChannel — Creates a new channel and an associated stream key to start streaming.
GetChannel — Gets the channel configuration for the specified channel ARN.
BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.
ListChannels — Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 Conflict Exception).
UpdateChannel — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
DeleteChannel — Deletes the specified channel.
Playback Restriction Policy Endpoints
CreatePlaybackRestrictionPolicy — Creates a new playback restriction policy, for constraining playback by countries and/or origins.
DeletePlaybackRestrictionPolicy — Deletes the specified playback restriction policy
GetPlaybackRestrictionPolicy — Gets the specified playback restriction policy.
ListPlaybackRestrictionPolicies — Gets summary information about playback restriction policies.
UpdatePlaybackRestrictionPolicy — Updates a specified playback restriction policy.
Private Channel Endpoints
For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
ImportPlaybackKeyPair — Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels (channels enabled for playback authorization).
GetPlaybackKeyPair — Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels.
ListPlaybackKeyPairs — Gets summary information about playback key pairs.
DeletePlaybackKeyPair — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.
StartViewerSessionRevocation — Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version.
BatchStartViewerSessionRevocation — Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
Recording Configuration Endpoints
CreateRecordingConfiguration — Creates a new recording configuration, used to enable recording to Amazon S3.
GetRecordingConfiguration — Gets the recording-configuration metadata for the specified ARN.
ListRecordingConfigurations — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN.
Stream Endpoints
GetStream — Gets information about the active (live) stream on a specified channel.
GetStreamSession — Gets metadata on a specified stream.
ListStreams — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
ListStreamSessions — Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.
StopStream — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
PutMetadata — Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed.
Stream Key Endpoints
CreateStreamKey — Creates a stream key, used to initiate a stream, for the specified channel ARN.
GetStreamKey — Gets stream key information for the specified ARN.
BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.
ListStreamKeys — Gets summary information about stream keys for the specified channel.
DeleteStreamKey — Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Amazon Web Services Tags Endpoints
TagResource — Adds or updates tags for the Amazon Web Services resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.
Introduction
The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.
All API request parameters and URLs are case sensitive.
For a summary of notable documentation changes in each release, see Document History.
Allowed Header Values
Accept: application/json
Accept-Encoding: gzip, deflate
Content-Type: application/json
Key Concepts
Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.
Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. Treat the stream key like a secret, since it allows anyone to stream to the channel.
Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.
Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.
Playback restriction policy — Restricts playback by countries and/or origin sites.
For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.
Tagging
A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.
At most 50 tags can be applied to a resource.
Authentication versus Authorization
Note the differences between these concepts:
Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed to view Amazon IVS private channels. (Private channels are channels that are enabled for \"playback authorization.\")
Authentication
All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.
You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the ivs:PutMetadata permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
" } diff --git a/botocore/data/neptune-graph/2023-11-29/service-2.json b/botocore/data/neptune-graph/2023-11-29/service-2.json index 58f09b07ad..be4317fc14 100644 --- a/botocore/data/neptune-graph/2023-11-29/service-2.json +++ b/botocore/data/neptune-graph/2023-11-29/service-2.json @@ -2,9 +2,10 @@ "version":"2.0", "metadata":{ "apiVersion":"2023-11-29", + "auth":["aws.auth#sigv4"], "endpointPrefix":"neptune-graph", - "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "ripServiceName":"neptune-graph", "serviceAbbreviation":"Neptune Graph", "serviceFullName":"Amazon Neptune Graph", @@ -2342,7 +2343,7 @@ "type":"integer", "box":true, "max":24576, - "min":128 + "min":32 }, "QueryLanguage":{ "type":"string", diff --git a/botocore/data/redshift-serverless/2021-04-21/service-2.json b/botocore/data/redshift-serverless/2021-04-21/service-2.json index 170fcd5185..26a91f59bb 100644 --- a/botocore/data/redshift-serverless/2021-04-21/service-2.json +++ b/botocore/data/redshift-serverless/2021-04-21/service-2.json @@ -172,7 +172,8 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, - {"shape":"TooManyTagsException"} + {"shape":"TooManyTagsException"}, + {"shape":"Ipv6CidrBlockNotFoundException"} ], "documentation":"Creates an workgroup in Amazon Redshift Serverless.
", "idempotent":true @@ -916,7 +917,8 @@ {"shape":"InsufficientCapacityException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, - {"shape":"ValidationException"} + {"shape":"ValidationException"}, + {"shape":"Ipv6CidrBlockNotFoundException"} ], "documentation":"Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
" + "documentation":"The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide
" }, "schedule":{ "shape":"Schedule", @@ -1383,6 +1385,10 @@ "shape":"Boolean", "documentation":"The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
" }, + "ipAddressType":{ + "shape":"IpAddressType", + "documentation":"The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" @@ -1999,6 +2005,19 @@ "documentation":"The provided pagination token is invalid.
", "exception":true }, + "IpAddressType":{ + "type":"string", + "pattern":"^(ipv4|dualstack)$" + }, + "Ipv6CidrBlockNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
", + "exception":true + }, "KmsKeyId":{"type":"string"}, "ListCustomDomainAssociationsRequest":{ "type":"structure", @@ -2538,6 +2557,10 @@ "shape":"String", "documentation":"The availability Zone.
" }, + "ipv6Address":{ + "shape":"String", + "documentation":"The IPv6 address of the network interface within the subnet.
" + }, "networkInterfaceId":{ "shape":"String", "documentation":"The unique identifier of the network interface.
" @@ -2925,7 +2948,7 @@ }, "roleArn":{ "shape":"IamRoleArn", - "documentation":"The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
" + "documentation":"The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide
" }, "schedule":{ "shape":"Schedule", @@ -3461,7 +3484,7 @@ }, "roleArn":{ "shape":"IamRoleArn", - "documentation":"The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
" + "documentation":"The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide
" }, "schedule":{ "shape":"Schedule", @@ -3581,6 +3604,10 @@ "shape":"Boolean", "documentation":"The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
" }, + "ipAddressType":{ + "shape":"IpAddressType", + "documentation":"The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" @@ -3777,6 +3804,10 @@ "shape":"Boolean", "documentation":"The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
" }, + "ipAddressType":{ + "shape":"IpAddressType", + "documentation":"The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" diff --git a/docs/source/conf.py b/docs/source/conf.py index 73c138269b..f956267691 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.34.1' # The full version, including alpha/beta/rc tags. -release = '1.34.145' +release = '1.34.146' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.