The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection\n reference when the connection is shared between Amazon Web Services.
\nThe ARN is never reused if the connection is deleted.
\nThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection\n reference when the connection is shared between Amazon Web Servicesservices.
\nThe ARN is never reused if the connection is deleted.
\nWhen to trigger Git sync to begin the stack update.
" } + }, + "PullRequestComment": { + "target": "com.amazonaws.codeconnections#PullRequestComment", + "traits": { + "smithy.api#documentation": "A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.
" + } } }, "traits": { @@ -2717,6 +2723,23 @@ } } }, + "com.amazonaws.codeconnections#PullRequestComment": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.codeconnections#RepositoryLinkArn": { "type": "string", "traits": { @@ -3463,6 +3486,12 @@ "traits": { "smithy.api#documentation": "When to trigger Git sync to begin the stack update.
" } + }, + "PullRequestComment": { + "target": "com.amazonaws.codeconnections#PullRequestComment", + "traits": { + "smithy.api#documentation": "A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.
" + } } }, "traits": { @@ -4071,6 +4100,12 @@ "traits": { "smithy.api#documentation": "When to trigger Git sync to begin the stack update.
" } + }, + "PullRequestComment": { + "target": "com.amazonaws.codeconnections#PullRequestComment", + "traits": { + "smithy.api#documentation": "TA toggle that specifies whether to enable or disable pull request comments for the sync configuration to be updated.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json index 112e5c5b08b..173acd3d08b 100644 --- a/codegen/sdk-codegen/aws-models/glue.json +++ b/codegen/sdk-codegen/aws-models/glue.json @@ -633,6 +633,9 @@ { "target": "com.amazonaws.glue#TagResource" }, + { + "target": "com.amazonaws.glue#TestConnection" + }, { "target": "com.amazonaws.glue#UntagResource" }, @@ -36229,6 +36232,102 @@ } } }, + "com.amazonaws.glue#TestConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#TestConnectionRequest" + }, + "output": { + "target": "com.amazonaws.glue#TestConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConflictException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Tests a connection to a service to validate the service credentials that you provide.
\nYou can either provide an existing connection name or a TestConnectionInput for testing a non-existing connection input. Providing both at the same time will cause an error.
If the action is successful, the service sends back an HTTP 200 response.
" + } + }, + "com.amazonaws.glue#TestConnectionInput": { + "type": "structure", + "members": { + "ConnectionType": { + "target": "com.amazonaws.glue#ConnectionType", + "traits": { + "smithy.api#documentation": "The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.
The key-value pairs that define parameters for the connection.
\nJDBC connections use the following connection properties:
\nRequired: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.
Required: All of (USERNAME, PASSWORD) or SECRET_ID.
Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.
SALESFORCE connections require the AuthenticationConfiguration member to be configured.
A structure containing the authentication configuration in the TestConnection request. Required for a connection to Salesforce using OAuth authentication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that is used to specify testing a connection to a service.
" + } + }, + "com.amazonaws.glue#TestConnectionRequest": { + "type": "structure", + "members": { + "ConnectionName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "Optional. The name of the connection to test. If only name is provided, the operation will get the connection and use that for testing.
" + } + }, + "TestConnectionInput": { + "target": "com.amazonaws.glue#TestConnectionInput", + "traits": { + "smithy.api#documentation": "A structure that is used to specify testing a connection to a service.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#TestConnectionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#ThrottlingException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/lambda.json b/codegen/sdk-codegen/aws-models/lambda.json index f015d547989..9e4dec4c63d 100644 --- a/codegen/sdk-codegen/aws-models/lambda.json +++ b/codegen/sdk-codegen/aws-models/lambda.json @@ -1650,6 +1650,23 @@ ], "traits": { "smithy.api#documentation": "Adds permissions to the resource-based policy of a version of an Lambda\n layer. Use this action to grant layer\n usage permission to other accounts. You can grant permission to a single account, all accounts in an organization,\n or all Amazon Web Services accounts.
\nTo revoke permission, call RemoveLayerVersionPermission with the statement ID that you\n specified when you added it.
", + "smithy.api#examples": [ + { + "title": "To add permissions to a layer version", + "documentation": "The following example grants permission for the account 223456789012 to use version 1 of a layer named my-layer.", + "input": { + "LayerName": "my-layer", + "VersionNumber": 1, + "StatementId": "xaccount", + "Action": "lambda:GetLayerVersion", + "Principal": "223456789012" + }, + "output": { + "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:GetLayerVersion\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1\"}", + "RevisionId": "35d87451-f796-4a3f-a618-95a3671b0a0c" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", @@ -1754,6 +1771,9 @@ { "target": "com.amazonaws.lambda#PreconditionFailedException" }, + { + "target": "com.amazonaws.lambda#PublicPolicyException" + }, { "target": "com.amazonaws.lambda#ResourceConflictException" }, @@ -1768,7 +1788,37 @@ } ], "traits": { - "smithy.api#documentation": "Grants an Amazon Web Servicesservice, Amazon Web Services account, or Amazon Web Services organization\n permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict\n access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name\n (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies\n to version $LATEST.
\nTo grant permission to another account, specify the account ID as the Principal. To grant\n permission to an organization defined in Organizations, specify the organization ID as the\n PrincipalOrgID. For Amazon Web Servicesservices, the principal is a domain-style identifier that\n the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Servicesservices, you can also specify the ARN of the associated resource as the SourceArn. If\n you grant permission to a service principal without specifying the source, other accounts could potentially\n configure resources in their account to invoke your Lambda function.
This operation adds a statement to a resource-based permissions policy for the function. For more information\n about function policies, see Using resource-based policies for Lambda.
", + "smithy.api#documentation": "Grants a principal \n permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict\n access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name\n (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies\n to version $LATEST.
\nTo grant permission to another account, specify the account ID as the Principal. To grant\n permission to an organization defined in Organizations, specify the organization ID as the\n PrincipalOrgID. For Amazon Web Servicesservices, the principal is a domain-style identifier that\n the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Servicesservices, you can also specify the ARN of the associated resource as the SourceArn. If\n you grant permission to a service principal without specifying the source, other accounts could potentially\n configure resources in their account to invoke your Lambda function.
This operation adds a statement to a resource-based permissions policy for the function. For more information\n about function policies, see Using resource-based policies for Lambda.
", + "smithy.api#examples": [ + { + "title": "To grant Amazon S3 permission to invoke a function", + "documentation": "The following example adds permission for Amazon S3 to invoke a Lambda function named my-function for notifications from a bucket named my-bucket-1xpuxmplzrlbh in account 123456789012.", + "input": { + "FunctionName": "my-function", + "StatementId": "s3", + "Action": "lambda:InvokeFunction", + "Principal": "s3.amazonaws.com", + "SourceArn": "arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*", + "SourceAccount": "123456789012" + }, + "output": { + "Statement": "{\"Sid\":\"s3\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"s3.amazonaws.com\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\",\"Condition\":{\"StringEquals\":{\"AWS:SourceAccount\":\"123456789012\"},\"ArnLike\":{\"AWS:SourceArn\":\"arn:aws:s3:::my-bucket-1xpuxmplzrlbh\"}}}" + } + }, + { + "title": "To grant another account permission to invoke a function", + "documentation": "The following example adds permission for account 223456789012 invoke a Lambda function named my-function.", + "input": { + "FunctionName": "my-function", + "StatementId": "xaccount", + "Action": "lambda:InvokeFunction", + "Principal": "223456789012" + }, + "output": { + "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\"}" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/2015-03-31/functions/{FunctionName}/policy", @@ -1804,7 +1854,7 @@ "Principal": { "target": "com.amazonaws.lambda#Principal", "traits": { - "smithy.api#documentation": "The Amazon Web Servicesservice or Amazon Web Services account that invokes the function. If you specify a\n service, use SourceArn or SourceAccount to limit who can invoke the function through\n that service.
The Amazon Web Servicesservice, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a\n service, use SourceArn or SourceAccount to limit who can invoke the function through\n that service.
Creates an alias for a\n Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a\n different version.
\nYou can also map an alias to split invocation requests between two versions. Use the\n RoutingConfig parameter to specify a second version and the percentage of invocation requests that\n it receives.
The code signing policies define the actions to take if the validation checks fail.
" } + }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "A list of tags to add to the code signing configuration.
" + } } }, "traits": { @@ -2537,6 +2612,26 @@ ], "traits": { "smithy.api#documentation": "Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.
\nFor details about how to configure different event sources, see the following topics.
\n\n \n Amazon Kinesis\n
\n\n \n Amazon SQS\n
\n\n \n Amazon MSK\n
\n\n \n Apache Kafka\n
\n\n \n Amazon DocumentDB\n
\nThe following error handling options are available only for stream sources (DynamoDB and Kinesis):
\n\n BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.
\n DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon SNS topic.
\n MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
\n MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
\n ParallelizationFactor – Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
\n\n \n Amazon Kinesis\n
\n\n \n Amazon SQS\n
\n\n \n Amazon MSK\n
\n\n \n Apache Kafka\n
\n\n \n Amazon DocumentDB\n
\n(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
" } }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "A list of tags to apply to the event source mapping.
" + } + }, "TumblingWindowInSeconds": { "target": "com.amazonaws.lambda#TumblingWindowInSeconds", "traits": { @@ -2736,6 +2837,66 @@ ], "traits": { "smithy.api#documentation": "Creates a Lambda function. To create a function, you need a deployment package and an execution role. The\n deployment package is a .zip file archive or container image that contains your function code. The execution role\n grants the function permission to use Amazon Web Servicesservices, such as Amazon CloudWatch Logs for log\n streaming and X-Ray for request tracing.
\nIf the deployment package is a container\n image, then you set the package type to Image. For a container image, the code property\n must include the URI of a container image in the Amazon ECR registry. You do not need to specify the\n handler and runtime properties.
If the deployment package is a .zip file archive, then\n you set the package type to Zip. For a .zip file archive, the code property specifies the location of\n the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must\n be compatible with the target instruction set architecture of the function (x86-64 or\n arm64). If you do not specify the architecture, then the default value is\n x86-64.
When you create a function, Lambda provisions an instance of the function and its supporting\n resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't\n invoke or modify the function. The State, StateReason, and StateReasonCode\n fields in the response from GetFunctionConfiguration indicate when the function is ready to\n invoke. For more information, see Lambda function states.
A function has an unpublished version, and can have published versions and aliases. The unpublished version\n changes when you update your function's code and configuration. A published version is a snapshot of your function\n code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be\n changed to map to a different version. Use the Publish parameter to create version 1 of\n your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify\n version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply\n to both the unpublished and published versions of the function, and include tags (TagResource)\n and per-function concurrency limits (PutFunctionConcurrency).
\nYou can use code signing if your deployment package is a .zip file archive. To enable code signing for this\n function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with\n UpdateFunctionCode, Lambda checks that the code package has a valid signature from\n a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted\n publishers for this function.
\nIf another Amazon Web Services account or an Amazon Web Servicesservice invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.
\nTo invoke your function directly, use Invoke. To invoke your function in response to events\n in other Amazon Web Servicesservices, create an event source mapping (CreateEventSourceMapping),\n or configure a function trigger in the other service. For more information, see Invoking Lambda\n functions.
", + "smithy.api#examples": [ + { + "title": "To create a function", + "documentation": "The following example creates a function with a deployment package in Amazon S3 and enables X-Ray tracing and environment variable encryption.", + "input": { + "FunctionName": "my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "Code": { + "S3Bucket": "my-bucket-1xpuxmplzrlbh", + "S3Key": "function.zip" + }, + "Description": "Process image objects from Amazon S3.", + "Timeout": 15, + "MemorySize": 256, + "Publish": true, + "Environment": { + "Variables": { + "BUCKET": "my-bucket-1xpuxmplzrlbh", + "PREFIX": "inbound" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "Tags": { + "DEPARTMENT": "Assets" + } + }, + "output": { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 15, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "1", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "State": "Active", + "LastUpdateStatus": "Successful" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/2015-03-31/functions", @@ -3074,6 +3235,16 @@ ], "traits": { "smithy.api#documentation": "Deletes a Lambda function alias.
", + "smithy.api#examples": [ + { + "title": "To delete a Lambda function alias", + "documentation": "The following example deletes an alias named BLUE from a function named my-function", + "input": { + "FunctionName": "my-function", + "Name": "BLUE" + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", @@ -3239,6 +3410,16 @@ ], "traits": { "smithy.api#documentation": "Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter.\n Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit\n permissions for DeleteAlias.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Servicesservices and resources that invoke your function\n directly, delete the trigger in the service where you originally configured it.
", + "smithy.api#examples": [ + { + "title": "To delete a version of a Lambda function", + "documentation": "The following example deletes version 1 of a Lambda function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/2015-03-31/functions/{FunctionName}", @@ -3326,6 +3507,15 @@ ], "traits": { "smithy.api#documentation": "Removes a concurrent execution limit from a function.
", + "smithy.api#examples": [ + { + "title": "To remove the reserved concurrent execution limit from a function", + "documentation": "The following example deletes the reserved concurrent execution limit from a function named my-function.", + "input": { + "FunctionName": "my-function" + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/2017-10-31/functions/{FunctionName}/concurrency", @@ -3376,6 +3566,16 @@ ], "traits": { "smithy.api#documentation": "Deletes the configuration for asynchronous invocation for a function, version, or alias.
\nTo configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
", + "smithy.api#examples": [ + { + "title": "To delete an asynchronous invocation configuration", + "documentation": "The following example deletes the asynchronous invocation configuration for the GREEN alias of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "GREEN" + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config", @@ -3501,6 +3701,16 @@ ], "traits": { "smithy.api#documentation": "Deletes a version of an Lambda\n layer. Deleted versions can no longer be viewed or added to functions. To avoid\n breaking functions, a copy of the version remains in Lambda until no functions refer to it.
", + "smithy.api#examples": [ + { + "title": "To delete a version of a Lambda layer", + "documentation": "The following example deletes version 2 of a layer named my-layer.", + "input": { + "LayerName": "my-layer", + "VersionNumber": 2 + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", @@ -3560,6 +3770,16 @@ ], "traits": { "smithy.api#documentation": "Deletes the provisioned concurrency configuration for a function.
", + "smithy.api#examples": [ + { + "title": "To delete a provisioned concurrency configuration", + "documentation": "The following example deletes the provisioned concurrency configuration for the GREEN alias of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "GREEN" + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", @@ -3620,7 +3840,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a resource-based policy from a function.
", + "smithy.api#documentation": "The option to create and modify full JSON resource-based policies, and to use the PutResourcePolicy, GetResourcePolicy, and DeleteResourcePolicy APIs, won't be \n available in all Amazon Web Services Regions until September 30, 2024.
\nDeletes a resource-based policy from a function.
", "smithy.api#http": { "method": "DELETE", "uri": "/2024-09-16/resource-policy/{ResourceArn}", @@ -4001,6 +4221,16 @@ } } }, + "com.amazonaws.lambda#EventSourceMappingArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 85, + "max": 120 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, "com.amazonaws.lambda#EventSourceMappingConfiguration": { "type": "structure", "members": { @@ -4177,6 +4407,12 @@ "traits": { "smithy.api#documentation": "An object that contains details about an error related to filter criteria encryption.
" } + }, + "EventSourceMappingArn": { + "target": "com.amazonaws.lambda#EventSourceMappingArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the event source mapping.
" + } } }, "traits": { @@ -4870,6 +5106,25 @@ ], "traits": { "smithy.api#documentation": "Retrieves details about your account's limits and usage in an Amazon Web Services Region.
", + "smithy.api#examples": [ + { + "title": "To get account settings", + "documentation": "This operation takes no parameters and returns details about storage and concurrency quotas in the current Region.", + "output": { + "AccountLimit": { + "CodeSizeUnzipped": 262144000, + "UnreservedConcurrentExecutions": 1000, + "ConcurrentExecutions": 1000, + "CodeSizeZipped": 52428800, + "TotalCodeSize": 80530636800 + }, + "AccountUsage": { + "FunctionCount": 4, + "TotalCodeSize": 9426 + } + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2016-08-19/account-settings", @@ -4928,6 +5183,23 @@ ], "traits": { "smithy.api#documentation": "Returns details about a Lambda function alias.
", + "smithy.api#examples": [ + { + "title": "To get a Lambda function alias", + "documentation": "The following example returns details about an alias named BLUE for a function named my-function", + "input": { + "FunctionName": "my-function", + "Name": "BLUE" + }, + "output": { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", + "Name": "BLUE", + "FunctionVersion": "3", + "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93", + "Description": "Production environment BLUE." + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", @@ -5089,6 +5361,52 @@ ], "traits": { "smithy.api#documentation": "Returns information about the function or function version, with a link to download the deployment package\n that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are\n returned.
", + "smithy.api#examples": [ + { + "title": "To get a Lambda function", + "documentation": "The following example returns code and configuration details for version 1 of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + }, + "output": { + "Configuration": { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 15, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "$LATEST", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "State": "Active", + "LastUpdateStatus": "Successful" + }, + "Code": { + "RepositoryType": "S3", + "Location": "https://awslambda-us-west-2-tasks.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-function-e7d9d1ed-xmpl-4f79-904a-4b87f2681f30?versionId=sH3TQwBOaUy..." + }, + "Tags": { + "DEPARTMENT": "Assets" + } + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2015-03-31/functions/{FunctionName}", @@ -5280,6 +5598,18 @@ ], "traits": { "smithy.api#documentation": "Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a\n function, use PutFunctionConcurrency.
", + "smithy.api#examples": [ + { + "title": "To get the reserved concurrency setting for a function", + "documentation": "The following example returns the reserved concurrency setting for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "ReservedConcurrentExecutions": 250 + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2019-09-30/functions/{FunctionName}/concurrency", @@ -5341,6 +5671,43 @@ ], "traits": { "smithy.api#documentation": "Returns the version-specific settings of a Lambda function or version. The output includes only options that\n can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.
\nTo get all of a function's details, including function-level settings, use GetFunction.
", + "smithy.api#examples": [ + { + "title": "To get a Lambda function's event source mapping", + "documentation": "The following example returns and configuration details for version 1 of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + }, + "output": { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 15, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "$LATEST", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "State": "Active", + "LastUpdateStatus": "Successful" + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2015-03-31/functions/{FunctionName}/configuration", @@ -5784,6 +6151,33 @@ ], "traits": { "smithy.api#documentation": "Returns information about a version of an Lambda\n layer, with a link to download the layer archive\n that's valid for 10 minutes.
", + "smithy.api#examples": [ + { + "title": "To get information about a Lambda layer version", + "documentation": "The following example returns information for version 1 of a layer named my-layer.", + "input": { + "LayerName": "my-layer", + "VersionNumber": 1 + }, + "output": { + "Content": { + "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", + "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", + "CodeSize": 169 + }, + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1", + "Description": "My Python layer", + "CreatedDate": "2018-11-14T23:03:52.894+0000", + "Version": 1, + "LicenseInfo": "MIT", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", @@ -5815,6 +6209,30 @@ ], "traits": { "smithy.api#documentation": "Returns information about a version of an Lambda\n layer, with a link to download the layer archive\n that's valid for 10 minutes.
", + "smithy.api#examples": [ + { + "title": "To get information about a Lambda layer version", + "documentation": "The following example returns information about the layer version with the specified Amazon Resource Name (ARN).", + "input": { + "Arn": "arn:aws:lambda:ca-central-1:123456789012:layer:blank-python-lib:3" + }, + "output": { + "Content": { + "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/blank-python-lib-e5212378-xmpl-44ee-8398-9d8ec5113949?versionId=WbZnvf...", + "CodeSha256": "6x+xmpl/M3BnQUk7gS9sGmfeFsR/npojXoA3fZUv4eU=", + "CodeSize": 9529009 + }, + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib", + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib:3", + "Description": "Dependencies for the blank-python sample app.", + "CreatedDate": "2020-03-31T00:35:18.949+0000", + "Version": 3, + "CompatibleRuntimes": [ + "python3.8" + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2018-10-31/layers?find=LayerVersion", @@ -6023,6 +6441,20 @@ ], "traits": { "smithy.api#documentation": "Returns the resource-based IAM policy for a function, version, or alias.
", + "smithy.api#examples": [ + { + "title": "To retrieve a Lambda function policy", + "documentation": "The following example returns the resource-based policy for version 1 of a Lambda function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + }, + "output": { + "Policy": "{\"Version\":\"2012-10-17\",\"Id\":\"default\",\"Statement\":[{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function:1\"}]}", + "RevisionId": "4843f2f6-7c59-4fda-b484-afd0bc0e22b8" + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2015-03-31/functions/{FunctionName}/policy", @@ -6100,6 +6532,38 @@ ], "traits": { "smithy.api#documentation": "Retrieves the provisioned concurrency configuration for a function's alias or version.
", + "smithy.api#examples": [ + { + "title": "To get a provisioned concurrency configuration", + "documentation": "The following example returns details for the provisioned concurrency configuration for the BLUE alias of the specified function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "BLUE" + }, + "output": { + "RequestedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 100, + "Status": "READY", + "LastModified": "2019-12-31T20:28:49+0000" + } + }, + { + "title": "To view a provisioned concurrency configuration", + "documentation": "The following example displays details for the provisioned concurrency configuration for the BLUE alias of the specified function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "BLUE" + }, + "output": { + "RequestedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 100, + "Status": "READY", + "LastModified": "2019-12-31T20:28:49+0000" + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", @@ -6198,7 +6662,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieve the public-access settings for a function.
", + "smithy.api#documentation": "The option to configure public-access settings, and to use the PutPublicAccessBlock and GetPublicAccessBlock APIs, won't be \n available in all Amazon Web Services Regions until September 30, 2024.
\nRetrieve the public-access settings for a function.
", "smithy.api#http": { "method": "GET", "uri": "/2024-09-16/public-access-block/{ResourceArn}", @@ -6259,7 +6723,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the resource-based policy attached to a function.
", + "smithy.api#documentation": "The option to create and modify full JSON resource-based policies, and to use the PutResourcePolicy, GetResourcePolicy, and DeleteResourcePolicy APIs, won't be \n available in all Amazon Web Services Regions until September 30, 2024.
\nRetrieves the resource-based policy attached to a function.
", "smithy.api#http": { "method": "GET", "uri": "/2024-09-16/resource-policy/{ResourceArn}", @@ -6837,6 +7301,35 @@ ], "traits": { "smithy.api#documentation": "Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or\n asynchronously. By default, Lambda invokes your function synchronously (i.e. theInvocationType\n is RequestResponse). To invoke a function asynchronously, set InvocationType to\n Event. Lambda passes the ClientContext object to your function for\n synchronous invocations only.
For synchronous invocation,\n details about the function response, including errors, are included in the response body and headers. For either\n invocation type, you can find more information in the execution log and trace.
\nWhen an error occurs, your function may be invoked multiple times. Retry behavior varies by error type,\n client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an\n error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in\n Lambda.
\nFor asynchronous invocation,\n Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity\n to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple\n times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.
\nThe status code in the API response doesn't reflect function errors. Error codes are reserved for errors that\n prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and\n configuration. For example, Lambda returns TooManyRequestsException if running the\n function would cause you to exceed a concurrency limit at either the account level\n (ConcurrentInvocationLimitExceeded) or function level\n (ReservedFunctionConcurrentInvocationLimitExceeded).
For functions with a long timeout, your client might disconnect during synchronous invocation while it waits\n for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long\n connections with timeout or keep-alive settings.
\nThis operation requires permission for the lambda:InvokeFunction action. For details on how to set up\n permissions for cross-account invocations, see Granting function\n access to other accounts.
", + "smithy.api#examples": [ + { + "title": "To invoke a Lambda function", + "documentation": "The following example invokes version 1 of a function named my-function with an empty event payload.", + "input": { + "FunctionName": "my-function", + "Payload": "{}", + "Qualifier": "1" + }, + "output": { + "StatusCode": 200, + "Payload": "200 SUCCESS" + } + }, + { + "title": "To invoke a Lambda function asynchronously", + "documentation": "The following example invokes version 1 of a function named my-function asynchronously.", + "input": { + "FunctionName": "my-function", + "Payload": "{}", + "InvocationType": "Event", + "Qualifier": "1" + }, + "output": { + "StatusCode": 202, + "Payload": "" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/2015-03-31/functions/{FunctionName}/invocations", @@ -6872,6 +7365,19 @@ "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "For asynchronous function invocation, use Invoke.
\nInvokes a function asynchronously.
\nIf you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not \n propagated to the function, even if X-Ray active tracing is turned on.
\nReturns a list of aliases\n for a Lambda function.
", + "smithy.api#examples": [ + { + "title": "To list a function's aliases", + "documentation": "The following example returns a list of aliases for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "Aliases": [ + { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA", + "RevisionId": "a410117f-xmpl-494e-8035-7e204bb7933b", + "FunctionVersion": "2", + "Name": "BLUE", + "Description": "Production environment BLUE.", + "RoutingConfig": { + "AdditionalVersionWeights": { + "1": 0.7 + } + } + }, + { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", + "RevisionId": "21d40116-xmpl-40ba-9360-3ea284da1bb5", + "FunctionVersion": "1", + "Name": "GREEN", + "Description": "Production environment GREEN." + } + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2015-03-31/functions/{FunctionName}/aliases", @@ -7882,6 +8420,28 @@ ], "traits": { "smithy.api#documentation": "Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a\n single event source.
Retrieves a list of configurations for asynchronous invocation for a function.
\nTo configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
", + "smithy.api#examples": [ + { + "title": "To view a list of asynchronous invocation configurations", + "documentation": "The following example returns a list of asynchronous invocation configurations for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "FunctionEventInvokeConfigs": [ + { + "LastModified": 1.577824406719E9, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", + "MaximumRetryAttempts": 2, + "MaximumEventAgeInSeconds": 1800 + }, + { + "LastModified": 1.577824396653E9, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", + "MaximumRetryAttempts": 0, + "MaximumEventAgeInSeconds": 3600 + } + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config/list", @@ -8147,6 +8732,58 @@ ], "traits": { "smithy.api#documentation": "Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50\n functions per call.
\nSet FunctionVersion to ALL to include all published versions of each function in\n addition to the unpublished version.
The ListFunctions operation returns a subset of the FunctionConfiguration fields.\n To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason,\n LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use GetFunction.
Lists the versions of an Lambda\n layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only\n versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only \n layer versions that are compatible with that architecture.
", + "smithy.api#examples": [ + { + "title": "To list versions of a layer", + "documentation": "The following example displays information about the versions for the layer named blank-java-lib", + "input": { + "LayerName": "blank-java-lib" + }, + "output": { + "LayerVersions": [ + { + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:7", + "Version": 7, + "Description": "Dependencies for the blank-java sample app.", + "CreatedDate": "2020-03-18T23:38:42.284+0000", + "CompatibleRuntimes": [ + "java8" + ] + }, + { + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:6", + "Version": 6, + "Description": "Dependencies for the blank-java sample app.", + "CreatedDate": "2020-03-17T07:24:21.960+0000", + "CompatibleRuntimes": [ + "java8" + ] + } + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2018-10-31/layers/{LayerName}/versions", @@ -8423,6 +9091,33 @@ ], "traits": { "smithy.api#documentation": "Lists Lambda\n layers and shows information about the latest version of each. Specify a\n runtime\n identifier to list only layers that indicate that they're compatible with that\n runtime. Specify a compatible architecture to include only layers that are compatible with\n that instruction set architecture.
", + "smithy.api#examples": [ + { + "title": "To list the layers that are compatible with your function's runtime", + "documentation": "The following example returns information about layers that are compatible with the Python 3.7 runtime.", + "input": { + "CompatibleRuntime": "python3.7" + }, + "output": { + "Layers": [ + { + "LayerName": "my-layer", + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", + "LatestMatchingVersion": { + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", + "Version": 2, + "Description": "My layer", + "CreatedDate": "2018-11-15T00:37:46.592+0000", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + } + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2018-10-31/layers", @@ -8516,6 +9211,35 @@ ], "traits": { "smithy.api#documentation": "Retrieves a list of provisioned concurrency configurations for a function.
", + "smithy.api#examples": [ + { + "title": "To get a list of provisioned concurrency configurations", + "documentation": "The following example returns a list of provisioned concurrency configurations for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "ProvisionedConcurrencyConfigs": [ + { + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", + "RequestedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 100, + "Status": "READY", + "LastModified": "2019-12-31T20:29:00+0000" + }, + { + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", + "RequestedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 100, + "Status": "READY", + "LastModified": "2019-12-31T20:28:49+0000" + } + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency?List=ALL", @@ -8602,7 +9326,22 @@ } ], "traits": { - "smithy.api#documentation": "Returns a function's tags. You can\n also view tags with GetFunction.
", + "smithy.api#documentation": "Returns a function, event source mapping, or code signing configuration's tags. You can\n also view funciton tags with GetFunction.
", + "smithy.api#examples": [ + { + "title": "To retrieve the list of tags for a Lambda function", + "documentation": "The following example displays the tags attached to the my-function Lambda function.", + "input": { + "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function" + }, + "output": { + "Tags": { + "Category": "Web Tools", + "Department": "Sales" + } + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2017-03-31/tags/{Resource}", @@ -8614,9 +9353,9 @@ "type": "structure", "members": { "Resource": { - "target": "com.amazonaws.lambda#FunctionArn", + "target": "com.amazonaws.lambda#TaggableResource", "traits": { - "smithy.api#documentation": "The function's Amazon Resource Name (ARN). \n Note: Lambda does not support adding tags to aliases or versions.
", + "smithy.api#documentation": "The resource's Amazon Resource Name (ARN). \n Note: Lambda does not support adding tags to function aliases or versions.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8664,6 +9403,69 @@ ], "traits": { "smithy.api#documentation": "Returns a list of versions,\n with the version-specific configuration of each. Lambda returns up to 50 versions per call.
", + "smithy.api#examples": [ + { + "title": "To list versions of a function", + "documentation": "The following example returns a list of versions of a function named my-function", + "input": { + "FunctionName": "my-function" + }, + "output": { + "Versions": [ + { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 15, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "$LATEST", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "850ca006-2d98-4ff4-86db-8766e9d32fe9" + }, + { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 5, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "1", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727" + } + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/2015-03-31/functions/{FunctionName}/versions", @@ -9316,6 +10118,42 @@ ], "traits": { "smithy.api#documentation": "Creates an Lambda\n layer from a ZIP archive. Each time you call PublishLayerVersion with the same\n layer name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
", + "smithy.api#examples": [ + { + "title": "To create a Lambda layer version", + "documentation": "The following example creates a new Python library layer version. The command retrieves the layer content a file named layer.zip in the specified S3 bucket.", + "input": { + "LayerName": "my-layer", + "Description": "My Python layer", + "Content": { + "S3Bucket": "lambda-layers-us-west-2-123456789012", + "S3Key": "layer.zip" + }, + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ], + "LicenseInfo": "MIT" + }, + "output": { + "Content": { + "Location": "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", + "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", + "CodeSize": 169 + }, + "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer", + "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1", + "Description": "My Python layer", + "CreatedDate": "2018-11-14T23:03:52.894+0000", + "Version": 1, + "LicenseInfo": "MIT", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/2018-10-31/layers/{LayerName}/versions", @@ -9466,6 +10304,44 @@ ], "traits": { "smithy.api#documentation": "Creates a version from the\n current code and configuration of a function. Use versions to create a snapshot of your function code and\n configuration that doesn't change.
\nLambda doesn't publish a version if the function's configuration and code haven't changed since the last\n version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the\n function before publishing a version.
\nClients can invoke versions directly or with an alias. To create an alias, use CreateAlias.
", + "smithy.api#examples": [ + { + "title": "To publish a version of a Lambda function", + "documentation": "This operation publishes a version of a Lambda function", + "input": { + "FunctionName": "myFunction", + "CodeSha256": "", + "Description": "" + }, + "output": { + "FunctionName": "my-function", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Runtime": "nodejs12.x", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Handler": "index.handler", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Timeout": 5, + "MemorySize": 256, + "LastModified": "2020-04-10T19:06:32.563+0000", + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "Version": "1", + "Environment": { + "Variables": { + "PREFIX": "inbound", + "BUCKET": "my-bucket-1xpuxmplzrlbh" + } + }, + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "TracingConfig": { + "Mode": "Active" + }, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "State": "Active", + "LastUpdateStatus": "Successful" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/2015-03-31/functions/{FunctionName}/versions", @@ -9616,6 +10492,19 @@ ], "traits": { "smithy.api#documentation": "Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency\n level.
\nConcurrency settings apply to the function as a whole, including all published versions and the unpublished\n version. Reserving concurrency both ensures that your function has capacity to process the specified number of\n events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see\n the current setting for a function.
\nUse GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency\n for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for\n functions that aren't configured with a per-function limit. For more information, see Lambda function scaling.
", + "smithy.api#examples": [ + { + "title": "To configure a reserved concurrency limit for a function", + "documentation": "The following example configures 100 reserved concurrent executions for the my-function function.", + "input": { + "FunctionName": "my-function", + "ReservedConcurrentExecutions": 100 + }, + "output": { + "ReservedConcurrentExecutions": 100 + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/2017-10-31/functions/{FunctionName}/concurrency", @@ -9819,6 +10708,23 @@ ], "traits": { "smithy.api#documentation": "Adds a provisioned concurrency configuration to a function's alias or version.
", + "smithy.api#examples": [ + { + "title": "To allocate provisioned concurrency", + "documentation": "The following example allocates 100 provisioned concurrency for the BLUE alias of the specified function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "BLUE", + "ProvisionedConcurrentExecutions": 100 + }, + "output": { + "RequestedProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 0, + "Status": "IN_PROGRESS", + "LastModified": "2019-11-21T19:32:12+0000" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", @@ -9927,7 +10833,7 @@ } ], "traits": { - "smithy.api#documentation": "Configure your function's public-access settings.
\nTo control public access to a Lambda function, you can choose whether to allow the creation of \n resource-based policies that \n allow public access to that function. You can also block public access to a function, even if it has an existing resource-based \n policy that allows it.
", + "smithy.api#documentation": "The option to configure public-access settings, and to use the PutPublicAccessBlock and GetPublicAccessBlock APIs, won't be \n available in all Amazon Web Services Regions until September 30, 2024.
\nConfigure your function's public-access settings.
\nTo control public access to a Lambda function, you can choose whether to allow the creation of \n resource-based policies that \n allow public access to that function. You can also block public access to a function, even if it has an existing resource-based \n policy that allows it.
", "smithy.api#http": { "method": "PUT", "uri": "/2024-09-16/public-access-block/{ResourceArn}", @@ -10007,7 +10913,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds a resource-based policy \n to a function. You can use resource-based policies to grant access to other \n Amazon Web Services accounts, \n organizations, or \n services. Resource-based policies \n apply to a single function, version, or alias.
\nAdding a resource-based policy using this API action replaces any existing policy you've previously created. This means that if \n you've previously added resource-based permissions to a function using the AddPermission action, those \n permissions will be overwritten by your new policy.
\nThe option to create and modify full JSON resource-based policies, and to use the PutResourcePolicy, GetResourcePolicy, and DeleteResourcePolicy APIs, won't be \n available in all Amazon Web Services Regions until September 30, 2024.
\nAdds a resource-based policy \n to a function. You can use resource-based policies to grant access to other \n Amazon Web Services accounts, \n organizations, or \n services. Resource-based policies \n apply to a single function, version, or alias.
\nAdding a resource-based policy using this API action replaces any existing policy you've previously created. This means that if \n you've previously added resource-based permissions to a function using the AddPermission action, those \n permissions will be overwritten by your new policy.
\nRemoves a statement from the permissions policy for a version of an Lambda\n layer. For more information, see\n AddLayerVersionPermission.
", + "smithy.api#examples": [ + { + "title": "To delete layer-version permissions", + "documentation": "The following example deletes permission for an account to configure a layer version.", + "input": { + "LayerName": "my-layer", + "VersionNumber": 1, + "StatementId": "xaccount" + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy/{StatementId}", @@ -10322,6 +11239,9 @@ { "target": "com.amazonaws.lambda#PreconditionFailedException" }, + { + "target": "com.amazonaws.lambda#PublicPolicyException" + }, { "target": "com.amazonaws.lambda#ResourceNotFoundException" }, @@ -10334,6 +11254,17 @@ ], "traits": { "smithy.api#documentation": "Revokes function-use permission from an Amazon Web Servicesservice or another Amazon Web Services account. You\n can get the ID of the statement from the output of GetPolicy.
", + "smithy.api#examples": [ + { + "title": "To remove a Lambda function's permissions", + "documentation": "The following example removes a permissions statement named xaccount from the PROD alias of a function named my-function.", + "input": { + "FunctionName": "my-function", + "StatementId": "xaccount", + "Qualifier": "PROD" + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/2015-03-31/functions/{FunctionName}/policy/{StatementId}", @@ -11436,7 +12367,19 @@ } ], "traits": { - "smithy.api#documentation": "Adds tags to a function.
", + "smithy.api#documentation": "Adds tags to a function, event source mapping, or code signing configuration.
", + "smithy.api#examples": [ + { + "title": "To add tags to an existing Lambda function", + "documentation": "The following example adds a tag with the key name DEPARTMENT and a value of 'Department A' to the specified Lambda function.", + "input": { + "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Tags": { + "DEPARTMENT": "Department A" + } + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/2017-03-31/tags/{Resource}", @@ -11448,9 +12391,9 @@ "type": "structure", "members": { "Resource": { - "target": "com.amazonaws.lambda#FunctionArn", + "target": "com.amazonaws.lambda#TaggableResource", "traits": { - "smithy.api#documentation": "The function's Amazon Resource Name (ARN).
", + "smithy.api#documentation": "The resource's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11458,7 +12401,7 @@ "Tags": { "target": "com.amazonaws.lambda#Tags", "traits": { - "smithy.api#documentation": "A list of tags to apply to the function.
", + "smithy.api#documentation": "A list of tags to apply to the resource.
", "smithy.api#required": {} } } @@ -11470,6 +12413,16 @@ "com.amazonaws.lambda#TagValue": { "type": "string" }, + "com.amazonaws.lambda#TaggableResource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:(function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?|code-signing-config:csc-[a-z0-9]{17}|event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" + } + }, "com.amazonaws.lambda#Tags": { "type": "map", "key": { @@ -11703,7 +12656,19 @@ } ], "traits": { - "smithy.api#documentation": "Removes tags from a function.
", + "smithy.api#documentation": "Removes tags from a function, event source mapping, or code signing configuration.
", + "smithy.api#examples": [ + { + "title": "To remove tags from an existing Lambda function", + "documentation": "The following example removes the tag with the key name DEPARTMENT tag from the my-function Lambda function.", + "input": { + "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "TagKeys": [ + "DEPARTMENT" + ] + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/2017-03-31/tags/{Resource}", @@ -11715,9 +12680,9 @@ "type": "structure", "members": { "Resource": { - "target": "com.amazonaws.lambda#FunctionArn", + "target": "com.amazonaws.lambda#TaggableResource", "traits": { - "smithy.api#documentation": "The function's Amazon Resource Name (ARN).
", + "smithy.api#documentation": "The resource's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11725,7 +12690,7 @@ "TagKeys": { "target": "com.amazonaws.lambda#TagKeyList", "traits": { - "smithy.api#documentation": "A list of tag keys to remove from the function.
", + "smithy.api#documentation": "A list of tag keys to remove from the resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -11765,6 +12730,34 @@ ], "traits": { "smithy.api#documentation": "Updates the configuration of a Lambda function alias.
", + "smithy.api#examples": [ + { + "title": "To update a function alias", + "documentation": "The following example updates the alias named BLUE to send 30% of traffic to version 2 and 70% to version 1.", + "input": { + "FunctionName": "my-function", + "Name": "BLUE", + "FunctionVersion": "2", + "RoutingConfig": { + "AdditionalVersionWeights": { + "1": 0.7 + } + } + }, + "output": { + "FunctionVersion": "2", + "Name": "BLUE", + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", + "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93", + "Description": "Production environment BLUE.", + "RoutingConfig": { + "AdditionalVersionWeights": { + "1": 0.7 + } + } + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", @@ -12088,6 +13081,35 @@ ], "traits": { "smithy.api#documentation": "Updates a Lambda function's code. If code signing is enabled for the function, the code package\n must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda.
\nIf the function's package type is Image, then you must specify the code package in\n ImageUri as the URI of a container image in the Amazon ECR registry.
If the function's package type is Zip, then you must specify the deployment package as a .zip file\n archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide\n the function code inline using the ZipFile field.
The code in the deployment package must be compatible with the target instruction set architecture of the\n function (x86-64 or arm64).
The function's code is locked when you publish a version. You can't modify the code of a published version,\n only the unpublished version.
\nFor a function defined as a container image, Lambda resolves the image tag to an image digest. In\n Amazon ECR, if you update the image tag to a new image, Lambda does not automatically\n update the function.
\nModify the version-specific settings of a Lambda function.
\nWhen you update a function, Lambda provisions an instance of the function and its supporting\n resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify\n the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason,\n and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration\n indicate when the update is complete and the function is processing events with the new configuration. For more\n information, see Lambda\n function states.
These settings can vary between versions of a function and are locked when you publish a version. You can't\n modify the configuration of a published version, only the unpublished version.
\nTo configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions\n to an Amazon Web Services account or Amazon Web Servicesservice, use AddPermission.
", + "smithy.api#examples": [ + { + "title": "To update a Lambda function's configuration", + "documentation": "The following example modifies the memory size to be 256 MB for the unpublished ($LATEST) version of a function named my-function.", + "input": { + "FunctionName": "my-function", + "MemorySize": 256 + }, + "output": { + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", + "FunctionName": "my-function", + "CodeSize": 308, + "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6", + "MemorySize": 256, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function", + "Version": "$LATEST", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Timeout": 3, + "LastModified": "2019-08-14T22:26:11.234+0000", + "Handler": "index.handler", + "Runtime": "nodejs12.x", + "Description": "" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/2015-03-31/functions/{FunctionName}/configuration", @@ -12364,6 +13414,32 @@ ], "traits": { "smithy.api#documentation": "Updates the configuration for asynchronous invocation for a function, version, or alias.
\nTo configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
", + "smithy.api#examples": [ + { + "title": "To update an asynchronous invocation configuration", + "documentation": "The following example adds an on-failure destination to the existing asynchronous invocation configuration for a function named my-function.", + "input": { + "FunctionName": "my-function", + "DestinationConfig": { + "OnFailure": { + "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" + } + } + }, + "output": { + "LastModified": 1.573687896493E9, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", + "MaximumRetryAttempts": 0, + "MaximumEventAgeInSeconds": 3600, + "DestinationConfig": { + "OnSuccess": {}, + "OnFailure": { + "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" + } + } + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config", diff --git a/codegen/sdk-codegen/aws-models/mediaconvert.json b/codegen/sdk-codegen/aws-models/mediaconvert.json index 88d0462fe0e..69b3a72ff4f 100644 --- a/codegen/sdk-codegen/aws-models/mediaconvert.json +++ b/codegen/sdk-codegen/aws-models/mediaconvert.json @@ -8780,6 +8780,28 @@ "smithy.api#documentation": "Set Embedded timecode override to Use MDPM when your AVCHD input contains timecode tag data in the Modified Digital Video Pack Metadata. When you do, we recommend you also set Timecode source to Embedded. Leave Embedded timecode override blank, or set to None, when your input does not contain MDPM timecode." } }, + "com.amazonaws.mediaconvert#EncryptionContractConfiguration": { + "type": "structure", + "members": { + "SpekeAudioPreset": { + "target": "com.amazonaws.mediaconvert#PresetSpeke20Audio", + "traits": { + "smithy.api#documentation": "Specify which SPEKE version 2.0 audio preset MediaConvert uses to request content keys from your SPEKE server. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/drm-content-speke-v2-presets.html To encrypt to your audio outputs, choose from the following: Audio preset 1, Audio preset 2, or Audio preset 3. To encrypt your audio outputs, using the same content key for both your audio and video outputs: Choose Shared. When you do, you must also set SPEKE v2.0 video preset to Shared. To not encrypt your audio outputs: Choose Unencrypted. When you do, to encrypt your video outputs, you must also specify a SPEKE v2.0 video preset (other than Shared or Unencrypted).", + "smithy.api#jsonName": "spekeAudioPreset" + } + }, + "SpekeVideoPreset": { + "target": "com.amazonaws.mediaconvert#PresetSpeke20Video", + "traits": { + "smithy.api#documentation": "Specify which SPEKE version 2.0 video preset MediaConvert uses to request content keys from your SPEKE server. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/drm-content-speke-v2-presets.html To encrypt to your video outputs, choose from the following: Video preset 1, Video preset 2, Video preset 3, Video preset 4, Video preset 5, Video preset 6, Video preset 7, or Video preset 8. To encrypt your video outputs, using the same content key for both your video and audio outputs: Choose Shared. When you do, you must also set SPEKE v2.0 audio preset to Shared. To not encrypt your video outputs: Choose Unencrypted. When you do, to encrypt your audio outputs, you must also specify a SPEKE v2.0 audio preset (other than Shared or Unencrypted).", + "smithy.api#jsonName": "spekeVideoPreset" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify the SPEKE version, either v1.0 or v2.0, that MediaConvert uses when encrypting your output. For more information, see: https://docs.aws.amazon.com/speke/latest/documentation/speke-api-specification.html To use SPEKE v1.0: Leave blank. To use SPEKE v2.0: Specify a SPEKE v2.0 video preset and a SPEKE v2.0 audio preset." + } + }, "com.amazonaws.mediaconvert#Endpoint": { "type": "structure", "members": { @@ -20965,6 +20987,112 @@ "smithy.api#documentation": "Settings for preset" } }, + "com.amazonaws.mediaconvert#PresetSpeke20Audio": { + "type": "enum", + "members": { + "PRESET_AUDIO_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESET_AUDIO_1" + } + }, + "PRESET_AUDIO_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESET_AUDIO_2" + } + }, + "PRESET_AUDIO_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESET_AUDIO_3" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + }, + "UNENCRYPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNENCRYPTED" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify which SPEKE version 2.0 audio preset MediaConvert uses to request content keys from your SPEKE server. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/drm-content-speke-v2-presets.html To encrypt to your audio outputs, choose from the following: Audio preset 1, Audio preset 2, or Audio preset 3. To encrypt your audio outputs, using the same content key for both your audio and video outputs: Choose Shared. When you do, you must also set SPEKE v2.0 video preset to Shared. To not encrypt your audio outputs: Choose Unencrypted. When you do, to encrypt your video outputs, you must also specify a SPEKE v2.0 video preset (other than Shared or Unencrypted)." + } + }, + "com.amazonaws.mediaconvert#PresetSpeke20Video": { + "type": "enum", + "members": { + "PRESET_VIDEO_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESET_VIDEO_1" + } + }, + "PRESET_VIDEO_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESET_VIDEO_2" + } + }, + "PRESET_VIDEO_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESET_VIDEO_3" + } + }, + "PRESET_VIDEO_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESET_VIDEO_4" + } + }, + "PRESET_VIDEO_5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESET_VIDEO_5" + } + }, + "PRESET_VIDEO_6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESET_VIDEO_6" + } + }, + "PRESET_VIDEO_7": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESET_VIDEO_7" + } + }, + "PRESET_VIDEO_8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESET_VIDEO_8" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + }, + "UNENCRYPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNENCRYPTED" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify which SPEKE version 2.0 video preset MediaConvert uses to request content keys from your SPEKE server. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/drm-content-speke-v2-presets.html To encrypt to your video outputs, choose from the following: Video preset 1, Video preset 2, Video preset 3, Video preset 4, Video preset 5, Video preset 6, Video preset 7, or Video preset 8. To encrypt your video outputs, using the same content key for both your video and audio outputs: Choose Shared. When you do, you must also set SPEKE v2.0 audio preset to Shared. To not encrypt your video outputs: Choose Unencrypted. When you do, to encrypt your audio outputs, you must also specify a SPEKE v2.0 audio preset (other than Shared or Unencrypted)." + } + }, "com.amazonaws.mediaconvert#PricingPlan": { "type": "enum", "members": { @@ -22278,6 +22406,13 @@ "smithy.api#jsonName": "certificateArn" } }, + "EncryptionContractConfiguration": { + "target": "com.amazonaws.mediaconvert#EncryptionContractConfiguration", + "traits": { + "smithy.api#documentation": "Specify the SPEKE version, either v1.0 or v2.0, that MediaConvert uses when encrypting your output. For more information, see: https://docs.aws.amazon.com/speke/latest/documentation/speke-api-specification.html To use SPEKE v1.0: Leave blank. To use SPEKE v2.0: Specify a SPEKE v2.0 video preset and a SPEKE v2.0 audio preset.", + "smithy.api#jsonName": "encryptionContractConfiguration" + } + }, "ResourceId": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -22321,6 +22456,13 @@ "smithy.api#jsonName": "dashSignaledSystemIds" } }, + "EncryptionContractConfiguration": { + "target": "com.amazonaws.mediaconvert#EncryptionContractConfiguration", + "traits": { + "smithy.api#documentation": "Specify the SPEKE version, either v1.0 or v2.0, that MediaConvert uses when encrypting your output. For more information, see: https://docs.aws.amazon.com/speke/latest/documentation/speke-api-specification.html To use SPEKE v1.0: Leave blank. To use SPEKE v2.0: Specify a SPEKE v2.0 video preset and a SPEKE v2.0 audio preset.", + "smithy.api#jsonName": "encryptionContractConfiguration" + } + }, "HlsSignaledSystemIds": { "target": "com.amazonaws.mediaconvert#__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12", "traits": { diff --git a/codegen/sdk-codegen/aws-models/medialive.json b/codegen/sdk-codegen/aws-models/medialive.json index b12751d814d..ee2f344e0bf 100644 --- a/codegen/sdk-codegen/aws-models/medialive.json +++ b/codegen/sdk-codegen/aws-models/medialive.json @@ -1991,6 +1991,98 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.medialive#BandwidthReductionFilterSettings": { + "type": "structure", + "members": { + "PostFilterSharpening": { + "target": "com.amazonaws.medialive#BandwidthReductionPostFilterSharpening", + "traits": { + "smithy.api#documentation": "Configures the sharpening control, which is available when the bandwidth reduction filter is enabled. This\ncontrol sharpens edges and contours, which produces a specific artistic effect that you might want.\n\nWe recommend that you test each of the values (including DISABLED) to observe the sharpening effect on the\ncontent.", + "smithy.api#jsonName": "postFilterSharpening" + } + }, + "Strength": { + "target": "com.amazonaws.medialive#BandwidthReductionFilterStrength", + "traits": { + "smithy.api#documentation": "Enables the bandwidth reduction filter. The filter strengths range from 1 to 4. We recommend that you always\nenable this filter and use AUTO, to let MediaLive apply the optimum filtering for the context.", + "smithy.api#jsonName": "strength" + } + } + }, + "traits": { + "smithy.api#documentation": "Bandwidth Reduction Filter Settings" + } + }, + "com.amazonaws.medialive#BandwidthReductionFilterStrength": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "STRENGTH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRENGTH_1" + } + }, + "STRENGTH_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRENGTH_2" + } + }, + "STRENGTH_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRENGTH_3" + } + }, + "STRENGTH_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRENGTH_4" + } + } + }, + "traits": { + "smithy.api#documentation": "Bandwidth Reduction Filter Strength" + } + }, + "com.amazonaws.medialive#BandwidthReductionPostFilterSharpening": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "SHARPENING_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARPENING_1" + } + }, + "SHARPENING_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARPENING_2" + } + }, + "SHARPENING_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARPENING_3" + } + } + }, + "traits": { + "smithy.api#documentation": "Bandwidth Reduction Post Filter Sharpening" + } + }, "com.amazonaws.medialive#BatchDelete": { "type": "operation", "input": { @@ -15485,6 +15577,12 @@ "traits": { "smithy.api#jsonName": "temporalFilterSettings" } + }, + "BandwidthReductionFilterSettings": { + "target": "com.amazonaws.medialive#BandwidthReductionFilterSettings", + "traits": { + "smithy.api#jsonName": "bandwidthReductionFilterSettings" + } } }, "traits": { @@ -16428,6 +16526,12 @@ "traits": { "smithy.api#jsonName": "temporalFilterSettings" } + }, + "BandwidthReductionFilterSettings": { + "target": "com.amazonaws.medialive#BandwidthReductionFilterSettings", + "traits": { + "smithy.api#jsonName": "bandwidthReductionFilterSettings" + } } }, "traits": { @@ -19975,7 +20079,7 @@ } }, "traits": { - "smithy.api#documentation": "With the introduction of MediaLive OnPrem, a MediaLive input can now exist in two different places: AWS or\ninside an on-premise datacenter. By default all inputs will continue to be AWS inputs." + "smithy.api#documentation": "With the introduction of MediaLive Anywhere, a MediaLive input can now exist in two different places: AWS or\ninside an on-premises datacenter. By default all inputs will continue to be AWS inputs." } }, "com.amazonaws.medialive#InputPreference": { @@ -25996,6 +26100,20 @@ "smithy.api#documentation": "The multiplex object." } }, + "com.amazonaws.medialive#MultiplexContainerSettings": { + "type": "structure", + "members": { + "MultiplexM2tsSettings": { + "target": "com.amazonaws.medialive#MultiplexM2tsSettings", + "traits": { + "smithy.api#jsonName": "multiplexM2tsSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Multiplex Container Settings" + } + }, "com.amazonaws.medialive#MultiplexGroupSettings": { "type": "structure", "members": {}, @@ -26003,6 +26121,112 @@ "smithy.api#documentation": "Multiplex Group Settings" } }, + "com.amazonaws.medialive#MultiplexM2tsSettings": { + "type": "structure", + "members": { + "AbsentInputAudioBehavior": { + "target": "com.amazonaws.medialive#M2tsAbsentInputAudioBehavior", + "traits": { + "smithy.api#documentation": "When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.", + "smithy.api#jsonName": "absentInputAudioBehavior" + } + }, + "Arib": { + "target": "com.amazonaws.medialive#M2tsArib", + "traits": { + "smithy.api#documentation": "When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.", + "smithy.api#jsonName": "arib" + } + }, + "AudioBufferModel": { + "target": "com.amazonaws.medialive#M2tsAudioBufferModel", + "traits": { + "smithy.api#documentation": "When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.", + "smithy.api#jsonName": "audioBufferModel" + } + }, + "AudioFramesPerPes": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "The number of audio frames to insert for each PES packet.", + "smithy.api#jsonName": "audioFramesPerPes" + } + }, + "AudioStreamType": { + "target": "com.amazonaws.medialive#M2tsAudioStreamType", + "traits": { + "smithy.api#documentation": "When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.", + "smithy.api#jsonName": "audioStreamType" + } + }, + "CcDescriptor": { + "target": "com.amazonaws.medialive#M2tsCcDescriptor", + "traits": { + "smithy.api#documentation": "When set to enabled, generates captionServiceDescriptor in PMT.", + "smithy.api#jsonName": "ccDescriptor" + } + }, + "Ebif": { + "target": "com.amazonaws.medialive#M2tsEbifControl", + "traits": { + "smithy.api#documentation": "If set to passthrough, passes any EBIF data from the input source to this output.", + "smithy.api#jsonName": "ebif" + } + }, + "EsRateInPes": { + "target": "com.amazonaws.medialive#M2tsEsRateInPes", + "traits": { + "smithy.api#documentation": "Include or exclude the ES Rate field in the PES header.", + "smithy.api#jsonName": "esRateInPes" + } + }, + "Klv": { + "target": "com.amazonaws.medialive#M2tsKlv", + "traits": { + "smithy.api#documentation": "If set to passthrough, passes any KLV data from the input source to this output.", + "smithy.api#jsonName": "klv" + } + }, + "NielsenId3Behavior": { + "target": "com.amazonaws.medialive#M2tsNielsenId3Behavior", + "traits": { + "smithy.api#documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", + "smithy.api#jsonName": "nielsenId3Behavior" + } + }, + "PcrControl": { + "target": "com.amazonaws.medialive#M2tsPcrControl", + "traits": { + "smithy.api#documentation": "When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.", + "smithy.api#jsonName": "pcrControl" + } + }, + "PcrPeriod": { + "target": "com.amazonaws.medialive#__integerMin0Max500", + "traits": { + "smithy.api#documentation": "Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.", + "smithy.api#jsonName": "pcrPeriod" + } + }, + "Scte35Control": { + "target": "com.amazonaws.medialive#M2tsScte35Control", + "traits": { + "smithy.api#documentation": "Optionally pass SCTE-35 signals from the input source to this output.", + "smithy.api#jsonName": "scte35Control" + } + }, + "Scte35PrerollPullupMilliseconds": { + "target": "com.amazonaws.medialive#__doubleMin0Max5000", + "traits": { + "smithy.api#documentation": "Defines the amount SCTE-35 preroll will be increased (in milliseconds) on the output. Preroll is the amount of time between the presence of a SCTE-35 indication in a transport stream and the PTS of the video frame it references. Zero means don't add pullup (it doesn't mean set the preroll to zero). Negative pullup is not supported, which means that you can't make the preroll shorter. Be aware that latency in the output will increase by the pullup amount.", + "smithy.api#jsonName": "scte35PrerollPullupMilliseconds" + } + } + }, + "traits": { + "smithy.api#documentation": "Multiplex M2ts Settings" + } + }, "com.amazonaws.medialive#MultiplexMediaConnectOutputDestinationSettings": { "type": "structure", "members": { @@ -26044,6 +26268,12 @@ "smithy.api#jsonName": "destination", "smithy.api#required": {} } + }, + "ContainerSettings": { + "target": "com.amazonaws.medialive#MultiplexContainerSettings", + "traits": { + "smithy.api#jsonName": "containerSettings" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index 04b27dedce3..2a69f098a82 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -6679,6 +6679,23 @@ "smithy.api#documentation": "A combo chart.
\nThe ComboChartVisual includes stacked bar combo charts and clustered bar combo charts
For more information, see Using combo charts in the Amazon QuickSight User Guide.
" } }, + "com.amazonaws.quicksight#CommitMode": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, "com.amazonaws.quicksight#ComparativeOrder": { "type": "structure", "members": { @@ -14472,6 +14489,12 @@ "traits": { "smithy.api#documentation": "The display options of a control.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a DateTimePickerControl.
A list of selectable values that are used in a control.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a FilterDropDownControl.
The display options of a control.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a RelativeDateTimeControl.
The type of the FilterDropDownControl. Choose one of the following options:
\n MULTI_SELECT: The user can select multiple entries from a dropdown menu.
\n SINGLE_SELECT: The user can select a single entry from a dropdown menu.
The visibility configurationof the Apply button on a DateTimePickerControl.
The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a FilterDropDownControl.
The display options of a control.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a FilterRelativeDateTimeControl.
List all folders that a resource is a member of.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/resource/{ResourceArn}/folders", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Folders", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListFoldersForResourceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) the resource whose folders you need to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned per request.
", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListFoldersForResourceResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "Folders": { + "target": "com.amazonaws.quicksight#FoldersForResourceArnList", + "traits": { + "smithy.api#documentation": "A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member of.
" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#ListFoldersRequest": { "type": "structure", "members": { @@ -35799,6 +35982,12 @@ "traits": { "smithy.api#documentation": "The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a ParameterDropDownControl.
Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built specifically to facilitate\n secure, web-based workloads. WorkSpaces Secure Browser makes it easy for customers to safely provide\n their employees with access to internal websites and SaaS web applications without the\n administrative burden of appliances or specialized client software. WorkSpaces Secure Browser provides\n simple policy tools tailored for user interactions, while offloading common tasks like\n capacity management, scaling, and maintaining browser images.
", + "smithy.api#documentation": "Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built\n specifically to facilitate secure, web-based workloads. WorkSpaces Secure Browser makes it\n easy for customers to safely provide their employees with access to internal websites and\n SaaS web applications without the administrative burden of appliances or specialized client\n software. WorkSpaces Secure Browser provides simple policy tools tailored for user\n interactions, while offloading common tasks like capacity management, scaling, and\n maintaining browser images.
", "smithy.api#title": "Amazon WorkSpaces Web", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1303,7 +1312,7 @@ "customerManagedKey": { "target": "com.amazonaws.workspacesweb#keyArn", "traits": { - "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the browser settings.
" + "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the browser\n settings.
" } }, "additionalEncryptionContext": { @@ -1636,19 +1645,19 @@ "allowlist": { "target": "com.amazonaws.workspacesweb#CookieSpecifications", "traits": { - "smithy.api#documentation": "The list of cookie specifications that are allowed to be synchronized to the remote browser.
", + "smithy.api#documentation": "The list of cookie specifications that are allowed to be synchronized to the remote\n browser.
", "smithy.api#required": {} } }, "blocklist": { "target": "com.amazonaws.workspacesweb#CookieSpecifications", "traits": { - "smithy.api#documentation": "The list of cookie specifications that are blocked from being synchronized to the remote browser.
" + "smithy.api#documentation": "The list of cookie specifications that are blocked from being synchronized to the remote\n browser.
" } } }, "traits": { - "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
", + "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end\n user's local browser to the remote browser.
", "smithy.api#sensitive": {} } }, @@ -1724,7 +1733,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.\n
", "smithy.api#idempotencyToken": {} } } @@ -1815,7 +1824,7 @@ "identityProviderDetails": { "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n token_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n attributes_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n jwks_uri\n if not available from discovery URL specified by\n oidc_issuer key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout (boolean) \n optional\n
\n IDPInit (boolean) optional\n
\n RequestSigningAlgorithm (string) optional\n - Only accepts rsa-sha256\n
\n EncryptedResponses (boolean) optional\n
The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n token_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n attributes_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n jwks_uri\n if not available from discovery URL specified by\n oidc_issuer key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout (boolean) optional\n
\n IDPInit (boolean) optional\n
\n RequestSigningAlgorithm (string) optional\n - Only accepts rsa-sha256\n
\n EncryptedResponses (boolean) optional\n
The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.
", + "smithy.api#documentation": "The subnets in which network interfaces are created to connect streaming instances to\n your VPC. At least two of these subnets must be in different availability zones.
", "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.workspacesweb#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "One or more security groups used to control access from streaming instances to your VPC.
", + "smithy.api#documentation": "One or more security groups used to control access from streaming instances to your\n VPC.
", "smithy.api#required": {} } }, @@ -2098,7 +2107,7 @@ "displayName": { "target": "com.amazonaws.workspacesweb#DisplayName", "traits": { - "smithy.api#documentation": "The name of the web portal. This is not visible to users who log into the web portal.
" + "smithy.api#documentation": "The name of the web portal. This is not visible to users who log into the web\n portal.
" } }, "tags": { @@ -2130,7 +2139,7 @@ "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.
The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources\n (including external identity provider integration), plus user and group access to your web\n portal, can be configured in the IAM Identity Center.
The endpoint URL of the web portal that users access in order to start streaming sessions.
", + "smithy.api#documentation": "The endpoint URL of the web portal that users access in order to start streaming\n sessions.
", "smithy.api#required": {} } } @@ -2282,7 +2291,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a user access logging settings resource that can be associated with a web portal.
", + "smithy.api#documentation": "Creates a user access logging settings resource that can be associated with a web\n portal.
", "smithy.api#http": { "method": "POST", "uri": "/userAccessLoggingSettings", @@ -2420,14 +2429,14 @@ "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect.
" + "smithy.api#documentation": "The amount of time that a streaming session remains active after users\n disconnect.
" } }, "idleDisconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from\n their streaming session and the disconnect timeout interval begins.
" } }, "clientToken": { @@ -2440,13 +2449,13 @@ "cookieSynchronizationConfiguration": { "target": "com.amazonaws.workspacesweb#CookieSynchronizationConfiguration", "traits": { - "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
" + "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end\n user's local browser to the remote browser.
" } }, "customerManagedKey": { "target": "com.amazonaws.workspacesweb#keyArn", "traits": { - "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the user settings.
" + "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the user\n settings.
" } }, "additionalEncryptionContext": { @@ -2458,7 +2467,7 @@ "deepLinkAllowed": { "target": "com.amazonaws.workspacesweb#EnabledType", "traits": { - "smithy.api#documentation": "Specifies whether the user can use deep links that open automatically when connecting to a session.
" + "smithy.api#documentation": "Specifies whether the user can use deep links that open automatically when connecting to\n a session.
" } } }, @@ -3369,6 +3378,72 @@ "com.amazonaws.workspacesweb#ExceptionMessage": { "type": "string" }, + "com.amazonaws.workspacesweb#ExpireSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#ExpireSessionRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#ExpireSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Expires an active secure browser session.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/portals/{portalId}/sessions/{sessionId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#ExpireSessionRequest": { + "type": "structure", + "members": { + "portalId": { + "target": "com.amazonaws.workspacesweb#PortalId", + "traits": { + "smithy.api#documentation": "The ID of the web portal for the session.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.workspacesweb#SessionId", + "traits": { + "smithy.api#documentation": "The ID of the session to expire.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspacesweb#ExpireSessionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspacesweb#FieldName": { "type": "string" }, @@ -3775,6 +3850,80 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspacesweb#GetSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#GetSessionRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#GetSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information for a secure browser session.
", + "smithy.api#http": { + "method": "GET", + "uri": "/portals/{portalId}/sessions/{sessionId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#GetSessionRequest": { + "type": "structure", + "members": { + "portalId": { + "target": "com.amazonaws.workspacesweb#PortalId", + "traits": { + "smithy.api#documentation": "The ID of the web portal for the session.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.workspacesweb#SessionId", + "traits": { + "smithy.api#documentation": "The ID of the session.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspacesweb#GetSessionResponse": { + "type": "structure", + "members": { + "session": { + "target": "com.amazonaws.workspacesweb#Session", + "traits": { + "smithy.api#documentation": "The sessions in a list.
", + "smithy.api#nestedProperties": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspacesweb#GetTrustStore": { "type": "operation", "input": { @@ -4083,7 +4232,7 @@ "identityProviderDetails": { "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n token_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n attributes_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n jwks_uri\n if not available from discovery URL specified by oidc_issuer\n key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout (boolean) optional\n
\n IDPInit (boolean) optional\n
\n RequestSigningAlgorithm (string) optional\n - Only accepts rsa-sha256\n
\n EncryptedResponses (boolean) optional\n
The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n token_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n attributes_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n jwks_uri\n if not available from discovery URL specified by oidc_issuer\n key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout (boolean) optional\n
\n IDPInit (boolean) optional\n
\n RequestSigningAlgorithm (string) optional\n - Only accepts rsa-sha256\n
\n EncryptedResponses (boolean) optional\n
A list of web portal ARNs that this IP access settings resource is associated with.
" + "smithy.api#documentation": "A list of web portal ARNs that this IP access settings resource is associated\n with.
" } }, "ipRules": { @@ -4324,7 +4473,7 @@ "customerManagedKey": { "target": "com.amazonaws.workspacesweb#keyArn", "traits": { - "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the IP access settings.
" + "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the IP access\n settings.
" } }, "additionalEncryptionContext": { @@ -4439,6 +4588,29 @@ "smithy.api#documentation": "The summary of IP access settings.
" } }, + "com.amazonaws.workspacesweb#IpAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.workspacesweb#IpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#IpAddress" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 45 + } + } + }, "com.amazonaws.workspacesweb#IpRange": { "type": "string", "traits": { @@ -4535,7 +4707,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
", "smithy.api#httpQuery": "nextToken" } }, @@ -4563,7 +4735,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" } } }, @@ -4614,7 +4786,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
", "smithy.api#httpQuery": "nextToken" } }, @@ -4644,7 +4816,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" } }, "identityProviders": { @@ -4701,7 +4873,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
", "smithy.api#httpQuery": "nextToken" } }, @@ -4729,7 +4901,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" } } }, @@ -4780,7 +4952,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
", "smithy.api#httpQuery": "nextToken" } }, @@ -4808,7 +4980,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" } } }, @@ -4859,7 +5031,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.\n
", "smithy.api#httpQuery": "nextToken" } }, @@ -4887,7 +5059,127 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspacesweb#ListSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#ListSessionsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#ListSessionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists information for multiple secure browser sessions from a specific portal.
", + "smithy.api#http": { + "method": "GET", + "uri": "/portals/{portalId}/sessions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "sessions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#ListSessionsRequest": { + "type": "structure", + "members": { + "portalId": { + "target": "com.amazonaws.workspacesweb#PortalId", + "traits": { + "smithy.api#documentation": "The ID of the web portal for the sessions.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "username": { + "target": "com.amazonaws.workspacesweb#Username", + "traits": { + "smithy.api#documentation": "The username of the session.
", + "smithy.api#httpQuery": "username" + } + }, + "sessionId": { + "target": "com.amazonaws.workspacesweb#SessionId", + "traits": { + "smithy.api#documentation": "The ID of the session.
", + "smithy.api#httpQuery": "sessionId" + } + }, + "sortBy": { + "target": "com.amazonaws.workspacesweb#SessionSortBy", + "traits": { + "smithy.api#documentation": "The method in which the returned sessions should be sorted.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "status": { + "target": "com.amazonaws.workspacesweb#SessionStatus", + "traits": { + "smithy.api#documentation": "The status of the session.
", + "smithy.api#httpQuery": "status" + } + }, + "maxResults": { + "target": "com.amazonaws.workspacesweb#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be included in the next page.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspacesweb#ListSessionsResponse": { + "type": "structure", + "members": { + "sessions": { + "target": "com.amazonaws.workspacesweb#SessionSummaryList", + "traits": { + "smithy.api#documentation": "The sessions in a list.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" } } }, @@ -5015,7 +5307,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
", "smithy.api#httpQuery": "nextToken", "smithy.api#notProperty": {} } @@ -5056,7 +5348,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.>
", + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.>
", "smithy.api#notProperty": {} } } @@ -5108,7 +5400,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
", "smithy.api#httpQuery": "nextToken" } }, @@ -5136,7 +5428,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" } } }, @@ -5187,7 +5479,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
", "smithy.api#httpQuery": "nextToken" } }, @@ -5215,7 +5507,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" } } }, @@ -5266,7 +5558,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.\n
", "smithy.api#httpQuery": "nextToken" } }, @@ -5294,7 +5586,7 @@ "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.\n
" } } }, @@ -5345,13 +5637,13 @@ "subnetIds": { "target": "com.amazonaws.workspacesweb#SubnetIdList", "traits": { - "smithy.api#documentation": "The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.
" + "smithy.api#documentation": "The subnets in which network interfaces are created to connect streaming instances to\n your VPC. At least two of these subnets must be in different availability zones.
" } }, "securityGroupIds": { "target": "com.amazonaws.workspacesweb#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "One or more security groups used to control access from streaming instances to your VPC.
" + "smithy.api#documentation": "One or more security groups used to control access from streaming instances to your VPC.\n
" } } }, @@ -5529,13 +5821,13 @@ "userAccessLoggingSettingsArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { - "smithy.api#documentation": "The ARN of the user access logging settings that is associated with the web portal.
" + "smithy.api#documentation": "The ARN of the user access logging settings that is associated with the web\n portal.
" } }, "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.
The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources\n (including external identity provider integration), plus user and group access to your web\n portal, can be configured in the IAM Identity Center.
The ARN of the user access logging settings that is associated with the web portal.
" + "smithy.api#documentation": "The ARN of the user access logging settings that is associated with the web\n portal.
" } }, "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.
The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources\n (including external identity provider integration), plus user and group access to your web\n portal, can be configured in the IAM Identity Center.
The ARN of the web portal.
" + } + }, + "sessionId": { + "target": "com.amazonaws.workspacesweb#StringType", + "traits": { + "smithy.api#documentation": "The ID of the session.
" + } + }, + "username": { + "target": "com.amazonaws.workspacesweb#Username", + "traits": { + "smithy.api#documentation": "The username of the session.
" + } + }, + "clientIpAddresses": { + "target": "com.amazonaws.workspacesweb#IpAddressList", + "traits": { + "smithy.api#documentation": "The IP address of the client.
" + } + }, + "status": { + "target": "com.amazonaws.workspacesweb#SessionStatus", + "traits": { + "smithy.api#documentation": "The status of the session.
" + } + }, + "startTime": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the session.
" + } + }, + "endTime": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a secure browser session.
" + } + }, + "com.amazonaws.workspacesweb#SessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.workspacesweb#SessionSortBy": { + "type": "enum", + "members": { + "START_TIME_ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartTimeAscending" + } + }, + "START_TIME_DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartTimeDescending" + } + } + } + }, + "com.amazonaws.workspacesweb#SessionStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminated" + } + } + } + }, + "com.amazonaws.workspacesweb#SessionSummary": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
" + } + }, + "sessionId": { + "target": "com.amazonaws.workspacesweb#StringType", + "traits": { + "smithy.api#documentation": "The ID of the session.
" + } + }, + "username": { + "target": "com.amazonaws.workspacesweb#Username", + "traits": { + "smithy.api#documentation": "The username of the session.
" + } + }, + "status": { + "target": "com.amazonaws.workspacesweb#SessionStatus", + "traits": { + "smithy.api#documentation": "The status of the session.
" + } + }, + "startTime": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the session.
" + } + }, + "endTime": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a secure browser session.
" + } + }, + "com.amazonaws.workspacesweb#SessionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#SessionSummary" + } + }, "com.amazonaws.workspacesweb#StatusReason": { "type": "string", "traits": { @@ -6023,7 +6469,7 @@ "traits": { "smithy.api#length": { "min": 2, - "max": 3 + "max": 5 } } }, @@ -6542,7 +6988,7 @@ "identityProviderDetails": { "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "The details of the identity provider. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n token_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n attributes_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n jwks_uri\n if not available from discovery URL specified by\n oidc_issuer key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout (boolean) optional\n
\n IDPInit (boolean) optional\n
\n RequestSigningAlgorithm (string) optional\n - Only accepts rsa-sha256\n
\n EncryptedResponses (boolean) optional\n
The details of the identity provider. The following list describes the provider detail\n keys for each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n token_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n attributes_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n jwks_uri\n if not available from discovery URL specified by\n oidc_issuer key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout (boolean) optional\n
\n IDPInit (boolean) optional\n
\n RequestSigningAlgorithm (string) optional\n - Only accepts rsa-sha256\n
\n EncryptedResponses (boolean) optional\n
The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.
" + "smithy.api#documentation": "The subnets in which network interfaces are created to connect streaming instances to\n your VPC. At least two of these subnets must be in different availability zones.
" } }, "securityGroupIds": { "target": "com.amazonaws.workspacesweb#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "One or more security groups used to control access from streaming instances to your VPC.
" + "smithy.api#documentation": "One or more security groups used to control access from streaming instances to your\n VPC.
" } }, "clientToken": { @@ -6810,13 +7256,13 @@ "displayName": { "target": "com.amazonaws.workspacesweb#DisplayName", "traits": { - "smithy.api#documentation": "The name of the web portal. This is not visible to users who log into the web portal.
" + "smithy.api#documentation": "The name of the web portal. This is not visible to users who log into the web\n portal.
" } }, "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.
The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources\n (including external identity provider integration), plus user and group access to your web\n portal, can be configured in the IAM Identity Center.
The amount of time that a streaming session remains active after users disconnect.
" + "smithy.api#documentation": "The amount of time that a streaming session remains active after users\n disconnect.
" } }, "idleDisconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from\n their streaming session and the disconnect timeout interval begins.
" } }, "clientToken": { @@ -7118,13 +7564,13 @@ "cookieSynchronizationConfiguration": { "target": "com.amazonaws.workspacesweb#CookieSynchronizationConfiguration", "traits": { - "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
\nIf the allowlist and blocklist are empty, the configuration becomes null.
" + "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end\n user's local browser to the remote browser.
\nIf the allowlist and blocklist are empty, the configuration becomes null.
" } }, "deepLinkAllowed": { "target": "com.amazonaws.workspacesweb#EnabledType", "traits": { - "smithy.api#documentation": "Specifies whether the user can use deep links that open automatically when connecting to a session.
" + "smithy.api#documentation": "Specifies whether the user can use deep links that open automatically when connecting to\n a session.
" } } }, @@ -7162,7 +7608,7 @@ "associatedPortalArns": { "target": "com.amazonaws.workspacesweb#ArnList", "traits": { - "smithy.api#documentation": "A list of web portal ARNs that this user access logging settings is associated with.
" + "smithy.api#documentation": "A list of web portal ARNs that this user access logging settings is associated\n with.
" } }, "kinesisStreamArn": { @@ -7301,26 +7747,26 @@ "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect.
" + "smithy.api#documentation": "The amount of time that a streaming session remains active after users\n disconnect.
" } }, "idleDisconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from\n their streaming session and the disconnect timeout interval begins.
" } }, "cookieSynchronizationConfiguration": { "target": "com.amazonaws.workspacesweb#CookieSynchronizationConfiguration", "traits": { - "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
" + "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end\n user's local browser to the remote browser.
" } }, "customerManagedKey": { "target": "com.amazonaws.workspacesweb#keyArn", "traits": { - "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the user settings.
" + "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the user\n settings.
" } }, "additionalEncryptionContext": { @@ -7332,7 +7778,7 @@ "deepLinkAllowed": { "target": "com.amazonaws.workspacesweb#EnabledType", "traits": { - "smithy.api#documentation": "Specifies whether the user can use deep links that open automatically when connecting to a session.
" + "smithy.api#documentation": "Specifies whether the user can use deep links that open automatically when connecting to\n a session.
" } } }, @@ -7467,26 +7913,26 @@ "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect.
" + "smithy.api#documentation": "The amount of time that a streaming session remains active after users\n disconnect.
" } }, "idleDisconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from\n their streaming session and the disconnect timeout interval begins.
" } }, "cookieSynchronizationConfiguration": { "target": "com.amazonaws.workspacesweb#CookieSynchronizationConfiguration", "traits": { - "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
" + "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end\n user's local browser to the remote browser.
" } }, "deepLinkAllowed": { "target": "com.amazonaws.workspacesweb#EnabledType", "traits": { - "smithy.api#documentation": "Specifies whether the user can use deep links that open automatically when connecting to a session.
" + "smithy.api#documentation": "Specifies whether the user can use deep links that open automatically when connecting to\n a session.
" } } }, @@ -7494,6 +7940,17 @@ "smithy.api#documentation": "The summary of user settings.
" } }, + "com.amazonaws.workspacesweb#Username": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.workspacesweb#ValidationException": { "type": "structure", "members": {