Name of the dependency package.
" + } + }, + "supportedVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Indicates the version of the supported dependency package.
" + } + }, + "isSemVer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Determines if the dependency package is using Semantic versioning. If set to true, it indicates that the dependency package uses Semantic versioning.
" + } + }, + "reason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Indicates the reason to include the dependency package in your project code.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Dependency package that may be required for the project code to run.
" + } + }, "com.amazonaws.amplifyuibuilder#CodegenFeatureFlags": { "type": "structure", "members": { @@ -1452,6 +1490,12 @@ "smithy.api#documentation": "The time that the code generation job was modified.
", "smithy.api#timestampFormat": "date-time" } + }, + "dependencies": { + "target": "com.amazonaws.amplifyuibuilder#CodegenDependencies", + "traits": { + "smithy.api#documentation": "Lists the dependency packages that may be required for the project code to run.
" + } } }, "traits": { @@ -3027,7 +3071,7 @@ } ], "traits": { - "smithy.api#documentation": "Exchanges an access code for a token.
", + "smithy.api#documentation": "This is for internal use.
\nAmplify uses this action to exchange an access code for a token.
", "smithy.api#http": { "uri": "/tokens/{provider}", "method": "POST" @@ -5246,6 +5290,18 @@ } } }, + "com.amazonaws.amplifyuibuilder#ReactCodegenDependencies": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#documentation": "Indicates the dependency version of the project code to be generated by Amazon Web Services Amplify. The version of the generated code output is determined by the version number contained in aws-amplify.
The API configuration for the code generation job.
" } + }, + "dependencies": { + "target": "com.amazonaws.amplifyuibuilder#ReactCodegenDependencies", + "traits": { + "smithy.api#documentation": "Lists the dependency packages that may be required for the project code to run.
" + } } }, "traits": { @@ -5306,7 +5368,7 @@ } ], "traits": { - "smithy.api#documentation": "Refreshes a previously issued access token that might have expired.
", + "smithy.api#documentation": "This is for internal use.
\nAmplify uses this action to refresh a previously issued access token that might have expired.
", "smithy.api#http": { "uri": "/tokens/{provider}/refresh", "method": "POST" diff --git a/codegen/sdk-codegen/aws-models/chime-sdk-media-pipelines.json b/codegen/sdk-codegen/aws-models/chime-sdk-media-pipelines.json index 391e9e027c0..5c3e3513e18 100644 --- a/codegen/sdk-codegen/aws-models/chime-sdk-media-pipelines.json +++ b/codegen/sdk-codegen/aws-models/chime-sdk-media-pipelines.json @@ -520,6 +520,16 @@ "smithy.api#pattern": "^44100|48000$" } }, + "com.amazonaws.chimesdkmediapipelines#AwsRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^([a-z]+-){2,}\\d+$" + } + }, "com.amazonaws.chimesdkmediapipelines#BadRequestException": { "type": "structure", "members": { @@ -759,6 +769,12 @@ { "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaLiveConnectorPipeline" }, + { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaPipelineKinesisVideoStreamPool" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaStreamPipeline" + }, { "target": "com.amazonaws.chimesdkmediapipelines#DeleteMediaCapturePipeline" }, @@ -768,6 +784,9 @@ { "target": "com.amazonaws.chimesdkmediapipelines#DeleteMediaPipeline" }, + { + "target": "com.amazonaws.chimesdkmediapipelines#DeleteMediaPipelineKinesisVideoStreamPool" + }, { "target": "com.amazonaws.chimesdkmediapipelines#GetMediaCapturePipeline" }, @@ -777,6 +796,9 @@ { "target": "com.amazonaws.chimesdkmediapipelines#GetMediaPipeline" }, + { + "target": "com.amazonaws.chimesdkmediapipelines#GetMediaPipelineKinesisVideoStreamPool" + }, { "target": "com.amazonaws.chimesdkmediapipelines#GetSpeakerSearchTask" }, @@ -789,6 +811,9 @@ { "target": "com.amazonaws.chimesdkmediapipelines#ListMediaInsightsPipelineConfigurations" }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaPipelineKinesisVideoStreamPools" + }, { "target": "com.amazonaws.chimesdkmediapipelines#ListMediaPipelines" }, @@ -818,6 +843,9 @@ }, { "target": "com.amazonaws.chimesdkmediapipelines#UpdateMediaInsightsPipelineStatus" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UpdateMediaPipelineKinesisVideoStreamPool" } ], "traits": { @@ -2365,6 +2393,190 @@ "smithy.api#output": {} } }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaPipelineKinesisVideoStreamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaPipelineKinesisVideoStreamPoolRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaPipelineKinesisVideoStreamPoolResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Kinesis video stream pool for the media pipeline.
", + "smithy.api#http": { + "method": "POST", + "uri": "/media-pipeline-kinesis-video-stream-pools", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaPipelineKinesisVideoStreamPoolRequest": { + "type": "structure", + "members": { + "StreamConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamConfiguration", + "traits": { + "smithy.api#documentation": "The configuration settings for the video stream.
", + "smithy.api#required": {} + } + }, + "PoolName": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolName", + "traits": { + "smithy.api#documentation": "The name of the video stream pool.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.chimesdkmediapipelines#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The token assigned to the client making the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.chimesdkmediapipelines#TagList", + "traits": { + "smithy.api#documentation": "The tags assigned to the video stream pool.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaPipelineKinesisVideoStreamPoolResponse": { + "type": "structure", + "members": { + "KinesisVideoStreamPoolConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for the Kinesis video stream pool.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaStreamPipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaStreamPipelineRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaStreamPipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a streaming media pipeline.
", + "smithy.api#http": { + "method": "POST", + "uri": "/sdk-media-stream-pipelines", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaStreamPipelineRequest": { + "type": "structure", + "members": { + "Sources": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaStreamSourceList", + "traits": { + "smithy.api#documentation": "The data sources for the media pipeline.
", + "smithy.api#required": {} + } + }, + "Sinks": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaStreamSinkList", + "traits": { + "smithy.api#documentation": "The data sink for the media pipeline.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.chimesdkmediapipelines#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The token assigned to the client making the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.chimesdkmediapipelines#TagList", + "traits": { + "smithy.api#documentation": "The tags assigned to the media pipeline.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaStreamPipelineResponse": { + "type": "structure", + "members": { + "MediaStreamPipeline": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaStreamPipeline", + "traits": { + "smithy.api#documentation": "The requested media pipeline.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.chimesdkmediapipelines#DataChannelConcatenationConfiguration": { "type": "structure", "members": { @@ -2380,6 +2592,22 @@ "smithy.api#documentation": "The content configuration object's data channel.
" } }, + "com.amazonaws.chimesdkmediapipelines#DataRetentionChangeInHours": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#DataRetentionInHours": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.chimesdkmediapipelines#DeleteMediaCapturePipeline": { "type": "operation", "input": { @@ -2538,6 +2766,65 @@ } } }, + "com.amazonaws.chimesdkmediapipelines#DeleteMediaPipelineKinesisVideoStreamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#DeleteMediaPipelineKinesisVideoStreamPoolRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Kinesis video stream pool.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/media-pipeline-kinesis-video-stream-pools/{Identifier}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#DeleteMediaPipelineKinesisVideoStreamPoolRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.chimesdkmediapipelines#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the pool being deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.chimesdkmediapipelines#DeleteMediaPipelineRequest": { "type": "structure", "members": { @@ -2873,6 +3160,76 @@ } } }, + "com.amazonaws.chimesdkmediapipelines#GetMediaPipelineKinesisVideoStreamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#GetMediaPipelineKinesisVideoStreamPoolRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#GetMediaPipelineKinesisVideoStreamPoolResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Kinesis video stream pool.
", + "smithy.api#http": { + "method": "GET", + "uri": "/media-pipeline-kinesis-video-stream-pools/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#GetMediaPipelineKinesisVideoStreamPoolRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.chimesdkmediapipelines#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the video stream pool.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chimesdkmediapipelines#GetMediaPipelineKinesisVideoStreamPoolResponse": { + "type": "structure", + "members": { + "KinesisVideoStreamPoolConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolConfiguration", + "traits": { + "smithy.api#documentation": "The video stream pool configuration object.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.chimesdkmediapipelines#GetMediaPipelineRequest": { "type": "structure", "members": { @@ -3035,7 +3392,7 @@ "VoiceToneAnalysisTaskId": { "target": "com.amazonaws.chimesdkmediapipelines#GuidString", "traits": { - "smithy.api#documentation": "The ID of the voice tone anlysis task.
", + "smithy.api#documentation": "The ID of the voice tone analysis task.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3185,7 +3542,7 @@ "TileAspectRatio": { "target": "com.amazonaws.chimesdkmediapipelines#TileAspectRatio", "traits": { - "smithy.api#documentation": "Sets the aspect ratio of the video tiles, such as 16:9.
" + "smithy.api#documentation": "Specifies the aspect ratio of all video tiles.
" } } }, @@ -3306,6 +3663,192 @@ "smithy.api#pattern": "^arn:[a-z\\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+$" } }, + "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamConfiguration": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.chimesdkmediapipelines#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region of the video stream.
", + "smithy.api#required": {} + } + }, + "DataRetentionInHours": { + "target": "com.amazonaws.chimesdkmediapipelines#DataRetentionInHours", + "traits": { + "smithy.api#documentation": "The amount of time that data is retained.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of an Kinesis video stream.
" + } + }, + "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamConfigurationUpdate": { + "type": "structure", + "members": { + "DataRetentionInHours": { + "target": "com.amazonaws.chimesdkmediapipelines#DataRetentionChangeInHours", + "traits": { + "smithy.api#documentation": "The updated time that data is retained.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The updated Kinesis video stream configuration object.
" + } + }, + "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolConfiguration": { + "type": "structure", + "members": { + "PoolArn": { + "target": "com.amazonaws.chimesdkmediapipelines#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the video stream pool configuration.
" + } + }, + "PoolName": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolName", + "traits": { + "smithy.api#documentation": "The name of the video stream pool configuration.
" + } + }, + "PoolId": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolId", + "traits": { + "smithy.api#documentation": "The ID of the video stream pool in the configuration.
" + } + }, + "PoolStatus": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolStatus", + "traits": { + "smithy.api#documentation": "The status of the video stream pool in the configuration.
" + } + }, + "PoolSize": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolSize", + "traits": { + "smithy.api#documentation": "The size of the video stream pool in the configuration.
" + } + }, + "StreamConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamConfiguration", + "traits": { + "smithy.api#documentation": "The Kinesis video stream pool configuration object.
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the configuration was created.
" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the configuration was updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The video stream pool configuration object.
" + } + }, + "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + }, + "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + }, + "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolSummary": { + "type": "structure", + "members": { + "PoolName": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolName", + "traits": { + "smithy.api#documentation": "The name of the video stream pool.
" + } + }, + "PoolId": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolId", + "traits": { + "smithy.api#documentation": "The ID of the video stream pool.
" + } + }, + "PoolArn": { + "target": "com.amazonaws.chimesdkmediapipelines#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the video stream pool.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the Kinesis video stream pool.
" + } + }, + "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolSummary" + } + }, "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamRecordingSourceRuntimeConfiguration": { "type": "structure", "members": { @@ -3410,24 +3953,111 @@ "smithy.api#pattern": "^[a-zA-Z-,]+$" } }, - "com.amazonaws.chimesdkmediapipelines#LayoutOption": { - "type": "enum", + "com.amazonaws.chimesdkmediapipelines#LayoutOption": { + "type": "enum", + "members": { + "GridView": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GridView" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelines": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of media pipelines.
", + "smithy.api#http": { + "method": "GET", + "uri": "/sdk-media-capture-pipelines", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "The token used to retrieve the next page of results.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmediapipelines#ResultMax", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call. Valid Range: 1 - 99.
", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesResponse": { + "type": "structure", "members": { - "GridView": { - "target": "smithy.api#Unit", + "MediaCapturePipelines": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaCapturePipelineSummaryList", "traits": { - "smithy.api#enumValue": "GridView" + "smithy.api#documentation": "The media pipeline objects in the list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "The token used to retrieve the next page of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelines": { + "com.amazonaws.chimesdkmediapipelines#ListMediaInsightsPipelineConfigurations": { "type": "operation", "input": { - "target": "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesRequest" + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaInsightsPipelineConfigurationsRequest" }, "output": { - "target": "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesResponse" + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaInsightsPipelineConfigurationsResponse" }, "errors": [ { @@ -3453,10 +4083,10 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of media pipelines.
", + "smithy.api#documentation": "Lists the available media insights pipeline configurations.
", "smithy.api#http": { "method": "GET", - "uri": "/sdk-media-capture-pipelines", + "uri": "/media-insights-pipeline-configurations", "code": 200 }, "smithy.api#paginated": { @@ -3466,20 +4096,20 @@ } } }, - "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesRequest": { + "com.amazonaws.chimesdkmediapipelines#ListMediaInsightsPipelineConfigurationsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.chimesdkmediapipelines#String", "traits": { - "smithy.api#documentation": "The token used to retrieve the next page of results.
", + "smithy.api#documentation": "The token used to return the next page of results.
", "smithy.api#httpQuery": "next-token" } }, "MaxResults": { "target": "com.amazonaws.chimesdkmediapipelines#ResultMax", "traits": { - "smithy.api#documentation": "The maximum number of results to return in a single call. Valid Range: 1 - 99.
", + "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#httpQuery": "max-results" } } @@ -3488,19 +4118,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesResponse": { + "com.amazonaws.chimesdkmediapipelines#ListMediaInsightsPipelineConfigurationsResponse": { "type": "structure", "members": { - "MediaCapturePipelines": { - "target": "com.amazonaws.chimesdkmediapipelines#MediaCapturePipelineSummaryList", + "MediaInsightsPipelineConfigurations": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaInsightsPipelineConfigurationSummaryList", "traits": { - "smithy.api#documentation": "The media pipeline objects in the list.
" + "smithy.api#documentation": "The requested list of media insights pipeline configurations.
" } }, "NextToken": { "target": "com.amazonaws.chimesdkmediapipelines#String", "traits": { - "smithy.api#documentation": "The token used to retrieve the next page of results.
" + "smithy.api#documentation": "The token used to return the next page of results.
" } } }, @@ -3508,13 +4138,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.chimesdkmediapipelines#ListMediaInsightsPipelineConfigurations": { + "com.amazonaws.chimesdkmediapipelines#ListMediaPipelineKinesisVideoStreamPools": { "type": "operation", "input": { - "target": "com.amazonaws.chimesdkmediapipelines#ListMediaInsightsPipelineConfigurationsRequest" + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaPipelineKinesisVideoStreamPoolsRequest" }, "output": { - "target": "com.amazonaws.chimesdkmediapipelines#ListMediaInsightsPipelineConfigurationsResponse" + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaPipelineKinesisVideoStreamPoolsResponse" }, "errors": [ { @@ -3540,10 +4170,10 @@ } ], "traits": { - "smithy.api#documentation": "Lists the available media insights pipeline configurations.
", + "smithy.api#documentation": "Lists the video stream pools in the media pipeline.
", "smithy.api#http": { "method": "GET", - "uri": "/media-insights-pipeline-configurations", + "uri": "/media-pipeline-kinesis-video-stream-pools", "code": 200 }, "smithy.api#paginated": { @@ -3553,13 +4183,13 @@ } } }, - "com.amazonaws.chimesdkmediapipelines#ListMediaInsightsPipelineConfigurationsRequest": { + "com.amazonaws.chimesdkmediapipelines#ListMediaPipelineKinesisVideoStreamPoolsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.chimesdkmediapipelines#String", "traits": { - "smithy.api#documentation": "The token used to return the next page of results.
", + "smithy.api#documentation": "The token used to return the next page of results.
", "smithy.api#httpQuery": "next-token" } }, @@ -3575,19 +4205,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.chimesdkmediapipelines#ListMediaInsightsPipelineConfigurationsResponse": { + "com.amazonaws.chimesdkmediapipelines#ListMediaPipelineKinesisVideoStreamPoolsResponse": { "type": "structure", "members": { - "MediaInsightsPipelineConfigurations": { - "target": "com.amazonaws.chimesdkmediapipelines#MediaInsightsPipelineConfigurationSummaryList", + "KinesisVideoStreamPools": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolSummaryList", "traits": { - "smithy.api#documentation": "The requested list of media insights pipeline configurations.
" + "smithy.api#documentation": "The list of video stream pools.
" } }, "NextToken": { "target": "com.amazonaws.chimesdkmediapipelines#String", "traits": { - "smithy.api#documentation": "The token used to return the next page of results.
" + "smithy.api#documentation": "The token used to return the next page of results.
" } } }, @@ -4477,6 +5107,12 @@ "traits": { "smithy.api#documentation": "The media insights pipeline of a media pipeline.
" } + }, + "MediaStreamPipeline": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaStreamPipeline", + "traits": { + "smithy.api#documentation": "Designates a media pipeline as a media stream pipeline.
" + } } }, "traits": { @@ -4698,6 +5334,165 @@ } } }, + "com.amazonaws.chimesdkmediapipelines#MediaStreamPipeline": { + "type": "structure", + "members": { + "MediaPipelineId": { + "target": "com.amazonaws.chimesdkmediapipelines#GuidString", + "traits": { + "smithy.api#documentation": "The ID of the media stream pipeline
" + } + }, + "MediaPipelineArn": { + "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the media stream pipeline.
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the media stream pipeline was created.
" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the media stream pipeline was updated.
" + } + }, + "Status": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineStatus", + "traits": { + "smithy.api#documentation": "The status of the media stream pipeline.
" + } + }, + "Sources": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaStreamSourceList", + "traits": { + "smithy.api#documentation": "The media stream pipeline's data sources.
" + } + }, + "Sinks": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaStreamSinkList", + "traits": { + "smithy.api#documentation": "The media stream pipeline's data sinks.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Structure that contains the settings for a media stream pipeline.
" + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaStreamPipelineSinkType": { + "type": "enum", + "members": { + "KinesisVideoStreamPool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KinesisVideoStreamPool" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaStreamSink": { + "type": "structure", + "members": { + "SinkArn": { + "target": "com.amazonaws.chimesdkmediapipelines#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the media stream sink.
", + "smithy.api#required": {} + } + }, + "SinkType": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaStreamPipelineSinkType", + "traits": { + "smithy.api#documentation": "The media stream sink's type.
", + "smithy.api#required": {} + } + }, + "ReservedStreamCapacity": { + "target": "com.amazonaws.chimesdkmediapipelines#ReservedStreamCapacity", + "traits": { + "smithy.api#documentation": "Specifies the number of streams that the sink can accept.
", + "smithy.api#required": {} + } + }, + "MediaStreamType": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaStreamType", + "traits": { + "smithy.api#documentation": "The media stream sink's media stream type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Structure that contains the settings for a media stream sink.
" + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaStreamSinkList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaStreamSink" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaStreamSource": { + "type": "structure", + "members": { + "SourceType": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineSourceType", + "traits": { + "smithy.api#documentation": "The type of media stream source.
", + "smithy.api#required": {} + } + }, + "SourceArn": { + "target": "com.amazonaws.chimesdkmediapipelines#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the media stream source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Structure that contains the settings for media stream sources.
" + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaStreamSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaStreamSource" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaStreamType": { + "type": "enum", + "members": { + "MixedAudio": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MixedAudio" + } + }, + "IndividualAudio": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IndividualAudio" + } + } + } + }, "com.amazonaws.chimesdkmediapipelines#MeetingEventsConcatenationConfiguration": { "type": "structure", "members": { @@ -5023,6 +5818,15 @@ } } }, + "com.amazonaws.chimesdkmediapipelines#ReservedStreamCapacity": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.chimesdkmediapipelines#ResolutionOption": { "type": "enum", "members": { @@ -6205,6 +7009,85 @@ "smithy.api#input": {} } }, + "com.amazonaws.chimesdkmediapipelines#UpdateMediaPipelineKinesisVideoStreamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#UpdateMediaPipelineKinesisVideoStreamPoolRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#UpdateMediaPipelineKinesisVideoStreamPoolResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an Kinesis video stream pool in a media pipeline.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/media-pipeline-kinesis-video-stream-pools/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#UpdateMediaPipelineKinesisVideoStreamPoolRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.chimesdkmediapipelines#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the video stream pool.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StreamConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamConfigurationUpdate", + "traits": { + "smithy.api#documentation": "The configuration settings for the video stream.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chimesdkmediapipelines#UpdateMediaPipelineKinesisVideoStreamPoolResponse": { + "type": "structure", + "members": { + "KinesisVideoStreamPoolConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolConfiguration", + "traits": { + "smithy.api#documentation": "The video stream pool configuration object.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.chimesdkmediapipelines#VerticalLayoutConfiguration": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/emr-serverless.json b/codegen/sdk-codegen/aws-models/emr-serverless.json index 7357a119ffa..a4490ed4b36 100644 --- a/codegen/sdk-codegen/aws-models/emr-serverless.json +++ b/codegen/sdk-codegen/aws-models/emr-serverless.json @@ -119,6 +119,15 @@ "traits": { "smithy.api#documentation": "The specification applied to each worker type.
" } + }, + "runtimeConfiguration": { + "target": "com.amazonaws.emrserverless#ConfigurationList", + "traits": { + "smithy.api#documentation": "The Configuration \n specifications of an application. Each configuration consists of a classification and properties. You use this \n parameter when creating or updating an application. To see the runtimeConfiguration object of an application,\n run the GetApplication API operation.
" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrserverless#MonitoringConfiguration" } }, "traits": { @@ -1433,6 +1442,18 @@ "traits": { "smithy.api#documentation": "The key-value pairs that specify worker type to\n WorkerTypeSpecificationInput. This parameter must contain all valid worker\n types for a Spark or Hive application. Valid worker types include Driver and\n Executor for Spark applications and HiveDriver and\n TezTask for Hive applications. You can either set image details in this\n parameter for each worker type, or in imageConfiguration for all worker\n types.
The Configuration \n specifications to use when creating an application. Each configuration consists of a classification and properties.\n This configuration is applied to all the job runs submitted under the application.
" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrserverless#MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "The configuration setting for monitoring.
" + } } } }, @@ -3410,6 +3431,18 @@ "traits": { "smithy.api#documentation": "The Amazon EMR release label for the application. You can change the release\n label to use a different release of Amazon EMR.
" } + }, + "runtimeConfiguration": { + "target": "com.amazonaws.emrserverless#ConfigurationList", + "traits": { + "smithy.api#documentation": "The Configuration \n specifications to use when updating an application. Each configuration consists of a classification and properties.\n This configuration is applied across all the job runs submitted under the application.
" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrserverless#MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "The configuration setting for monitoring.
" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/finspace-data.json b/codegen/sdk-codegen/aws-models/finspace-data.json index 7a05fb6f548..7c27b7cda55 100644 --- a/codegen/sdk-codegen/aws-models/finspace-data.json +++ b/codegen/sdk-codegen/aws-models/finspace-data.json @@ -956,7 +956,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.
", + "smithy.api#documentation": "Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
", "smithy.api#http": { "method": "POST", "uri": "/permission-group/{permissionGroupId}/users/{userId}", @@ -1041,7 +1041,8 @@ } }, "traits": { - "smithy.api#documentation": "The credentials required to access the external Dataview from the S3 location.
" + "smithy.api#documentation": "The credentials required to access the external Dataview from the S3 location.
", + "smithy.api#sensitive": {} } }, "com.amazonaws.finspacedata#Boolean": { @@ -1873,7 +1874,7 @@ "smithy.api#documentation": "The last name of the user that you want to register.
" } }, - "ApiAccess": { + "apiAccess": { "target": "com.amazonaws.finspacedata#ApiAccess", "traits": { "smithy.api#documentation": "The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
\n ENABLED – The user has permissions to use the APIs.
\n DISABLED – The user does not have permissions to use any APIs.
Short term API credentials.
" + "smithy.api#documentation": "Short term API credentials.
", + "smithy.api#sensitive": {} } }, "com.amazonaws.finspacedata#DataViewArn": { @@ -2551,7 +2553,7 @@ "userId": { "target": "com.amazonaws.finspacedata#UserId", "traits": { - "smithy.api#documentation": "The unique identifier for the user account that you want to disable.
", + "smithy.api#documentation": "The unique identifier for the user that you want to deactivate.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2574,7 +2576,7 @@ "userId": { "target": "com.amazonaws.finspacedata#UserId", "traits": { - "smithy.api#documentation": "The unique identifier for the disabled user account.
" + "smithy.api#documentation": "The unique identifier for the deactivated user.
" } } }, @@ -2611,7 +2613,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes a user account from a permission group.
", + "smithy.api#documentation": "Removes a user from a permission group.
", "smithy.api#http": { "method": "DELETE", "uri": "/permission-group/{permissionGroupId}/users/{userId}", @@ -2724,7 +2726,7 @@ "userId": { "target": "com.amazonaws.finspacedata#UserId", "traits": { - "smithy.api#documentation": "The unique identifier for the user account that you want to enable.
", + "smithy.api#documentation": "The unique identifier for the user that you want to activate.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2747,7 +2749,7 @@ "userId": { "target": "com.amazonaws.finspacedata#UserId", "traits": { - "smithy.api#documentation": "The unique identifier for the enabled user account.
" + "smithy.api#documentation": "The unique identifier for the active user.
" } } }, @@ -3450,7 +3452,7 @@ } ], "traits": { - "smithy.api#documentation": "Request programmatic credentials to use with FinSpace SDK.
", + "smithy.api#documentation": "Request programmatic credentials to use with FinSpace SDK. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.
", "smithy.api#http": { "method": "GET", "uri": "/credentials/programmatic", @@ -3561,13 +3563,13 @@ "userId": { "target": "com.amazonaws.finspacedata#UserId", "traits": { - "smithy.api#documentation": "The unique identifier for the user account that is retrieved.
" + "smithy.api#documentation": "The unique identifier for the user that is retrieved.
" } }, "status": { "target": "com.amazonaws.finspacedata#UserStatus", "traits": { - "smithy.api#documentation": "The current status of the user account.
\n\n CREATING – The user account creation is in progress.
\n ENABLED – The user account is created and is currently active.
\n DISABLED – The user account is currently inactive.
The current status of the user.
\n\n CREATING – The creation is in progress.
\n ENABLED – The user is created and is currently active.
\n DISABLED – The user is currently inactive.
The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
" + "smithy.api#documentation": "The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.
" } }, "lastEnabledTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
" + "smithy.api#documentation": "Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
" } }, "lastDisabledTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
" + "smithy.api#documentation": "Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.
" } }, "lastModifiedTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
" + "smithy.api#documentation": "Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.
" } }, "lastLoginTime": { @@ -4137,7 +4139,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all the permission groups that are associated with a specific user account.
", + "smithy.api#documentation": "Lists all the permission groups that are associated with a specific user.
", "smithy.api#http": { "method": "GET", "uri": "/user/{userId}/permission-groups", @@ -4264,7 +4266,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all available user accounts in FinSpace.
", + "smithy.api#documentation": "Lists all available users in FinSpace.
", "smithy.api#http": { "method": "GET", "uri": "/user", @@ -4394,7 +4396,7 @@ "users": { "target": "com.amazonaws.finspacedata#UserList", "traits": { - "smithy.api#documentation": "A list of all the user accounts.
" + "smithy.api#documentation": "A list of all the users.
" } }, "nextToken": { @@ -4486,7 +4488,7 @@ "membershipStatus": { "target": "com.amazonaws.finspacedata#PermissionGroupMembershipStatus", "traits": { - "smithy.api#documentation": "Indicates the status of the user account within a permission group.
\n\n ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
\n ADDITION_SUCCESS – The user account is successfully added to the permission group.
\n REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
Indicates the status of the user within a permission group.
\n\n ADDITION_IN_PROGRESS – The user is currently being added to the permission group.
\n ADDITION_SUCCESS – The user is successfully added to the permission group.
\n REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
Indicates the status of the user account within a permission group.
\n\n ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
\n ADDITION_SUCCESS – The user account is successfully added to the permission group.
\n REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
Indicates the status of the user within a permission group.
\n\n ADDITION_IN_PROGRESS – The user is currently being added to the permission group.
\n ADDITION_SUCCESS – The user is successfully added to the permission group.
\n REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
The structure of a permission group associated with a user account.
" + "smithy.api#documentation": "The structure of a permission group associated with a user.
" } }, "com.amazonaws.finspacedata#PermissionGroupByUserList": { @@ -4690,7 +4692,7 @@ "temporaryPassword": { "target": "com.amazonaws.finspacedata#Password", "traits": { - "smithy.api#documentation": "A randomly generated temporary password for the requested user account. This password expires in 7 days.
" + "smithy.api#documentation": "A randomly generated temporary password for the requested user. This password expires in 7 days.
" } } }, @@ -4858,8 +4860,8 @@ "traits": { "smithy.api#default": 0, "smithy.api#range": { - "min": 60, - "max": 720 + "min": 1, + "max": 60 } } }, @@ -5301,7 +5303,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the details of the specified user account. You cannot update the userId for a user.
Modifies the details of the specified user. You cannot update the userId for a user.
The unique identifier for the user account to update.
", + "smithy.api#documentation": "The unique identifier for the user that you want to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5368,7 +5370,7 @@ "userId": { "target": "com.amazonaws.finspacedata#UserId", "traits": { - "smithy.api#documentation": "The unique identifier of the updated user account.
" + "smithy.api#documentation": "The unique identifier of the updated user.
" } } }, @@ -5388,7 +5390,7 @@ "status": { "target": "com.amazonaws.finspacedata#UserStatus", "traits": { - "smithy.api#documentation": "The current status of the user account.
\n\n CREATING – The user account creation is in progress.
\n ENABLED – The user account is created and is currently active.
\n DISABLED – The user account is currently inactive.
The current status of the user.
\n\n CREATING – The user creation is in progress.
\n ENABLED – The user is created and is currently active.
\n DISABLED – The user is currently inactive.
The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
" + "smithy.api#documentation": "The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.
" } }, "lastEnabledTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.\n
" + "smithy.api#documentation": "Describes the last time the user was activated. The value is determined as epoch time in milliseconds.\n
" } }, "lastDisabledTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
" + "smithy.api#documentation": "Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.
" } }, "lastModifiedTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.\n
" + "smithy.api#documentation": "Describes the last time the user was updated. The value is determined as epoch time in milliseconds.\n
" } }, "lastLoginTime": { @@ -5464,7 +5466,7 @@ } }, "traits": { - "smithy.api#documentation": "The details of the user account.
" + "smithy.api#documentation": "The details of the user.
" } }, "com.amazonaws.finspacedata#UserByPermissionGroup": { @@ -5479,7 +5481,7 @@ "status": { "target": "com.amazonaws.finspacedata#UserStatus", "traits": { - "smithy.api#documentation": "The current status of the user account.
\n\n CREATING – The user account creation is in progress.
\n ENABLED – The user account is created and is currently active.
\n DISABLED – The user account is currently inactive.
The current status of the user.
\n\n CREATING – The user creation is in progress.
\n ENABLED – The user is created and is currently active.
\n DISABLED – The user is currently inactive.
Indicates the status of the user account within a permission group.
\n\n ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
\n ADDITION_SUCCESS – The user account is successfully added to the permission group.
\n REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
Indicates the status of the user within a permission group.
\n\n ADDITION_IN_PROGRESS – The user is currently being added to the permission group.
\n ADDITION_SUCCESS – The user is successfully added to the permission group.
\n REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
The structure of a user account associated with a permission group.
" + "smithy.api#documentation": "The structure of a user associated with a permission group.
" } }, "com.amazonaws.finspacedata#UserByPermissionGroupList": { diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index 0a51d1c1556..73ef12cf8a1 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -30287,6 +30287,12 @@ "traits": { "smithy.api#enumValue": "DATASET" } + }, + "TOPIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOPIC" + } } } }, @@ -36380,6 +36386,12 @@ "traits": { "smithy.api#documentation": "The identity ID for a user in the external login provider.
" } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "The tags to associate with the user.
" + } } }, "traits": { @@ -42341,7 +42353,7 @@ } ], "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
\nTags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, template, and topic.
\nTagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:
\nYou can't use tags to track costs for Amazon QuickSight. This isn't\n\t\t\t\tpossible because you can't tag the resources that Amazon QuickSight costs are based \n\t\t\t\ton, for example Amazon QuickSight storage capacity (SPICE), number of users, type \n\t\t\t\tof users, and usage metrics.
\nAmazon QuickSight doesn't currently support the tag editor for Resource Groups.
\nAssigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
\nTags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, template, topic, and user.
\nTagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:
\nTags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
\nAmazon QuickSight doesn't currently support the tag editor for Resource Groups.
\nAmazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure\n end-to-end management solution for hybrid cloud environments that enables safe and secure\n operations at scale.
\nThis reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.
\n\n Related resources\n
\nFor information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
\nFor details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the\n \n Systems Manager Automation runbook reference\n .
\nFor information about AppConfig, a capability of Systems Manager, see the \n AppConfig User Guide\n \n and the \n AppConfig\n API Reference\n .
\nFor information about Incident Manager, a capability of Systems Manager, see the \n Systems Manager Incident Manager User\n Guide\n and the \n Systems Manager Incident Manager API\n Reference\n .
\nAmazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure\n end-to-end management solution for hybrid cloud environments that enables safe and secure\n operations at scale.
\nThis reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.
\n\n Related resources\n
\nFor information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
\nFor details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the\n \n Systems Manager Automation runbook reference\n .
\nFor information about AppConfig, a capability of Systems Manager, see the \n AppConfig User Guide\n \n and the \n AppConfig\n API Reference\n .
\nFor information about Incident Manager, a capability of Systems Manager, see the \n Systems Manager Incident Manager User\n Guide\n and the \n Systems Manager Incident Manager API\n Reference\n .
\nInformation about the OpsItem.
", + "smithy.api#documentation": "User-defined text that contains information about the OpsItem, in Markdown format.\n
\nProvide enough information so that users viewing this OpsItem for the first time \n understand the issue.
\nThe type of OpsItem to create. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insights\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem to create. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insight\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insights\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insight\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insights\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insight\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nUpdate the information about the OpsItem. Provide enough information so that users reading\n this OpsItem for the first time understand the issue.
" + "smithy.api#documentation": "User-defined text that contains information about the OpsItem, in Markdown format.
" } }, "OperationalData": { diff --git a/codegen/sdk-codegen/aws-models/wafv2.json b/codegen/sdk-codegen/aws-models/wafv2.json index 54b6534cfc9..71f31071626 100644 --- a/codegen/sdk-codegen/aws-models/wafv2.json +++ b/codegen/sdk-codegen/aws-models/wafv2.json @@ -104,14 +104,14 @@ "CreationPath": { "target": "com.amazonaws.wafv2#CreationPathString", "traits": { - "smithy.api#documentation": "The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST requests.
For example, for the URL https://example.com/web/signup, you would provide the path /web/signup.
The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST requests.
For example, for the URL https://example.com/web/newaccount, you would provide\n\tthe path /web/newaccount. Account creation page paths that\n\tstart with the path that you provide are considered a match. For example\n\t/web/newaccount matches the account creation paths\n\t\t/web/newaccount, /web/newaccount/,\n\t\t/web/newaccountPage, and\n\t\t/web/newaccount/thisPage, but doesn't match the path\n\t\t/home/web/newaccount or\n\t\t/website/newaccount.
The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
\nThis page must accept GET text/html requests.
For example, for the URL https://example.com/web/register, you would provide the path /web/register.
The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
\nThis page must accept GET text/html requests.
For example, for the URL https://example.com/web/registration, you would provide\n\tthe path /web/registration. Registration page paths that\n\tstart with the path that you provide are considered a match. For example\n\t /web/registration matches the registration paths\n\t /web/registration, /web/registration/,\n\t /web/registrationPage, and\n\t /web/registration/thisPage, but doesn't match the path\n\t /home/web/registration or\n\t /website/registration.
The path of the login endpoint for your application. For example, for the URL\n https://example.com/web/login, you would provide the path\n /web/login.
The rule group inspects only HTTP POST requests to your specified login endpoint.
The path of the login endpoint for your application. For example, for the URL\n https://example.com/web/login, you would provide the path\n /web/login. Login paths that start with the path that you provide are considered a match. For example /web/login matches the login paths /web/login, /web/login/, /web/loginPage, and /web/login/thisPage, but doesn't match the login path /home/web/login or /website/login.
The rule group inspects only HTTP POST requests to your specified login endpoint.
A string value that you want WAF to search for. WAF searches only in the part of\n web requests that you designate for inspection in FieldToMatch. The\n maximum length of the value is 200 bytes.
\nValid values depend on the component that you specify for inspection in\n FieldToMatch:
\n Method: The HTTP method that you want WAF to search for. This\n indicates the type of operation specified in the request.
\n UriPath: The value that you want WAF to search for in the URI path,\n for example, /images/daily-ad.jpg.
\n HeaderOrder: The comma-separated list of header names to match for. WAF creates a \n string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.
If SearchString includes alphabetic characters A-Z and a-z, note that the\n value is case sensitive.
\n If you're using the WAF API\n
\nSpecify a base64-encoded version of the value. The maximum length of the value before\n you base64-encode it is 200 bytes.
\nFor example, suppose the value of Type is HEADER and the value\n of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME base64-encoding and include the resulting value,\n QmFkQm90, in the value of SearchString.
\n If you're using the CLI or one of the Amazon Web Services SDKs\n
\nThe value that you want WAF to search for. The SDK automatically base64 encodes the\n value.
", + "smithy.api#documentation": "A string value that you want WAF to search for. WAF searches only in the part of\n web requests that you designate for inspection in FieldToMatch. The\n maximum length of the value is 200 bytes.
\nValid values depend on the component that you specify for inspection in\n FieldToMatch:
\n Method: The HTTP method that you want WAF to search for. This\n indicates the type of operation specified in the request.
\n UriPath: The value that you want WAF to search for in the URI path,\n for example, /images/daily-ad.jpg.
\n JA3Fingerprint: The string to match against the web request's JA3 fingerprint header. The header contains a hash fingerprint of the TLS Client Hello packet for \n the request.
\n HeaderOrder: The comma-separated list of header names to match for. WAF creates a \n string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.
If SearchString includes alphabetic characters A-Z and a-z, note that the\n value is case sensitive.
\n If you're using the WAF API\n
\nSpecify a base64-encoded version of the value. The maximum length of the value before\n you base64-encode it is 200 bytes.
\nFor example, suppose the value of Type is HEADER and the value\n of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME base64-encoding and include the resulting value,\n QmFkQm90, in the value of SearchString.
\n If you're using the CLI or one of the Amazon Web Services SDKs\n
\nThe value that you want WAF to search for. The SDK automatically base64 encodes the\n value.
", "smithy.api#required": {} } }, @@ -1888,7 +1888,7 @@ "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": []\n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n
INVALID specification: \"Addresses\": [\"\"] INVALID
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nFor requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": []\n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n
INVALID specification: \"Addresses\": [\"\"] INVALID
The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" + "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" } }, "VisibilityConfig": { @@ -4210,7 +4210,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a WebACL per the specifications provided.
\nA web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
" + "smithy.api#documentation": "Creates a WebACL per the specifications provided.
\nA web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
" } }, "com.amazonaws.wafv2#CreateWebACLRequest": { @@ -4246,7 +4246,7 @@ "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" + "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" } }, "VisibilityConfig": { @@ -4408,7 +4408,7 @@ "ResponseHeaders": { "target": "com.amazonaws.wafv2#CustomHTTPHeaders", "traits": { - "smithy.api#documentation": "The HTTP headers to use in the response. Duplicate header names are not allowed.
\nFor information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.
" + "smithy.api#documentation": "The HTTP headers to use in the response. You can specify any header name except for content-type. Duplicate header names are not allowed.
For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.
" } } }, @@ -5456,6 +5456,12 @@ "traits": { "smithy.api#documentation": "Inspect a string containing the list of the request's header names, ordered as they appear in the web request\nthat WAF receives for inspection. \n WAF generates the string and then uses that as the field to match component in its inspection. \n WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.
Match against the request's JA3 fingerprint header. The header contains a hash fingerprint of the TLS Client Hello packet for the request.
\nYou can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to \n EXACTLY.
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": []\n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n
INVALID specification: \"Addresses\": [\"\"] INVALID
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nFor requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": []\n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n
INVALID specification: \"Addresses\": [\"\"] INVALID
The match status to assign to the web request if the request doesn't have a JA3 fingerprint.
\nYou can specify the following fallback behaviors:
\n\n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
\n NO_MATCH - Treat the web request as not matching the rule statement.
Match against the request's JA3 fingerprint header. The header contains a hash fingerprint of the TLS Client Hello packet for the request.
\nYou can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to \n EXACTLY.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group \n inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count.\n Each rule includes one top-level Statement that WAF uses to\n identify matching web requests, and parameters that govern how WAF handles them.
" + "smithy.api#documentation": "A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to manage in some way. \n Each rule includes one top-level Statement that WAF uses to\n identify matching web requests, and parameters that govern how WAF handles them.
" } }, "com.amazonaws.wafv2#RuleAction": { @@ -10743,7 +10764,7 @@ "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" + "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" } }, "VisibilityConfig": { @@ -10806,7 +10827,7 @@ } }, "traits": { - "smithy.api#documentation": "A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
\nYou cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You \n can only use a rule group reference statement at the top level inside a web ACL.
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
\nYou cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group\n reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
\nYou cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You \n can only use a rule group reference statement at the top level inside a web ACL.
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
\nYou cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group\n reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
\nYou cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group \n inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.
You can specify the following transformation types:
\n\n BASE64_DECODE - Decode a\n Base64-encoded string.
\n BASE64_DECODE_EXT - Decode a\n Base64-encoded string, but use a forgiving implementation that ignores\n characters that aren't valid.
\n CMD_LINE - Command-line transformations. These are\n helpful in reducing effectiveness of attackers who inject an operating system command-line \n command and use unusual formatting to disguise some or all of the command.
\nDelete the following characters: \\ \" ' ^\n
Delete spaces before the following characters: / (\n
Replace the following characters with a space: , ;\n
Replace multiple spaces with one space
\nConvert uppercase letters (A-Z) to lowercase (a-z)
\n\n COMPRESS_WHITE_SPACE - Replace these characters\n with a space character (decimal 32):
\n\n \\f, formfeed, decimal 12
\n \\t, tab, decimal 9
\n \\n, newline, decimal 10
\n \\r, carriage return, decimal 13
\n \\v, vertical tab, decimal 11
Non-breaking space, decimal 160
\n\n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
\n CSS_DECODE - Decode characters that were encoded\n using CSS 2.x escape rules syndata.html#characters. This function uses up to\n two bytes in the decoding process, so it can help to uncover ASCII characters that were\n encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in\n countering evasion, which is a combination of a backslash and non-hexadecimal characters.\n For example, ja\\vascript for javascript.
\n ESCAPE_SEQ_DECODE - Decode the following ANSI C\n escape sequences: \\a, \\b, \\f, \\n,\n \\r, \\t, \\v, \\\\, \\?,\n \\', \\\", \\xHH (hexadecimal), \\0OOO\n (octal). Encodings that aren't valid remain in the output.
\n HEX_DECODE - Decode a string of hexadecimal\n characters into a binary.
\n\n HTML_ENTITY_DECODE - Replace HTML-encoded\n characters with unencoded characters. HTML_ENTITY_DECODE performs these\n operations:
Replaces (ampersand)quot; with \"\n
Replaces (ampersand)nbsp; with a non-breaking space, decimal\n 160
Replaces (ampersand)lt; with a \"less than\" symbol
Replaces (ampersand)gt; with >\n
Replaces characters that are represented in hexadecimal format,\n (ampersand)#xhhhh;, with the corresponding characters
Replaces characters that are represented in decimal format,\n (ampersand)#nnnn;, with the corresponding characters
\n JS_DECODE - Decode JavaScript escape sequences. If\n a\n \\\n u\n HHHH\n code is in the full-width ASCII code range of FF01-FF5E, then the higher byte\n is used to detect and adjust the lower byte. If not, only the lower byte is used and the\n higher byte is zeroed, causing a possible loss of information.
\n LOWERCASE - Convert uppercase letters (A-Z) to\n lowercase (a-z).
\n\n MD5 - Calculate an MD5 hash from the data in the\n input. The computed hash is in a raw binary form.
\n\n NONE - Specify NONE if you don't want\n any text transformations.
\n NORMALIZE_PATH - Remove multiple slashes, directory\n self-references, and directory back-references that are not at the beginning of the input\n from an input string.
\n\n NORMALIZE_PATH_WIN - This is the same as\n NORMALIZE_PATH, but first converts backslash characters to forward slashes.
\n REMOVE_NULLS - Remove all NULL bytes\n from the input.
\n REPLACE_COMMENTS - Replace each occurrence of a\n C-style comment (/* ... */) with a single space. Multiple consecutive\n occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII\n 0x20). However, a standalone termination of a comment (*/) is not acted upon.
\n REPLACE_NULLS - Replace NULL bytes in the input\n with space characters (ASCII 0x20).
\n SQL_HEX_DECODE - Decode SQL hex data. Example\n (0x414243) will be decoded to (ABC).
\n URL_DECODE - Decode a URL-encoded value.
\n\n URL_DECODE_UNI - Like URL_DECODE, but\n with support for Microsoft-specific %u encoding. If the code is in the\n full-width ASCII code range of FF01-FF5E, the higher byte is used to detect\n and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is\n zeroed.
\n UTF8_TO_UNICODE - Convert all UTF-8 character\n sequences to Unicode. This helps input normalization, and minimizing false-positives and\n false-negatives for non-English languages.
", + "smithy.api#documentation": "For detailed descriptions of each of the transformation types, see Text transformations \n in the WAF Developer Guide.
", "smithy.api#required": {} } } @@ -11809,7 +11830,7 @@ "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nTo configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": []\n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n
INVALID specification: \"Addresses\": [\"\"] INVALID
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
\nFor requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.
For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
\nExample JSON Addresses specifications:
Empty array: \"Addresses\": []\n
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n
INVALID specification: \"Addresses\": [\"\"] INVALID
The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" + "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" } }, "VisibilityConfig": { @@ -12208,7 +12229,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified WebACL. While updating a web ACL, WAF provides\n continuous coverage to the resources that you have associated with the web ACL.
\nThis operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.
\nTo modify a web ACL, do the following:
\nRetrieve it by calling GetWebACL\n
\nUpdate its settings as needed
\nProvide the complete web ACL specification to this call
\nWhen you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
\nA web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
" + "smithy.api#documentation": "Updates the specified WebACL. While updating a web ACL, WAF provides\n continuous coverage to the resources that you have associated with the web ACL.
\nThis operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.
\nTo modify a web ACL, do the following:
\nRetrieve it by calling GetWebACL\n
\nUpdate its settings as needed
\nProvide the complete web ACL specification to this call
\nWhen you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
\nA web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
" } }, "com.amazonaws.wafv2#UpdateWebACLRequest": { @@ -12251,7 +12272,7 @@ "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" + "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" } }, "VisibilityConfig": { @@ -12705,7 +12726,7 @@ "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" + "smithy.api#documentation": "The Rule statements used to identify the web requests that you \n want to manage. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n
" } }, "VisibilityConfig": { @@ -12779,7 +12800,7 @@ } }, "traits": { - "smithy.api#documentation": "A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
" + "smithy.api#documentation": "A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
" } }, "com.amazonaws.wafv2#WebACLSummaries": { @@ -12839,7 +12860,7 @@ "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.